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