src/testutils/testoptions.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, 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 testoptions.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "testoptions.h"
  43
  44 #include <cstdio>
  45 #include <cstdlib>
  46
  47 #include <list>
  48
  49 #include <gmock/gmock.h>
  50
  51 #include "gromacs/legacyheaders/thread_mpi/mutex.h"
  52
  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/options/basicoptions.h"
  58 #include "gromacs/options/options.h"
  59 #include "gromacs/utility/common.h"
  60 #include "gromacs/utility/errorcodes.h"
  61 #include "gromacs/utility/exceptions.h"
  62 #include "gromacs/utility/file.h"
  63
  64 #include "refdata.h"
  65 #include "testfilemanager.h"
  66 #include "mpi-printer.h"
  67
  68 namespace gmx
  69 {
  70 namespace test
  71 {
  72
  73 namespace
  74 {
  75
  76 /*! \brief
  77  * Singleton registry for test options added with GMX_TEST_OPTIONS.
  78  *
  79  * \ingroup module_testutils
  80  */
  81 class TestOptionsRegistry
  82 {
  83     public:
  84         //! Returns the singleton instance of this class.
  85         static TestOptionsRegistry &getInstance()
  86         {
  87             static TestOptionsRegistry singleton;
  88             return singleton;
  89         }
  90
  91         //! Adds a provider into the registry.
  92         void add(const char * /*name*/, TestOptionsProvider *provider)
  93         {
  94             tMPI::lock_guard<tMPI::mutex> lock(listMutex_);
  95             providerList_.push_back(provider);
  96         }
  97
  98         //! Initializes the options from all the provides.
  99         void initOptions(Options *options);
 100
 101     private:
 102         TestOptionsRegistry() {}
 103
 104         typedef std::list<TestOptionsProvider *> ProviderList;
 105
 106         tMPI::mutex             listMutex_;
 107         ProviderList            providerList_;
 108
 109         GMX_DISALLOW_COPY_AND_ASSIGN(TestOptionsRegistry);
 110 };
 111
 112 void TestOptionsRegistry::initOptions(Options *options)
 113 {
 114     // TODO: Have some deterministic order for the options; now it depends on
 115     // the order in which the global initializers are run.
 116     tMPI::lock_guard<tMPI::mutex> lock(listMutex_);
 117     ProviderList::const_iterator  i;
 118     for (i = providerList_.begin(); i != providerList_.end(); ++i)
 119     {
 120         (*i)->initOptions(options);
 121     }
 122 }
 123
 124 //! Prints the command-line options for the unit test binary.
 125 void printHelp(const Options &options)
 126 {
 127     std::fprintf(stderr,
 128                  "\nYou can use the following GROMACS-specific command-line flags\n"
 129                  "to control the behavior of the tests:\n\n");
 130     CommandLineHelpContext context(&File::standardError(),
 131                                    eHelpOutputFormat_Console, NULL);
 132     CommandLineHelpWriter(options).writeHelp(context);
 133 }
 134
 135 }       // namespace
 136
 137 void registerTestOptions(const char *name, TestOptionsProvider *provider)
 138 {
 139     TestOptionsRegistry::getInstance().add(name, provider);
 140 }
 141
 142 void initTestUtils(const char *dataPath, const char *tempPath, int *argc, char ***argv)
 143 {
 144     gmx::initForCommandLine(argc, argv);
 145     try
 146     {
 147         ::testing::InitGoogleMock(argc, *argv);
 148         if (dataPath != NULL)
 149         {
 150             TestFileManager::setInputDataDirectory(dataPath);
 151         }
 152         if (tempPath != NULL)
 153         {
 154             TestFileManager::setOutputTempDirectory(tempPath);
 155         }
 156         bool    bHelp = false;
 157         Options options(NULL, NULL);
 158         // TODO: A single option that accepts multiple names would be nicer.
 159         // Also, we recognize -help, but GTest doesn't, which leads to a bit
 160         // unintuitive behavior.
 161         options.addOption(BooleanOption("h").store(&bHelp)
 162                               .description("Print GROMACS-specific unit test options"));
 163         options.addOption(BooleanOption("help").store(&bHelp).hidden());
 164         options.addOption(BooleanOption("?").store(&bHelp).hidden());
 165         // TODO: Consider removing this option from test binaries that do not need it.
 166         initReferenceData(&options);
 167         TestOptionsRegistry::getInstance().initOptions(&options);
 168         try
 169         {
 170             CommandLineParser(&options).parse(argc, *argv);
 171             options.finish();
 172         }
 173         catch (const UserInputError &)
 174         {
 175             printHelp(options);
 176             throw;
 177         }
 178         if (bHelp)
 179         {
 180             printHelp(options);
 181         }
 182         setFatalErrorHandler(NULL);
 183         initMPIOutput();
 184     }
 185     catch (const std::exception &ex)
 186     {
 187         printFatalErrorMessage(stderr, ex);
 188         std::exit(processExceptionAtExit(ex));
 189     }
 190 }
 191
 192 void finalizeTestUtils()
 193 {
 194     gmx::finalizeForCommandLine();
 195 }
 196
 197 } // namespace test
 198 } // namespace gmx