src/testutils/testinit.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015, 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 "config.h"
  47
  48 #include <cstdio>
  49 #include <cstdlib>
  50
  51 #include <boost/scoped_ptr.hpp>
  52 #include <gmock/gmock.h>
  53
  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/errorcodes.h"
  63 #include "gromacs/utility/exceptions.h"
  64 #include "gromacs/utility/file.h"
  65 #include "gromacs/utility/futil.h"
  66 #include "gromacs/utility/path.h"
  67 #include "gromacs/utility/programcontext.h"
  68
  69 #include "testutils/mpi-printer.h"
  70 #include "testutils/refdata.h"
  71 #include "testutils/testfilemanager.h"
  72 #include "testutils/testoptions.h"
  73
  74 namespace gmx
  75 {
  76 namespace test
  77 {
  78
  79 namespace
  80 {
  81
  82 /*! \brief
  83  * Custom program context for test binaries.
  84  *
  85  * This context overrides the defaultLibraryDataPath() implementation to always
  86  * load data files from the source directory, as the test binaries are never
  87  * installed.  It also support overriding the directory through a command-line
  88  * option to the test binary.
  89  *
  90  * \ingroup module_testutils
  91  */
  92 class TestProgramContext : public ProgramContextInterface
  93 {
  94     public:
  95         /*! \brief
  96          * Initializes a test program context.
  97          *
  98          * \param[in] context  Current \Gromacs program context.
  99          */
 100         explicit TestProgramContext(const ProgramContextInterface &context)
 101             : context_(context),
 102               dataPath_(Path::join(CMAKE_SOURCE_DIR, "share/top"))
 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_ = Path::join(sourceRoot, "share/top");
 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 const char *defaultLibraryDataPath() const
 127         {
 128             return dataPath_.c_str();
 129         }
 130         virtual const char *commandLine() const
 131         {
 132             return context_.commandLine();
 133         }
 134
 135     private:
 136         const ProgramContextInterface   &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     std::fprintf(stderr,
 144                  "\nYou can use the following GROMACS-specific command-line flags\n"
 145                  "to control the behavior of the tests:\n\n");
 146     CommandLineHelpContext context(&File::standardError(),
 147                                    eHelpOutputFormat_Console, NULL);
 148     context.setModuleDisplayName(getProgramContext().displayName());
 149     CommandLineHelpWriter(options).writeHelp(context);
 150 }
 151
 152 //! Global program context instance for test binaries.
 153 boost::scoped_ptr<TestProgramContext> g_testContext;
 154
 155 }       // namespace
 156
 157 //! \cond internal
 158 void initTestUtils(const char *dataPath, const char *tempPath, int *argc, char ***argv)
 159 {
 160 #ifndef NDEBUG
 161     gmx_feenableexcept();
 162 #endif
 163     const CommandLineProgramContext &context = initForCommandLine(argc, argv);
 164     try
 165     {
 166         g_testContext.reset(new TestProgramContext(context));
 167         setProgramContext(g_testContext.get());
 168         // Use the default finder that does not respect GMXLIB, since the tests
 169         // generally can only get confused by a different set of data files.
 170         setLibraryFileFinder(NULL);
 171         ::testing::InitGoogleMock(argc, *argv);
 172         if (dataPath != NULL)
 173         {
 174             TestFileManager::setInputDataDirectory(
 175                     Path::join(CMAKE_SOURCE_DIR, dataPath));
 176         }
 177         if (tempPath != NULL)
 178         {
 179             TestFileManager::setGlobalOutputTempDirectory(tempPath);
 180         }
 181         bool        bHelp = false;
 182         std::string sourceRoot;
 183         Options     options(NULL, NULL);
 184         // TODO: A single option that accepts multiple names would be nicer.
 185         // Also, we recognize -help, but GTest doesn't, which leads to a bit
 186         // unintuitive behavior.
 187         options.addOption(BooleanOption("h").store(&bHelp)
 188                               .description("Print GROMACS-specific unit test options"));
 189         options.addOption(BooleanOption("help").store(&bHelp).hidden());
 190         options.addOption(BooleanOption("?").store(&bHelp).hidden());
 191         // TODO: Make this into a FileNameOption (or a DirectoryNameOption).
 192         options.addOption(StringOption("src-root").store(&sourceRoot)
 193                               .description("Override source tree location (for data files)"));
 194         // TODO: Consider removing this option from test binaries that do not need it.
 195         initReferenceData(&options);
 196         initTestOptions(&options);
 197         try
 198         {
 199             CommandLineParser(&options).parse(argc, *argv);
 200             options.finish();
 201         }
 202         catch (const UserInputError &)
 203         {
 204             printHelp(options);
 205             throw;
 206         }
 207         if (bHelp)
 208         {
 209             printHelp(options);
 210         }
 211         if (!sourceRoot.empty())
 212         {
 213             g_testContext->overrideSourceRoot(sourceRoot);
 214             TestFileManager::setInputDataDirectory(
 215                     Path::join(sourceRoot, dataPath));
 216         }
 217         setFatalErrorHandler(NULL);
 218         initMPIOutput();
 219     }
 220     catch (const std::exception &ex)
 221     {
 222         printFatalErrorMessage(stderr, ex);
 223         int retcode = processExceptionAtExitForCommandLine(ex);
 224         // TODO: It could be nice to destroy things in proper order such that
 225         // g_testContext would not contain hanging references at this point,
 226         // but in practice that should not matter.
 227         g_testContext.reset();
 228         std::exit(retcode);
 229     }
 230 }
 231
 232 void finalizeTestUtils()
 233 {
 234     setProgramContext(NULL);
 235     g_testContext.reset();
 236     finalizeForCommandLine();
 237 }
 238 //! \endcond
 239
 240 } // namespace test
 241 } // namespace gmx