src/testutils/stringtest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 <boost/scoped_ptr.hpp>
  49 #include <gtest/gtest.h>
  50
  51 #include "refdata.h"
  52
  53 namespace gmx
  54 {
  55 namespace test
  56 {
  57
  58 /*! \libinternal \brief
  59  * Test fixture for tests that check string formatting.
  60  *
  61  * For development, tests that use this fixture as their base can be run with a
  62  * '-stdout' command-line option to print out the tested strings to stdout.
  63  * If this flag is not given, they check the strings using the XML reference
  64  * framework (see TestReferenceData).
  65  *
  66  * \inlibraryapi
  67  * \ingroup module_testutils
  68  */
  69 class StringTestBase : public ::testing::Test
  70 {
  71     public:
  72         //! Static fixture setup to parse command-line options.
  73         static void SetUpTestCase();
  74
  75         StringTestBase();
  76         ~StringTestBase();
  77
  78         /*! \brief
  79          * Returns the root checker for this test's reference data.
  80          *
  81          * Can be used to perform custom checks against reference data (e.g.,
  82          * if the test needs to check some other values than plain strings.
  83          */
  84         TestReferenceChecker &checker();
  85
  86         /*! \brief
  87          * Check a string.
  88          *
  89          * \param[in] text  String to check.
  90          * \param[in] id    Unique (within a single test) id for the string.
  91          */
  92         void checkText(const std::string &text, const char *id);
  93         /*! \brief
  94          * Check contents of a file as a single string.
  95          *
  96          * \param[in] filename  Name of the file to check.
  97          * \param[in] id        Unique (within a single test) id for the string.
  98          *
  99          * Provided for convenience.  Reads the contents of \p filename into a
 100          * single string and calls checkText().
 101          */
 102         void checkFileContents(const std::string &filename, const char *id);
 103
 104     private:
 105         static bool                             s_bWriteToStdOut;
 106
 107         TestReferenceData                       data_;
 108         boost::scoped_ptr<TestReferenceChecker> checker_;
 109 };
 110
 111 } // namespace test
 112 } // namespace gmx
 113
 114 #endif