src/gromacs/coordinateio/tests/requirements.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020, 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/stringutil.h"
  56
  57 #include "gromacs/coordinateio/tests/coordinate_test.h"
  58
  59 namespace gmx
  60 {
  61
  62 template<typename>
  63 class ArrayRef;
  64
  65 namespace test
  66 {
  67
  68 //! Test enums to decide on how to use options framework
  69 enum class TestEnums
  70 {
  71     efTestString,
  72     efTestInt,
  73     efTestFloat
  74 };
  75
  76 /*!\brief
  77  * Helper function to split string with multiple values into option settings.
  78  *
  79  * \param[in] assigner     Options assigner to use.
  80  * \param[in] optionValues String to split that contains option values.
  81  * \param[in] type         Determine which input time we are using.
  82  */
  83 static void splitAndAddValues(OptionsAssigner* assigner, const std::string& optionValues, TestEnums type)
  84 {
  85     std::vector<std::string> strings = splitString(optionValues);
  86     for (const auto& entry : strings)
  87     {
  88         switch (type)
  89         {
  90             case (TestEnums::efTestFloat):
  91             {
  92                 real value = std::stod(entry);
  93                 Any  var(value);
  94                 assigner->appendValue(var);
  95                 break;
  96             }
  97             case (TestEnums::efTestString):
  98             {
  99                 assigner->appendValue(entry);
 100                 break;
 101             }
 102             case (TestEnums::efTestInt):
 103             {
 104                 int value = std::stoi(entry);
 105                 Any var(value);
 106                 assigner->appendValue(var);
 107                 break;
 108             }
 109             default: 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() { requirementsBuilder_.initOptions(&options_); }
 122
 123     /*! \brief
 124      * Set value for options in flag setting object.
 125      *
 126      * \param[in] optionName   Name of the option to add value for.
 127      * \param[in] optionValues Values to set for option.
 128      * \param[in] options      Container for options.
 129      * \param[in] type         Need to know type of entries.
 130      */
 131     static void setModuleFlag(const std::string& optionName,
 132                               const std::string& optionValues,
 133                               Options*           options,
 134                               TestEnums          type)
 135     {
 136         OptionsAssigner assigner(options);
 137         assigner.start();
 138         assigner.startOption(optionName.c_str());
 139         splitAndAddValues(&assigner, optionValues, type);
 140
 141         assigner.finishOption();
 142         assigner.finish();
 143     }
 144
 145     //! Storage of requirments.
 146     OutputRequirementOptionDirector requirementsBuilder_;
 147     //! Options storage
 148     Options options_;
 149 };
 150
 151 } // namespace test
 152
 153 } // namespace gmx
 154
 155 #endif