src/gromacs/options/tests/filenameoptionmanager.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Tests file name option implementation dependent on gmx::FileNameOptionManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #include "gromacs/options/filenameoptionmanager.h"
  43
  44 #include <gtest/gtest.h>
  45
  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"
  51 #include "gromacs/utility/path.h"
  52
  53 #include "testutils/testasserts.h"
  54 #include "testutils/testfilemanager.h"
  55
  56 namespace
  57 {
  58
  59 using gmx::FileNameOption;
  60
  61 class FileNameOptionManagerTest : public ::testing::Test
  62 {
  63     public:
  64         FileNameOptionManagerTest()
  65             : options_(NULL, NULL)
  66         {
  67             options_.addManager(&manager_);
  68         }
  69
  70         std::string createDummyFile(const char *suffix)
  71         {
  72             std::string filename(tempFiles_.getTemporaryFilePath(suffix));
  73             gmx::File::writeFileFromString(filename, "Dummy file");
  74             return filename;
  75         }
  76
  77         gmx::FileNameOptionManager manager_;
  78         gmx::Options               options_;
  79         gmx::test::TestFileManager tempFiles_;
  80 };
  81
  82 /********************************************************************
  83  * Actual tests
  84  */
  85
  86 TEST_F(FileNameOptionManagerTest, AddsMissingExtension)
  87 {
  88     std::string value;
  89     ASSERT_NO_THROW_GMX(options_.addOption(
  90                                 FileNameOption("f").store(&value)
  91                                     .filetype(gmx::eftTrajectory).outputFile()));
  92
  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());
 100
 101     EXPECT_EQ("testfile.xtc", value);
 102 }
 103
 104 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingInputFile)
 105 {
 106     std::string value;
 107     ASSERT_NO_THROW_GMX(options_.addOption(
 108                                 FileNameOption("f").store(&value)
 109                                     .filetype(gmx::eftIndex).inputFile()));
 110     EXPECT_TRUE(value.empty());
 111
 112     gmx::OptionsAssigner assigner(&options_);
 113     EXPECT_NO_THROW_GMX(assigner.start());
 114     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 115     EXPECT_THROW_GMX(assigner.appendValue("missing.ndx"), gmx::InvalidInputError);
 116     EXPECT_NO_THROW_GMX(assigner.finishOption());
 117     EXPECT_NO_THROW_GMX(assigner.finish());
 118     EXPECT_NO_THROW_GMX(options_.finish());
 119
 120     EXPECT_TRUE(value.empty());
 121 }
 122
 123 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingGenericInputFile)
 124 {
 125     std::string value;
 126     ASSERT_NO_THROW_GMX(options_.addOption(
 127                                 FileNameOption("f").store(&value)
 128                                     .filetype(gmx::eftTrajectory).inputFile()));
 129     EXPECT_TRUE(value.empty());
 130
 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.trr"), gmx::InvalidInputError);
 135     EXPECT_NO_THROW_GMX(assigner.finishOption());
 136     EXPECT_NO_THROW_GMX(assigner.finish());
 137     EXPECT_NO_THROW_GMX(options_.finish());
 138
 139     EXPECT_TRUE(value.empty());
 140 }
 141
 142 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingDefaultInputFile)
 143 {
 144     std::string value;
 145     ASSERT_NO_THROW_GMX(options_.addOption(
 146                                 FileNameOption("f").store(&value)
 147                                     .filetype(gmx::eftIndex).inputFile()
 148                                     .defaultBasename("missing")));
 149
 150     gmx::OptionsAssigner assigner(&options_);
 151     EXPECT_NO_THROW_GMX(assigner.start());
 152     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 153     EXPECT_NO_THROW_GMX(assigner.finishOption());
 154     EXPECT_NO_THROW_GMX(assigner.finish());
 155     EXPECT_THROW_GMX(options_.finish(), gmx::InvalidInputError);
 156 }
 157
 158 TEST_F(FileNameOptionManagerTest, GivesErrorOnMissingRequiredInputFile)
 159 {
 160     std::string value;
 161     ASSERT_NO_THROW_GMX(options_.addOption(
 162                                 FileNameOption("f").store(&value).required()
 163                                     .filetype(gmx::eftIndex).inputFile()
 164                                     .defaultBasename("missing")));
 165     EXPECT_EQ("missing.ndx", value);
 166
 167     gmx::OptionsAssigner assigner(&options_);
 168     EXPECT_NO_THROW_GMX(assigner.start());
 169     EXPECT_NO_THROW_GMX(assigner.finish());
 170     EXPECT_THROW_GMX(options_.finish(), gmx::InvalidInputError);
 171 }
 172
 173 TEST_F(FileNameOptionManagerTest, AddsMissingExtensionBasedOnExistingFile)
 174 {
 175     std::string filename(createDummyFile(".trr"));
 176     std::string inputValue(gmx::Path::stripExtension(filename));
 177
 178     std::string value;
 179     ASSERT_NO_THROW_GMX(options_.addOption(
 180                                 FileNameOption("f").store(&value)
 181                                     .filetype(gmx::eftTrajectory).inputFile()));
 182
 183     gmx::OptionsAssigner assigner(&options_);
 184     EXPECT_NO_THROW_GMX(assigner.start());
 185     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 186     EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
 187     EXPECT_NO_THROW_GMX(assigner.finishOption());
 188     EXPECT_NO_THROW_GMX(assigner.finish());
 189     EXPECT_NO_THROW_GMX(options_.finish());
 190
 191     EXPECT_EQ(filename, value);
 192 }
 193
 194 TEST_F(FileNameOptionManagerTest,
 195        AddsMissingExtensionForRequiredDefaultNameBasedOnExistingFile)
 196 {
 197     std::string filename(createDummyFile(".trr"));
 198     std::string inputValue(gmx::Path::stripExtension(filename));
 199
 200     std::string value;
 201     ASSERT_NO_THROW_GMX(options_.addOption(
 202                                 FileNameOption("f").store(&value).required()
 203                                     .filetype(gmx::eftTrajectory).inputFile()
 204                                     .defaultBasename(inputValue.c_str())));
 205     EXPECT_EQ(inputValue + ".xtc", value);
 206
 207     gmx::OptionsAssigner assigner(&options_);
 208     EXPECT_NO_THROW_GMX(assigner.start());
 209     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 210     EXPECT_NO_THROW_GMX(assigner.finishOption());
 211     EXPECT_NO_THROW_GMX(assigner.finish());
 212     EXPECT_NO_THROW_GMX(options_.finish());
 213
 214     EXPECT_EQ(filename, value);
 215 }
 216
 217 TEST_F(FileNameOptionManagerTest,
 218        AddsMissingExtensionForOptionalDefaultNameBasedOnExistingFile)
 219 {
 220     std::string filename(createDummyFile(".trr"));
 221     std::string inputValue(gmx::Path::stripExtension(filename));
 222
 223     std::string value;
 224     ASSERT_NO_THROW_GMX(options_.addOption(
 225                                 FileNameOption("f").store(&value)
 226                                     .filetype(gmx::eftTrajectory).inputFile()
 227                                     .defaultBasename(inputValue.c_str())));
 228
 229     gmx::OptionsAssigner assigner(&options_);
 230     EXPECT_NO_THROW_GMX(assigner.start());
 231     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 232     EXPECT_NO_THROW_GMX(assigner.finishOption());
 233     EXPECT_NO_THROW_GMX(assigner.finish());
 234     EXPECT_NO_THROW_GMX(options_.finish());
 235
 236     EXPECT_EQ(filename, value);
 237 }
 238
 239 TEST_F(FileNameOptionManagerTest,
 240        AddsMissingExtensionForRequiredFromDefaultNameOptionBasedOnExistingFile)
 241 {
 242     std::string filename(createDummyFile(".trr"));
 243     std::string inputValue(gmx::Path::stripExtension(filename));
 244
 245     std::string value;
 246     ASSERT_NO_THROW_GMX(options_.addOption(
 247                                 FileNameOption("f").store(&value).required()
 248                                     .filetype(gmx::eftTrajectory).inputFile()
 249                                     .defaultBasename("foo")));
 250     ASSERT_NO_THROW_GMX(manager_.addDefaultFileNameOption(&options_, "deffnm"));
 251     EXPECT_EQ("foo.xtc", value);
 252
 253     gmx::OptionsAssigner assigner(&options_);
 254     EXPECT_NO_THROW_GMX(assigner.start());
 255     EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
 256     EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
 257     EXPECT_NO_THROW_GMX(assigner.finishOption());
 258     EXPECT_NO_THROW_GMX(assigner.finish());
 259     EXPECT_NO_THROW_GMX(options_.finish());
 260
 261     EXPECT_EQ(filename, value);
 262 }
 263
 264 TEST_F(FileNameOptionManagerTest,
 265        AddsMissingExtensionForOptionalFromDefaultNameOptionBasedOnExistingFile)
 266 {
 267     std::string filename(createDummyFile(".trr"));
 268     std::string inputValue(gmx::Path::stripExtension(filename));
 269
 270     std::string value;
 271     ASSERT_NO_THROW_GMX(options_.addOption(
 272                                 FileNameOption("f").store(&value)
 273                                     .filetype(gmx::eftTrajectory).inputFile()
 274                                     .defaultBasename("foo")));
 275     ASSERT_NO_THROW_GMX(manager_.addDefaultFileNameOption(&options_, "deffnm"));
 276
 277     gmx::OptionsAssigner assigner(&options_);
 278     EXPECT_NO_THROW_GMX(assigner.start());
 279     EXPECT_NO_THROW_GMX(assigner.startOption("deffnm"));
 280     EXPECT_NO_THROW_GMX(assigner.appendValue(inputValue));
 281     EXPECT_NO_THROW_GMX(assigner.finishOption());
 282     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 283     EXPECT_NO_THROW_GMX(assigner.finishOption());
 284     EXPECT_NO_THROW_GMX(assigner.finish());
 285     EXPECT_NO_THROW_GMX(options_.finish());
 286
 287     EXPECT_EQ(filename, value);
 288 }
 289
 290 } // namespace