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