2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2018,2019, 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 * Test fixture and helper classes for tests using gmx::CommandLineModuleManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_commandline
42 #ifndef GMX_COMMANDLINE_CMDLINEMODULEMANAGERTEST_H
43 #define GMX_COMMANDLINE_CMDLINEMODULEMANAGERTEST_H
47 #include <gmock/gmock.h>
49 #include "gromacs/commandline/cmdlinehelpcontext.h"
50 #include "gromacs/commandline/cmdlinemodule.h"
51 #include "gromacs/commandline/cmdlineoptionsmodule.h"
52 #include "gromacs/utility/classhelpers.h"
54 #include "testutils/stringtest.h"
63 class TestFileOutputRedirector;
66 * Mock implementation of gmx::ICommandLineModule.
68 * \ingroup module_commandline
70 class MockModule : public gmx::ICommandLineModule
73 //! Creates a mock module with the given name and description.
74 MockModule(const char* name, const char* description);
75 ~MockModule() override;
77 const char* name() const override { return name_; }
78 const char* shortDescription() const override { return descr_; }
80 MOCK_METHOD1(init, void(gmx::CommandLineModuleSettings* settings));
81 MOCK_METHOD2(run, int(int argc, char* argv[]));
82 MOCK_CONST_METHOD1(writeHelp, void(const gmx::CommandLineHelpContext& context));
84 //! Sets the expected display name for writeHelp() calls.
85 void setExpectedDisplayName(const char* expected) { expectedDisplayName_ = expected; }
88 //! Checks the context passed to writeHelp().
89 void checkHelpContext(const gmx::CommandLineHelpContext& context) const;
93 std::string expectedDisplayName_;
97 * Mock implementation of gmx::ICommandLineOptionsModule.
99 * \ingroup module_commandline
101 class MockOptionsModule : public gmx::ICommandLineOptionsModule
105 ~MockOptionsModule() override;
107 MOCK_METHOD1(init, void(gmx::CommandLineModuleSettings* settings));
108 MOCK_METHOD2(initOptions,
109 void(gmx::IOptionsContainer* options, gmx::ICommandLineOptionsModuleSettings* settings));
110 MOCK_METHOD0(optionsFinished, void());
111 MOCK_METHOD0(run, int());
115 * Test fixture for tests using gmx::CommandLineModuleManager.
117 * \ingroup module_commandline
119 class CommandLineModuleManagerTestBase : public gmx::test::StringTestBase
122 CommandLineModuleManagerTestBase();
123 ~CommandLineModuleManagerTestBase() override;
125 //! Creates the manager to run the given command line.
126 void initManager(const CommandLine& args, const char* realBinaryName);
127 //! Adds a mock module to the manager.
128 MockModule& addModule(const char* name, const char* description);
129 //! Adds a mock module using gmx::Options to the manager.
130 MockOptionsModule& addOptionsModule(const char* name, const char* description);
131 //! Adds a mock help topic to the manager.
132 MockHelpTopic& addHelpTopic(const char* name, const char* title);
135 * Returns the manager for this test.
137 * initManager() must have been called.
139 CommandLineModuleManager& manager();
142 * Checks all output from the manager using reference data.
144 * Both output to `stdout` and to files is checked.
146 * The manager is put into quiet mode by default, so the manager will
147 * only print out information if, e.g., help is explicitly requested.
149 void checkRedirectedOutput();
154 PrivateImplPointer<Impl> impl_;