src/testutils/stringtest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, 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 "gromacs/options/basicoptions.h"
  47 #include "gromacs/options/options.h"
  48 #include "gromacs/utility/file.h"
  49
  50 #include "testutils/testoptions.h"
  51
  52 namespace gmx
  53 {
  54 namespace test
  55 {
  56
  57 namespace
  58 {
  59 //! Stores the -stdout flag value to print out values instead of checking them.
  60 bool g_bWriteToStdOut = false;
  61 }
  62
  63 // TODO: Only add this option to those test binaries that actually need it
  64 // (depending on the linker, it may or may not appear right now),
  65 // or replace by a generic mechanism in TestReferenceData.
  66 //! \cond
  67 GMX_TEST_OPTIONS(StringTestOptions, options)
  68 {
  69     options->addOption(
  70             BooleanOption("stdout")
  71                 .store(&g_bWriteToStdOut)
  72                 .description("Print the test string to stdout instead of checking against reference data"));
  73 }
  74 //! \endcond
  75
  76 StringTestBase::StringTestBase()
  77 {
  78 }
  79
  80 StringTestBase::~StringTestBase()
  81 {
  82 }
  83
  84 TestReferenceChecker &
  85 StringTestBase::checker()
  86 {
  87     if (checker_.get() == NULL)
  88     {
  89         checker_.reset(new TestReferenceChecker(data_.rootChecker()));
  90     }
  91     return *checker_;
  92 }
  93
  94 void
  95 StringTestBase::checkText(const std::string &text, const char *id)
  96 {
  97     if (g_bWriteToStdOut)
  98     {
  99         printf("%s:\n", id);
 100         printf("%s[END]\n", text.c_str());
 101     }
 102     else
 103     {
 104         checker().checkStringBlock(text, id);
 105     }
 106 }
 107
 108 void
 109 StringTestBase::checkFileContents(const std::string &filename, const char *id)
 110 {
 111     std::string text = File::readToString(filename);
 112     checkText(text, id);
 113 }
 114
 115 } // namespace test
 116 } // namespace gmx