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"
53 #include "gromacs/utility/file.h"
54 #include "gromacs/utility/path.h"
56 #include "testutils/testasserts.h"
57 #include "testutils/testfilemanager.h"
62 using gmx::FileNameOption;
64 class FileNameOptionManagerTest : public ::testing::Test
67 FileNameOptionManagerTest()
68 : options_(NULL, NULL)
70 options_.addManager(&manager_);
73 std::string createDummyFile(const char *suffix)
75 std::string filename(tempFiles_.getTemporaryFilePath(suffix));
76 gmx::File::writeFileFromString(filename, "Dummy file");
80 gmx::FileNameOptionManager manager_;
81 gmx::Options options_;
82 gmx::test::TestFileManager tempFiles_;
85 /********************************************************************
89 TEST_F(FileNameOptionManagerTest, AddsMissingExtension)
92 ASSERT_NO_THROW_GMX(options_.addOption(
93 FileNameOption("f").store(&value)
94 .filetype(gmx::eftTrajectory).outputFile()));
96 gmx::OptionsAssigner assigner(&options_);
97 EXPECT_NO_THROW_GMX(assigner.start());
98 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
99 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
100 EXPECT_NO_THROW_GMX(assigner.finishOption());
101 EXPECT_NO_THROW_GMX(assigner.finish());
102 EXPECT_NO_THROW_GMX(options_.finish());
104 EXPECT_EQ("testfile.xtc", value);
107 TEST_F(FileNameOptionManagerTest, AddsMissingCustomDefaultExtension)
110 ASSERT_NO_THROW_GMX(options_.addOption(
111 FileNameOption("f").store(&value)
112 .filetype(gmx::eftTrajectory).outputFile()
113 .defaultType(efPDB)));
115 gmx::OptionsAssigner assigner(&options_);
116 EXPECT_NO_THROW_GMX(assigner.start());
117 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
118 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
119 EXPECT_NO_THROW_GMX(assigner.finishOption());
120 EXPECT_NO_THROW_GMX(assigner.finish());
121 EXPECT_NO_THROW_GMX(options_.finish());
123 EXPECT_EQ("testfile.pdb", value);
126 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingInputFile)
129 ASSERT_NO_THROW_GMX(options_.addOption(
130 FileNameOption("f").store(&value)
131 .filetype(gmx::eftIndex).inputFile()));
132 EXPECT_TRUE(value.empty());
134 gmx::OptionsAssigner assigner(&options_);
135 EXPECT_NO_THROW_GMX(assigner.start());
136 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
137 EXPECT_THROW_GMX(assigner.appendValue("missing.ndx"), gmx::InvalidInputError);
138 EXPECT_NO_THROW_GMX(assigner.finishOption());
139 EXPECT_NO_THROW_GMX(assigner.finish());
140 EXPECT_NO_THROW_GMX(options_.finish());
142 EXPECT_TRUE(value.empty());
145 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingGenericInputFile)
148 ASSERT_NO_THROW_GMX(options_.addOption(
149 FileNameOption("f").store(&value)
150 .filetype(gmx::eftTrajectory).inputFile()));
151 EXPECT_TRUE(value.empty());
153 gmx::OptionsAssigner assigner(&options_);
154 EXPECT_NO_THROW_GMX(assigner.start());
155 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
156 EXPECT_THROW_GMX(assigner.appendValue("missing.trr"), gmx::InvalidInputError);
157 EXPECT_NO_THROW_GMX(assigner.finishOption());
158 EXPECT_NO_THROW_GMX(assigner.finish());
159 EXPECT_NO_THROW_GMX(options_.finish());
161 EXPECT_TRUE(value.empty());
164 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingDefaultInputFile)
167 ASSERT_NO_THROW_GMX(options_.addOption(
168 FileNameOption("f").store(&value)
169 .filetype(gmx::eftIndex).inputFile()
170 .defaultBasename("missing")));
172 gmx::OptionsAssigner assigner(&options_);
173 EXPECT_NO_THROW_GMX(assigner.start());
174 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
175 EXPECT_NO_THROW_GMX(assigner.finishOption());
176 EXPECT_NO_THROW_GMX(assigner.finish());
177 EXPECT_THROW_GMX(options_.finish(), gmx::InvalidInputError);
180 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingRequiredInputFile)
183 ASSERT_NO_THROW_GMX(options_.addOption(
184 FileNameOption("f").store(&value).required()
185 .filetype(gmx::eftIndex).inputFile()
186 .defaultBasename("missing")));
187 EXPECT_EQ("missing.ndx", value);
189 gmx::OptionsAssigner assigner(&options_);
190 EXPECT_NO_THROW_GMX(assigner.start());
191 EXPECT_NO_THROW_GMX(assigner.finish());
192 EXPECT_THROW_GMX(options_.finish(), gmx::InvalidInputError);
195 TEST_F(FileNameOptionManagerTest, AcceptsMissingInputFileIfSpecified)
198 ASSERT_NO_THROW_GMX(options_.addOption(
199 FileNameOption("f").store(&value)
200 .filetype(gmx::eftIndex).inputFile()
202 EXPECT_TRUE(value.empty());
204 gmx::OptionsAssigner assigner(&options_);
205 EXPECT_NO_THROW_GMX(assigner.start());
206 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
207 EXPECT_NO_THROW_GMX(assigner.appendValue("missing.ndx"));
208 EXPECT_NO_THROW_GMX(assigner.finishOption());
209 EXPECT_NO_THROW_GMX(assigner.finish());
210 EXPECT_NO_THROW_GMX(options_.finish());
212 EXPECT_EQ("missing.ndx", value);
215 TEST_F(FileNameOptionManagerTest, AcceptsMissingDefaultInputFileIfSpecified)
218 ASSERT_NO_THROW_GMX(options_.addOption(
219 FileNameOption("f").store(&value)
220 .filetype(gmx::eftIndex).inputFile()
221 .defaultBasename("missing")
224 gmx::OptionsAssigner assigner(&options_);
225 EXPECT_NO_THROW_GMX(assigner.start());
226 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
227 EXPECT_NO_THROW_GMX(assigner.finishOption());
228 EXPECT_NO_THROW_GMX(assigner.finish());
229 EXPECT_NO_THROW_GMX(options_.finish());
231 EXPECT_EQ("missing.ndx", value);
234 TEST_F(FileNameOptionManagerTest, AcceptsMissingRequiredInputFileIfSpecified)
237 ASSERT_NO_THROW_GMX(options_.addOption(
238 FileNameOption("f").store(&value).required()
239 .filetype(gmx::eftIndex).inputFile()
240 .defaultBasename("missing")
242 EXPECT_EQ("missing.ndx", value);
244 gmx::OptionsAssigner assigner(&options_);
245 EXPECT_NO_THROW_GMX(assigner.start());
246 EXPECT_NO_THROW_GMX(assigner.finish());
247 EXPECT_NO_THROW_GMX(options_.finish());
249 EXPECT_EQ("missing.ndx", value);
252 TEST_F(FileNameOptionManagerTest, AddsMissingExtensionBasedOnExistingFile)
254 std::string filename(createDummyFile(".trr"));
255 std::string inputValue(gmx::Path::stripExtension(filename));
258 ASSERT_NO_THROW_GMX(options_.addOption(
259 FileNameOption("f").store(&value)
260 .filetype(gmx::eftTrajectory).inputFile()));
262 gmx::OptionsAssigner assigner(&options_);
263 EXPECT_NO_THROW_GMX(assigner.start());
264 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
265 EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
266 EXPECT_NO_THROW_GMX(assigner.finishOption());
267 EXPECT_NO_THROW_GMX(assigner.finish());
268 EXPECT_NO_THROW_GMX(options_.finish());
270 EXPECT_EQ(filename, value);
273 TEST_F(FileNameOptionManagerTest,
274 AddsMissingExtensionForRequiredDefaultNameBasedOnExistingFile)
276 std::string filename(createDummyFile(".trr"));
277 std::string inputValue(gmx::Path::stripExtension(filename));
280 ASSERT_NO_THROW_GMX(options_.addOption(
281 FileNameOption("f").store(&value).required()
282 .filetype(gmx::eftTrajectory).inputFile()
283 .defaultBasename(inputValue.c_str())));
284 EXPECT_EQ(inputValue + ".xtc", value);
286 gmx::OptionsAssigner assigner(&options_);
287 EXPECT_NO_THROW_GMX(assigner.start());
288 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
289 EXPECT_NO_THROW_GMX(assigner.finishOption());
290 EXPECT_NO_THROW_GMX(assigner.finish());
291 EXPECT_NO_THROW_GMX(options_.finish());
293 EXPECT_EQ(filename, value);
296 TEST_F(FileNameOptionManagerTest,
297 AddsMissingExtensionForOptionalDefaultNameBasedOnExistingFile)
299 std::string filename(createDummyFile(".trr"));
300 std::string inputValue(gmx::Path::stripExtension(filename));
303 ASSERT_NO_THROW_GMX(options_.addOption(
304 FileNameOption("f").store(&value)
305 .filetype(gmx::eftTrajectory).inputFile()
306 .defaultBasename(inputValue.c_str())));
308 gmx::OptionsAssigner assigner(&options_);
309 EXPECT_NO_THROW_GMX(assigner.start());
310 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
311 EXPECT_NO_THROW_GMX(assigner.finishOption());
312 EXPECT_NO_THROW_GMX(assigner.finish());
313 EXPECT_NO_THROW_GMX(options_.finish());
315 EXPECT_EQ(filename, value);
318 TEST_F(FileNameOptionManagerTest,
319 AddsMissingExtensionForRequiredFromDefaultNameOptionBasedOnExistingFile)
321 std::string filename(createDummyFile(".trr"));
322 std::string inputValue(gmx::Path::stripExtension(filename));
325 ASSERT_NO_THROW_GMX(options_.addOption(
326 FileNameOption("f").store(&value).required()
327 .filetype(gmx::eftTrajectory).inputFile()
328 .defaultBasename("foo")));
329 ASSERT_NO_THROW_GMX(manager_.addDefaultFileNameOption(&options_, "deffnm"));
330 EXPECT_EQ("foo.xtc", value);
332 gmx::OptionsAssigner assigner(&options_);
333 EXPECT_NO_THROW_GMX(assigner.start());
334 EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
335 EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
336 EXPECT_NO_THROW_GMX(assigner.finishOption());
337 EXPECT_NO_THROW_GMX(assigner.finish());
338 EXPECT_NO_THROW_GMX(options_.finish());
340 EXPECT_EQ(filename, value);
343 TEST_F(FileNameOptionManagerTest,
344 AddsMissingExtensionForOptionalFromDefaultNameOptionBasedOnExistingFile)
346 std::string filename(createDummyFile(".trr"));
347 std::string inputValue(gmx::Path::stripExtension(filename));
350 ASSERT_NO_THROW_GMX(options_.addOption(
351 FileNameOption("f").store(&value)
352 .filetype(gmx::eftTrajectory).inputFile()
353 .defaultBasename("foo")));
354 ASSERT_NO_THROW_GMX(manager_.addDefaultFileNameOption(&options_, "deffnm"));
356 gmx::OptionsAssigner assigner(&options_);
357 EXPECT_NO_THROW_GMX(assigner.start());
358 EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
359 EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
360 EXPECT_NO_THROW_GMX(assigner.finishOption());
361 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
362 EXPECT_NO_THROW_GMX(assigner.finishOption());
363 EXPECT_NO_THROW_GMX(assigner.finish());
364 EXPECT_NO_THROW_GMX(options_.finish());
366 EXPECT_EQ(filename, value);