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