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, 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), dataPath_(CMAKE_SOURCE_DIR)
 103         {
 104         }
 105
 106         /*! \brief
 107          * Sets the source directory root from which to look for data files.
 108          */
 109         void overrideSourceRoot(const std::string &sourceRoot)
 110         {
 111             dataPath_ = sourceRoot;
 112         }
 113
 114         virtual const char *programName() const
 115         {
 116             return context_.programName();
 117         }
 118         virtual const char *displayName() const
 119         {
 120             return context_.displayName();
 121         }
 122         virtual const char *fullBinaryPath() const
 123         {
 124             return context_.fullBinaryPath();
 125         }
 126         virtual InstallationPrefixInfo installationPrefix() const
 127         {
 128             return InstallationPrefixInfo(dataPath_.c_str(), true);
 129         }
 130         virtual const char *commandLine() const
 131         {
 132             return context_.commandLine();
 133         }
 134
 135     private:
 136         const IProgramContext           &context_;
 137         std::string                      dataPath_;
 138 };
 139
 140 //! Prints the command-line options for the unit test binary.
 141 void printHelp(const Options &options)
 142 {
 143     const std::string &program = getProgramContext().displayName();
 144     std::fprintf(stderr,
 145                  "\nYou can use the following GROMACS-specific command-line flags\n"
 146                  "to control the behavior of the tests:\n\n");
 147     TextWriter             writer(&TextOutputFile::standardError());
 148     CommandLineHelpContext context(&writer, eHelpOutputFormat_Console, nullptr, program);
 149     context.setModuleDisplayName(program);
 150     CommandLineHelpWriter(options).writeHelp(context);
 151 }
 152
 153 //! Global program context instance for test binaries.
 154 // Never releases ownership.
 155 std::unique_ptr<TestProgramContext> g_testContext;
 156
 157 }       // namespace
 158
 159 //! \cond internal
 160 void initTestUtils(const char *dataPath, const char *tempPath, bool usesMpi,
 161                    bool usesHardwareDetection, int *argc, char ***argv)
 162 {
 163 #ifndef NDEBUG
 164     gmx_feenableexcept();
 165 #endif
 166     const CommandLineProgramContext &context = initForCommandLine(argc, argv);
 167     try
 168     {
 169         if (!usesMpi && gmx_node_num() > 1)
 170         {
 171             // We cannot continue, since some tests might be using
 172             // MPI_COMM_WORLD, which could deadlock if we would only
 173             // continue with the master rank here.
 174             if (gmx_node_rank() == 0)
 175             {
 176                 fprintf(stderr, "NOTE: You are running %s on %d MPI ranks, "
 177                         "but it is does not contain MPI-enabled tests. "
 178                         "The test will now exit.\n",
 179                         context.programName(), gmx_node_num());
 180             }
 181             finalizeForCommandLine();
 182             std::exit(1);
 183         }
 184         if (usesHardwareDetection)
 185         {
 186             callAddGlobalTestEnvironment();
 187         }
 188         g_testContext.reset(new TestProgramContext(context));
 189         setProgramContext(g_testContext.get());
 190         // Use the default finder that does not respect GMXLIB, since the tests
 191         // generally can only get confused by a different set of data files.
 192         setLibraryFileFinder(nullptr);
 193         ::testing::InitGoogleMock(argc, *argv);
 194         if (dataPath != nullptr)
 195         {
 196             TestFileManager::setInputDataDirectory(
 197                     Path::join(CMAKE_SOURCE_DIR, dataPath));
 198         }
 199         if (tempPath != nullptr)
 200         {
 201             TestFileManager::setGlobalOutputTempDirectory(tempPath);
 202         }
 203         bool        bHelp = false;
 204         std::string sourceRoot;
 205         Options     options;
 206         // TODO: A single option that accepts multiple names would be nicer.
 207         // Also, we recognize -help, but GTest doesn't, which leads to a bit
 208         // unintuitive behavior.
 209         options.addOption(BooleanOption("h").store(&bHelp)
 210                               .description("Print GROMACS-specific unit test options"));
 211         options.addOption(BooleanOption("help").store(&bHelp).hidden());
 212         options.addOption(BooleanOption("?").store(&bHelp).hidden());
 213         // TODO: Make this into a FileNameOption (or a DirectoryNameOption).
 214         options.addOption(StringOption("src-root").store(&sourceRoot)
 215                               .description("Override source tree location (for data files)"));
 216         // The potential MPI test event listener must be initialized first,
 217         // because it should appear in the start of the event listener list,
 218         // before other event listeners that may generate test failures
 219         // (currently, such an event listener is used by the reference data
 220         // framework).
 221         if (usesMpi)
 222         {
 223             initMPIOutput();
 224         }
 225         // TODO: Consider removing this option from test binaries that do not need it.
 226         initReferenceData(&options);
 227         initTestOptions(&options);
 228         try
 229         {
 230             CommandLineParser(&options).parse(argc, *argv);
 231             options.finish();
 232         }
 233         catch (const UserInputError &)
 234         {
 235             printHelp(options);
 236             throw;
 237         }
 238         if (bHelp)
 239         {
 240             printHelp(options);
 241         }
 242         if (!sourceRoot.empty())
 243         {
 244             g_testContext->overrideSourceRoot(sourceRoot);
 245             TestFileManager::setInputDataDirectory(
 246                     Path::join(sourceRoot, dataPath));
 247         }
 248     }
 249     catch (const std::exception &ex)
 250     {
 251         printFatalErrorMessage(stderr, ex);
 252         int retcode = processExceptionAtExitForCommandLine(ex);
 253         // TODO: It could be nice to destroy things in proper order such that
 254         // g_testContext would not contain hanging references at this point,
 255         // but in practice that should not matter.
 256         g_testContext.reset();
 257         std::exit(retcode);
 258     }
 259 }
 260
 261 void finalizeTestUtils()
 262 {
 263     setProgramContext(nullptr);
 264     g_testContext.reset();
 265     finalizeForCommandLine();
 266 }
 267 //! \endcond
 268
 269 } // namespace test
 270 } // namespace gmx