2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * 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::CommandLineHelpWriter.
39 * These tests fail for any change in the output, and it should be reviewed
40 * whether the change was intentional.
41 * For development, the tests can be run with a '-stdout' command-line option
42 * to print out the help to stdout instead of using the XML reference
45 * \author Teemu Murtola <teemu.murtola@gmail.com>
46 * \ingroup module_commandline
48 #include <gtest/gtest.h>
50 #include "gromacs/legacyheaders/types/simple.h"
52 #include "gromacs/commandline/cmdlinehelpwriter.h"
53 #include "gromacs/onlinehelp/helpwritercontext.h"
54 #include "gromacs/options/basicoptions.h"
55 #include "gromacs/options/filenameoption.h"
56 #include "gromacs/options/options.h"
57 #include "gromacs/selection/selectioncollection.h"
58 #include "gromacs/selection/selectionfileoption.h"
59 #include "gromacs/selection/selectionoption.h"
60 #include "gromacs/selection/selectionoptionmanager.h"
61 #include "gromacs/utility/file.h"
63 #include "testutils/stringtest.h"
64 #include "testutils/testfilemanager.h"
69 class CommandLineHelpWriterTest : public ::gmx::test::StringTestBase
72 void checkHelp(gmx::CommandLineHelpWriter *writer);
74 gmx::test::TestFileManager tempFiles_;
77 void CommandLineHelpWriterTest::checkHelp(gmx::CommandLineHelpWriter *writer)
79 std::string filename = tempFiles_.getTemporaryFilePath("helptext.txt");
80 gmx::File file(filename, "w");
81 gmx::HelpWriterContext context(&file, gmx::eHelpOutputFormat_Console);
82 writer->writeHelp(context);
85 checkFileContents(filename, "HelpText");
89 /********************************************************************
94 * Tests help printing for each option type, but doesn't contain much
95 * variablity in the options.
97 TEST_F(CommandLineHelpWriterTest, HandlesOptionTypes)
101 Options options("test", "Short Description");
102 options.addOption(BooleanOption("bool").description("Boolean option")
103 .defaultValue(true));
104 options.addOption(BooleanOption("hidden").description("Hidden option")
105 .hidden().defaultValue(true));
106 options.addOption(IntegerOption("int").description("Integer option")
108 ivec intvec = {1, 2, 3};
109 options.addOption(IntegerOption("ivec").description("Integer vector option")
110 .vector().store(intvec));
111 options.addOption(DoubleOption("double").description("Double option")
113 dvec dblvec = {1.1, 2.3, 3.2};
114 options.addOption(DoubleOption("dvec").description("Double vector option")
115 .vector().store(dblvec));
116 options.addOption(DoubleOption("time").description("Time option (%t)")
117 .timeValue().defaultValue(10.0));
118 options.addOption(StringOption("string").description("String option")
119 .defaultValue("test"));
120 const char * const enumValues[] = { "no", "opt1", "opt2" };
121 options.addOption(StringOption("enum").description("Enum option")
122 .enumValue(enumValues).defaultEnumIndex(0));
124 std::string filename;
125 options.addOption(FileNameOption("f")
126 .description("Input file description")
127 .filetype(eftTrajectory).inputFile().required()
128 .defaultBasename("traj"));
129 options.addOption(FileNameOption("lib")
130 .description("Library file description")
131 .filetype(eftGenericData).inputFile().libraryFile()
132 .defaultBasename("libdata"));
133 options.addOption(FileNameOption("io")
135 .description("Input/Output file description")
136 .filetype(eftGenericData).inputOutputFile()
137 .defaultBasename("inout"));
138 options.addOption(FileNameOption("o")
139 .description("Output file description")
140 .filetype(eftPlot).outputFile());
142 options.addOption(SelectionFileOption("sf"));
143 options.addOption(SelectionOption("sel").description("Selection option"));
145 CommandLineHelpWriter writer(options);
146 writer.setShowHidden(true);
151 * Tests help printing with file name options with various values that don't
152 * fit into the allocated columns.
154 TEST_F(CommandLineHelpWriterTest, HandlesLongFileOptions)
156 using gmx::FileNameOption;
157 using gmx::eftGenericData;
158 using gmx::eftTrajectory;
160 gmx::Options options(NULL, NULL);
161 options.addOption(FileNameOption("f")
162 .description("File name option with a long value")
163 .filetype(eftTrajectory).inputFile().required()
164 .defaultBasename("path/to/long/trajectory/name"));
165 options.addOption(FileNameOption("f2")
166 .description("File name option with a long value")
167 .filetype(eftTrajectory).inputFile().required()
168 .defaultBasename("path/to/long/trajectory"));
169 options.addOption(FileNameOption("lib")
170 .description("File name option with a long value and type")
171 .filetype(eftTrajectory).inputFile().libraryFile()
172 .defaultBasename("path/to/long/trajectory/name"));
173 options.addOption(FileNameOption("longfileopt")
174 .description("File name option with a long name")
175 .filetype(eftGenericData).inputFile()
176 .defaultBasename("deffile"));
177 options.addOption(FileNameOption("longfileopt2")
178 .description("File name option with multiple long fields")
179 .filetype(eftGenericData).inputFile().libraryFile()
180 .defaultBasename("path/to/long/file/name"));
182 gmx::CommandLineHelpWriter writer(options);
187 * Tests help printing with general options with various values that don't
188 * fit into the allocated columns.
190 TEST_F(CommandLineHelpWriterTest, HandlesLongOptions)
192 using gmx::BooleanOption;
193 using gmx::DoubleOption;
194 using gmx::StringOption;
196 gmx::Options options(NULL, NULL);
197 options.addOption(BooleanOption("longboolean")
198 .description("Boolean option with a long name")
199 .defaultValue(true));
200 dvec dblvec = {1.135, 2.32, 3.2132};
201 options.addOption(DoubleOption("dvec").description("Double vector option")
202 .vector().store(dblvec));
203 std::vector<std::string> values;
204 values.push_back("A very long string value that overflows even the description column");
205 values.push_back("Another very long string value that overflows even the description column");
206 options.addOption(StringOption("string")
207 .description("String option with very long values (may "
208 "be less relevant with selections having "
209 "their own option type)")
210 .storeVector(&values));
212 gmx::CommandLineHelpWriter writer(options);
217 * Tests help printing with selection options with values.
219 TEST_F(CommandLineHelpWriterTest, HandlesSelectionOptions)
221 using gmx::SelectionFileOption;
222 using gmx::SelectionOption;
224 gmx::Options options(NULL, NULL);
225 options.addOption(SelectionFileOption("sf"));
226 options.addOption(SelectionOption("refsel").required()
227 .description("Reference selection option"));
228 options.addOption(SelectionOption("sel").required().valueCount(2)
229 .description("Selection option"));
230 gmx::SelectionCollection selections;
231 gmx::SelectionOptionManager manager(&selections);
232 setManagerForSelectionOptions(&options, &manager);
234 manager.parseRequestedFromString(
236 "surface = within 0.5 of resname SOL;"
237 "group \"Protein\" and surface;"
238 "group \"Protein\" and not surface;");
240 gmx::CommandLineHelpWriter writer(options);
245 * Tests help printing for multiple sections.
247 TEST_F(CommandLineHelpWriterTest, HandlesMultipleSections)
251 Options options("test", "Main Title");
252 Options subSect1("subsect1", "Subsection 1 Title");
253 Options subSect2("subsect2", "Subsection 2 Title");
254 Options subSect3("subsect3", NULL);
255 options.addSubSection(&subSect1);
256 options.addSubSection(&subSect2);
257 options.addSubSection(&subSect3);
258 options.setDescription("Description for main section.");
259 subSect1.setDescription("Description for subsection 1.");
260 subSect2.setDescription("Description for subsection 2.");
261 subSect3.setDescription("Description for subsection 3.");
262 options.addOption(IntegerOption("main")
263 .description("Option in main section"));
264 subSect1.addOption(IntegerOption("sub1")
265 .description("Option in subsection 1"));
266 subSect2.addOption(IntegerOption("sub2")
267 .description("Option in subsection 2"));
269 CommandLineHelpWriter writer(options);
270 writer.setShowDescriptions(true);