src/gromacs/coordinateio/tests/requirements.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*!\file
  36  * \libinternal
  37  * \brief
  38  * Helpers and data for flag setting method.
  39  *
  40  * \author Paul Bauer <paul.bauer.q@gmail.com>
  41  * \inlibraryapi
  42  * \ingroup module_coordinateio
  43  */
  44
  45 #ifndef GMX_COORDINATEIO_TESTS_FLAG_H
  46 #define GMX_COORDINATEIO_TESTS_FLAG_H
  47
  48 #include "gmxpre.h"
  49
  50 #include <gtest/gtest.h>
  51
  52 #include "gromacs/coordinateio/requirements.h"
  53 #include "gromacs/options/options.h"
  54 #include "gromacs/utility/any.h"
  55 #include "gromacs/utility/arrayref.h"
  56 #include "gromacs/utility/stringutil.h"
  57
  58 #include "gromacs/coordinateio/tests/coordinate_test.h"
  59
  60 namespace gmx
  61 {
  62
  63 namespace test
  64 {
  65
  66 //! Test enums to decide on how to use options framework
  67 enum class TestEnums
  68 {
  69     efTestString,
  70     efTestInt,
  71     efTestFloat
  72 };
  73
  74 /*!\brief
  75  * Helper function to split string with multiple values into option settings.
  76  *
  77  * \param[in] assigner     Options assigner to use.
  78  * \param[in] optionValues String to split that contains option values.
  79  * \param[in] type         Determine which input time we are using.
  80  */
  81 static void
  82 splitAndAddValues(OptionsAssigner *assigner, const std::string &optionValues, TestEnums type)
  83 {
  84     std::vector<std::string> strings = splitString(optionValues);
  85     for (const auto &entry : strings)
  86     {
  87         switch (type)
  88         {
  89             case (TestEnums::efTestFloat):
  90                 {
  91                     real    value = std::stod(entry);
  92                     Any     var(value);
  93                     assigner->appendValue(var);
  94                     break;
  95                 }
  96             case (TestEnums::efTestString):
  97             {
  98                 assigner->appendValue(entry);
  99                 break;
 100             }
 101             case (TestEnums::efTestInt):
 102             {
 103                 int     value = std::stoi(entry);
 104                 Any     var(value);
 105                 assigner->appendValue(var);
 106                 break;
 107             }
 108             default:
 109                 GMX_THROW(InternalError("No such input type"));
 110         }
 111     }
 112 }
 113
 114
 115 /*! \libinternal \brief
 116  * Test fixture to test user inputs.
 117  */
 118 class FlagTest : public gmx::test::CommandLineTestBase
 119 {
 120     public:
 121         FlagTest()
 122         {
 123             requirementsBuilder_.initOptions(&options_);
 124         }
 125
 126         /*! \brief
 127          * Set value for options in flag setting object.
 128          *
 129          * \param[in] optionName   Name of the option to add value for.
 130          * \param[in] optionValues Values to set for option.
 131          * \param[in] options      Container for options.
 132          * \param[in] type         Need to know type of entries.
 133          */
 134         void setModuleFlag(const std::string &optionName,
 135                            const std::string &optionValues,
 136                            Options           *options,
 137                            TestEnums          type)
 138         {
 139             OptionsAssigner assigner(options);
 140             assigner.start();
 141             assigner.startOption(optionName.c_str());
 142             splitAndAddValues(&assigner, optionValues, type);
 143
 144             assigner.finishOption();
 145             assigner.finish();
 146         }
 147
 148         //! Storage of requirments.
 149         OutputRequirementOptionDirector requirementsBuilder_;
 150         //! Options storage
 151         Options                         options_;
 152 };
 153
 154 } // namespace test
 155
 156 } // namespace gmx
 157
 158 #endif