src/gromacs/commandline/tests/cmdlinemodulemanagertest.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 classes from cmdlinemodulemanagertest.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_commandline
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "cmdlinemodulemanagertest.h"
  45
  46 #include <string>
  47
  48 #include <boost/scoped_ptr.hpp>
  49 #include <gmock/gmock.h>
  50
  51 #include "gromacs/commandline/cmdlinehelpcontext.h"
  52 #include "gromacs/commandline/cmdlinemodule.h"
  53 #include "gromacs/commandline/cmdlinemodulemanager.h"
  54 #include "gromacs/commandline/cmdlineprogramcontext.h"
  55 #include "gromacs/utility/stringutil.h"
  56
  57 #include "gromacs/onlinehelp/tests/mock_helptopic.h"
  58 #include "testutils/cmdlinetest.h"
  59 #include "testutils/testfilemanager.h"
  60
  61 namespace gmx
  62 {
  63 namespace test
  64 {
  65
  66 namespace
  67 {
  68
  69 /*! \brief
  70  * Helper method to disable nice() calls from CommandLineModuleManager.
  71  *
  72  * \ingroup module_commandline
  73  */
  74 void disableNice(gmx::CommandLineModuleSettings *settings)
  75 {
  76     settings->setDefaultNiceLevel(0);
  77 }
  78
  79 }       // namespace
  80
  81 /********************************************************************
  82  * MockModule
  83  */
  84
  85 MockModule::MockModule(const char *name, const char *description)
  86     : name_(name), descr_(description)
  87 {
  88     using ::testing::_;
  89     using ::testing::Invoke;
  90     ON_CALL(*this, init(_))
  91         .WillByDefault(Invoke(&disableNice));
  92     ON_CALL(*this, writeHelp(_))
  93         .WillByDefault(Invoke(this, &MockModule::checkHelpContext));
  94 }
  95
  96 MockModule::~MockModule()
  97 {
  98 }
  99
 100 void MockModule::checkHelpContext(const gmx::CommandLineHelpContext &context) const
 101 {
 102     EXPECT_EQ(expectedDisplayName_, context.moduleDisplayName());
 103
 104     gmx::TextLineWrapperSettings settings;
 105     std::string                  moduleName =
 106         context.writerContext().substituteMarkupAndWrapToString(
 107                 settings, "[THISMODULE]");
 108     EXPECT_EQ(expectedDisplayName_, moduleName);
 109 }
 110
 111 /********************************************************************
 112  * MockOptionsModule
 113  */
 114
 115 MockOptionsModule::MockOptionsModule()
 116 {
 117     using ::testing::_;
 118     using ::testing::Invoke;
 119     ON_CALL(*this, init(_))
 120         .WillByDefault(Invoke(&disableNice));
 121 }
 122
 123 MockOptionsModule::~MockOptionsModule()
 124 {
 125 }
 126
 127 /********************************************************************
 128  * Test fixture for the tests
 129  */
 130
 131 class CommandLineModuleManagerTestBase::Impl
 132 {
 133     public:
 134         boost::scoped_ptr<CommandLineProgramContext> programContext_;
 135         boost::scoped_ptr<CommandLineModuleManager>  manager_;
 136         TestFileManager                              fileManager_;
 137 };
 138
 139 CommandLineModuleManagerTestBase::CommandLineModuleManagerTestBase()
 140     : impl_(new Impl)
 141 {
 142 }
 143
 144 CommandLineModuleManagerTestBase::~CommandLineModuleManagerTestBase()
 145 {
 146 }
 147
 148 void CommandLineModuleManagerTestBase::initManager(
 149         const CommandLine &args, const char *realBinaryName)
 150 {
 151     impl_->manager_.reset();
 152     impl_->programContext_.reset(
 153             new gmx::CommandLineProgramContext(args.argc(), args.argv()));
 154     impl_->manager_.reset(new gmx::CommandLineModuleManager(
 155                                   realBinaryName, impl_->programContext_.get()));
 156     impl_->manager_->setQuiet(true);
 157 }
 158
 159 MockModule &
 160 CommandLineModuleManagerTestBase::addModule(const char *name, const char *description)
 161 {
 162     MockModule *module = new MockModule(name, description);
 163     manager().addModule(gmx::CommandLineModulePointer(module));
 164     return *module;
 165 }
 166
 167 MockOptionsModule &
 168 CommandLineModuleManagerTestBase::addOptionsModule(const char *name, const char *description)
 169 {
 170     MockOptionsModule *module = new MockOptionsModule();
 171     gmx::CommandLineOptionsModuleInterface::registerModule(
 172             &manager(), name, description, module);
 173     return *module;
 174 }
 175
 176 MockHelpTopic &
 177 CommandLineModuleManagerTestBase::addHelpTopic(const char *name, const char *title)
 178 {
 179     MockHelpTopic *topic = new MockHelpTopic(name, title, "Help text");
 180     manager().addHelpTopic(gmx::HelpTopicPointer(topic));
 181     return *topic;
 182 }
 183
 184 CommandLineModuleManager &CommandLineModuleManagerTestBase::manager()
 185 {
 186     return *impl_->manager_;
 187 }
 188
 189 void CommandLineModuleManagerTestBase::redirectManagerOutput()
 190 {
 191     impl_->manager_->setOutputRedirector(&initOutputRedirector(&impl_->fileManager_));
 192 }
 193
 194 } // namespace test
 195 } // namespace gmx