src/testutils/stringtest.cpp

   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 /*! \internal \file
  36  * \brief
  37  * Implements gmx::test::StringTestBase.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "stringtest.h"
  45
  46 #include <string>
  47
  48 #include <boost/scoped_ptr.hpp>
  49
  50 #include "gromacs/options/basicoptions.h"
  51 #include "gromacs/options/options.h"
  52 #include "gromacs/utility/file.h"
  53
  54 #include "testutils/refdata.h"
  55 #include "testutils/testoptions.h"
  56
  57 namespace gmx
  58 {
  59 namespace test
  60 {
  61
  62 namespace
  63 {
  64 //! Stores the -stdout flag value to print out values instead of checking them.
  65 bool g_bWriteToStdOut = false;
  66 }
  67
  68 // TODO: Only add this option to those test binaries that actually need it
  69 // (depending on the linker, it may or may not appear right now),
  70 // or replace by a generic mechanism in TestReferenceData.
  71 //! \cond
  72 GMX_TEST_OPTIONS(StringTestOptions, options)
  73 {
  74     options->addOption(
  75             BooleanOption("stdout")
  76                 .store(&g_bWriteToStdOut)
  77                 .description("Print the test string to stdout instead of checking against reference data"));
  78 }
  79 //! \endcond
  80
  81 /********************************************************************
  82  * StringTestBase::Impl
  83  */
  84
  85 class StringTestBase::Impl
  86 {
  87     public:
  88         TestReferenceData                           data_;
  89         boost::scoped_ptr<TestReferenceChecker>     checker_;
  90 };
  91
  92 /********************************************************************
  93  * StringTestBase
  94  */
  95
  96 // static
  97 void StringTestBase::checkText(TestReferenceChecker *checker,
  98                                const std::string &text, const char *id)
  99 {
 100     if (g_bWriteToStdOut)
 101     {
 102         printf("%s:\n", id);
 103         printf("%s[END]\n", text.c_str());
 104     }
 105     else
 106     {
 107         checker->checkStringBlock(text, id);
 108     }
 109 }
 110
 111 StringTestBase::StringTestBase()
 112     : impl_(new Impl)
 113 {
 114 }
 115
 116 StringTestBase::~StringTestBase()
 117 {
 118 }
 119
 120 TestReferenceChecker &
 121 StringTestBase::checker()
 122 {
 123     if (!impl_->checker_)
 124     {
 125         impl_->checker_.reset(new TestReferenceChecker(impl_->data_.rootChecker()));
 126     }
 127     return *impl_->checker_;
 128 }
 129
 130 void
 131 StringTestBase::checkText(const std::string &text, const char *id)
 132 {
 133     checkText(&checker(), text, id);
 134 }
 135
 136 void
 137 StringTestBase::checkFileContents(const std::string &filename, const char *id)
 138 {
 139     const std::string text = File::readToString(filename);
 140     checkText(text, id);
 141 }
 142
 143 } // namespace test
 144 } // namespace gmx