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 file name option implementation.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
44 #include <gtest/gtest.h>
46 #include "gromacs/options/filenameoption.h"
47 #include "gromacs/options/filenameoptionmanager.h"
48 #include "gromacs/options/options.h"
49 #include "gromacs/options/optionsassigner.h"
50 #include "gromacs/utility/exceptions.h"
51 #include "gromacs/utility/file.h"
52 #include "gromacs/utility/path.h"
54 #include "testutils/testasserts.h"
55 #include "testutils/testfilemanager.h"
60 using gmx::FileNameOption;
61 using gmx::test::TestFileManager;
63 TEST(FileNameOptionTest, AddsMissingExtension)
65 gmx::Options options(NULL, NULL);
67 ASSERT_NO_THROW_GMX(options.addOption(
68 FileNameOption("f").store(&value)
69 .filetype(gmx::eftTrajectory).outputFile()));
71 gmx::OptionsAssigner assigner(&options);
72 EXPECT_NO_THROW_GMX(assigner.start());
73 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
74 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
75 EXPECT_NO_THROW_GMX(assigner.finishOption());
76 EXPECT_NO_THROW_GMX(assigner.finish());
77 EXPECT_NO_THROW_GMX(options.finish());
79 EXPECT_EQ("testfile.xtc", value);
82 TEST(FileNameOptionTest, HandlesRequiredDefaultValueWithoutExtension)
84 gmx::Options options(NULL, NULL);
86 ASSERT_NO_THROW_GMX(options.addOption(
87 FileNameOption("f").store(&value).required()
88 .filetype(gmx::eftGenericData).outputFile()
89 .defaultBasename("testfile")));
90 EXPECT_EQ("testfile.dat", value);
92 gmx::OptionsAssigner assigner(&options);
93 EXPECT_NO_THROW_GMX(assigner.start());
94 EXPECT_NO_THROW_GMX(assigner.finish());
95 EXPECT_NO_THROW_GMX(options.finish());
97 EXPECT_EQ("testfile.dat", value);
100 TEST(FileNameOptionTest, HandlesRequiredOptionWithoutValue)
102 gmx::Options options(NULL, NULL);
104 ASSERT_NO_THROW_GMX(options.addOption(
105 FileNameOption("f").store(&value).required()
106 .filetype(gmx::eftGenericData).outputFile()
107 .defaultBasename("testfile")));
109 gmx::OptionsAssigner assigner(&options);
110 EXPECT_NO_THROW_GMX(assigner.start());
111 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
112 EXPECT_NO_THROW_GMX(assigner.finishOption());
113 EXPECT_NO_THROW_GMX(assigner.finish());
114 EXPECT_NO_THROW_GMX(options.finish());
116 EXPECT_EQ("testfile.dat", value);
119 TEST(FileNameOptionTest, HandlesOptionalUnsetOption)
121 gmx::Options options(NULL, NULL);
123 ASSERT_NO_THROW_GMX(options.addOption(
124 FileNameOption("f").store(&value)
125 .filetype(gmx::eftTrajectory).outputFile()
126 .defaultBasename("testfile")));
127 EXPECT_TRUE(value.empty());
129 gmx::OptionsAssigner assigner(&options);
130 EXPECT_NO_THROW_GMX(assigner.start());
131 EXPECT_NO_THROW_GMX(assigner.finish());
132 EXPECT_NO_THROW_GMX(options.finish());
134 EXPECT_TRUE(value.empty());
137 TEST(FileNameOptionTest, HandlesOptionalDefaultValueWithoutExtension)
139 gmx::Options options(NULL, NULL);
141 ASSERT_NO_THROW_GMX(options.addOption(
142 FileNameOption("f").store(&value)
143 .filetype(gmx::eftIndex).outputFile()
144 .defaultBasename("testfile")));
145 EXPECT_TRUE(value.empty());
147 gmx::OptionsAssigner assigner(&options);
148 EXPECT_NO_THROW_GMX(assigner.start());
149 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
150 EXPECT_NO_THROW_GMX(assigner.finishOption());
151 EXPECT_NO_THROW_GMX(assigner.finish());
152 EXPECT_NO_THROW_GMX(options.finish());
154 EXPECT_EQ("testfile.ndx", value);
157 TEST(FileNameOptionTest, AddsMissingExtensionBasedOnExistingFile)
159 TestFileManager tempFiles;
160 std::string filename(tempFiles.getTemporaryFilePath(".trr"));
161 gmx::File::writeFileFromString(filename, "Dummy trajectory file");
162 std::string inputValue(gmx::Path::stripExtension(filename));
164 gmx::Options options(NULL, NULL);
166 ASSERT_NO_THROW_GMX(options.addOption(
167 FileNameOption("f").store(&value)
168 .filetype(gmx::eftTrajectory).inputFile()));
170 gmx::OptionsAssigner assigner(&options);
171 EXPECT_NO_THROW_GMX(assigner.start());
172 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
173 EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
174 EXPECT_NO_THROW_GMX(assigner.finishOption());
175 EXPECT_NO_THROW_GMX(assigner.finish());
176 EXPECT_NO_THROW_GMX(options.finish());
178 EXPECT_EQ(filename, value);
181 TEST(FileNameOptionTest, AddsMissingExtensionForRequiredDefaultNameBasedOnExistingFile)
183 TestFileManager tempFiles;
184 std::string filename(tempFiles.getTemporaryFilePath(".trr"));
185 gmx::File::writeFileFromString(filename, "Dummy trajectory file");
186 std::string inputValue(gmx::Path::stripExtension(filename));
188 gmx::Options options(NULL, NULL);
190 ASSERT_NO_THROW_GMX(options.addOption(
191 FileNameOption("f").store(&value).required()
192 .filetype(gmx::eftTrajectory).inputFile()
193 .defaultBasename(inputValue.c_str())));
194 EXPECT_EQ(inputValue + ".xtc", value);
196 gmx::OptionsAssigner assigner(&options);
197 EXPECT_NO_THROW_GMX(assigner.start());
198 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
199 EXPECT_NO_THROW_GMX(assigner.finishOption());
200 EXPECT_NO_THROW_GMX(assigner.finish());
201 EXPECT_NO_THROW_GMX(options.finish());
203 EXPECT_EQ(filename, value);
206 TEST(FileNameOptionTest, AddsMissingExtensionForOptionalDefaultNameBasedOnExistingFile)
208 TestFileManager tempFiles;
209 std::string filename(tempFiles.getTemporaryFilePath(".trr"));
210 gmx::File::writeFileFromString(filename, "Dummy trajectory file");
211 std::string inputValue(gmx::Path::stripExtension(filename));
213 gmx::Options options(NULL, NULL);
215 ASSERT_NO_THROW_GMX(options.addOption(
216 FileNameOption("f").store(&value)
217 .filetype(gmx::eftTrajectory).inputFile()
218 .defaultBasename(inputValue.c_str())));
220 gmx::OptionsAssigner assigner(&options);
221 EXPECT_NO_THROW_GMX(assigner.start());
222 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
223 EXPECT_NO_THROW_GMX(assigner.finishOption());
224 EXPECT_NO_THROW_GMX(assigner.finish());
225 EXPECT_NO_THROW_GMX(options.finish());
227 EXPECT_EQ(filename, value);
230 TEST(FileNameOptionTest, AddsMissingExtensionForRequiredFromDefaultNameOptionBasedOnExistingFile)
232 TestFileManager tempFiles;
233 std::string filename(tempFiles.getTemporaryFilePath(".trr"));
234 gmx::File::writeFileFromString(filename, "Dummy trajectory file");
235 std::string inputValue(gmx::Path::stripExtension(filename));
237 gmx::FileNameOptionManager manager;
238 gmx::Options options(NULL, NULL);
240 ASSERT_NO_THROW_GMX(options.addManager(&manager));
241 ASSERT_NO_THROW_GMX(options.addOption(
242 FileNameOption("f").store(&value).required()
243 .filetype(gmx::eftTrajectory).inputFile()
244 .defaultBasename("foo")));
245 ASSERT_NO_THROW_GMX(manager.addDefaultFileNameOption(&options, "deffnm"));
246 EXPECT_EQ("foo.xtc", value);
248 gmx::OptionsAssigner assigner(&options);
249 EXPECT_NO_THROW_GMX(assigner.start());
250 EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
251 EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
252 EXPECT_NO_THROW_GMX(assigner.finishOption());
253 EXPECT_NO_THROW_GMX(assigner.finish());
254 EXPECT_NO_THROW_GMX(options.finish());
256 EXPECT_EQ(filename, value);
259 TEST(FileNameOptionTest, AddsMissingExtensionForOptionalFromDefaultNameOptionBasedOnExistingFile)
261 TestFileManager tempFiles;
262 std::string filename(tempFiles.getTemporaryFilePath(".trr"));
263 gmx::File::writeFileFromString(filename, "Dummy trajectory file");
264 std::string inputValue(gmx::Path::stripExtension(filename));
266 gmx::FileNameOptionManager manager;
267 gmx::Options options(NULL, NULL);
269 ASSERT_NO_THROW_GMX(options.addManager(&manager));
270 ASSERT_NO_THROW_GMX(options.addOption(
271 FileNameOption("f").store(&value)
272 .filetype(gmx::eftTrajectory).inputFile()
273 .defaultBasename("foo")));
274 ASSERT_NO_THROW_GMX(manager.addDefaultFileNameOption(&options, "deffnm"));
276 gmx::OptionsAssigner assigner(&options);
277 EXPECT_NO_THROW_GMX(assigner.start());
278 EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
279 EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
280 EXPECT_NO_THROW_GMX(assigner.finishOption());
281 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
282 EXPECT_NO_THROW_GMX(assigner.finishOption());
283 EXPECT_NO_THROW_GMX(assigner.finish());
284 EXPECT_NO_THROW_GMX(options.finish());
286 EXPECT_EQ(filename, value);