src/gromacs/commandline/tests/cmdlinemodulemanagertest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2018 by the GROMACS development team.
   5  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Test fixture and helper classes for tests using gmx::CommandLineModuleManager.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_commandline
  42  */
  43 #ifndef GMX_COMMANDLINE_CMDLINEMODULEMANAGERTEST_H
  44 #define GMX_COMMANDLINE_CMDLINEMODULEMANAGERTEST_H
  45
  46 #include <string>
  47
  48 #include <gmock/gmock.h>
  49
  50 #include "gromacs/commandline/cmdlinehelpcontext.h"
  51 #include "gromacs/commandline/cmdlinemodule.h"
  52 #include "gromacs/commandline/cmdlineoptionsmodule.h"
  53 #include "gromacs/utility/classhelpers.h"
  54
  55 #include "testutils/stringtest.h"
  56
  57 namespace gmx
  58 {
  59 namespace test
  60 {
  61
  62 class CommandLine;
  63 class MockHelpTopic;
  64 class TestFileOutputRedirector;
  65
  66 /*! \internal \brief
  67  * Mock implementation of gmx::ICommandLineModule.
  68  *
  69  * \ingroup module_commandline
  70  */
  71 class MockModule : public gmx::ICommandLineModule
  72 {
  73 public:
  74     //! Creates a mock module with the given name and description.
  75     MockModule(const char* name, const char* description);
  76     ~MockModule() override;
  77
  78     const char* name() const override { return name_; }
  79     const char* shortDescription() const override { return descr_; }
  80
  81     MOCK_METHOD1(init, void(gmx::CommandLineModuleSettings* settings));
  82     MOCK_METHOD2(run, int(int argc, char* argv[]));
  83     MOCK_CONST_METHOD1(writeHelp, void(const gmx::CommandLineHelpContext& context));
  84
  85     //! Sets the expected display name for writeHelp() calls.
  86     void setExpectedDisplayName(const char* expected) { expectedDisplayName_ = expected; }
  87
  88 private:
  89     //! Checks the context passed to writeHelp().
  90     void checkHelpContext(const gmx::CommandLineHelpContext& context) const;
  91
  92     const char* name_;
  93     const char* descr_;
  94     std::string expectedDisplayName_;
  95 };
  96
  97 /*! \internal \brief
  98  * Mock implementation of gmx::ICommandLineOptionsModule.
  99  *
 100  * \ingroup module_commandline
 101  */
 102 class MockOptionsModule : public gmx::ICommandLineOptionsModule
 103 {
 104 public:
 105     MockOptionsModule();
 106     ~MockOptionsModule() override;
 107
 108     MOCK_METHOD1(init, void(gmx::CommandLineModuleSettings* settings));
 109     MOCK_METHOD2(initOptions,
 110                  void(gmx::IOptionsContainer* options, gmx::ICommandLineOptionsModuleSettings* settings));
 111     MOCK_METHOD0(optionsFinished, void());
 112     MOCK_METHOD0(run, int());
 113 };
 114
 115 /*! \internal \brief
 116  * Test fixture for tests using gmx::CommandLineModuleManager.
 117  *
 118  * \ingroup module_commandline
 119  */
 120 class CommandLineModuleManagerTestBase : public gmx::test::StringTestBase
 121 {
 122 public:
 123     CommandLineModuleManagerTestBase();
 124     ~CommandLineModuleManagerTestBase() override;
 125
 126     //! Creates the manager to run the given command line.
 127     void initManager(const CommandLine& args, const char* realBinaryName);
 128     //! Adds a mock module to the manager.
 129     MockModule& addModule(const char* name, const char* description);
 130     //! Adds a mock module using gmx::Options to the manager.
 131     MockOptionsModule& addOptionsModule(const char* name, const char* description);
 132     //! Adds a mock help topic to the manager.
 133     MockHelpTopic& addHelpTopic(const char* name, const char* title);
 134
 135     /*! \brief
 136      * Returns the manager for this test.
 137      *
 138      * initManager() must have been called.
 139      */
 140     CommandLineModuleManager& manager();
 141
 142     /*! \brief
 143      * Checks all output from the manager using reference data.
 144      *
 145      * Both output to `stdout` and to files is checked.
 146      *
 147      * The manager is put into quiet mode by default, so the manager will
 148      * only print out information if, e.g., help is explicitly requested.
 149      */
 150     void checkRedirectedOutput();
 151
 152 private:
 153     class Impl;
 154
 155     PrivateImplPointer<Impl> impl_;
 156 };
 157
 158 } // namespace test
 159 } // namespace gmx
 160
 161 #endif