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
42 #include "testoptions.h"
49 #include <gmock/gmock.h>
51 #include "thread_mpi/mutex.h"
53 #include "gromacs/commandline/cmdlinehelpcontext.h"
54 #include "gromacs/commandline/cmdlinehelpwriter.h"
55 #include "gromacs/commandline/cmdlineinit.h"
56 #include "gromacs/commandline/cmdlineparser.h"
57 #include "gromacs/options/basicoptions.h"
58 #include "gromacs/options/options.h"
59 #include "gromacs/utility/common.h"
60 #include "gromacs/utility/errorcodes.h"
61 #include "gromacs/utility/exceptions.h"
62 #include "gromacs/utility/file.h"
63 #include "gromacs/utility/programcontext.h"
66 #include "testfilemanager.h"
67 #include "mpi-printer.h"
78 * Singleton registry for test options added with #GMX_TEST_OPTIONS.
80 * \ingroup module_testutils
82 class TestOptionsRegistry
85 //! Returns the singleton instance of this class.
86 static TestOptionsRegistry
&getInstance()
88 static TestOptionsRegistry singleton
;
92 //! Adds a provider into the registry.
93 void add(const char * /*name*/, TestOptionsProvider
*provider
)
95 tMPI::lock_guard
<tMPI::mutex
> lock(listMutex_
);
96 providerList_
.push_back(provider
);
99 //! Initializes the options from all the provides.
100 void initOptions(Options
*options
);
103 TestOptionsRegistry() {}
105 typedef std::list
<TestOptionsProvider
*> ProviderList
;
107 tMPI::mutex listMutex_
;
108 ProviderList providerList_
;
110 GMX_DISALLOW_COPY_AND_ASSIGN(TestOptionsRegistry
);
113 void TestOptionsRegistry::initOptions(Options
*options
)
115 // TODO: Have some deterministic order for the options; now it depends on
116 // the order in which the global initializers are run.
117 tMPI::lock_guard
<tMPI::mutex
> lock(listMutex_
);
118 ProviderList::const_iterator i
;
119 for (i
= providerList_
.begin(); i
!= providerList_
.end(); ++i
)
121 (*i
)->initOptions(options
);
125 //! Prints the command-line options for the unit test binary.
126 void printHelp(const Options
&options
)
129 "\nYou can use the following GROMACS-specific command-line flags\n"
130 "to control the behavior of the tests:\n\n");
131 CommandLineHelpContext
context(&File::standardError(),
132 eHelpOutputFormat_Console
, NULL
);
133 context
.setModuleDisplayName(getProgramContext().displayName());
134 CommandLineHelpWriter(options
).writeHelp(context
);
139 void registerTestOptions(const char *name
, TestOptionsProvider
*provider
)
141 TestOptionsRegistry::getInstance().add(name
, provider
);
144 void initTestUtils(const char *dataPath
, const char *tempPath
, int *argc
, char ***argv
)
146 gmx::initForCommandLine(argc
, argv
);
149 ::testing::InitGoogleMock(argc
, *argv
);
150 if (dataPath
!= NULL
)
152 TestFileManager::setInputDataDirectory(dataPath
);
154 if (tempPath
!= NULL
)
156 TestFileManager::setGlobalOutputTempDirectory(tempPath
);
159 Options
options(NULL
, NULL
);
160 // TODO: A single option that accepts multiple names would be nicer.
161 // Also, we recognize -help, but GTest doesn't, which leads to a bit
162 // unintuitive behavior.
163 options
.addOption(BooleanOption("h").store(&bHelp
)
164 .description("Print GROMACS-specific unit test options"));
165 options
.addOption(BooleanOption("help").store(&bHelp
).hidden());
166 options
.addOption(BooleanOption("?").store(&bHelp
).hidden());
167 // TODO: Consider removing this option from test binaries that do not need it.
168 initReferenceData(&options
);
169 TestOptionsRegistry::getInstance().initOptions(&options
);
172 CommandLineParser(&options
).parse(argc
, *argv
);
175 catch (const UserInputError
&)
184 setFatalErrorHandler(NULL
);
187 catch (const std::exception
&ex
)
189 printFatalErrorMessage(stderr
, ex
);
190 std::exit(processExceptionAtExit(ex
));
194 void finalizeTestUtils()
196 gmx::finalizeForCommandLine();