src/gromacs/options/tests/filenameoption.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #include <vector>
  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
  52 #include "testutils/testfilemanager.h"
  53
  54 namespace
  55 {
  56
  57 using gmx::FileNameOption;
  58 using gmx::test::TestFileManager;
  59
  60 TEST(FileNameOptionTest, AddsMissingExtension)
  61 {
  62     gmx::Options           options(NULL, NULL);
  63     std::string            value;
  64     ASSERT_NO_THROW(options.addOption(
  65                             FileNameOption("f").store(&value)
  66                                 .filetype(gmx::eftTrajectory).outputFile()));
  67
  68     gmx::OptionsAssigner assigner(&options);
  69     EXPECT_NO_THROW(assigner.start());
  70     EXPECT_NO_THROW(assigner.startOption("f"));
  71     EXPECT_NO_THROW(assigner.appendValue("testfile"));
  72     EXPECT_NO_THROW(assigner.finishOption());
  73     EXPECT_NO_THROW(assigner.finish());
  74     EXPECT_NO_THROW(options.finish());
  75
  76     EXPECT_EQ("testfile.xtc", value);
  77 }
  78
  79 TEST(FileNameOptionTest, HandlesRequiredDefaultValueWithoutExtension)
  80 {
  81     gmx::Options           options(NULL, NULL);
  82     std::string            value;
  83     ASSERT_NO_THROW(options.addOption(
  84                             FileNameOption("f").store(&value).required()
  85                                 .filetype(gmx::eftGenericData).outputFile()
  86                                 .defaultBasename("testfile")));
  87     EXPECT_EQ("testfile.dat", value);
  88
  89     gmx::OptionsAssigner assigner(&options);
  90     EXPECT_NO_THROW(assigner.start());
  91     EXPECT_NO_THROW(assigner.finish());
  92     EXPECT_NO_THROW(options.finish());
  93
  94     EXPECT_EQ("testfile.dat", value);
  95 }
  96
  97 TEST(FileNameOptionTest, HandlesOptionalDefaultValueWithoutExtension)
  98 {
  99     gmx::Options           options(NULL, NULL);
 100     std::string            value;
 101     ASSERT_NO_THROW(options.addOption(
 102                             FileNameOption("f").store(&value)
 103                                 .filetype(gmx::eftIndex).outputFile()
 104                                 .defaultBasename("testfile")));
 105     EXPECT_TRUE(value.empty());
 106
 107     gmx::OptionsAssigner assigner(&options);
 108     EXPECT_NO_THROW(assigner.start());
 109     EXPECT_NO_THROW(assigner.startOption("f"));
 110     EXPECT_NO_THROW(assigner.finishOption());
 111     EXPECT_NO_THROW(assigner.finish());
 112     EXPECT_NO_THROW(options.finish());
 113
 114     EXPECT_EQ("testfile.ndx", value);
 115 }
 116
 117 TEST(FileNameOptionTest, AddsMissingExtensionBasedOnExistingFile)
 118 {
 119     gmx::Options           options(NULL, NULL);
 120     std::string            value;
 121     ASSERT_NO_THROW(options.addOption(
 122                             FileNameOption("f").store(&value)
 123                                 .filetype(gmx::eftTrajectory).inputFile()));
 124     TestFileManager      tempFiles;
 125     std::string          filename(tempFiles.getTemporaryFilePath(".trr"));
 126     gmx::File::writeFileFromString(filename, "Dummy trajectory file");
 127     std::string          inputValue(filename.substr(0, filename.length() - 4));
 128
 129     gmx::OptionsAssigner assigner(&options);
 130     EXPECT_NO_THROW(assigner.start());
 131     EXPECT_NO_THROW(assigner.startOption("f"));
 132     EXPECT_NO_THROW(assigner.appendValue(inputValue));
 133     EXPECT_NO_THROW(assigner.finishOption());
 134     EXPECT_NO_THROW(assigner.finish());
 135     EXPECT_NO_THROW(options.finish());
 136
 137     EXPECT_EQ(filename, value);
 138 }
 139
 140 } // namespace