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 <gmock/gmock.h>
  50
  51 #include "gromacs/commandline/cmdlinehelpcontext.h"
  52 #include "gromacs/commandline/cmdlinehelpwriter.h"
  53 #include "gromacs/commandline/cmdlineinit.h"
  54 #include "gromacs/commandline/cmdlineparser.h"
  55 #include "gromacs/math/utilities.h"
  56 #include "gromacs/options/basicoptions.h"
  57 #include "gromacs/options/options.h"
  58 #include "gromacs/utility/errorcodes.h"
  59 #include "gromacs/utility/exceptions.h"
  60 #include "gromacs/utility/file.h"
  61 #include "gromacs/utility/programcontext.h"
  62
  63 #include "testutils/mpi-printer.h"
  64 #include "testutils/refdata.h"
  65 #include "testutils/testfilemanager.h"
  66 #include "testutils/testoptions.h"
  67
  68 namespace gmx
  69 {
  70 namespace test
  71 {
  72
  73 namespace
  74 {
  75 //! Prints the command-line options for the unit test binary.
  76 void printHelp(const Options &options)
  77 {
  78     std::fprintf(stderr,
  79                  "\nYou can use the following GROMACS-specific command-line flags\n"
  80                  "to control the behavior of the tests:\n\n");
  81     CommandLineHelpContext context(&File::standardError(),
  82                                    eHelpOutputFormat_Console, NULL);
  83     context.setModuleDisplayName(getProgramContext().displayName());
  84     CommandLineHelpWriter(options).writeHelp(context);
  85 }
  86 }       // namespace
  87
  88 //! \cond internal
  89 void initTestUtils(const char *dataPath, const char *tempPath, int *argc, char ***argv)
  90 {
  91 #ifndef NDEBUG
  92     gmx_feenableexcept();
  93 #endif
  94     gmx::initForCommandLine(argc, argv);
  95     try
  96     {
  97         ::testing::InitGoogleMock(argc, *argv);
  98         if (dataPath != NULL)
  99         {
 100             TestFileManager::setInputDataDirectory(dataPath);
 101         }
 102         if (tempPath != NULL)
 103         {
 104             TestFileManager::setGlobalOutputTempDirectory(tempPath);
 105         }
 106         bool    bHelp = false;
 107         Options options(NULL, NULL);
 108         // TODO: A single option that accepts multiple names would be nicer.
 109         // Also, we recognize -help, but GTest doesn't, which leads to a bit
 110         // unintuitive behavior.
 111         options.addOption(BooleanOption("h").store(&bHelp)
 112                               .description("Print GROMACS-specific unit test options"));
 113         options.addOption(BooleanOption("help").store(&bHelp).hidden());
 114         options.addOption(BooleanOption("?").store(&bHelp).hidden());
 115         // TODO: Consider removing this option from test binaries that do not need it.
 116         initReferenceData(&options);
 117         initTestOptions(&options);
 118         try
 119         {
 120             CommandLineParser(&options).parse(argc, *argv);
 121             options.finish();
 122         }
 123         catch (const UserInputError &)
 124         {
 125             printHelp(options);
 126             throw;
 127         }
 128         if (bHelp)
 129         {
 130             printHelp(options);
 131         }
 132         setFatalErrorHandler(NULL);
 133         initMPIOutput();
 134     }
 135     catch (const std::exception &ex)
 136     {
 137         printFatalErrorMessage(stderr, ex);
 138         std::exit(processExceptionAtExitForCommandLine(ex));
 139     }
 140 }
 141
 142 void finalizeTestUtils()
 143 {
 144     gmx::finalizeForCommandLine();
 145 }
 146 //! \endcond
 147
 148 } // namespace test
 149 } // namespace gmx