2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * directory and at http://www.gromacs.org.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
37 * Functions for accessing test command-line options.
39 * Functions in this header allow accessing command-line options passed to the
40 * test executable from tests. This can be used to, e.g., enable additional
41 * output for debugging purposes.
43 * \author Teemu Murtola <teemu.murtola@gmail.com>
45 * \ingroup module_testutils
47 #ifndef GMX_TESTUTILS_TESTOPTIONS_H
48 #define GMX_TESTUTILS_TESTOPTIONS_H
58 /*! \libinternal \brief
59 * Provides additional options for the test executable.
61 * Typically not used directly in test code, but through the
62 * GMX_TEST_OPTIONS macro.
65 * \ingroup module_testutils
67 class TestOptionsProvider
71 * Initializes the options from this provider.
73 * \param options The options need to be added here.
75 virtual void initOptions(Options *options) = 0;
78 virtual ~TestOptionsProvider() {}
81 /*! \libinternal \brief
82 * Registers a test option provider with the test framework.
84 * \param[in] name Name of the options provider (for ordering).
85 * \param[in] provider The provider to register.
86 * \throws std::bad_alloc if out of memory.
87 * \throws tMPI::system_error on mutex failures.
89 * Typically not used directly in test code, but through the
90 * GMX_TEST_OPTIONS macro.
92 * This gets called from constructors for global variables, so ideally
93 * it would not throw to avoid unhandled exceptions. But since this
94 * is only test code, it is not worth the effort to try to remove those
95 * rare exceptions (mutex failures and out-of-memory from STL).
97 * \ingroup module_testutils
99 void registerTestOptions(const char *name, TestOptionsProvider *provider);
101 /*! \libinternal \brief
102 * Macro to add additional command-line options for the test binary.
109 bool g_optionValue = false;
111 GMX_TEST_OPTIONS(MyTestOptions, options)
113 options->addOption(BooleanOption("-flag").store(g_optionValue)
114 .description("My description"));
120 * One macro invocation per an added option, with more of the implementation
121 * details hidden inside the macro, could be nicer. But that requires more
122 * elaborate macro machinery, so it is probably not worth the effort and
125 * \ingroup module_testutils
127 #define GMX_TEST_OPTIONS(name, options) \
128 class name : public ::gmx::test::TestOptionsProvider \
133 ::gmx::test::registerTestOptions(#name, this); \
135 virtual void initOptions(::gmx::Options *options); \
138 static name s_##name##Instance; \
140 void name::initOptions(::gmx::Options *options)
142 /*! \libinternal \brief
143 * Initializes the test utilities library.
145 * Does not throw. Terminates the program with a non-zero error code if an
148 * This function is automatically called by unittest_main.cpp.
150 void initTestUtils(const char *dataPath, int *argc, char ***argv);