2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 * Implements classes from cmdlinemodulemanagertest.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_commandline
44 #include "cmdlinemodulemanagertest.h"
48 #include <boost/scoped_ptr.hpp>
49 #include <gmock/gmock.h>
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"
57 #include "gromacs/onlinehelp/tests/mock_helptopic.h"
58 #include "testutils/cmdlinetest.h"
59 #include "testutils/testfileredirector.h"
70 * Helper method to disable nice() calls from CommandLineModuleManager.
72 * \ingroup module_commandline
74 void disableNice(gmx::CommandLineModuleSettings *settings)
76 settings->setDefaultNiceLevel(0);
81 /********************************************************************
85 MockModule::MockModule(const char *name, const char *description)
86 : name_(name), descr_(description)
89 using ::testing::Invoke;
90 ON_CALL(*this, init(_))
91 .WillByDefault(Invoke(&disableNice));
92 ON_CALL(*this, writeHelp(_))
93 .WillByDefault(Invoke(this, &MockModule::checkHelpContext));
96 MockModule::~MockModule()
100 void MockModule::checkHelpContext(const gmx::CommandLineHelpContext &context) const
102 EXPECT_EQ(expectedDisplayName_, context.moduleDisplayName());
104 gmx::TextLineWrapperSettings settings;
105 std::string moduleName =
106 context.writerContext().substituteMarkupAndWrapToString(
107 settings, "[THISMODULE]");
108 EXPECT_EQ(expectedDisplayName_, moduleName);
111 /********************************************************************
115 MockOptionsModule::MockOptionsModule()
118 using ::testing::Invoke;
119 ON_CALL(*this, init(_))
120 .WillByDefault(Invoke(&disableNice));
123 MockOptionsModule::~MockOptionsModule()
127 /********************************************************************
128 * Test fixture for the tests
131 class CommandLineModuleManagerTestBase::Impl
134 TestFileOutputRedirector redirector_;
135 boost::scoped_ptr<CommandLineProgramContext> programContext_;
136 boost::scoped_ptr<CommandLineModuleManager> manager_;
139 CommandLineModuleManagerTestBase::CommandLineModuleManagerTestBase()
144 CommandLineModuleManagerTestBase::~CommandLineModuleManagerTestBase()
148 void CommandLineModuleManagerTestBase::initManager(
149 const CommandLine &args, const char *realBinaryName)
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 impl_->manager_->setOutputRedirector(&impl_->redirector_);
161 CommandLineModuleManagerTestBase::addModule(const char *name, const char *description)
163 MockModule *module = new MockModule(name, description);
164 manager().addModule(gmx::CommandLineModulePointer(module));
169 CommandLineModuleManagerTestBase::addOptionsModule(const char *name, const char *description)
171 MockOptionsModule *module = new MockOptionsModule();
172 gmx::CommandLineOptionsModuleInterface::registerModule(
173 &manager(), name, description, module);
178 CommandLineModuleManagerTestBase::addHelpTopic(const char *name, const char *title)
180 MockHelpTopic *topic = new MockHelpTopic(name, title, "Help text");
181 manager().addHelpTopic(gmx::HelpTopicPointer(topic));
185 CommandLineModuleManager &CommandLineModuleManagerTestBase::manager()
187 return *impl_->manager_;
190 void CommandLineModuleManagerTestBase::checkRedirectedOutput()
192 impl_->redirector_.checkRedirectedFiles(&checker());