2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015, 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 testinit.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_testutils
49 #include <boost/scoped_ptr.hpp>
50 #include <gmock/gmock.h>
52 #include "buildinfo.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/commandline/cmdlineprogramcontext.h"
58 #include "gromacs/math/utilities.h"
59 #include "gromacs/options/basicoptions.h"
60 #include "gromacs/options/options.h"
61 #include "gromacs/utility/errorcodes.h"
62 #include "gromacs/utility/exceptions.h"
63 #include "gromacs/utility/file.h"
64 #include "gromacs/utility/futil.h"
65 #include "gromacs/utility/path.h"
66 #include "gromacs/utility/programcontext.h"
68 #include "testutils/mpi-printer.h"
69 #include "testutils/refdata.h"
70 #include "testutils/testfilemanager.h"
71 #include "testutils/testoptions.h"
82 * Custom program context for test binaries.
84 * This context overrides the installationPrefix() implementation to always
85 * load data files from the source directory, as the test binaries are never
86 * installed. It also support overriding the directory through a command-line
87 * option to the test binary.
89 * \ingroup module_testutils
91 class TestProgramContext : public ProgramContextInterface
95 * Initializes a test program context.
97 * \param[in] context Current \Gromacs program context.
99 explicit TestProgramContext(const ProgramContextInterface &context)
100 : context_(context), dataPath_(CMAKE_SOURCE_DIR)
105 * Sets the source directory root from which to look for data files.
107 void overrideSourceRoot(const std::string &sourceRoot)
109 dataPath_ = sourceRoot;
112 virtual const char *programName() const
114 return context_.programName();
116 virtual const char *displayName() const
118 return context_.displayName();
120 virtual const char *fullBinaryPath() const
122 return context_.fullBinaryPath();
124 virtual InstallationPrefixInfo installationPrefix() const
126 return InstallationPrefixInfo(dataPath_.c_str(), true);
128 virtual const char *commandLine() const
130 return context_.commandLine();
134 const ProgramContextInterface &context_;
135 std::string dataPath_;
138 //! Prints the command-line options for the unit test binary.
139 void printHelp(const Options &options)
142 "\nYou can use the following GROMACS-specific command-line flags\n"
143 "to control the behavior of the tests:\n\n");
144 CommandLineHelpContext context(&File::standardError(),
145 eHelpOutputFormat_Console, NULL);
146 context.setModuleDisplayName(getProgramContext().displayName());
147 CommandLineHelpWriter(options).writeHelp(context);
150 //! Global program context instance for test binaries.
151 boost::scoped_ptr<TestProgramContext> g_testContext;
156 void initTestUtils(const char *dataPath, const char *tempPath, int *argc, char ***argv)
159 gmx_feenableexcept();
161 const CommandLineProgramContext &context = initForCommandLine(argc, argv);
164 g_testContext.reset(new TestProgramContext(context));
165 setProgramContext(g_testContext.get());
166 // Use the default finder that does not respect GMXLIB, since the tests
167 // generally can only get confused by a different set of data files.
168 setLibraryFileFinder(NULL);
169 ::testing::InitGoogleMock(argc, *argv);
170 if (dataPath != NULL)
172 TestFileManager::setInputDataDirectory(
173 Path::join(CMAKE_SOURCE_DIR, dataPath));
175 if (tempPath != NULL)
177 TestFileManager::setGlobalOutputTempDirectory(tempPath);
180 std::string sourceRoot;
181 Options options(NULL, NULL);
182 // TODO: A single option that accepts multiple names would be nicer.
183 // Also, we recognize -help, but GTest doesn't, which leads to a bit
184 // unintuitive behavior.
185 options.addOption(BooleanOption("h").store(&bHelp)
186 .description("Print GROMACS-specific unit test options"));
187 options.addOption(BooleanOption("help").store(&bHelp).hidden());
188 options.addOption(BooleanOption("?").store(&bHelp).hidden());
189 // TODO: Make this into a FileNameOption (or a DirectoryNameOption).
190 options.addOption(StringOption("src-root").store(&sourceRoot)
191 .description("Override source tree location (for data files)"));
192 // TODO: Consider removing this option from test binaries that do not need it.
193 initReferenceData(&options);
194 initTestOptions(&options);
197 CommandLineParser(&options).parse(argc, *argv);
200 catch (const UserInputError &)
209 if (!sourceRoot.empty())
211 g_testContext->overrideSourceRoot(sourceRoot);
212 TestFileManager::setInputDataDirectory(
213 Path::join(sourceRoot, dataPath));
215 setFatalErrorHandler(NULL);
218 catch (const std::exception &ex)
220 printFatalErrorMessage(stderr, ex);
221 int retcode = processExceptionAtExitForCommandLine(ex);
222 // TODO: It could be nice to destroy things in proper order such that
223 // g_testContext would not contain hanging references at this point,
224 // but in practice that should not matter.
225 g_testContext.reset();
230 void finalizeTestUtils()
232 setProgramContext(NULL);
233 g_testContext.reset();
234 finalizeForCommandLine();