src/gromacs/commandline/tests/cmdlinehelpmodule.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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.
   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  * Tests gmx::CommandLineHelpModule through gmx::CommandLineModuleManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_commandline
  41  */
  42 #include "gmxpre.h"
  43
  44 #include <cstdio>
  45
  46 #include <gmock/gmock.h>
  47
  48 #include "gromacs/commandline/cmdlinemodulemanager.h"
  49 #include "gromacs/options/basicoptions.h"
  50 #include "gromacs/options/options.h"
  51 #include "gromacs/utility/textwriter.h"
  52
  53 #include "gromacs/onlinehelp/tests/mock_helptopic.h"
  54 #include "testutils/cmdlinetest.h"
  55 #include "testutils/testasserts.h"
  56
  57 #include "cmdlinemodulemanagertest.h"
  58
  59 namespace
  60 {
  61
  62 using gmx::test::CommandLine;
  63 using gmx::test::MockHelpTopic;
  64 using gmx::test::MockOptionsModule;
  65
  66 //! Test fixture for the tests.
  67 typedef gmx::test::CommandLineModuleManagerTestBase CommandLineHelpModuleTest;
  68
  69 TEST_F(CommandLineHelpModuleTest, PrintsGeneralHelp)
  70 {
  71     const char *const cmdline[] = {
  72         "test"
  73     };
  74     CommandLine       args(cmdline);
  75     initManager(args, "test");
  76     addModule("module", "First module");
  77     addModule("other", "Second module");
  78     addHelpTopic("topic", "Test topic");
  79     int rc = 0;
  80     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
  81     ASSERT_EQ(0, rc);
  82     checkRedirectedOutput();
  83 }
  84
  85 TEST_F(CommandLineHelpModuleTest, PrintsHelpOnTopic)
  86 {
  87     const char *const cmdline[] = {
  88         "test", "help", "topic"
  89     };
  90     CommandLine       args(cmdline);
  91     initManager(args, "test");
  92     addModule("module", "First module");
  93     MockHelpTopic &topic = addHelpTopic("topic", "Test topic");
  94     topic.addSubTopic("sub1", "Subtopic 1", "");
  95     topic.addSubTopic("sub2", "Subtopic 2", "");
  96     using ::testing::_;
  97     EXPECT_CALL(topic, writeHelp(_));
  98     int rc = 0;
  99     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
 100     ASSERT_EQ(0, rc);
 101     checkRedirectedOutput();
 102 }
 103
 104 /*! \brief
 105  * Initializes Options for help export tests.
 106  *
 107  * \ingroup module_commandline
 108  */
 109 void initOptionsBasic(gmx::IOptionsContainer                 *options,
 110                       gmx::ICommandLineOptionsModuleSettings *settings)
 111 {
 112     const char *const desc[] = {
 113         "Sample description",
 114         "for testing [THISMODULE]."
 115     };
 116     settings->setHelpText(desc);
 117     const char *const bug[] = {
 118         "Known issue for [THISMODULE].",
 119         "With another bug for [THISMODULE]."
 120     };
 121     settings->setBugText(bug);
 122     options->addOption(gmx::IntegerOption("int").description("Integer option"));
 123 }
 124
 125 TEST_F(CommandLineHelpModuleTest, ExportsHelp)
 126 {
 127     const char *const cmdline[] = {
 128         "test", "help", "-export", "rst"
 129     };
 130     // TODO: Find a more elegant solution, or get rid of the links.dat altogether.
 131     gmx::TextWriter::writeFileFromString("links.dat", "");
 132     CommandLine        args(cmdline);
 133     initManager(args, "test");
 134     MockOptionsModule &mod1 = addOptionsModule("module", "First module");
 135     MockOptionsModule &mod2 = addOptionsModule("other", "Second module");
 136     {
 137         gmx::CommandLineModuleGroup group = manager().addModuleGroup("Group 1");
 138         group.addModule("module");
 139     }
 140     {
 141         gmx::CommandLineModuleGroup group = manager().addModuleGroup("Group 2");
 142         group.addModule("other");
 143     }
 144     MockHelpTopic &topic1 = addHelpTopic("topic1", "Test topic");
 145     MockHelpTopic &sub1   = topic1.addSubTopic("sub1", "Subtopic 1", "Sub text");
 146     MockHelpTopic &sub2   = topic1.addSubTopic("sub2", "Subtopic 2", "Sub text");
 147     MockHelpTopic &sub3   = topic1.addSubTopic("other", "Out-of-order subtopic", "Sub text");
 148     MockHelpTopic &topic2 = addHelpTopic("topic2", "Another topic");
 149     using ::testing::_;
 150     using ::testing::Invoke;
 151     EXPECT_CALL(mod1, initOptions(_, _)).WillOnce(Invoke(&initOptionsBasic));
 152     EXPECT_CALL(mod2, initOptions(_, _));
 153     EXPECT_CALL(topic1, writeHelp(_));
 154     EXPECT_CALL(sub1, writeHelp(_));
 155     EXPECT_CALL(sub2, writeHelp(_));
 156     EXPECT_CALL(sub3, writeHelp(_));
 157     EXPECT_CALL(topic2, writeHelp(_));
 158     int rc = 0;
 159     ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
 160     ASSERT_EQ(0, rc);
 161     checkRedirectedOutput();
 162     std::remove("links.dat");
 163 }
 164
 165 } // namespace