src/testutils/textblockmatchers.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2018,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 classes from textblockmatchers.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "testutils/textblockmatchers.h"
  45
  46 #include <memory>
  47 #include <regex>
  48
  49 #include "gromacs/utility/stringstream.h"
  50 #include "gromacs/utility/textreader.h"
  51 #include "gromacs/utility/textwriter.h"
  52
  53 #include "testutils/refdata.h"
  54
  55 namespace gmx
  56 {
  57 namespace test
  58 {
  59
  60 namespace
  61 {
  62
  63 class ExactTextMatcher : public ITextBlockMatcher
  64 {
  65 public:
  66     void checkStream(TextInputStream* stream, TestReferenceChecker* checker) override
  67     {
  68         TextReader reader(stream);
  69         checker->checkTextBlock(reader.readAll(), "Contents");
  70     }
  71 };
  72
  73 class NoTextMatcher : public ITextBlockMatcher
  74 {
  75 public:
  76     void checkStream(TextInputStream* /*stream*/, TestReferenceChecker* /*checker*/) override {}
  77 };
  78
  79 class FilteringExactTextMatcher : public ITextBlockMatcher
  80 {
  81 public:
  82     FilteringExactTextMatcher(const std::vector<std::string>& linesToSkip)
  83     {
  84         // Prepare the regular expressions to filter out of the stream.
  85         for (const auto& lineToSkip : linesToSkip)
  86         {
  87             regexesToSkip_.emplace_back(lineToSkip, std::regex::nosubs | std::regex::extended);
  88         }
  89     }
  90
  91     void checkStream(TextInputStream* stream, TestReferenceChecker* checker) override
  92     {
  93         StringOutputStream filteredStream;
  94         {
  95             TextReader reader(stream);
  96             TextWriter writer(&filteredStream);
  97
  98             // Filter the stream
  99             std::string line;
 100             while (reader.readLine(&line))
 101             {
 102                 bool shouldSkip = false;
 103                 for (const auto& regexToSkip : regexesToSkip_)
 104                 {
 105                     if (std::regex_match(line.c_str(), regexToSkip))
 106                     {
 107                         shouldSkip = true;
 108                         break;
 109                     }
 110                 }
 111                 if (!shouldSkip)
 112                 {
 113                     writer.writeLine(line);
 114                 }
 115             }
 116         }
 117         StringInputStream filteredStreamToCheck(filteredStream.toString());
 118         TextReader        reader(&filteredStreamToCheck);
 119         checker->checkTextBlock(reader.readAll(), "Contents");
 120     }
 121
 122     std::vector<std::regex> regexesToSkip_;
 123 };
 124
 125 } // namespace
 126
 127 ITextBlockMatcher::~ITextBlockMatcher() {}
 128
 129 ITextBlockMatcherSettings::~ITextBlockMatcherSettings() {}
 130
 131 TextBlockMatcherPointer ExactTextMatch::createMatcher() const
 132 {
 133     return TextBlockMatcherPointer(std::make_unique<ExactTextMatcher>());
 134 }
 135
 136 TextBlockMatcherPointer NoTextMatch::createMatcher() const
 137 {
 138     return TextBlockMatcherPointer(std::make_unique<NoTextMatcher>());
 139 }
 140
 141 FilteringExactTextMatch::FilteringExactTextMatch(std::vector<std::string> linesToSkip) :
 142     linesToSkip_(std::move(linesToSkip))
 143 {
 144 }
 145
 146 void FilteringExactTextMatch::addRegexToSkip(const std::string& lineToSkip)
 147 {
 148     linesToSkip_.push_back(lineToSkip);
 149 }
 150
 151 TextBlockMatcherPointer FilteringExactTextMatch::createMatcher() const
 152 {
 153     return TextBlockMatcherPointer(std::make_unique<FilteringExactTextMatcher>(linesToSkip_));
 154 }
 155
 156 } // namespace test
 157 } // namespace gmx