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/options.h"
48 #include "gromacs/options/optionsassigner.h"
49 #include "gromacs/utility/exceptions.h"
50 #include "gromacs/utility/file.h"
52 #include "testutils/testasserts.h"
53 #include "testutils/testfilemanager.h"
58 using gmx::FileNameOption;
59 using gmx::test::TestFileManager;
61 TEST(FileNameOptionTest, AddsMissingExtension)
63 gmx::Options options(NULL, NULL);
65 ASSERT_NO_THROW_GMX(options.addOption(
66 FileNameOption("f").store(&value)
67 .filetype(gmx::eftTrajectory).outputFile()));
69 gmx::OptionsAssigner assigner(&options);
70 EXPECT_NO_THROW_GMX(assigner.start());
71 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
72 EXPECT_NO_THROW_GMX(assigner.appendValue("testfile"));
73 EXPECT_NO_THROW_GMX(assigner.finishOption());
74 EXPECT_NO_THROW_GMX(assigner.finish());
75 EXPECT_NO_THROW_GMX(options.finish());
77 EXPECT_EQ("testfile.xtc", value);
80 TEST(FileNameOptionTest, HandlesRequiredDefaultValueWithoutExtension)
82 gmx::Options options(NULL, NULL);
84 ASSERT_NO_THROW_GMX(options.addOption(
85 FileNameOption("f").store(&value).required()
86 .filetype(gmx::eftGenericData).outputFile()
87 .defaultBasename("testfile")));
88 EXPECT_EQ("testfile.dat", value);
90 gmx::OptionsAssigner assigner(&options);
91 EXPECT_NO_THROW_GMX(assigner.start());
92 EXPECT_NO_THROW_GMX(assigner.finish());
93 EXPECT_NO_THROW_GMX(options.finish());
95 EXPECT_EQ("testfile.dat", value);
98 TEST(FileNameOptionTest, HandlesRequiredOptionWithoutValue)
100 gmx::Options options(NULL, NULL);
102 ASSERT_NO_THROW_GMX(options.addOption(
103 FileNameOption("f").store(&value).required()
104 .filetype(gmx::eftGenericData).outputFile()
105 .defaultBasename("testfile")));
107 gmx::OptionsAssigner assigner(&options);
108 EXPECT_NO_THROW_GMX(assigner.start());
109 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
110 EXPECT_NO_THROW_GMX(assigner.finishOption());
111 EXPECT_NO_THROW_GMX(assigner.finish());
112 EXPECT_NO_THROW_GMX(options.finish());
114 EXPECT_EQ("testfile.dat", value);
117 TEST(FileNameOptionTest, HandlesOptionalDefaultValueWithoutExtension)
119 gmx::Options options(NULL, NULL);
121 ASSERT_NO_THROW_GMX(options.addOption(
122 FileNameOption("f").store(&value)
123 .filetype(gmx::eftIndex).outputFile()
124 .defaultBasename("testfile")));
125 EXPECT_TRUE(value.empty());
127 gmx::OptionsAssigner assigner(&options);
128 EXPECT_NO_THROW_GMX(assigner.start());
129 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
130 EXPECT_NO_THROW_GMX(assigner.finishOption());
131 EXPECT_NO_THROW_GMX(assigner.finish());
132 EXPECT_NO_THROW_GMX(options.finish());
134 EXPECT_EQ("testfile.ndx", value);
137 TEST(FileNameOptionTest, AddsMissingExtensionBasedOnExistingFile)
139 gmx::Options options(NULL, NULL);
141 ASSERT_NO_THROW_GMX(options.addOption(
142 FileNameOption("f").store(&value)
143 .filetype(gmx::eftTrajectory).inputFile()));
144 TestFileManager tempFiles;
145 std::string filename(tempFiles.getTemporaryFilePath(".trr"));
146 gmx::File::writeFileFromString(filename, "Dummy trajectory file");
147 std::string inputValue(filename.substr(0, filename.length() - 4));
149 gmx::OptionsAssigner assigner(&options);
150 EXPECT_NO_THROW_GMX(assigner.start());
151 EXPECT_NO_THROW_GMX(assigner.startOption("f"));
152 EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
153 EXPECT_NO_THROW_GMX(assigner.finishOption());
154 EXPECT_NO_THROW_GMX(assigner.finish());
155 EXPECT_NO_THROW_GMX(options.finish());
157 EXPECT_EQ(filename, value);