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/init.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 /*! \internal \brief
  76  * Global test environment for freeing up libxml2 internal buffers.
  77  */
  78 class GromacsTestEnvironment : public ::testing::Environment
  79 {
  80     public:
  81         //! Calls MPI_Finalize() if necessary.
  82         virtual void TearDown()
  83         {
  84             gmx::finalize();
  85         }
  86 };
  87
  88 /*! \brief
  89  * Singleton registry for test options added with GMX_TEST_OPTIONS.
  90  *
  91  * \ingroup module_testutils
  92  */
  93 class TestOptionsRegistry
  94 {
  95     public:
  96         //! Returns the singleton instance of this class.
  97         static TestOptionsRegistry &getInstance()
  98         {
  99             static TestOptionsRegistry singleton;
 100             return singleton;
 101         }
 102
 103         //! Adds a provider into the registry.
 104         void add(const char * /*name*/, TestOptionsProvider *provider)
 105         {
 106             tMPI::lock_guard<tMPI::mutex> lock(listMutex_);
 107             providerList_.push_back(provider);
 108         }
 109
 110         //! Initializes the options from all the provides.
 111         void initOptions(Options *options);
 112
 113     private:
 114         TestOptionsRegistry() {}
 115
 116         typedef std::list<TestOptionsProvider *> ProviderList;
 117
 118         tMPI::mutex             listMutex_;
 119         ProviderList            providerList_;
 120
 121         GMX_DISALLOW_COPY_AND_ASSIGN(TestOptionsRegistry);
 122 };
 123
 124 void TestOptionsRegistry::initOptions(Options *options)
 125 {
 126     // TODO: Have some deterministic order for the options; now it depends on
 127     // the order in which the global initializers are run.
 128     tMPI::lock_guard<tMPI::mutex> lock(listMutex_);
 129     ProviderList::const_iterator i;
 130     for (i = providerList_.begin(); i != providerList_.end(); ++i)
 131     {
 132         (*i)->initOptions(options);
 133     }
 134 }
 135
 136 //! Prints the command-line options for the unit test binary.
 137 void printHelp(const Options &options)
 138 {
 139     std::fprintf(stderr,
 140                  "\nYou can use the following GROMACS-specific command-line flags\n"
 141                  "to control the behavior of the tests:\n\n");
 142     HelpWriterContext context(&File::standardError(),
 143                               eHelpOutputFormat_Console);
 144     CommandLineHelpWriter(options).writeHelp(context);
 145 }
 146
 147 } // namespace
 148
 149 void registerTestOptions(const char *name, TestOptionsProvider *provider)
 150 {
 151     TestOptionsRegistry::getInstance().add(name, provider);
 152 }
 153
 154 void initTestUtils(const char *dataPath, int *argc, char ***argv)
 155 {
 156     try
 157     {
 158         gmx::init(argc, argv);
 159         ::testing::InitGoogleMock(argc, *argv);
 160         if (dataPath != NULL)
 161         {
 162             TestFileManager::setInputDataDirectory(dataPath);
 163         }
 164         bool bHelp = false;
 165         Options options(NULL, NULL);
 166         // TODO: A single option that accepts multiple names would be nicer.
 167         // Also, we recognize -help, but GTest doesn't, which leads to a bit
 168         // unintuitive behavior.
 169         options.addOption(BooleanOption("h").store(&bHelp)
 170                               .description("Print GROMACS-specific unit test options"));
 171         options.addOption(BooleanOption("help").store(&bHelp).hidden());
 172         options.addOption(BooleanOption("?").store(&bHelp).hidden());
 173         // TODO: Consider removing this option from test binaries that do not need it.
 174         initReferenceData(&options);
 175         TestOptionsRegistry::getInstance().initOptions(&options);
 176         try
 177         {
 178             CommandLineParser(&options).parse(argc, *argv);
 179             options.finish();
 180         }
 181         catch (const UserInputError &)
 182         {
 183             printHelp(options);
 184             throw;
 185         }
 186         if (bHelp)
 187         {
 188             printHelp(options);
 189         }
 190         setFatalErrorHandler(NULL);
 191         ::testing::AddGlobalTestEnvironment(new GromacsTestEnvironment);
 192     }
 193     catch (const std::exception &ex)
 194     {
 195         printFatalErrorMessage(stderr, ex);
 196         std::exit(processExceptionAtExit(ex));
 197     }
 198 }
 199
 200 } // namespace test
 201 } // namespace gmx