src/gromacs/options/tests/filenameoption.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016, 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 basic file name option implementation.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/options/filenameoption.h"
  45
  46 #include <gtest/gtest.h>
  47
  48 #include "gromacs/fileio/filetypes.h"
  49 #include "gromacs/options/options.h"
  50 #include "gromacs/options/optionsassigner.h"
  51 #include "gromacs/utility/exceptions.h"
  52
  53 #include "testutils/testasserts.h"
  54
  55 namespace
  56 {
  57
  58 using gmx::FileNameOption;
  59
  60 TEST(FileNameOptionTest, HandlesRequiredDefaultValueWithoutExtension)
  61 {
  62     gmx::Options           options;
  63     std::string            value;
  64     ASSERT_NO_THROW_GMX(options.addOption(
  65                                 FileNameOption("f").store(&value).required()
  66                                     .filetype(gmx::eftGenericData).outputFile()
  67                                     .defaultBasename("testfile")));
  68     EXPECT_EQ("testfile.dat", value);
  69
  70     gmx::OptionsAssigner assigner(&options);
  71     EXPECT_NO_THROW_GMX(assigner.start());
  72     EXPECT_NO_THROW_GMX(assigner.finish());
  73     EXPECT_NO_THROW_GMX(options.finish());
  74
  75     EXPECT_EQ("testfile.dat", value);
  76 }
  77
  78 TEST(FileNameOptionTest, HandlesRequiredOptionWithoutValue)
  79 {
  80     gmx::Options           options;
  81     std::string            value;
  82     ASSERT_NO_THROW_GMX(options.addOption(
  83                                 FileNameOption("f").store(&value).required()
  84                                     .filetype(gmx::eftGenericData).outputFile()
  85                                     .defaultBasename("testfile")));
  86     EXPECT_EQ("testfile.dat", value);
  87
  88     gmx::OptionsAssigner assigner(&options);
  89     EXPECT_NO_THROW_GMX(assigner.start());
  90     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
  91     EXPECT_NO_THROW_GMX(assigner.finishOption());
  92     EXPECT_NO_THROW_GMX(assigner.finish());
  93     EXPECT_NO_THROW_GMX(options.finish());
  94
  95     EXPECT_EQ("testfile.dat", value);
  96 }
  97
  98 TEST(FileNameOptionTest, HandlesOptionalUnsetOption)
  99 {
 100     gmx::Options           options;
 101     std::string            value;
 102     ASSERT_NO_THROW_GMX(options.addOption(
 103                                 FileNameOption("f").store(&value)
 104                                     .filetype(gmx::eftTrajectory).outputFile()
 105                                     .defaultBasename("testfile")));
 106     EXPECT_TRUE(value.empty());
 107
 108     gmx::OptionsAssigner assigner(&options);
 109     EXPECT_NO_THROW_GMX(assigner.start());
 110     EXPECT_NO_THROW_GMX(assigner.finish());
 111     EXPECT_NO_THROW_GMX(options.finish());
 112
 113     EXPECT_TRUE(value.empty());
 114 }
 115
 116 TEST(FileNameOptionTest, HandlesOptionalDefaultValueWithoutExtension)
 117 {
 118     gmx::Options           options;
 119     std::string            value;
 120     ASSERT_NO_THROW_GMX(options.addOption(
 121                                 FileNameOption("f").store(&value)
 122                                     .filetype(gmx::eftIndex).outputFile()
 123                                     .defaultBasename("testfile")));
 124     EXPECT_TRUE(value.empty());
 125
 126     gmx::OptionsAssigner assigner(&options);
 127     EXPECT_NO_THROW_GMX(assigner.start());
 128     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 129     EXPECT_NO_THROW_GMX(assigner.finishOption());
 130     EXPECT_NO_THROW_GMX(assigner.finish());
 131     EXPECT_NO_THROW_GMX(options.finish());
 132
 133     EXPECT_EQ("testfile.ndx", value);
 134 }
 135
 136 TEST(FileNameOptionTest, HandlesRequiredCustomDefaultExtension)
 137 {
 138     gmx::Options           options;
 139     std::string            value;
 140     ASSERT_NO_THROW_GMX(options.addOption(
 141                                 FileNameOption("f").store(&value).required()
 142                                     .filetype(gmx::eftTrajectory).outputFile()
 143                                     .defaultBasename("testfile")
 144                                     .defaultType(efPDB)));
 145     EXPECT_EQ("testfile.pdb", value);
 146
 147     gmx::OptionsAssigner assigner(&options);
 148     EXPECT_NO_THROW_GMX(assigner.start());
 149     EXPECT_NO_THROW_GMX(assigner.finish());
 150     EXPECT_NO_THROW_GMX(options.finish());
 151
 152     EXPECT_EQ("testfile.pdb", value);
 153 }
 154
 155 TEST(FileNameOptionTest, HandlesOptionalCustomDefaultExtension)
 156 {
 157     gmx::Options           options;
 158     std::string            value;
 159     ASSERT_NO_THROW_GMX(options.addOption(
 160                                 FileNameOption("f").store(&value)
 161                                     .filetype(gmx::eftTrajectory).outputFile()
 162                                     .defaultBasename("testfile")
 163                                     .defaultType(efPDB)));
 164     EXPECT_TRUE(value.empty());
 165
 166     gmx::OptionsAssigner assigner(&options);
 167     EXPECT_NO_THROW_GMX(assigner.start());
 168     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 169     EXPECT_NO_THROW_GMX(assigner.finishOption());
 170     EXPECT_NO_THROW_GMX(assigner.finish());
 171     EXPECT_NO_THROW_GMX(options.finish());
 172
 173     EXPECT_EQ("testfile.pdb", value);
 174 }
 175
 176 TEST(FileNameOptionTest, GivesErrorOnUnknownFileSuffix)
 177 {
 178     gmx::Options           options;
 179     std::string            value;
 180     ASSERT_NO_THROW_GMX(options.addOption(
 181                                 FileNameOption("f").store(&value)
 182                                     .filetype(gmx::eftIndex).outputFile()));
 183     EXPECT_TRUE(value.empty());
 184
 185     gmx::OptionsAssigner assigner(&options);
 186     EXPECT_NO_THROW_GMX(assigner.start());
 187     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 188     EXPECT_THROW_GMX(assigner.appendValue("testfile.foo"), gmx::InvalidInputError);
 189     EXPECT_NO_THROW_GMX(assigner.finishOption());
 190     EXPECT_NO_THROW_GMX(assigner.finish());
 191     EXPECT_NO_THROW_GMX(options.finish());
 192
 193     EXPECT_TRUE(value.empty());
 194 }
 195
 196 TEST(FileNameOptionTest, GivesErrorOnInvalidFileSuffix)
 197 {
 198     gmx::Options           options;
 199     std::string            value;
 200     ASSERT_NO_THROW_GMX(options.addOption(
 201                                 FileNameOption("f").store(&value)
 202                                     .filetype(gmx::eftTrajectory).outputFile()));
 203     EXPECT_TRUE(value.empty());
 204
 205     gmx::OptionsAssigner assigner(&options);
 206     EXPECT_NO_THROW_GMX(assigner.start());
 207     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 208     EXPECT_THROW_GMX(assigner.appendValue("testfile.dat"), gmx::InvalidInputError);
 209     EXPECT_NO_THROW_GMX(assigner.finishOption());
 210     EXPECT_NO_THROW_GMX(assigner.finish());
 211     EXPECT_NO_THROW_GMX(options.finish());
 212
 213     EXPECT_TRUE(value.empty());
 214 }
 215
 216 } // namespace