src/testutils/testinit.cpp

   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,2021, 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 "testutils/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/refdata.h"
  72 #include "testutils/test_hardware_environment.h"
  73 #include "testutils/testfilemanager.h"
  74 #include "testutils/testoptions.h"
  75
  76 #include "mpi_printer.h"
  77
  78 namespace gmx
  79 {
  80 namespace test
  81 {
  82
  83 namespace
  84 {
  85
  86 /*! \brief
  87  * Custom program context for test binaries.
  88  *
  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.
  93  *
  94  * \ingroup module_testutils
  95  */
  96 class TestProgramContext : public IProgramContext
  97 {
  98 public:
  99     /*! \brief
 100      * Initializes a test program context.
 101      *
 102      * \param[in] context  Current \Gromacs program context.
 103      */
 104     explicit TestProgramContext(const IProgramContext& context) :
 105         context_(context),
 106         dataPath_(CMAKE_SOURCE_DIR)
 107     {
 108     }
 109
 110     /*! \brief
 111      * Sets the source directory root from which to look for data files.
 112      */
 113     void overrideSourceRoot(const std::string& sourceRoot) { dataPath_ = sourceRoot; }
 114
 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
 119     {
 120         return InstallationPrefixInfo(dataPath_.c_str(), true);
 121     }
 122     const char* commandLine() const override { return context_.commandLine(); }
 123
 124 private:
 125     const IProgramContext& context_;
 126     std::string            dataPath_;
 127 };
 128
 129 //! Prints the command-line options for the unit test binary.
 130 void printHelp(const Options& options)
 131 {
 132     const std::string& program = getProgramContext().displayName();
 133     std::fprintf(stderr,
 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);
 140 }
 141
 142 //! Global program context instance for test binaries.
 143 // Never releases ownership.
 144 std::unique_ptr<TestProgramContext> g_testContext;
 145
 146 } // namespace
 147
 148 //! \cond internal
 149 void initTestUtils(const char* dataPath,
 150                    const char* tempPath,
 151                    bool        usesMpi,
 152                    bool        usesHardwareDetection,
 153                    int*        argc,
 154                    char***     argv)
 155 {
 156     if (gmxShouldEnableFPExceptions())
 157     {
 158         gmx_feenableexcept();
 159     }
 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(),
 175                         gmx_node_num());
 176             }
 177             finalizeForCommandLine();
 178             std::exit(1);
 179         }
 180         if (usesHardwareDetection)
 181         {
 182             callAddGlobalTestEnvironment();
 183         }
 184         g_testContext = std::make_unique<TestProgramContext>(context);
 185         setProgramContext(g_testContext.get());
 186         // Use the default finder that does not respect GMXLIB, since the tests
 187         // generally can only get confused by a different set of data files.
 188         setLibraryFileFinder(nullptr);
 189         ::testing::InitGoogleMock(argc, *argv);
 190         if (dataPath != nullptr)
 191         {
 192             TestFileManager::setInputDataDirectory(Path::join(CMAKE_SOURCE_DIR, dataPath));
 193         }
 194         if (tempPath != nullptr)
 195         {
 196             TestFileManager::setGlobalOutputTempDirectory(tempPath);
 197         }
 198         TestFileManager::setTestSimulationDatabaseDirectory(GMX_TESTSIMULATIONDATABASE_DIR);
 199
 200         bool        bHelp = false;
 201         std::string sourceRoot;
 202         Options     options;
 203         // TODO: A single option that accepts multiple names would be nicer.
 204         // Also, we recognize -help, but GTest doesn't, which leads to a bit
 205         // unintuitive behavior.
 206         options.addOption(BooleanOption("h").store(&bHelp).description(
 207                 "Print GROMACS-specific unit test options"));
 208         options.addOption(BooleanOption("help").store(&bHelp).hidden());
 209         options.addOption(BooleanOption("?").store(&bHelp).hidden());
 210         // TODO: Make this into a FileNameOption (or a DirectoryNameOption).
 211         options.addOption(
 212                 StringOption("src-root").store(&sourceRoot).description("Override source tree location (for data files)"));
 213         // The potential MPI test event listener must be initialized first,
 214         // because it should appear in the start of the event listener list,
 215         // before other event listeners that may generate test failures
 216         // (currently, such an event listener is used by the reference data
 217         // framework).
 218         if (usesMpi)
 219         {
 220             initMPIOutput();
 221         }
 222         // TODO: Consider removing this option from test binaries that do not need it.
 223         initReferenceData(&options);
 224         initTestOptions(&options);
 225         try
 226         {
 227             CommandLineParser(&options).parse(argc, *argv);
 228             options.finish();
 229         }
 230         catch (const UserInputError&)
 231         {
 232             printHelp(options);
 233             throw;
 234         }
 235         if (bHelp)
 236         {
 237             printHelp(options);
 238         }
 239         if (!sourceRoot.empty())
 240         {
 241             g_testContext->overrideSourceRoot(sourceRoot);
 242             TestFileManager::setInputDataDirectory(Path::join(sourceRoot, dataPath));
 243         }
 244     }
 245     catch (const std::exception& ex)
 246     {
 247         printFatalErrorMessage(stderr, ex);
 248         int retcode = processExceptionAtExitForCommandLine(ex);
 249         // TODO: It could be nice to destroy things in proper order such that
 250         // g_testContext would not contain hanging references at this point,
 251         // but in practice that should not matter.
 252         g_testContext.reset();
 253         std::exit(retcode);
 254     }
 255 }
 256
 257 void finalizeTestUtils()
 258 {
 259     setProgramContext(nullptr);
 260     g_testContext.reset();
 261     finalizeForCommandLine();
 262 }
 263 //! \endcond
 264
 265 } // namespace test
 266 } // namespace gmx