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,2019, 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().filetype(gmx::eftGenericData).outputFile().defaultBasename("testfile")));
  66     EXPECT_EQ("testfile.dat", value);
  67
  68     gmx::OptionsAssigner assigner(&options);
  69     EXPECT_NO_THROW_GMX(assigner.start());
  70     EXPECT_NO_THROW_GMX(assigner.finish());
  71     EXPECT_NO_THROW_GMX(options.finish());
  72
  73     EXPECT_EQ("testfile.dat", value);
  74 }
  75
  76 TEST(FileNameOptionTest, HandlesRequiredOptionWithoutValue)
  77 {
  78     gmx::Options options;
  79     std::string  value;
  80     ASSERT_NO_THROW_GMX(options.addOption(
  81             FileNameOption("f").store(&value).required().filetype(gmx::eftGenericData).outputFile().defaultBasename("testfile")));
  82     EXPECT_EQ("testfile.dat", value);
  83
  84     gmx::OptionsAssigner assigner(&options);
  85     EXPECT_NO_THROW_GMX(assigner.start());
  86     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
  87     EXPECT_NO_THROW_GMX(assigner.finishOption());
  88     EXPECT_NO_THROW_GMX(assigner.finish());
  89     EXPECT_NO_THROW_GMX(options.finish());
  90
  91     EXPECT_EQ("testfile.dat", value);
  92 }
  93
  94 TEST(FileNameOptionTest, HandlesOptionalUnsetOption)
  95 {
  96     gmx::Options options;
  97     std::string  value;
  98     ASSERT_NO_THROW_GMX(options.addOption(
  99             FileNameOption("f").store(&value).filetype(gmx::eftTrajectory).outputFile().defaultBasename("testfile")));
 100     EXPECT_TRUE(value.empty());
 101
 102     gmx::OptionsAssigner assigner(&options);
 103     EXPECT_NO_THROW_GMX(assigner.start());
 104     EXPECT_NO_THROW_GMX(assigner.finish());
 105     EXPECT_NO_THROW_GMX(options.finish());
 106
 107     EXPECT_TRUE(value.empty());
 108 }
 109
 110 TEST(FileNameOptionTest, HandlesOptionalDefaultValueWithoutExtension)
 111 {
 112     gmx::Options options;
 113     std::string  value;
 114     ASSERT_NO_THROW_GMX(options.addOption(
 115             FileNameOption("f").store(&value).filetype(gmx::eftIndex).outputFile().defaultBasename("testfile")));
 116     EXPECT_TRUE(value.empty());
 117
 118     gmx::OptionsAssigner assigner(&options);
 119     EXPECT_NO_THROW_GMX(assigner.start());
 120     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 121     EXPECT_NO_THROW_GMX(assigner.finishOption());
 122     EXPECT_NO_THROW_GMX(assigner.finish());
 123     EXPECT_NO_THROW_GMX(options.finish());
 124
 125     EXPECT_EQ("testfile.ndx", value);
 126 }
 127
 128 TEST(FileNameOptionTest, HandlesRequiredCustomDefaultExtension)
 129 {
 130     gmx::Options options;
 131     std::string  value;
 132     ASSERT_NO_THROW_GMX(options.addOption(FileNameOption("f")
 133                                                   .store(&value)
 134                                                   .required()
 135                                                   .filetype(gmx::eftTrajectory)
 136                                                   .outputFile()
 137                                                   .defaultBasename("testfile")
 138                                                   .defaultType(efPDB)));
 139     EXPECT_EQ("testfile.pdb", value);
 140
 141     gmx::OptionsAssigner assigner(&options);
 142     EXPECT_NO_THROW_GMX(assigner.start());
 143     EXPECT_NO_THROW_GMX(assigner.finish());
 144     EXPECT_NO_THROW_GMX(options.finish());
 145
 146     EXPECT_EQ("testfile.pdb", value);
 147 }
 148
 149 TEST(FileNameOptionTest, HandlesOptionalCustomDefaultExtension)
 150 {
 151     gmx::Options options;
 152     std::string  value;
 153     ASSERT_NO_THROW_GMX(options.addOption(FileNameOption("f")
 154                                                   .store(&value)
 155                                                   .filetype(gmx::eftTrajectory)
 156                                                   .outputFile()
 157                                                   .defaultBasename("testfile")
 158                                                   .defaultType(efPDB)));
 159     EXPECT_TRUE(value.empty());
 160
 161     gmx::OptionsAssigner assigner(&options);
 162     EXPECT_NO_THROW_GMX(assigner.start());
 163     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 164     EXPECT_NO_THROW_GMX(assigner.finishOption());
 165     EXPECT_NO_THROW_GMX(assigner.finish());
 166     EXPECT_NO_THROW_GMX(options.finish());
 167
 168     EXPECT_EQ("testfile.pdb", value);
 169 }
 170
 171 TEST(FileNameOptionTest, GivesErrorOnUnknownFileSuffix)
 172 {
 173     gmx::Options options;
 174     std::string  value;
 175     ASSERT_NO_THROW_GMX(
 176             options.addOption(FileNameOption("f").store(&value).filetype(gmx::eftIndex).outputFile()));
 177     EXPECT_TRUE(value.empty());
 178
 179     gmx::OptionsAssigner assigner(&options);
 180     EXPECT_NO_THROW_GMX(assigner.start());
 181     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 182     EXPECT_THROW_GMX(assigner.appendValue("testfile.foo"), gmx::InvalidInputError);
 183     EXPECT_NO_THROW_GMX(assigner.finishOption());
 184     EXPECT_NO_THROW_GMX(assigner.finish());
 185     EXPECT_NO_THROW_GMX(options.finish());
 186
 187     EXPECT_TRUE(value.empty());
 188 }
 189
 190 TEST(FileNameOptionTest, GivesErrorOnInvalidFileSuffix)
 191 {
 192     gmx::Options options;
 193     std::string  value;
 194     ASSERT_NO_THROW_GMX(options.addOption(
 195             FileNameOption("f").store(&value).filetype(gmx::eftTrajectory).outputFile()));
 196     EXPECT_TRUE(value.empty());
 197
 198     gmx::OptionsAssigner assigner(&options);
 199     EXPECT_NO_THROW_GMX(assigner.start());
 200     EXPECT_NO_THROW_GMX(assigner.startOption("f"));
 201     EXPECT_THROW_GMX(assigner.appendValue("testfile.dat"), gmx::InvalidInputError);
 202     EXPECT_NO_THROW_GMX(assigner.finishOption());
 203     EXPECT_NO_THROW_GMX(assigner.finish());
 204     EXPECT_NO_THROW_GMX(options.finish());
 205
 206     EXPECT_TRUE(value.empty());
 207 }
 208
 209 } // namespace