src/testutils/include/testutils/conftest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019,2020,2021, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares function to add the content of a conf file to a checker.
  38  *
  39  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS_CONFTEST_H
  44 #define GMX_TESTUTILS_CONFTEST_H
  45
  46 #include <string>
  47
  48 #include "testutils/testasserts.h"
  49 #include "testutils/textblockmatchers.h"
  50
  51 namespace gmx
  52 {
  53
  54 class TextInputStream;
  55
  56 namespace test
  57 {
  58
  59 class TestReferenceChecker;
  60
  61 struct ConfMatchSettings
  62 {
  63     FloatingPointTolerance tolerance              = defaultRealTolerance();
  64     bool                   matchFullConfiguration = false;
  65 };
  66
  67 /*! \brief
  68  * Adds content of a gro file to TestReferenceChecker object.
  69  *
  70  * \param[in] input       Stream that provides the gro content.
  71  * \param[in,out] checker Checker to use.
  72  * \param[in] settings    Settings to use for matching.
  73  *
  74  * Parses a gro file from the input stream, and checks the contents against
  75  * reference data (only first two lines for now).
  76  *
  77  * \see ConfMatch
  78  */
  79 void checkConfFile(TextInputStream* input, TestReferenceChecker* checker, const ConfMatchSettings& settings);
  80
  81 /*! \libinternal \brief
  82  * Match the contents as an gro file.
  83  *
  84  * \see checkGroFile()
  85  *
  86  * \inlibraryapi
  87  * \ingroup module_testutils
  88  */
  89 class ConfMatch : public ITextBlockMatcherSettings
  90 {
  91 public:
  92     //! Sets the tolerance for matching floating point values.
  93     ConfMatch& tolerance(const FloatingPointTolerance& tolerance)
  94     {
  95         settings_.tolerance = tolerance;
  96         return *this;
  97     }
  98     //! Sets whether the full file contents should be matched
  99     ConfMatch& matchFullConfiguration(const bool flag)
 100     {
 101         settings_.matchFullConfiguration = flag;
 102         return *this;
 103     }
 104
 105     TextBlockMatcherPointer createMatcher() const override;
 106
 107 private:
 108     ConfMatchSettings settings_;
 109 };
 110
 111 } // namespace test
 112
 113 } // namespace gmx
 114
 115 #endif