2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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 * Tests gmx::CommandLineHelpModule through gmx::CommandLineModuleManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_commandline
46 #include <gmock/gmock.h>
48 #include "gromacs/commandline/cmdlinemodulemanager.h"
49 #include "gromacs/options/basicoptions.h"
50 #include "gromacs/options/options.h"
51 #include "gromacs/utility/file.h"
53 #include "gromacs/onlinehelp/tests/mock_helptopic.h"
54 #include "testutils/cmdlinetest.h"
55 #include "testutils/testasserts.h"
57 #include "cmdlinemodulemanagertest.h"
62 using gmx::test::CommandLine;
63 using gmx::test::MockHelpTopic;
64 using gmx::test::MockModule;
65 using gmx::test::MockOptionsModule;
67 //! Test fixture for the tests.
68 typedef gmx::test::CommandLineModuleManagerTestBase CommandLineHelpModuleTest;
70 TEST_F(CommandLineHelpModuleTest, PrintsGeneralHelp)
72 const char *const cmdline[] = {
75 CommandLine args(cmdline);
76 initManager(args, "test");
77 redirectManagerOutput();
78 addModule("module", "First module");
79 addModule("other", "Second module");
80 addHelpTopic("topic", "Test topic");
82 ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
84 checkRedirectedOutputFiles();
87 TEST_F(CommandLineHelpModuleTest, PrintsHelpOnTopic)
89 const char *const cmdline[] = {
90 "test", "help", "topic"
92 CommandLine args(cmdline);
93 initManager(args, "test");
94 redirectManagerOutput();
95 addModule("module", "First module");
96 MockHelpTopic &topic = addHelpTopic("topic", "Test topic");
97 topic.addSubTopic("sub1", "Subtopic 1", "");
98 topic.addSubTopic("sub2", "Subtopic 2", "");
100 EXPECT_CALL(topic, writeHelp(_));
102 ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
104 checkRedirectedOutputFiles();
108 * Initializes Options for help export tests.
110 * \ingroup module_commandline
112 void initOptionsBasic(gmx::Options *options)
114 const char *const desc[] = {
115 "Sample description",
116 "for testing [THISMODULE]."
118 options->setDescription(desc);
119 options->addOption(gmx::IntegerOption("int"));
122 TEST_F(CommandLineHelpModuleTest, ExportsHelp)
124 const char *const cmdline[] = {
125 "test", "help", "-export", "rst"
127 // TODO: Find a more elegant solution, or get rid of the links.dat altogether.
128 gmx::File::writeFileFromString("links.dat", "");
129 CommandLine args(cmdline);
130 initManager(args, "test");
131 redirectManagerOutput();
132 MockOptionsModule &mod1 = addOptionsModule("module", "First module");
133 MockOptionsModule &mod2 = addOptionsModule("other", "Second module");
135 gmx::CommandLineModuleGroup group = manager().addModuleGroup("Group 1");
136 group.addModule("module");
139 gmx::CommandLineModuleGroup group = manager().addModuleGroup("Group 2");
140 group.addModule("other");
142 MockHelpTopic &topic1 = addHelpTopic("topic1", "Test topic");
143 MockHelpTopic &sub1 = topic1.addSubTopic("sub1", "Subtopic 1", "Sub text");
144 MockHelpTopic &sub2 = topic1.addSubTopic("sub2", "Subtopic 2", "Sub text");
145 MockHelpTopic &sub3 = topic1.addSubTopic("other", "Out-of-order subtopic", "Sub text");
146 MockHelpTopic &topic2 = addHelpTopic("topic2", "Another topic");
148 using ::testing::Invoke;
149 EXPECT_CALL(mod1, initOptions(_)).WillOnce(Invoke(&initOptionsBasic));
150 EXPECT_CALL(mod2, initOptions(_));
151 EXPECT_CALL(topic1, writeHelp(_));
152 EXPECT_CALL(sub1, writeHelp(_));
153 EXPECT_CALL(sub2, writeHelp(_));
154 EXPECT_CALL(sub3, writeHelp(_));
155 EXPECT_CALL(topic2, writeHelp(_));
157 ASSERT_NO_THROW_GMX(rc = manager().run(args.argc(), args.argv()));
159 checkRedirectedOutputFiles();
160 std::remove("links.dat");