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 class FileOutputRedirectorInterface;
  56
  57 namespace test
  58 {
  59
  60 class TestFileManager;
  61 class TestReferenceChecker;
  62
  63 /*! \libinternal \brief
  64  * Test fixture for tests that check string formatting.
  65  *
  66  * For development, tests that use this fixture as their base can be run with a
  67  * '-stdout' command-line option to print out the tested strings to stdout.
  68  * If this flag is not given, they check the strings using the XML reference
  69  * framework (see TestReferenceData).
  70  *
  71  * \inlibraryapi
  72  * \ingroup module_testutils
  73  */
  74 class StringTestBase : public ::testing::Test
  75 {
  76     public:
  77         StringTestBase();
  78         ~StringTestBase();
  79
  80         /*! \brief
  81          * Creates a redirector that directs all output to temporary files.
  82          *
  83          * \param[in] fileManager  File manager to use for temporary files.
  84          *
  85          * Can only be called once in a test.
  86          *
  87          * \see checkRedirectedOutputFiles()
  88          */
  89         FileOutputRedirectorInterface &
  90         initOutputRedirector(TestFileManager *fileManager);
  91
  92         /*! \brief
  93          * Returns the root checker for this test's reference data.
  94          *
  95          * Can be used to perform custom checks against reference data (e.g.,
  96          * if the test needs to check some other values than plain strings.
  97          */
  98         TestReferenceChecker &checker();
  99
 100         /*! \brief
 101          * Checks a string.
 102          *
 103          * \param[in] text  String to check.
 104          * \param[in] id    Unique (within a single test) id for the string.
 105          */
 106         void checkText(const std::string &text, const char *id);
 107         /*! \brief
 108          * Checks contents of a file as a single string.
 109          *
 110          * \param[in] filename  Name of the file to check.
 111          * \param[in] id        Unique (within a single test) id for the string.
 112          *
 113          * Provided for convenience.  Reads the contents of \p filename into a
 114          * single string and calls checkText().
 115          */
 116         void checkFileContents(const std::string &filename, const char *id);
 117         /*! \brief
 118          * Checks contents of all files redirected with initOutputRedirector().
 119          *
 120          * Uses the same logic as checkFileContents() to check each file
 121          * (including `stdout`) that has been created using the redirector
 122          * returned by initOutputRedirector().
 123          *
 124          * initOutputRedirector() must have been called.
 125          * This method should not be called if the redirector will still be
 126          * used for further output in the test.  Behavior is not designed for
 127          * checking in the middle of the test, although that could potentially
 128          * be changed if necessary.
 129          */
 130         void checkRedirectedOutputFiles();
 131
 132     private:
 133         class Impl;
 134
 135         PrivateImplPointer<Impl> impl_;
 136 };
 137
 138 } // namespace test
 139 } // namespace gmx
 140
 141 #endif