2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014, 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::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/cmdlinehelpcontext.h"
53 #include "gromacs/commandline/cmdlinehelpwriter.h"
54 #include "gromacs/options/basicoptions.h"
55 #include "gromacs/options/filenameoption.h"
56 #include "gromacs/options/options.h"
57 #include "gromacs/utility/file.h"
59 #include "testutils/stringtest.h"
60 #include "testutils/testfilemanager.h"
65 class CommandLineHelpWriterTest : public ::gmx::test::StringTestBase
68 CommandLineHelpWriterTest() : bHidden_(false) {}
70 void checkHelp(gmx::CommandLineHelpWriter *writer);
72 gmx::test::TestFileManager tempFiles_;
76 void CommandLineHelpWriterTest::checkHelp(gmx::CommandLineHelpWriter *writer)
78 std::string filename = tempFiles_.getTemporaryFilePath("helptext.txt");
79 gmx::File file(filename, "w");
80 gmx::CommandLineHelpContext context(&file, gmx::eHelpOutputFormat_Console, NULL);
81 context.setShowHidden(bHidden_);
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("mult")
130 .description("Multiple file description")
131 .filetype(eftTrajectory).inputFile().multiValue()
132 .defaultBasename("traj"));
133 options.addOption(FileNameOption("lib")
134 .description("Library file description")
135 .filetype(eftGenericData).inputFile().libraryFile()
136 .defaultBasename("libdata"));
137 options.addOption(FileNameOption("io")
139 .description("Input/Output file description")
140 .filetype(eftGenericData).inputOutputFile()
141 .defaultBasename("inout"));
142 options.addOption(FileNameOption("o")
143 .description("Output file description")
144 .filetype(eftPlot).outputFile());
146 CommandLineHelpWriter writer(options);
152 * Tests help printing with file name options with various values that don't
153 * fit into the allocated columns.
155 TEST_F(CommandLineHelpWriterTest, HandlesLongFileOptions)
157 using gmx::FileNameOption;
158 using gmx::eftGenericData;
159 using gmx::eftTrajectory;
161 gmx::Options options(NULL, NULL);
162 options.addOption(FileNameOption("f")
163 .description("File name option with a long value")
164 .filetype(eftTrajectory).inputFile().required()
165 .defaultBasename("path/to/long/trajectory/name"));
166 options.addOption(FileNameOption("f2")
167 .description("File name option with a long value")
168 .filetype(eftTrajectory).inputFile().required()
169 .defaultBasename("path/to/long/trajectory"));
170 options.addOption(FileNameOption("lib")
171 .description("File name option with a long value and type")
172 .filetype(eftTrajectory).inputFile().libraryFile()
173 .defaultBasename("path/to/long/trajectory/name"));
174 options.addOption(FileNameOption("longfileopt")
175 .description("File name option with a long name")
176 .filetype(eftGenericData).inputFile()
177 .defaultBasename("deffile"));
178 options.addOption(FileNameOption("longfileopt2")
179 .description("File name option with multiple long fields")
180 .filetype(eftGenericData).inputFile().libraryFile()
181 .defaultBasename("path/to/long/file/name"));
183 gmx::CommandLineHelpWriter writer(options);
188 * Tests help printing with general options with various values that don't
189 * fit into the allocated columns.
191 TEST_F(CommandLineHelpWriterTest, HandlesLongOptions)
193 using gmx::BooleanOption;
194 using gmx::DoubleOption;
195 using gmx::StringOption;
197 gmx::Options options(NULL, NULL);
198 options.addOption(BooleanOption("longboolean")
199 .description("Boolean option with a long name")
200 .defaultValue(true));
201 dvec dblvec = {1.135, 2.32, 3.2132};
202 options.addOption(DoubleOption("dvec").description("Double vector option")
203 .vector().store(dblvec));
204 std::vector<std::string> values;
205 values.push_back("A very long string value that overflows even the description column");
206 values.push_back("Another very long string value that overflows even the description column");
207 options.addOption(StringOption("string")
208 .description("String option with very long values (may "
209 "be less relevant with selections having "
210 "their own option type)")
211 .storeVector(&values));
213 gmx::CommandLineHelpWriter writer(options);
217 /* TODO: Add corresponding tests to either the selection module, or as part of
218 * trajectoryanalysis tests.
219 * Tests help printing with selection options with values.
222 TEST_F(CommandLineHelpWriterTest, HandlesSelectionOptions)
224 using gmx::SelectionFileOption;
225 using gmx::SelectionOption;
227 gmx::Options options(NULL, NULL);
228 options.addOption(SelectionFileOption("sf"));
229 options.addOption(SelectionOption("refsel").required()
230 .description("Reference selection option"));
231 options.addOption(SelectionOption("sel").required().valueCount(2)
232 .description("Selection option"));
233 gmx::SelectionCollection selections;
234 gmx::SelectionOptionManager manager(&selections);
235 setManagerForSelectionOptions(&options, &manager);
237 manager.parseRequestedFromString(
239 "surface = within 0.5 of resname SOL;"
240 "group \"Protein\" and surface;"
241 "group \"Protein\" and not surface;");
243 gmx::CommandLineHelpWriter writer(options);
249 * Tests help printing for multiple sections.
251 TEST_F(CommandLineHelpWriterTest, HandlesMultipleSections)
255 Options options("test", "Main Title");
256 Options subSect1("subsect1", "Subsection 1 Title");
257 Options subSect2("subsect2", "Subsection 2 Title");
258 Options subSect3("subsect3", NULL);
259 options.addSubSection(&subSect1);
260 options.addSubSection(&subSect2);
261 options.addSubSection(&subSect3);
262 options.setDescription("Description for main section.");
263 subSect1.setDescription("Description for subsection 1.");
264 subSect2.setDescription("Description for subsection 2.");
265 subSect3.setDescription("Description for subsection 3.");
266 options.addOption(IntegerOption("main")
267 .description("Option in main section"));
268 subSect1.addOption(IntegerOption("sub1")
269 .description("Option in subsection 1"));
270 subSect2.addOption(IntegerOption("sub2")
271 .description("Option in subsection 2"));
273 CommandLineHelpWriter writer(options);
274 writer.setShowDescriptions(true);