2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
5 * Copyright (c) 2017,2018,2019,2020, by the GROMACS development team, led by
6 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7 * and including many others, as listed in the AUTHORS file in the
8 * top-level source directory and at http://www.gromacs.org.
10 * GROMACS is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public License
12 * as published by the Free Software Foundation; either version 2.1
13 * of the License, or (at your option) any later version.
15 * GROMACS is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with GROMACS; if not, see
22 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * If you want to redistribute modifications to GROMACS, please
26 * consider that scientific software is very special. Version
27 * control is crucial - bugs must be traceable. We will be happy to
28 * consider code for inclusion in the official distribution, but
29 * derived work must not be called official GROMACS. Details are found
30 * in the README & COPYING files - if they are missing, get the
31 * official version at http://www.gromacs.org.
33 * To help us fund GROMACS development, we humbly ask that you cite
34 * the research papers on the package. Check out http://www.gromacs.org.
38 * Implements functions in testinit.h.
40 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_testutils
45 #include "testutils/testinit.h"
52 #include <gmock/gmock.h>
54 #include "buildinfo.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/commandline/cmdlineprogramcontext.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/refdata.h"
72 #include "testutils/test_hardware_environment.h"
73 #include "testutils/testfilemanager.h"
74 #include "testutils/testoptions.h"
76 #include "mpi_printer.h"
87 * Custom program context for test binaries.
89 * This context overrides the installationPrefix() implementation to always
90 * load data files from the source directory, as the test binaries are never
91 * installed. It also support overriding the directory through a command-line
92 * option to the test binary.
94 * \ingroup module_testutils
96 class TestProgramContext : public IProgramContext
100 * Initializes a test program context.
102 * \param[in] context Current \Gromacs program context.
104 explicit TestProgramContext(const IProgramContext& context) :
106 dataPath_(CMAKE_SOURCE_DIR)
111 * Sets the source directory root from which to look for data files.
113 void overrideSourceRoot(const std::string& sourceRoot) { dataPath_ = sourceRoot; }
115 const char* programName() const override { return context_.programName(); }
116 const char* displayName() const override { return context_.displayName(); }
117 const char* fullBinaryPath() const override { return context_.fullBinaryPath(); }
118 InstallationPrefixInfo installationPrefix() const override
120 return InstallationPrefixInfo(dataPath_.c_str(), true);
122 const char* commandLine() const override { return context_.commandLine(); }
125 const IProgramContext& context_;
126 std::string dataPath_;
129 //! Prints the command-line options for the unit test binary.
130 void printHelp(const Options& options)
132 const std::string& program = getProgramContext().displayName();
134 "\nYou can use the following GROMACS-specific command-line flags\n"
135 "to control the behavior of the tests:\n\n");
136 TextWriter writer(&TextOutputFile::standardError());
137 CommandLineHelpContext context(&writer, eHelpOutputFormat_Console, nullptr, program);
138 context.setModuleDisplayName(program);
139 CommandLineHelpWriter(options).writeHelp(context);
142 //! Global program context instance for test binaries.
143 // Never releases ownership.
144 std::unique_ptr<TestProgramContext> g_testContext;
149 void initTestUtils(const char* dataPath,
150 const char* tempPath,
152 bool usesHardwareDetection,
156 #if !defined NDEBUG \
157 && !((defined __clang__ || (defined(__GNUC__) && !defined(__ICC) && __GNUC__ == 7)) \
158 && defined __OPTIMIZE__)
159 gmx_feenableexcept();
161 const CommandLineProgramContext& context = initForCommandLine(argc, argv);
164 if (!usesMpi && gmx_node_num() > 1)
166 // We cannot continue, since some tests might be using
167 // MPI_COMM_WORLD, which could deadlock if we would only
168 // continue with the master rank here.
169 if (gmx_node_rank() == 0)
172 "NOTE: You are running %s on %d MPI ranks, "
173 "but it is does not contain MPI-enabled tests. "
174 "The test will now exit.\n",
175 context.programName(),
178 finalizeForCommandLine();
181 if (usesHardwareDetection)
183 callAddGlobalTestEnvironment();
185 g_testContext = std::make_unique<TestProgramContext>(context);
186 setProgramContext(g_testContext.get());
187 // Use the default finder that does not respect GMXLIB, since the tests
188 // generally can only get confused by a different set of data files.
189 setLibraryFileFinder(nullptr);
190 ::testing::InitGoogleMock(argc, *argv);
191 if (dataPath != nullptr)
193 TestFileManager::setInputDataDirectory(Path::join(CMAKE_SOURCE_DIR, dataPath));
195 if (tempPath != nullptr)
197 TestFileManager::setGlobalOutputTempDirectory(tempPath);
199 TestFileManager::setTestSimulationDatabaseDirectory(GMX_TESTSIMULATIONDATABASE_DIR);
202 std::string sourceRoot;
204 // TODO: A single option that accepts multiple names would be nicer.
205 // Also, we recognize -help, but GTest doesn't, which leads to a bit
206 // unintuitive behavior.
207 options.addOption(BooleanOption("h").store(&bHelp).description(
208 "Print GROMACS-specific unit test options"));
209 options.addOption(BooleanOption("help").store(&bHelp).hidden());
210 options.addOption(BooleanOption("?").store(&bHelp).hidden());
211 // TODO: Make this into a FileNameOption (or a DirectoryNameOption).
213 StringOption("src-root").store(&sourceRoot).description("Override source tree location (for data files)"));
214 // The potential MPI test event listener must be initialized first,
215 // because it should appear in the start of the event listener list,
216 // before other event listeners that may generate test failures
217 // (currently, such an event listener is used by the reference data
223 // TODO: Consider removing this option from test binaries that do not need it.
224 initReferenceData(&options);
225 initTestOptions(&options);
228 CommandLineParser(&options).parse(argc, *argv);
231 catch (const UserInputError&)
240 if (!sourceRoot.empty())
242 g_testContext->overrideSourceRoot(sourceRoot);
243 TestFileManager::setInputDataDirectory(Path::join(sourceRoot, dataPath));
246 catch (const std::exception& ex)
248 printFatalErrorMessage(stderr, ex);
249 int retcode = processExceptionAtExitForCommandLine(ex);
250 // TODO: It could be nice to destroy things in proper order such that
251 // g_testContext would not contain hanging references at this point,
252 // but in practice that should not matter.
253 g_testContext.reset();
258 void finalizeTestUtils()
260 setProgramContext(nullptr);
261 g_testContext.reset();
262 finalizeForCommandLine();