src/testutils/testoptions.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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/cmdlinehelpwriter.h"
  54 #include "gromacs/commandline/cmdlineparser.h"
  55 #include "gromacs/onlinehelp/helpwritercontext.h"
  56 #include "gromacs/options/basicoptions.h"
  57 #include "gromacs/options/options.h"
  58 #include "gromacs/utility/common.h"
  59 #include "gromacs/utility/errorcodes.h"
  60 #include "gromacs/utility/exceptions.h"
  61 #include "gromacs/utility/file.h"
  62 #include "gromacs/utility/programinfo.h"
  63
  64 #include "refdata.h"
  65 #include "testfilemanager.h"
  66
  67 namespace gmx
  68 {
  69 namespace test
  70 {
  71
  72 namespace
  73 {
  74
  75 /*! \brief
  76  * Singleton registry for test options added with GMX_TEST_OPTIONS.
  77  *
  78  * \ingroup module_testutils
  79  */
  80 class TestOptionsRegistry
  81 {
  82     public:
  83         //! Returns the singleton instance of this class.
  84         static TestOptionsRegistry &getInstance()
  85         {
  86             static TestOptionsRegistry singleton;
  87             return singleton;
  88         }
  89
  90         //! Adds a provider into the registry.
  91         void add(const char * /*name*/, TestOptionsProvider *provider)
  92         {
  93             tMPI::lock_guard<tMPI::mutex> lock(listMutex_);
  94             providerList_.push_back(provider);
  95         }
  96
  97         //! Initializes the options from all the provides.
  98         void initOptions(Options *options);
  99
 100     private:
 101         TestOptionsRegistry() {}
 102
 103         typedef std::list<TestOptionsProvider *> ProviderList;
 104
 105         tMPI::mutex             listMutex_;
 106         ProviderList            providerList_;
 107
 108         GMX_DISALLOW_COPY_AND_ASSIGN(TestOptionsRegistry);
 109 };
 110
 111 void TestOptionsRegistry::initOptions(Options *options)
 112 {
 113     // TODO: Have some deterministic order for the options; now it depends on
 114     // the order in which the global initializers are run.
 115     tMPI::lock_guard<tMPI::mutex> lock(listMutex_);
 116     ProviderList::const_iterator i;
 117     for (i = providerList_.begin(); i != providerList_.end(); ++i)
 118     {
 119         (*i)->initOptions(options);
 120     }
 121 }
 122
 123 //! Prints the command-line options for the unit test binary.
 124 void printHelp(const Options &options)
 125 {
 126     std::fprintf(stderr,
 127                  "\nYou can use the following GROMACS-specific command-line flags\n"
 128                  "to control the behavior of the tests:\n\n");
 129     HelpWriterContext context(&File::standardError(),
 130                               eHelpOutputFormat_Console);
 131     CommandLineHelpWriter(options).writeHelp(context);
 132 }
 133
 134 } // namespace
 135
 136 void registerTestOptions(const char *name, TestOptionsProvider *provider)
 137 {
 138     TestOptionsRegistry::getInstance().add(name, provider);
 139 }
 140
 141 void initTestUtils(const char *dataPath, int *argc, char *argv[])
 142 {
 143     try
 144     {
 145         ProgramInfo::init(*argc, argv);
 146         ::testing::InitGoogleMock(argc, argv);
 147         if (dataPath != NULL)
 148         {
 149             TestFileManager::setInputDataDirectory(dataPath);
 150         }
 151         bool bHelp = false;
 152         Options options(NULL, NULL);
 153         // TODO: A single option that accepts multiple names would be nicer.
 154         // Also, we recognize -help, but GTest doesn't, which leads to a bit
 155         // unintuitive behavior.
 156         options.addOption(BooleanOption("h").store(&bHelp)
 157                               .description("Print GROMACS-specific unit test options"));
 158         options.addOption(BooleanOption("help").store(&bHelp).hidden());
 159         options.addOption(BooleanOption("?").store(&bHelp).hidden());
 160         // TODO: Consider removing this option from test binaries that do not need it.
 161         initReferenceData(&options);
 162         TestOptionsRegistry::getInstance().initOptions(&options);
 163         try
 164         {
 165             CommandLineParser(&options).parse(argc, argv);
 166             options.finish();
 167         }
 168         catch (const UserInputError &)
 169         {
 170             printHelp(options);
 171             throw;
 172         }
 173         if (bHelp)
 174         {
 175             printHelp(options);
 176         }
 177         setFatalErrorHandler(NULL);
 178     }
 179     catch (const std::exception &ex)
 180     {
 181         printFatalErrorMessage(stderr, ex);
 182         std::exit(1);
 183     }
 184 }
 185
 186 } // namespace test
 187 } // namespace gmx