2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2016,2017,2018, 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
51 #include <gmock/gmock.h>
53 #include "buildinfo.h"
54 #include "gromacs/commandline/cmdlinehelpcontext.h"
55 #include "gromacs/commandline/cmdlinehelpwriter.h"
56 #include "gromacs/commandline/cmdlineinit.h"
57 #include "gromacs/commandline/cmdlineparser.h"
58 #include "gromacs/commandline/cmdlineprogramcontext.h"
59 #include "gromacs/compat/make_unique.h"
60 #include "gromacs/math/utilities.h"
61 #include "gromacs/options/basicoptions.h"
62 #include "gromacs/options/options.h"
63 #include "gromacs/utility/basenetwork.h"
64 #include "gromacs/utility/exceptions.h"
65 #include "gromacs/utility/filestream.h"
66 #include "gromacs/utility/futil.h"
67 #include "gromacs/utility/path.h"
68 #include "gromacs/utility/programcontext.h"
69 #include "gromacs/utility/textwriter.h"
71 #include "testutils/mpi-printer.h"
72 #include "testutils/refdata.h"
73 #include "testutils/testfilemanager.h"
74 #include "testutils/testoptions.h"
85 * Custom program context for test binaries.
87 * This context overrides the installationPrefix() implementation to always
88 * load data files from the source directory, as the test binaries are never
89 * installed. It also support overriding the directory through a command-line
90 * option to the test binary.
92 * \ingroup module_testutils
94 class TestProgramContext
: public IProgramContext
98 * Initializes a test program context.
100 * \param[in] context Current \Gromacs program context.
102 explicit TestProgramContext(const IProgramContext
&context
)
103 : context_(context
), dataPath_(CMAKE_SOURCE_DIR
)
108 * Sets the source directory root from which to look for data files.
110 void overrideSourceRoot(const std::string
&sourceRoot
)
112 dataPath_
= sourceRoot
;
115 const char *programName() const override
117 return context_
.programName();
119 const char *displayName() const override
121 return context_
.displayName();
123 const char *fullBinaryPath() const override
125 return context_
.fullBinaryPath();
127 InstallationPrefixInfo
installationPrefix() const override
129 return InstallationPrefixInfo(dataPath_
.c_str(), true);
131 const char *commandLine() const override
133 return context_
.commandLine();
137 const IProgramContext
&context_
;
138 std::string dataPath_
;
141 //! Prints the command-line options for the unit test binary.
142 void printHelp(const Options
&options
)
144 const std::string
&program
= getProgramContext().displayName();
146 "\nYou can use the following GROMACS-specific command-line flags\n"
147 "to control the behavior of the tests:\n\n");
148 TextWriter
writer(&TextOutputFile::standardError());
149 CommandLineHelpContext
context(&writer
, eHelpOutputFormat_Console
, nullptr, program
);
150 context
.setModuleDisplayName(program
);
151 CommandLineHelpWriter(options
).writeHelp(context
);
154 //! Global program context instance for test binaries.
155 // Never releases ownership.
156 std::unique_ptr
<TestProgramContext
> g_testContext
;
161 void initTestUtils(const char *dataPath
, const char *tempPath
, bool usesMpi
,
162 bool usesHardwareDetection
, int *argc
, char ***argv
)
164 #if !defined NDEBUG && \
165 !((defined __clang__ || (defined(__GNUC__) && !defined(__ICC) && __GNUC__ == 7)) \
166 && defined __OPTIMIZE__)
167 gmx_feenableexcept();
169 const CommandLineProgramContext
&context
= initForCommandLine(argc
, argv
);
172 if (!usesMpi
&& gmx_node_num() > 1)
174 // We cannot continue, since some tests might be using
175 // MPI_COMM_WORLD, which could deadlock if we would only
176 // continue with the master rank here.
177 if (gmx_node_rank() == 0)
179 fprintf(stderr
, "NOTE: You are running %s on %d MPI ranks, "
180 "but it is does not contain MPI-enabled tests. "
181 "The test will now exit.\n",
182 context
.programName(), gmx_node_num());
184 finalizeForCommandLine();
187 if (usesHardwareDetection
)
189 callAddGlobalTestEnvironment();
191 g_testContext
= gmx::compat::make_unique
<TestProgramContext
>(context
);
192 setProgramContext(g_testContext
.get());
193 // Use the default finder that does not respect GMXLIB, since the tests
194 // generally can only get confused by a different set of data files.
195 setLibraryFileFinder(nullptr);
196 ::testing::InitGoogleMock(argc
, *argv
);
197 if (dataPath
!= nullptr)
199 TestFileManager::setInputDataDirectory(
200 Path::join(CMAKE_SOURCE_DIR
, dataPath
));
202 if (tempPath
!= nullptr)
204 TestFileManager::setGlobalOutputTempDirectory(tempPath
);
206 TestFileManager::setTestSimulationDatabaseDirectory(
207 GMX_TESTSIMULATIONDATABASE_DIR
);
210 std::string sourceRoot
;
212 // TODO: A single option that accepts multiple names would be nicer.
213 // Also, we recognize -help, but GTest doesn't, which leads to a bit
214 // unintuitive behavior.
215 options
.addOption(BooleanOption("h").store(&bHelp
)
216 .description("Print GROMACS-specific unit test options"));
217 options
.addOption(BooleanOption("help").store(&bHelp
).hidden());
218 options
.addOption(BooleanOption("?").store(&bHelp
).hidden());
219 // TODO: Make this into a FileNameOption (or a DirectoryNameOption).
220 options
.addOption(StringOption("src-root").store(&sourceRoot
)
221 .description("Override source tree location (for data files)"));
222 // The potential MPI test event listener must be initialized first,
223 // because it should appear in the start of the event listener list,
224 // before other event listeners that may generate test failures
225 // (currently, such an event listener is used by the reference data
231 // TODO: Consider removing this option from test binaries that do not need it.
232 initReferenceData(&options
);
233 initTestOptions(&options
);
236 CommandLineParser(&options
).parse(argc
, *argv
);
239 catch (const UserInputError
&)
248 if (!sourceRoot
.empty())
250 g_testContext
->overrideSourceRoot(sourceRoot
);
251 TestFileManager::setInputDataDirectory(
252 Path::join(sourceRoot
, dataPath
));
255 catch (const std::exception
&ex
)
257 printFatalErrorMessage(stderr
, ex
);
258 int retcode
= processExceptionAtExitForCommandLine(ex
);
259 // TODO: It could be nice to destroy things in proper order such that
260 // g_testContext would not contain hanging references at this point,
261 // but in practice that should not matter.
262 g_testContext
.reset();
267 void finalizeTestUtils()
269 setProgramContext(nullptr);
270 g_testContext
.reset();
271 finalizeForCommandLine();