src/testutils/xvgtest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,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 xvg files.
  38  *
  39  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_testutils
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "testutils/xvgtest.h"
  46
  47 #include <cerrno>
  48 #include <cstdlib>
  49
  50 #include <vector>
  51
  52 #include "gromacs/utility/gmxassert.h"
  53 #include "gromacs/utility/stringutil.h"
  54 #include "gromacs/utility/textstream.h"
  55
  56 #include "testutils/refdata.h"
  57 #include "testutils/testasserts.h"
  58 #include "testutils/textblockmatchers.h"
  59
  60 namespace gmx
  61 {
  62 namespace test
  63 {
  64
  65 namespace
  66 {
  67
  68 class XvgMatcher : public ITextBlockMatcher
  69 {
  70 public:
  71     explicit XvgMatcher(const XvgMatchSettings& settings) : settings_(settings) {}
  72
  73     void checkStream(TextInputStream* stream, TestReferenceChecker* checker) override
  74     {
  75         checkXvgFile(stream, checker, settings_);
  76     }
  77
  78 private:
  79     XvgMatchSettings settings_;
  80 };
  81
  82 //! Helper function to identify which @ lines in xvg files should be tested.
  83 bool isRelevantXvgCommand(const std::string& line)
  84 {
  85     return contains(line, " title ") || contains(line, " subtitle ") || contains(line, " label ")
  86            || contains(line, "@TYPE ") || contains(line, " legend \"");
  87 }
  88
  89 //! Helper function to check a single xvg value in a sequence.
  90 void checkXvgDataPoint(TestReferenceChecker* checker, const std::string& value)
  91 {
  92     checker->checkRealFromString(value, nullptr);
  93 }
  94
  95 } // namespace
  96
  97 void checkXvgFile(TextInputStream* input, TestReferenceChecker* checker, const XvgMatchSettings& settings)
  98 {
  99     TestReferenceChecker legendChecker(checker->checkCompound("XvgLegend", "Legend"));
 100     TestReferenceChecker dataChecker(checker->checkCompound("XvgData", "Data"));
 101     dataChecker.setDefaultTolerance(settings.tolerance);
 102
 103     std::string legendText;
 104     int         dataRowCount = 0;
 105     std::string line;
 106     while (input->readLine(&line))
 107     {
 108         // Ignore comments, as they contain dynamic content, and very little of
 109         // that would be useful to test (and in particular, not with every
 110         // output file).
 111         if (startsWith(line, "#"))
 112         {
 113             continue;
 114         }
 115         // Ignore ampersand dataset separators (for now)
 116         // Later, when we need to test code that writes multiple
 117         // datasets, we might want to introduce that new concept
 118         // to this testing code.
 119         if (startsWith(line, "&"))
 120         {
 121             continue;
 122         }
 123         if (startsWith(line, "@"))
 124         {
 125             if (isRelevantXvgCommand(line))
 126             {
 127                 legendText.append(stripString(line.substr(1)));
 128                 legendText.append("\n");
 129             }
 130             continue;
 131         }
 132         if (!settings.testData)
 133         {
 134             break;
 135         }
 136         const std::vector<std::string> columns = splitString(line);
 137         const std::string              id      = formatString("Row%d", dataRowCount);
 138         dataChecker.checkSequence(columns.begin(), columns.end(), id.c_str(), &checkXvgDataPoint);
 139         ++dataRowCount;
 140     }
 141     dataChecker.checkUnusedEntries();
 142     legendChecker.checkTextBlock(legendText, "XvgLegend");
 143 }
 144
 145 TextBlockMatcherPointer XvgMatch::createMatcher() const
 146 {
 147     return TextBlockMatcherPointer(new XvgMatcher(settings_));
 148 }
 149
 150 } // namespace test
 151 } // namespace gmx