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 <cstdio>
  47 #include <cstdlib>
  48
  49 #include <boost/scoped_ptr.hpp>
  50 #include <gmock/gmock.h>
  51
  52 #include "buildinfo.h"
  53 #include "gromacs/commandline/cmdlinehelpcontext.h"
  54 #include "gromacs/commandline/cmdlinehelpwriter.h"
  55 #include "gromacs/commandline/cmdlineinit.h"
  56 #include "gromacs/commandline/cmdlineparser.h"
  57 #include "gromacs/commandline/cmdlineprogramcontext.h"
  58 #include "gromacs/math/utilities.h"
  59 #include "gromacs/options/basicoptions.h"
  60 #include "gromacs/options/options.h"
  61 #include "gromacs/utility/errorcodes.h"
  62 #include "gromacs/utility/exceptions.h"
  63 #include "gromacs/utility/filestream.h"
  64 #include "gromacs/utility/futil.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 installationPrefix() 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), dataPath_(CMAKE_SOURCE_DIR)
 101         {
 102         }
 103
 104         /*! \brief
 105          * Sets the source directory root from which to look for data files.
 106          */
 107         void overrideSourceRoot(const std::string &sourceRoot)
 108         {
 109             dataPath_ = sourceRoot;
 110         }
 111
 112         virtual const char *programName() const
 113         {
 114             return context_.programName();
 115         }
 116         virtual const char *displayName() const
 117         {
 118             return context_.displayName();
 119         }
 120         virtual const char *fullBinaryPath() const
 121         {
 122             return context_.fullBinaryPath();
 123         }
 124         virtual InstallationPrefixInfo installationPrefix() const
 125         {
 126             return InstallationPrefixInfo(dataPath_.c_str(), true);
 127         }
 128         virtual const char *commandLine() const
 129         {
 130             return context_.commandLine();
 131         }
 132
 133     private:
 134         const ProgramContextInterface   &context_;
 135         std::string                      dataPath_;
 136 };
 137
 138 //! Prints the command-line options for the unit test binary.
 139 void printHelp(const Options &options)
 140 {
 141     const std::string &program = getProgramContext().displayName();
 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(&TextOutputFile::standardError(),
 146                                    eHelpOutputFormat_Console, NULL, program);
 147     context.setModuleDisplayName(program);
 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         // Use the default finder that does not respect GMXLIB, since the tests
 168         // generally can only get confused by a different set of data files.
 169         setLibraryFileFinder(NULL);
 170         ::testing::InitGoogleMock(argc, *argv);
 171         if (dataPath != NULL)
 172         {
 173             TestFileManager::setInputDataDirectory(
 174                     Path::join(CMAKE_SOURCE_DIR, dataPath));
 175         }
 176         if (tempPath != NULL)
 177         {
 178             TestFileManager::setGlobalOutputTempDirectory(tempPath);
 179         }
 180         bool        bHelp = false;
 181         std::string sourceRoot;
 182         Options     options(NULL, NULL);
 183         // TODO: A single option that accepts multiple names would be nicer.
 184         // Also, we recognize -help, but GTest doesn't, which leads to a bit
 185         // unintuitive behavior.
 186         options.addOption(BooleanOption("h").store(&bHelp)
 187                               .description("Print GROMACS-specific unit test options"));
 188         options.addOption(BooleanOption("help").store(&bHelp).hidden());
 189         options.addOption(BooleanOption("?").store(&bHelp).hidden());
 190         // TODO: Make this into a FileNameOption (or a DirectoryNameOption).
 191         options.addOption(StringOption("src-root").store(&sourceRoot)
 192                               .description("Override source tree location (for data files)"));
 193         // TODO: Consider removing this option from test binaries that do not need it.
 194         initReferenceData(&options);
 195         initTestOptions(&options);
 196         try
 197         {
 198             CommandLineParser(&options).parse(argc, *argv);
 199             options.finish();
 200         }
 201         catch (const UserInputError &)
 202         {
 203             printHelp(options);
 204             throw;
 205         }
 206         if (bHelp)
 207         {
 208             printHelp(options);
 209         }
 210         if (!sourceRoot.empty())
 211         {
 212             g_testContext->overrideSourceRoot(sourceRoot);
 213             TestFileManager::setInputDataDirectory(
 214                     Path::join(sourceRoot, dataPath));
 215         }
 216         setFatalErrorHandler(NULL);
 217         initMPIOutput();
 218     }
 219     catch (const std::exception &ex)
 220     {
 221         printFatalErrorMessage(stderr, ex);
 222         int retcode = processExceptionAtExitForCommandLine(ex);
 223         // TODO: It could be nice to destroy things in proper order such that
 224         // g_testContext would not contain hanging references at this point,
 225         // but in practice that should not matter.
 226         g_testContext.reset();
 227         std::exit(retcode);
 228     }
 229 }
 230
 231 void finalizeTestUtils()
 232 {
 233     setProgramContext(NULL);
 234     g_testContext.reset();
 235     finalizeForCommandLine();
 236 }
 237 //! \endcond
 238
 239 } // namespace test
 240 } // namespace gmx