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