2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2014,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 file name option implementation dependent on gmx::FileNameOptionManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
44 #include "gromacs/options/filenameoptionmanager.h"
46 #include <gtest/gtest.h>
48 #include "gromacs/fileio/filenm.h"
49 #include "gromacs/options/filenameoption.h"
50 #include "gromacs/options/options.h"
51 #include "gromacs/options/optionsassigner.h"
52 #include "gromacs/utility/exceptions.h"
54 #include "testutils/testasserts.h"
55 #include "testutils/testfileredirector.h"
60 using gmx::FileNameOption;
62 class FileNameOptionManagerTest : public ::testing::Test
65 FileNameOptionManagerTest()
66 : options_(NULL, NULL)
68 manager_.setInputRedirector(&redirector_);
69 options_.addManager(&manager_);
72 void addExistingFile(const char *filename)
74 redirector_.addExistingFile(filename);
77 gmx::test::TestFileInputRedirector redirector_;
78 gmx::FileNameOptionManager manager_;
79 gmx::Options options_;
82 /********************************************************************
86 TEST_F(FileNameOptionManagerTest, AddsMissingExtension)
89 ASSERT_NO_THROW_GMX(options_.addOption(
90 FileNameOption("f").store(&value)
91 .filetype(gmx::eftTrajectory).outputFile()));
93 gmx::OptionsAssigner assigner(&options_);
94 EXPECT_NO_THROW_GMX(assigner.start());
95 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
96 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
97 EXPECT_NO_THROW_GMX(assigner.finishOption());
98 EXPECT_NO_THROW_GMX(assigner.finish());
99 EXPECT_NO_THROW_GMX(options_.finish());
101 EXPECT_EQ("testfile.xtc", value);
104 TEST_F(FileNameOptionManagerTest, AddsMissingCustomDefaultExtension)
107 ASSERT_NO_THROW_GMX(options_.addOption(
108 FileNameOption("f").store(&value)
109 .filetype(gmx::eftTrajectory).outputFile()
110 .defaultType(efPDB)));
112 gmx::OptionsAssigner assigner(&options_);
113 EXPECT_NO_THROW_GMX(assigner.start());
114 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
115 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
116 EXPECT_NO_THROW_GMX(assigner.finishOption());
117 EXPECT_NO_THROW_GMX(assigner.finish());
118 EXPECT_NO_THROW_GMX(options_.finish());
120 EXPECT_EQ("testfile.pdb", value);
123 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingInputFile)
126 ASSERT_NO_THROW_GMX(options_.addOption(
127 FileNameOption("f").store(&value)
128 .filetype(gmx::eftIndex).inputFile()));
129 EXPECT_TRUE(value.empty());
131 gmx::OptionsAssigner assigner(&options_);
132 EXPECT_NO_THROW_GMX(assigner.start());
133 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
134 EXPECT_THROW_GMX(assigner.appendValue("missing.ndx"), gmx::InvalidInputError);
135 EXPECT_NO_THROW_GMX(assigner.finishOption());
136 EXPECT_NO_THROW_GMX(assigner.finish());
137 EXPECT_NO_THROW_GMX(options_.finish());
139 EXPECT_TRUE(value.empty());
142 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingGenericInputFile)
145 ASSERT_NO_THROW_GMX(options_.addOption(
146 FileNameOption("f").store(&value)
147 .filetype(gmx::eftTrajectory).inputFile()));
148 EXPECT_TRUE(value.empty());
150 gmx::OptionsAssigner assigner(&options_);
151 EXPECT_NO_THROW_GMX(assigner.start());
152 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
153 EXPECT_THROW_GMX(assigner.appendValue("missing.trr"), gmx::InvalidInputError);
154 EXPECT_NO_THROW_GMX(assigner.finishOption());
155 EXPECT_NO_THROW_GMX(assigner.finish());
156 EXPECT_NO_THROW_GMX(options_.finish());
158 EXPECT_TRUE(value.empty());
161 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingDefaultInputFile)
164 ASSERT_NO_THROW_GMX(options_.addOption(
165 FileNameOption("f").store(&value)
166 .filetype(gmx::eftIndex).inputFile()
167 .defaultBasename("missing")));
169 gmx::OptionsAssigner assigner(&options_);
170 EXPECT_NO_THROW_GMX(assigner.start());
171 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
172 EXPECT_NO_THROW_GMX(assigner.finishOption());
173 EXPECT_NO_THROW_GMX(assigner.finish());
174 EXPECT_THROW_GMX(options_.finish(), gmx::InvalidInputError);
177 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingRequiredInputFile)
180 ASSERT_NO_THROW_GMX(options_.addOption(
181 FileNameOption("f").store(&value).required()
182 .filetype(gmx::eftIndex).inputFile()
183 .defaultBasename("missing")));
184 EXPECT_EQ("missing.ndx", value);
186 gmx::OptionsAssigner assigner(&options_);
187 EXPECT_NO_THROW_GMX(assigner.start());
188 EXPECT_NO_THROW_GMX(assigner.finish());
189 EXPECT_THROW_GMX(options_.finish(), gmx::InvalidInputError);
192 TEST_F(FileNameOptionManagerTest, AcceptsMissingInputFileIfSpecified)
195 ASSERT_NO_THROW_GMX(options_.addOption(
196 FileNameOption("f").store(&value)
197 .filetype(gmx::eftIndex).inputFile()
199 EXPECT_TRUE(value.empty());
201 gmx::OptionsAssigner assigner(&options_);
202 EXPECT_NO_THROW_GMX(assigner.start());
203 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
204 EXPECT_NO_THROW_GMX(assigner.appendValue("missing.ndx"));
205 EXPECT_NO_THROW_GMX(assigner.finishOption());
206 EXPECT_NO_THROW_GMX(assigner.finish());
207 EXPECT_NO_THROW_GMX(options_.finish());
209 EXPECT_EQ("missing.ndx", value);
212 TEST_F(FileNameOptionManagerTest, AcceptsMissingDefaultInputFileIfSpecified)
215 ASSERT_NO_THROW_GMX(options_.addOption(
216 FileNameOption("f").store(&value)
217 .filetype(gmx::eftIndex).inputFile()
218 .defaultBasename("missing")
221 gmx::OptionsAssigner assigner(&options_);
222 EXPECT_NO_THROW_GMX(assigner.start());
223 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
224 EXPECT_NO_THROW_GMX(assigner.finishOption());
225 EXPECT_NO_THROW_GMX(assigner.finish());
226 EXPECT_NO_THROW_GMX(options_.finish());
228 EXPECT_EQ("missing.ndx", value);
231 TEST_F(FileNameOptionManagerTest, AcceptsMissingRequiredInputFileIfSpecified)
234 ASSERT_NO_THROW_GMX(options_.addOption(
235 FileNameOption("f").store(&value).required()
236 .filetype(gmx::eftIndex).inputFile()
237 .defaultBasename("missing")
239 EXPECT_EQ("missing.ndx", value);
241 gmx::OptionsAssigner assigner(&options_);
242 EXPECT_NO_THROW_GMX(assigner.start());
243 EXPECT_NO_THROW_GMX(assigner.finish());
244 EXPECT_NO_THROW_GMX(options_.finish());
246 EXPECT_EQ("missing.ndx", value);
249 TEST_F(FileNameOptionManagerTest, AddsMissingExtensionBasedOnExistingFile)
251 addExistingFile("testfile.trr");
254 ASSERT_NO_THROW_GMX(options_.addOption(
255 FileNameOption("f").store(&value)
256 .filetype(gmx::eftTrajectory).inputFile()));
258 gmx::OptionsAssigner assigner(&options_);
259 EXPECT_NO_THROW_GMX(assigner.start());
260 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
261 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
262 EXPECT_NO_THROW_GMX(assigner.finishOption());
263 EXPECT_NO_THROW_GMX(assigner.finish());
264 EXPECT_NO_THROW_GMX(options_.finish());
266 EXPECT_EQ("testfile.trr", value);
269 TEST_F(FileNameOptionManagerTest,
270 AddsMissingExtensionForRequiredDefaultNameBasedOnExistingFile)
272 addExistingFile("testfile.trr");
275 ASSERT_NO_THROW_GMX(options_.addOption(
276 FileNameOption("f").store(&value).required()
277 .filetype(gmx::eftTrajectory).inputFile()
278 .defaultBasename("testfile")));
279 EXPECT_EQ("testfile.xtc", value);
281 gmx::OptionsAssigner assigner(&options_);
282 EXPECT_NO_THROW_GMX(assigner.start());
283 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
284 EXPECT_NO_THROW_GMX(assigner.finishOption());
285 EXPECT_NO_THROW_GMX(assigner.finish());
286 EXPECT_NO_THROW_GMX(options_.finish());
288 EXPECT_EQ("testfile.trr", value);
291 TEST_F(FileNameOptionManagerTest,
292 AddsMissingExtensionForOptionalDefaultNameBasedOnExistingFile)
294 addExistingFile("testfile.trr");
297 ASSERT_NO_THROW_GMX(options_.addOption(
298 FileNameOption("f").store(&value)
299 .filetype(gmx::eftTrajectory).inputFile()
300 .defaultBasename("testfile")));
302 gmx::OptionsAssigner assigner(&options_);
303 EXPECT_NO_THROW_GMX(assigner.start());
304 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
305 EXPECT_NO_THROW_GMX(assigner.finishOption());
306 EXPECT_NO_THROW_GMX(assigner.finish());
307 EXPECT_NO_THROW_GMX(options_.finish());
309 EXPECT_EQ("testfile.trr", value);
312 TEST_F(FileNameOptionManagerTest,
313 AddsMissingExtensionForRequiredFromDefaultNameOptionBasedOnExistingFile)
315 addExistingFile("testfile.trr");
318 ASSERT_NO_THROW_GMX(options_.addOption(
319 FileNameOption("f").store(&value).required()
320 .filetype(gmx::eftTrajectory).inputFile()
321 .defaultBasename("foo")));
322 ASSERT_NO_THROW_GMX(manager_.addDefaultFileNameOption(&options_, "deffnm"));
323 EXPECT_EQ("foo.xtc", value);
325 gmx::OptionsAssigner assigner(&options_);
326 EXPECT_NO_THROW_GMX(assigner.start());
327 EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
328 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
329 EXPECT_NO_THROW_GMX(assigner.finishOption());
330 EXPECT_NO_THROW_GMX(assigner.finish());
331 EXPECT_NO_THROW_GMX(options_.finish());
333 EXPECT_EQ("testfile.trr", value);
336 TEST_F(FileNameOptionManagerTest,
337 AddsMissingExtensionForOptionalFromDefaultNameOptionBasedOnExistingFile)
339 addExistingFile("testfile.trr");
342 ASSERT_NO_THROW_GMX(options_.addOption(
343 FileNameOption("f").store(&value)
344 .filetype(gmx::eftTrajectory).inputFile()
345 .defaultBasename("foo")));
346 ASSERT_NO_THROW_GMX(manager_.addDefaultFileNameOption(&options_, "deffnm"));
348 gmx::OptionsAssigner assigner(&options_);
349 EXPECT_NO_THROW_GMX(assigner.start());
350 EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
351 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
352 EXPECT_NO_THROW_GMX(assigner.finishOption());
353 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
354 EXPECT_NO_THROW_GMX(assigner.finishOption());
355 EXPECT_NO_THROW_GMX(assigner.finish());
356 EXPECT_NO_THROW_GMX(options_.finish());
358 EXPECT_EQ("testfile.trr", value);
361 TEST_F(FileNameOptionManagerTest, DefaultNameOptionWorksWithoutInputChecking)
364 ASSERT_NO_THROW_GMX(manager_.disableInputOptionChecking(true));
365 ASSERT_NO_THROW_GMX(options_.addOption(
366 FileNameOption("f").store(&value).required()
367 .filetype(gmx::eftIndex).inputFile()
368 .defaultBasename("default")
370 ASSERT_NO_THROW_GMX(manager_.addDefaultFileNameOption(&options_, "deffnm"));
371 EXPECT_EQ("default.ndx", value);
373 gmx::OptionsAssigner assigner(&options_);
374 EXPECT_NO_THROW_GMX(assigner.start());
375 EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
376 EXPECT_NO_THROW_GMX(assigner.appendValue("missing"));
377 EXPECT_NO_THROW_GMX(assigner.finishOption());
378 EXPECT_NO_THROW_GMX(assigner.finish());
379 EXPECT_NO_THROW_GMX(options_.finish());
381 EXPECT_EQ("missing.ndx", value);