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