Allow MPI-enabled clients to provide the library communicator.
[alexxy/gromacs.git] / src / api / cpp / tests / CMakeLists.txt
1 #
2 # This file is part of the GROMACS molecular simulation package.
3 #
4 # Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 # and including many others, as listed in the AUTHORS file in the
7 # top-level source directory and at http://www.gromacs.org.
8 #
9 # GROMACS is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public License
11 # as published by the Free Software Foundation; either version 2.1
12 # of the License, or (at your option) any later version.
13 #
14 # GROMACS is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # Lesser General Public License for more details.
18 #
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with GROMACS; if not, see
21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23 #
24 # If you want to redistribute modifications to GROMACS, please
25 # consider that scientific software is very special. Version
26 # control is crucial - bugs must be traceable. We will be happy to
27 # consider code for inclusion in the official distribution, but
28 # derived work must not be called official GROMACS. Details are found
29 # in the README & COPYING files - if they are missing, get the
30 # official version at http://www.gromacs.org.
31 #
32 # To help us fund GROMACS development, we humbly ask that you cite
33 # the research papers on the package. Check out http://www.gromacs.org.
34
35 # For an executable target already defined, CMake tests are added with the
36 # following syntax:
37 #
38 # add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]]
39 #            [WORKING_DIRECTORY dir]
40 #            COMMAND <command> [arg1 [arg2 ...]])
41 #
42 # The GROMACS convention to get the appropriate compilation environment for
43 # unit tests is the gmx_add_unit_test macro, defined in
44 # src/testutils/TestMacros.cmake, which does not allow arbitrary argument
45 # passing to add_test. Instead, use set_tests_properties().
46
47 #
48 # Test public interface.
49 #
50
51 add_library(gmxapi-testsupport INTERFACE)
52 target_include_directories(gmxapi-testsupport INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
53
54 # TODO: Test tMPI build in a MPI-enabled client context.
55 gmx_add_gtest_executable(gmxapi-test
56     CPP_SOURCE_FILES
57         restraint.cpp
58         runner.cpp
59         status.cpp
60         stopsignaler.cpp
61         system.cpp
62         version.cpp
63         # pseudo-library for code for mdrun
64         $<TARGET_OBJECTS:mdrun_objlib>
65         )
66
67 # Link against the gmxapi libraries and get access to its public (installed) headers.
68 target_link_libraries(gmxapi-test PRIVATE Gromacs::gmxapi gmxapi-testsupport mdrun_test_infrastructure)
69
70 gmx_register_gtest_test(GmxapiExternalInterfaceTests gmxapi-test OPENMP_THREADS 2 INTEGRATION_TEST IGNORE_LEAKS)
71
72 set_tests_properties(GmxapiExternalInterfaceTests PROPERTIES
73                      WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
74
75 #
76 # Test public interface with MPI.
77 #
78 # gmxapi is expected to work whether or not GROMACS was built with MPI (or tMPI)
79 # but we don't assume that MPI is available to the build tree or testing tools
80 # unless CMake was configured with MPI.
81 #
82 # For MPI-enabled testing of gmxapi clients using non-MPI-enabled GROMACS, we
83 # defer testing to the Python gmxapi client package tests.
84 #
85 if (GMX_MPI)
86     gmx_add_gtest_executable(gmxapi-mpi-test MPI
87                              CPP_SOURCE_FILES
88                              context.cpp
89                              restraint.cpp
90                              runner.cpp
91                              status.cpp
92                              stopsignaler.cpp
93                              system.cpp
94                              version.cpp
95                              # pseudo-library for code for mdrun
96                              $<TARGET_OBJECTS:mdrun_objlib>
97                              )
98
99     target_include_directories(gmxapi-mpi-test PRIVATE
100                                ${CMAKE_CURRENT_SOURCE_DIR})
101     target_link_libraries(gmxapi-mpi-test PRIVATE Gromacs::gmxapi gmxapi-testsupport mdrun_test_infrastructure)
102
103     gmx_register_gtest_test(GmxapiMpiTests gmxapi-mpi-test MPI_RANKS 2 OPENMP_THREADS 2 INTEGRATION_TEST IGNORE_LEAKS)
104
105     set_tests_properties(GmxapiMpiTests PROPERTIES
106                          WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
107 endif ()