1 /*
2 * This file is part of the GROMACS molecular simulation package.
3 *
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.
9 *
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.
14 *
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.
19 *
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.
24 *
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.
32 *
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.
35 */
36 /*! \internal \file
37 * \brief
38 * Implements functions in testinit.h.
39 *
40 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_testutils
42 */
43 #include "gmxpre.h"
44
45 #include "testinit.h"
46
47 #include <cstdio>
48 #include <cstdlib>
49
50 #include <memory>
51
52 #include <gmock/gmock.h>
53
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"
70
71 #include "testutils/mpi_printer.h"
72 #include "testutils/refdata.h"
73 #include "testutils/test_hardware_environment.h"
74 #include "testutils/testfilemanager.h"
75 #include "testutils/testoptions.h"
76
77 namespace gmx
78 {
79 namespace test
80 {
81
82 namespace
83 {
84
85 /*! \brief
86 * Custom program context for test binaries.
87 *
88 * This context overrides the installationPrefix() implementation to always
89 * load data files from the source directory, as the test binaries are never
90 * installed. It also support overriding the directory through a command-line
91 * option to the test binary.
92 *
93 * \ingroup module_testutils
94 */
95 class TestProgramContext : public IProgramContext
96 {
97 public:
98 /*! \brief
99 * Initializes a test program context.
100 *
101 * \param[in] context Current \Gromacs program context.
102 */
TestProgramContext(const IProgramContext & context)103 explicit TestProgramContext(const IProgramContext& context) :
104 context_(context),
105 dataPath_(CMAKE_SOURCE_DIR)
106 {
107 }
108
109 /*! \brief
110 * Sets the source directory root from which to look for data files.
111 */
overrideSourceRoot(const std::string & sourceRoot)112 void overrideSourceRoot(const std::string& sourceRoot) { dataPath_ = sourceRoot; }
113
programName() const114 const char* programName() const override { return context_.programName(); }
displayName() const115 const char* displayName() const override { return context_.displayName(); }
fullBinaryPath() const116 const char* fullBinaryPath() const override { return context_.fullBinaryPath(); }
installationPrefix() const117 InstallationPrefixInfo installationPrefix() const override
118 {
119 return InstallationPrefixInfo(dataPath_.c_str(), true);
120 }
commandLine() const121 const char* commandLine() const override { return context_.commandLine(); }
122
123 private:
124 const IProgramContext& context_;
125 std::string dataPath_;
126 };
127
128 //! Prints the command-line options for the unit test binary.
printHelp(const Options & options)129 void printHelp(const Options& options)
130 {
131 const std::string& program = getProgramContext().displayName();
132 std::fprintf(stderr,
133 "\nYou can use the following GROMACS-specific command-line flags\n"
134 "to control the behavior of the tests:\n\n");
135 TextWriter writer(&TextOutputFile::standardError());
136 CommandLineHelpContext context(&writer, eHelpOutputFormat_Console, nullptr, program);
137 context.setModuleDisplayName(program);
138 CommandLineHelpWriter(options).writeHelp(context);
139 }
140
141 //! Global program context instance for test binaries.
142 // Never releases ownership.
143 std::unique_ptr<TestProgramContext> g_testContext;
144
145 } // namespace
146
147 //! \cond internal
initTestUtils(const char * dataPath,const char * tempPath,bool usesMpi,bool usesHardwareDetection,int * argc,char *** argv)148 void initTestUtils(const char* dataPath,
149 const char* tempPath,
150 bool usesMpi,
151 bool usesHardwareDetection,
152 int* argc,
153 char*** argv)
154 {
155 #if !defined NDEBUG \
156 && !((defined __clang__ || (defined(__GNUC__) && !defined(__ICC) && __GNUC__ == 7)) \
157 && defined __OPTIMIZE__)
158 gmx_feenableexcept();
159 #endif
160 const CommandLineProgramContext& context = initForCommandLine(argc, argv);
161 try
162 {
163 if (!usesMpi && gmx_node_num() > 1)
164 {
165 // We cannot continue, since some tests might be using
166 // MPI_COMM_WORLD, which could deadlock if we would only
167 // continue with the master rank here.
168 if (gmx_node_rank() == 0)
169 {
170 fprintf(stderr,
171 "NOTE: You are running %s on %d MPI ranks, "
172 "but it is does not contain MPI-enabled tests. "
173 "The test will now exit.\n",
174 context.programName(), gmx_node_num());
175 }
176 finalizeForCommandLine();
177 std::exit(1);
178 }
179 if (usesHardwareDetection)
180 {
181 callAddGlobalTestEnvironment();
182 }
183 g_testContext = std::make_unique<TestProgramContext>(context);
184 setProgramContext(g_testContext.get());
185 // Use the default finder that does not respect GMXLIB, since the tests
186 // generally can only get confused by a different set of data files.
187 setLibraryFileFinder(nullptr);
188 ::testing::InitGoogleMock(argc, *argv);
189 if (dataPath != nullptr)
190 {
191 TestFileManager::setInputDataDirectory(Path::join(CMAKE_SOURCE_DIR, dataPath));
192 }
193 if (tempPath != nullptr)
194 {
195 TestFileManager::setGlobalOutputTempDirectory(tempPath);
196 }
197 TestFileManager::setTestSimulationDatabaseDirectory(GMX_TESTSIMULATIONDATABASE_DIR);
198
199 bool bHelp = false;
200 std::string sourceRoot;
201 Options options;
202 // TODO: A single option that accepts multiple names would be nicer.
203 // Also, we recognize -help, but GTest doesn't, which leads to a bit
204 // unintuitive behavior.
205 options.addOption(BooleanOption("h").store(&bHelp).description(
206 "Print GROMACS-specific unit test options"));
207 options.addOption(BooleanOption("help").store(&bHelp).hidden());
208 options.addOption(BooleanOption("?").store(&bHelp).hidden());
209 // TODO: Make this into a FileNameOption (or a DirectoryNameOption).
210 options.addOption(
211 StringOption("src-root").store(&sourceRoot).description("Override source tree location (for data files)"));
212 // The potential MPI test event listener must be initialized first,
213 // because it should appear in the start of the event listener list,
214 // before other event listeners that may generate test failures
215 // (currently, such an event listener is used by the reference data
216 // framework).
217 if (usesMpi)
218 {
219 initMPIOutput();
220 }
221 // TODO: Consider removing this option from test binaries that do not need it.
222 initReferenceData(&options);
223 initTestOptions(&options);
224 try
225 {
226 CommandLineParser(&options).parse(argc, *argv);
227 options.finish();
228 }
229 catch (const UserInputError&)
230 {
231 printHelp(options);
232 throw;
233 }
234 if (bHelp)
235 {
236 printHelp(options);
237 }
238 if (!sourceRoot.empty())
239 {
240 g_testContext->overrideSourceRoot(sourceRoot);
241 TestFileManager::setInputDataDirectory(Path::join(sourceRoot, dataPath));
242 }
243 }
244 catch (const std::exception& ex)
245 {
246 printFatalErrorMessage(stderr, ex);
247 int retcode = processExceptionAtExitForCommandLine(ex);
248 // TODO: It could be nice to destroy things in proper order such that
249 // g_testContext would not contain hanging references at this point,
250 // but in practice that should not matter.
251 g_testContext.reset();
252 std::exit(retcode);
253 }
254 }
255
finalizeTestUtils()256 void finalizeTestUtils()
257 {
258 setProgramContext(nullptr);
259 g_testContext.reset();
260 finalizeForCommandLine();
261 }
262 //! \endcond
263
264 } // namespace test
265 } // namespace gmx
266