src/testutils/stringtest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2019,2020, 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 "testutils/stringtest.h"
  45
  46 #include <string>
  47
  48 #include "gromacs/options/basicoptions.h"
  49 #include "gromacs/options/ioptionscontainer.h"
  50 #include "gromacs/utility/textreader.h"
  51
  52 #include "testutils/refdata.h"
  53 #include "testutils/testoptions.h"
  54
  55 namespace gmx
  56 {
  57 namespace test
  58 {
  59
  60 namespace
  61 {
  62 //! Stores the -stdout flag value to print out values instead of checking them.
  63 bool g_bWriteToStdOut = false;
  64 } // namespace
  65
  66 // TODO: Only add this option to those test binaries that actually need it
  67 // (depending on the linker, it may or may not appear right now),
  68 // or replace by a generic mechanism in TestReferenceData.
  69 //! \cond
  70 GMX_TEST_OPTIONS(StringTestOptions, options)
  71 {
  72     options->addOption(
  73             BooleanOption("stdout").store(&g_bWriteToStdOut).description("Print the test string to stdout instead of checking against reference data"));
  74 }
  75 //! \endcond
  76
  77 /********************************************************************
  78  * StringTestBase::Impl
  79  */
  80
  81 class StringTestBase::Impl
  82 {
  83 public:
  84     TestReferenceData    data_;
  85     TestReferenceChecker checker_;
  86 };
  87
  88 /********************************************************************
  89  * StringTestBase
  90  */
  91
  92 // static
  93 void StringTestBase::checkText(TestReferenceChecker* checker, const std::string& text, const char* id)
  94 {
  95     if (g_bWriteToStdOut)
  96     {
  97         printf("%s:\n", id);
  98         printf("%s[END]\n", text.c_str());
  99     }
 100     else
 101     {
 102         checker->checkTextBlock(text, id);
 103     }
 104 }
 105
 106 StringTestBase::StringTestBase() : impl_(new Impl) {}
 107
 108 StringTestBase::~StringTestBase() {}
 109
 110 TestReferenceChecker& StringTestBase::checker()
 111 {
 112     if (!impl_->checker_)
 113     {
 114         impl_->checker_ = impl_->data_.rootChecker();
 115     }
 116     return impl_->checker_;
 117 }
 118
 119 void StringTestBase::checkText(const std::string& text, const char* id)
 120 {
 121     checkText(&checker(), text, id);
 122 }
 123
 124 void StringTestBase::checkFileContents(const std::string& filename, const char* id)
 125 {
 126     const std::string text = TextReader::readFileToString(filename);
 127     checkText(text, id);
 128 }
 129
 130 void StringTestBase::testFilesEqual(const std::string& refFilename, const std::string& testFilename)
 131 {
 132     const std::string expectedContents = TextReader::readFileToString(refFilename);
 133     const std::string contents         = TextReader::readFileToString(testFilename);
 134     if (g_bWriteToStdOut)
 135     {
 136         printf("%s[END]\n", contents.c_str());
 137     }
 138     EXPECT_EQ(expectedContents, contents);
 139 }
 140
 141 } // namespace test
 142 } // namespace gmx