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,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 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 "gmxpre.h"
  46
  47 #include "gromacs/commandline/cmdlineparser.h"
  48
  49 #include <vector>
  50
  51 #include <gtest/gtest.h>
  52
  53 #include "gromacs/options/basicoptions.h"
  54 #include "gromacs/options/options.h"
  55
  56 #include "testutils/cmdlinetest.h"
  57 #include "testutils/testasserts.h"
  58
  59 namespace
  60 {
  61
  62 using gmx::test::CommandLine;
  63
  64 class CommandLineParserTest : public ::testing::Test
  65 {
  66     public:
  67         CommandLineParserTest();
  68
  69         gmx::Options            options_;
  70         gmx::CommandLineParser  parser_;
  71         bool                    flag_;
  72         std::vector<int>        ivalues_;
  73         std::vector<double>     dvalues_;
  74         int                     ivalue1p_;
  75         int                     ivalue12_;
  76 };
  77
  78 CommandLineParserTest::CommandLineParserTest()
  79     : options_(NULL, NULL), parser_(&options_),
  80       flag_(false), ivalue1p_(0), ivalue12_(0)
  81 {
  82     using gmx::BooleanOption;
  83     using gmx::IntegerOption;
  84     using gmx::DoubleOption;
  85     options_.addOption(BooleanOption("flag").store(&flag_));
  86     options_.addOption(IntegerOption("mvi").storeVector(&ivalues_).multiValue());
  87     options_.addOption(DoubleOption("mvd").storeVector(&dvalues_).allowMultiple());
  88     options_.addOption(IntegerOption("1p").store(&ivalue1p_));
  89     options_.addOption(IntegerOption("12").store(&ivalue12_));
  90 }
  91
  92 TEST_F(CommandLineParserTest, HandlesSingleValues)
  93 {
  94     const char *const cmdline[] = {
  95         "test", "-flag", "yes", "-mvi", "2", "-mvd", "2.7"
  96     };
  97     CommandLine       args(cmdline);
  98     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
  99     ASSERT_NO_THROW_GMX(options_.finish());
 100
 101     EXPECT_TRUE(flag_);
 102     ASSERT_EQ(1U, ivalues_.size());
 103     EXPECT_EQ(2, ivalues_[0]);
 104     ASSERT_EQ(1U, dvalues_.size());
 105     EXPECT_DOUBLE_EQ(2.7, dvalues_[0]);
 106 }
 107
 108 TEST_F(CommandLineParserTest, HandlesNegativeNumbers)
 109 {
 110     const char *const cmdline[] = {
 111         "test", "-mvi", "1", "-2", "-mvd", "-2.7"
 112     };
 113     CommandLine       args(cmdline);
 114     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
 115     ASSERT_NO_THROW_GMX(options_.finish());
 116
 117     ASSERT_EQ(2U, ivalues_.size());
 118     EXPECT_EQ(1, ivalues_[0]);
 119     EXPECT_EQ(-2, ivalues_[1]);
 120     ASSERT_EQ(1U, dvalues_.size());
 121     EXPECT_DOUBLE_EQ(-2.7, dvalues_[0]);
 122 }
 123
 124 TEST_F(CommandLineParserTest, HandlesDoubleDashOptionPrefix)
 125 {
 126     const char *const cmdline[] = {
 127         "test", "--mvi", "1", "-2", "--mvd", "-2.7"
 128     };
 129     CommandLine       args(cmdline);
 130     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
 131     ASSERT_NO_THROW_GMX(options_.finish());
 132
 133     ASSERT_EQ(2U, ivalues_.size());
 134     EXPECT_EQ(1, ivalues_[0]);
 135     EXPECT_EQ(-2, ivalues_[1]);
 136     ASSERT_EQ(1U, dvalues_.size());
 137     EXPECT_DOUBLE_EQ(-2.7, dvalues_[0]);
 138 }
 139
 140 TEST_F(CommandLineParserTest, HandlesOptionsStartingWithNumbers)
 141 {
 142     const char *const cmdline[] = {
 143         "test", "--12", "1", "-1p", "-12"
 144     };
 145     CommandLine       args(cmdline);
 146     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
 147     ASSERT_NO_THROW_GMX(options_.finish());
 148
 149     EXPECT_EQ(1, ivalue12_);
 150     EXPECT_EQ(-12, ivalue1p_);
 151 }
 152
 153 TEST_F(CommandLineParserTest, HandlesSkipUnknown)
 154 {
 155     const char *const cmdline[] = {
 156         "test", "-opt1", "-flag", "-opt2", "value", "-mvi", "2", "-mvd", "2.7", "-opt3"
 157     };
 158     CommandLine       args(cmdline);
 159     parser_.skipUnknown(true);
 160     ASSERT_NO_THROW_GMX(parser_.parse(&args.argc(), args.argv()));
 161     ASSERT_NO_THROW_GMX(options_.finish());
 162
 163     ASSERT_EQ(5, args.argc());
 164     EXPECT_STREQ("test", args.arg(0));
 165     EXPECT_STREQ("-opt1", args.arg(1));
 166     EXPECT_STREQ("-opt2", args.arg(2));
 167     EXPECT_STREQ("value", args.arg(3));
 168     EXPECT_STREQ("-opt3", args.arg(4));
 169     EXPECT_TRUE(args.arg(5) == NULL);
 170
 171     EXPECT_TRUE(flag_);
 172     ASSERT_EQ(1U, ivalues_.size());
 173     EXPECT_EQ(2, ivalues_[0]);
 174     ASSERT_EQ(1U, dvalues_.size());
 175     EXPECT_DOUBLE_EQ(2.7, dvalues_[0]);
 176 }
 177
 178 } // namespace