2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2019,2020, 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"
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/gmxassert.h"
56 #include "gromacs/utility/stringutil.h"
58 #include "gromacs/onlinehelp/tests/mock_helptopic.h"
59 #include "testutils/cmdlinetest.h"
60 #include "testutils/testfileredirector.h"
71 * Helper method to disable nice() calls from CommandLineModuleManager.
73 * \ingroup module_commandline
75 void disableNice(gmx::CommandLineModuleSettings* settings)
77 settings->setDefaultNiceLevel(0);
82 /********************************************************************
86 MockModule::MockModule(const char* name, const char* description) : name_(name), descr_(description)
89 using ::testing::Invoke;
90 ON_CALL(*this, init(_)).WillByDefault(Invoke(&disableNice));
91 ON_CALL(*this, writeHelp(_)).WillByDefault(Invoke(this, &MockModule::checkHelpContext));
94 MockModule::~MockModule() {}
96 void MockModule::checkHelpContext(const gmx::CommandLineHelpContext& context) const
98 EXPECT_EQ(expectedDisplayName_, context.moduleDisplayName());
100 gmx::TextLineWrapperSettings settings;
101 std::string moduleName =
102 context.writerContext().substituteMarkupAndWrapToString(settings, "[THISMODULE]");
103 EXPECT_EQ(expectedDisplayName_, moduleName);
106 /********************************************************************
110 MockOptionsModule::MockOptionsModule()
113 using ::testing::Invoke;
114 ON_CALL(*this, init(_)).WillByDefault(Invoke(&disableNice));
117 MockOptionsModule::~MockOptionsModule() {}
119 /********************************************************************
120 * Test fixture for the tests
123 class CommandLineModuleManagerTestBase::Impl
126 Impl(const CommandLine& args, const char* realBinaryName) :
127 programContext_(args.argc(), args.argv()),
128 manager_(realBinaryName, &programContext_)
130 manager_.setQuiet(true);
131 manager_.setOutputRedirector(&redirector_);
134 TestFileOutputRedirector redirector_;
135 CommandLineProgramContext programContext_;
136 CommandLineModuleManager manager_;
139 CommandLineModuleManagerTestBase::CommandLineModuleManagerTestBase() : impl_(nullptr) {}
141 CommandLineModuleManagerTestBase::~CommandLineModuleManagerTestBase() {}
143 void CommandLineModuleManagerTestBase::initManager(const CommandLine& args, const char* realBinaryName)
145 GMX_RELEASE_ASSERT(impl_ == nullptr, "initManager() called more than once in test");
146 impl_.reset(new Impl(args, realBinaryName));
149 MockModule& CommandLineModuleManagerTestBase::addModule(const char* name, const char* description)
151 MockModule* module = new MockModule(name, description);
152 manager().addModule(gmx::CommandLineModulePointer(module));
156 MockOptionsModule& CommandLineModuleManagerTestBase::addOptionsModule(const char* name, const char* description)
158 std::unique_ptr<MockOptionsModule> modulePtr(new MockOptionsModule());
159 MockOptionsModule* module = modulePtr.get();
160 gmx::ICommandLineOptionsModule::registerModuleDirect(
161 &manager(), name, description, std::move(modulePtr));
165 MockHelpTopic& CommandLineModuleManagerTestBase::addHelpTopic(const char* name, const char* title)
167 MockHelpTopic* topic = new MockHelpTopic(name, title, "Help text");
168 manager().addHelpTopic(gmx::HelpTopicPointer(topic));
172 CommandLineModuleManager& CommandLineModuleManagerTestBase::manager()
174 GMX_RELEASE_ASSERT(impl_ != nullptr, "initManager() not called");
175 return impl_->manager_;
178 void CommandLineModuleManagerTestBase::checkRedirectedOutput()
180 GMX_RELEASE_ASSERT(impl_ != nullptr, "initManager() not called");
181 impl_->redirector_.checkRedirectedFiles(&checker());