src/testutils/stringtest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015, 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 gmx::test::StringTestBase.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS_STRINGTEST_H
  44 #define GMX_TESTUTILS_STRINGTEST_H
  45
  46 #include <string>
  47
  48 #include <gtest/gtest.h>
  49
  50 #include "gromacs/utility/classhelpers.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  * \inlibraryapi
  69  * \ingroup module_testutils
  70  */
  71 class StringTestBase : public ::testing::Test
  72 {
  73     public:
  74         /*! \brief
  75          * Checks a block of text.
  76          *
  77          * This static method is provided for code that does not derive from
  78          * StringTestBase to use the same functionality, e.g., implementing the
  79          * `-stdout` option.
  80          */
  81         static void checkText(TestReferenceChecker *checker,
  82                               const std::string &text, const char *id);
  83
  84         StringTestBase();
  85         ~StringTestBase();
  86
  87         /*! \brief
  88          * Returns the root checker for this test's reference data.
  89          *
  90          * Can be used to perform custom checks against reference data (e.g.,
  91          * if the test needs to check some other values than plain strings.
  92          */
  93         TestReferenceChecker &checker();
  94
  95         /*! \brief
  96          * Checks a string.
  97          *
  98          * \param[in] text  String to check.
  99          * \param[in] id    Unique (within a single test) id for the string.
 100          */
 101         void checkText(const std::string &text, const char *id);
 102         /*! \brief
 103          * Checks contents of a file as a single string.
 104          *
 105          * \param[in] filename  Name of the file to check.
 106          * \param[in] id        Unique (within a single test) id for the string.
 107          *
 108          * Provided for convenience.  Reads the contents of \p filename into a
 109          * single string and calls checkText().
 110          */
 111         void checkFileContents(const std::string &filename, const char *id);
 112
 113         /*! \brief
 114          * Tests that contents of two files are equal.
 115          *
 116          * \param[in] refFilename   File with the expected contents.
 117          * \param[in] testFilename  File with the contents to be tested.
 118          */
 119         void testFilesEqual(const std::string &refFilename,
 120                             const std::string &testFilename);
 121
 122     private:
 123         class Impl;
 124
 125         PrivateImplPointer<Impl> impl_;
 126 };
 127
 128 } // namespace test
 129 } // namespace gmx
 130
 131 #endif