2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014, 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.
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.
37 * Implements functions in testoptions.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_testutils
44 #include "testoptions.h"
51 #include <gmock/gmock.h>
53 #include "thread_mpi/mutex.h"
55 #include "gromacs/commandline/cmdlinehelpcontext.h"
56 #include "gromacs/commandline/cmdlinehelpwriter.h"
57 #include "gromacs/commandline/cmdlineinit.h"
58 #include "gromacs/commandline/cmdlineparser.h"
59 #include "gromacs/options/basicoptions.h"
60 #include "gromacs/options/options.h"
61 #include "gromacs/utility/common.h"
62 #include "gromacs/utility/errorcodes.h"
63 #include "gromacs/utility/exceptions.h"
64 #include "gromacs/utility/file.h"
65 #include "gromacs/utility/programcontext.h"
67 #include "testutils/mpi-printer.h"
68 #include "testutils/refdata.h"
69 #include "testutils/testfilemanager.h"
80 * Singleton registry for test options added with #GMX_TEST_OPTIONS.
82 * \ingroup module_testutils
84 class TestOptionsRegistry
87 //! Returns the singleton instance of this class.
88 static TestOptionsRegistry &getInstance()
90 static TestOptionsRegistry singleton;
94 //! Adds a provider into the registry.
95 void add(const char * /*name*/, TestOptionsProvider *provider)
97 tMPI::lock_guard<tMPI::mutex> lock(listMutex_);
98 providerList_.push_back(provider);
101 //! Initializes the options from all the provides.
102 void initOptions(Options *options);
105 TestOptionsRegistry() {}
107 typedef std::list<TestOptionsProvider *> ProviderList;
109 tMPI::mutex listMutex_;
110 ProviderList providerList_;
112 GMX_DISALLOW_COPY_AND_ASSIGN(TestOptionsRegistry);
115 void TestOptionsRegistry::initOptions(Options *options)
117 // TODO: Have some deterministic order for the options; now it depends on
118 // the order in which the global initializers are run.
119 tMPI::lock_guard<tMPI::mutex> lock(listMutex_);
120 ProviderList::const_iterator i;
121 for (i = providerList_.begin(); i != providerList_.end(); ++i)
123 (*i)->initOptions(options);
127 //! Prints the command-line options for the unit test binary.
128 void printHelp(const Options &options)
131 "\nYou can use the following GROMACS-specific command-line flags\n"
132 "to control the behavior of the tests:\n\n");
133 CommandLineHelpContext context(&File::standardError(),
134 eHelpOutputFormat_Console, NULL);
135 context.setModuleDisplayName(getProgramContext().displayName());
136 CommandLineHelpWriter(options).writeHelp(context);
141 void registerTestOptions(const char *name, TestOptionsProvider *provider)
143 TestOptionsRegistry::getInstance().add(name, provider);
146 void initTestUtils(const char *dataPath, const char *tempPath, int *argc, char ***argv)
148 gmx::initForCommandLine(argc, argv);
151 ::testing::InitGoogleMock(argc, *argv);
152 if (dataPath != NULL)
154 TestFileManager::setInputDataDirectory(dataPath);
156 if (tempPath != NULL)
158 TestFileManager::setGlobalOutputTempDirectory(tempPath);
161 Options options(NULL, NULL);
162 // TODO: A single option that accepts multiple names would be nicer.
163 // Also, we recognize -help, but GTest doesn't, which leads to a bit
164 // unintuitive behavior.
165 options.addOption(BooleanOption("h").store(&bHelp)
166 .description("Print GROMACS-specific unit test options"));
167 options.addOption(BooleanOption("help").store(&bHelp).hidden());
168 options.addOption(BooleanOption("?").store(&bHelp).hidden());
169 // TODO: Consider removing this option from test binaries that do not need it.
170 initReferenceData(&options);
171 TestOptionsRegistry::getInstance().initOptions(&options);
174 CommandLineParser(&options).parse(argc, *argv);
177 catch (const UserInputError &)
186 setFatalErrorHandler(NULL);
189 catch (const std::exception &ex)
191 printFatalErrorMessage(stderr, ex);
192 std::exit(processExceptionAtExit(ex));
196 void finalizeTestUtils()
198 gmx::finalizeForCommandLine();