src/testutils/conftest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019,2020,2021, 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 routine to check the content of conf files.
  38  *
  39  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  40  * \ingroup module_testutils
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "testutils/conftest.h"
  45
  46 #include <cstdio>
  47 #include <cstdlib>
  48
  49 #include "gromacs/utility/gmxassert.h"
  50 #include "gromacs/utility/stringutil.h"
  51 #include "gromacs/utility/textreader.h"
  52 #include "gromacs/utility/textstream.h"
  53
  54 #include "testutils/refdata.h"
  55 #include "testutils/testasserts.h"
  56 #include "testutils/textblockmatchers.h"
  57
  58 namespace gmx
  59 {
  60
  61 namespace test
  62 {
  63
  64 namespace
  65 {
  66
  67 class ConfMatcher : public ITextBlockMatcher
  68 {
  69 public:
  70     explicit ConfMatcher(const ConfMatchSettings& settings) : settings_(settings) {}
  71
  72     void checkStream(TextInputStream* stream, TestReferenceChecker* checker) override
  73     {
  74         checkConfFile(stream, checker, settings_);
  75     }
  76
  77 private:
  78     ConfMatchSettings settings_;
  79 };
  80
  81 } // namespace
  82
  83 void checkConfFile(TextInputStream* input, TestReferenceChecker* checker, const ConfMatchSettings& settings)
  84 {
  85
  86     TestReferenceChecker groChecker(checker->checkCompound("GroFile", "Header"));
  87     // Check the first two lines of the output file
  88     std::string line;
  89     EXPECT_TRUE(input->readLine(&line));
  90     line = stripSuffixIfPresent(line, "\n");
  91     groChecker.checkString(line, "Title");
  92     EXPECT_TRUE(input->readLine(&line));
  93     line = stripSuffixIfPresent(line, "\n");
  94     groChecker.checkInteger(std::atoi(line.c_str()), "Number of atoms");
  95     // Check the full configuration only if required
  96     if (settings.matchFullConfiguration)
  97     {
  98         TextReader reader(input);
  99         checker->checkTextBlock(reader.readAll(), "Configuration");
 100     }
 101 }
 102
 103 TextBlockMatcherPointer ConfMatch::createMatcher() const
 104 {
 105     return TextBlockMatcherPointer(new ConfMatcher(settings_));
 106 }
 107
 108 } // namespace test
 109 } // namespace gmx