src/gromacs/commandline/tests/cmdlineparser.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013, 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 gmx::CommandLineParser.
  38  *
  39  * These tests exercise a large fraction of the code, so they may
  40  * catch errors in other parts than just in command-line parsing.
  41  *
  42  * \author Teemu Murtola <teemu.murtola@gmail.com>
  43  * \ingroup module_commandline
  44  */
  45 #include <vector>
  46
  47 #include <gtest/gtest.h>
  48
  49 #include "gromacs/commandline/cmdlineparser.h"
  50 #include "gromacs/options/basicoptions.h"
  51 #include "gromacs/options/options.h"
  52
  53 #include "testutils/cmdlinetest.h"
  54 #include "testutils/testasserts.h"
  55
  56 namespace
  57 {
  58
  59 using gmx::test::CommandLine;
  60
  61 class CommandLineParserTest : public ::testing::Test
  62 {
  63     public:
  64         CommandLineParserTest();
  65
  66         gmx::Options            options_;
  67         gmx::CommandLineParser  parser_;
  68         bool                    flag_;
  69         std::vector<int>        ivalues_;
  70         std::vector<double>     dvalues_;
  71         int                     ivalue1p_;
  72         int                     ivalue12_;
  73 };
  74
  75 CommandLineParserTest::CommandLineParserTest()
  76     : options_(NULL, NULL), parser_(&options_),
  77       flag_(false), ivalue1p_(0), ivalue12_(0)
  78 {
  79     using gmx::BooleanOption;
  80     using gmx::IntegerOption;
  81     using gmx::DoubleOption;
  82     options_.addOption(BooleanOption("flag").store(&flag_));
  83     options_.addOption(IntegerOption("mvi").storeVector(&ivalues_).multiValue());
  84     options_.addOption(DoubleOption("mvd").storeVector(&dvalues_).allowMultiple());
  85     options_.addOption(IntegerOption("1p").store(&ivalue1p_));
  86     options_.addOption(IntegerOption("12").store(&ivalue12_));
  87 }
  88
  89 TEST_F(CommandLineParserTest, HandlesSingleValues)
  90 {
  91     const char *const cmdline[] = {
  92         "test", "-flag", "yes", "-mvi", "2", "-mvd", "2.7"
  93     };
  94     CommandLine       args(CommandLine::create(cmdline));
  95     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
  96     ASSERT_NO_THROW_GMX(options_.finish());
  97
  98     EXPECT_TRUE(flag_);
  99     ASSERT_EQ(1U, ivalues_.size());
 100     EXPECT_EQ(2, ivalues_[0]);
 101     ASSERT_EQ(1U, dvalues_.size());
 102     EXPECT_DOUBLE_EQ(2.7, dvalues_[0]);
 103 }
 104
 105 TEST_F(CommandLineParserTest, HandlesNegativeNumbers)
 106 {
 107     const char *const cmdline[] = {
 108         "test", "-mvi", "1", "-2", "-mvd", "-2.7"
 109     };
 110     CommandLine       args(CommandLine::create(cmdline));
 111     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
 112     ASSERT_NO_THROW_GMX(options_.finish());
 113
 114     ASSERT_EQ(2U, ivalues_.size());
 115     EXPECT_EQ(1, ivalues_[0]);
 116     EXPECT_EQ(-2, ivalues_[1]);
 117     ASSERT_EQ(1U, dvalues_.size());
 118     EXPECT_DOUBLE_EQ(-2.7, dvalues_[0]);
 119 }
 120
 121 TEST_F(CommandLineParserTest, HandlesDoubleDashOptionPrefix)
 122 {
 123     const char *const cmdline[] = {
 124         "test", "--mvi", "1", "-2", "--mvd", "-2.7"
 125     };
 126     CommandLine       args(CommandLine::create(cmdline));
 127     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
 128     ASSERT_NO_THROW_GMX(options_.finish());
 129
 130     ASSERT_EQ(2U, ivalues_.size());
 131     EXPECT_EQ(1, ivalues_[0]);
 132     EXPECT_EQ(-2, ivalues_[1]);
 133     ASSERT_EQ(1U, dvalues_.size());
 134     EXPECT_DOUBLE_EQ(-2.7, dvalues_[0]);
 135 }
 136
 137 TEST_F(CommandLineParserTest, HandlesOptionsStartingWithNumbers)
 138 {
 139     const char *const cmdline[] = {
 140         "test", "--12", "1", "-1p", "-12"
 141     };
 142     CommandLine       args(CommandLine::create(cmdline));
 143     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
 144     ASSERT_NO_THROW_GMX(options_.finish());
 145
 146     EXPECT_EQ(1, ivalue12_);
 147     EXPECT_EQ(-12, ivalue1p_);
 148 }
 149
 150 TEST_F(CommandLineParserTest, HandlesSkipUnknown)
 151 {
 152     const char *const cmdline[] = {
 153         "test", "-opt1", "-flag", "-opt2", "value", "-mvi", "2", "-mvd", "2.7", "-opt3"
 154     };
 155     CommandLine       args(CommandLine::create(cmdline));
 156     parser_.skipUnknown(true);
 157     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
 158     ASSERT_NO_THROW_GMX(options_.finish());
 159
 160     ASSERT_EQ(5, args.argc());
 161     EXPECT_STREQ("test", args.arg(0));
 162     EXPECT_STREQ("-opt1", args.arg(1));
 163     EXPECT_STREQ("-opt2", args.arg(2));
 164     EXPECT_STREQ("value", args.arg(3));
 165     EXPECT_STREQ("-opt3", args.arg(4));
 166
 167     EXPECT_TRUE(flag_);
 168     ASSERT_EQ(1U, ivalues_.size());
 169     EXPECT_EQ(2, ivalues_[0]);
 170     ASSERT_EQ(1U, dvalues_.size());
 171     EXPECT_DOUBLE_EQ(2.7, dvalues_[0]);
 172 }
 173
 174 } // namespace