src/testutils/include/testutils/stringtest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2017 by the GROMACS development team.
   5  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \libinternal \file
  37  * \brief
  38  * Declares gmx::test::StringTestBase.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \inlibraryapi
  42  * \ingroup module_testutils
  43  */
  44 #ifndef GMX_TESTUTILS_STRINGTEST_H
  45 #define GMX_TESTUTILS_STRINGTEST_H
  46
  47 #include <memory>
  48 #include <string>
  49
  50 #include <gtest/gtest.h>
  51
  52 namespace gmx
  53 {
  54
  55 namespace test
  56 {
  57
  58 class TestReferenceChecker;
  59
  60 /*! \libinternal \brief
  61  * Test fixture for tests that check string formatting.
  62  *
  63  * For development, tests that use this fixture as their base can be run with a
  64  * '-stdout' command-line option to print out the tested strings to stdout.
  65  * If this flag is not given, they check the strings using the XML reference
  66  * framework (see TestReferenceData).
  67  *
  68  * Tests that need simple checking of a string, or container of
  69  * strings, should consider the normal implementation in
  70  * TestReferenceChecker.
  71  *
  72  * \inlibraryapi
  73  * \ingroup module_testutils
  74  */
  75 class StringTestBase : public ::testing::Test
  76 {
  77 public:
  78     /*! \brief
  79      * Checks a block of text.
  80      *
  81      * This static method is provided for code that does not derive from
  82      * StringTestBase to use the same functionality, e.g., implementing the
  83      * `-stdout` option.
  84      */
  85     static void checkText(TestReferenceChecker* checker, const std::string& text, const char* id);
  86
  87     StringTestBase();
  88     ~StringTestBase() override;
  89
  90     /*! \brief
  91      * Returns the root checker for this test's reference data.
  92      *
  93      * Can be used to perform custom checks against reference data (e.g.,
  94      * if the test needs to check some other values than plain strings.
  95      */
  96     TestReferenceChecker& checker();
  97
  98     /*! \brief
  99      * Checks a string.
 100      *
 101      * \param[in] text  String to check.
 102      * \param[in] id    Unique (within a single test) id for the string.
 103      */
 104     void checkText(const std::string& text, const char* id);
 105     /*! \brief
 106      * Checks contents of a file as a single string.
 107      *
 108      * \param[in] filename  Name of the file to check.
 109      * \param[in] id        Unique (within a single test) id for the string.
 110      *
 111      * Provided for convenience.  Reads the contents of \p filename into a
 112      * single string and calls checkText().
 113      */
 114     void checkFileContents(const std::string& filename, const char* id);
 115
 116     /*! \brief
 117      * Tests that contents of two files are equal.
 118      *
 119      * \param[in] refFilename   File with the expected contents.
 120      * \param[in] testFilename  File with the contents to be tested.
 121      */
 122     static void testFilesEqual(const std::string& refFilename, const std::string& testFilename);
 123
 124 private:
 125     class Impl;
 126
 127     std::unique_ptr<Impl> impl_;
 128 };
 129
 130 } // namespace test
 131 } // namespace gmx
 132
 133 #endif