2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
5 * Copyright (c) 2017,2018,2019,2020, by the GROMACS development team, led by
6 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7 * and including many others, as listed in the AUTHORS file in the
8 * top-level source directory and at http://www.gromacs.org.
10 * GROMACS is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public License
12 * as published by the Free Software Foundation; either version 2.1
13 * of the License, or (at your option) any later version.
15 * GROMACS is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with GROMACS; if not, see
22 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * If you want to redistribute modifications to GROMACS, please
26 * consider that scientific software is very special. Version
27 * control is crucial - bugs must be traceable. We will be happy to
28 * consider code for inclusion in the official distribution, but
29 * derived work must not be called official GROMACS. Details are found
30 * in the README & COPYING files - if they are missing, get the
31 * official version at http://www.gromacs.org.
33 * To help us fund GROMACS development, we humbly ask that you cite
34 * the research papers on the package. Check out http://www.gromacs.org.
38 * Functions for initialing \Gromacs unit test executables.
40 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_testutils
43 #ifndef GMX_TESTUTILS_TESTINIT_H
44 #define GMX_TESTUTILS_TESTINIT_H
55 * Initializes the test utilities library.
57 * Does not throw. Terminates the program with a non-zero error code if an
60 * This function is automatically called by unittest_main.cpp.
62 * \param[in] dataPath Filepath to input files.
63 * \param[in] tempPath Filepath to temporary files.
64 * \param[in] usesMpi If the test is run with MPI or not.
65 * \param[in] usesHardwareDetection If hardwaredetection is enabled.
66 * \param[in] argc Number of cmdline options
67 * \param[in] argv Cmdline options.
69 * \ingroup module_testutils
71 void initTestUtils(const char* dataPath,
74 bool usesHardwareDetection,
80 * Finalizes the test utilities library.
82 * Does not throw. Terminates the program with a non-zero error code if an
85 * This function is automatically called by unittest_main.cpp.
87 * \ingroup module_testutils
89 void finalizeTestUtils();
92 /*! \brief Declare a function that all unit test implementations can use
93 * to set up any environment that they need.
95 * When registering the unit test in CMake, the HARDWARE_DETECTION
96 * flag requires that the code for that unit test implements this
97 * function. Otherwise, a default stub implementation is provided.
99 * This approach conforms to the recommendation by GoogleTest to
100 * arrange for the code that sets up the global test environment to be
101 * called from main, rather than potentially rely on brittle static
102 * initialization order. */
103 void callAddGlobalTestEnvironment();