src/testutils/textblockmatchers.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2018,2019, 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 "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,
  67                          TestReferenceChecker *checker) override
  68         {
  69             TextReader reader(stream);
  70             checker->checkTextBlock(reader.readAll(), "Contents");
  71         }
  72 };
  73
  74 class NoTextMatcher : public ITextBlockMatcher
  75 {
  76     public:
  77         void checkStream(TextInputStream      * /*stream*/,
  78                          TestReferenceChecker * /*checker*/) override
  79         {
  80         }
  81 };
  82
  83 class FilteringExactTextMatcher : public ITextBlockMatcher
  84 {
  85     public:
  86         FilteringExactTextMatcher(const std::vector<std::string> &linesToSkip)
  87         {
  88             // Prepare the regular expressions to filter out of the stream.
  89             for (const auto &lineToSkip : linesToSkip)
  90             {
  91                 regexesToSkip_.emplace_back(lineToSkip, std::regex::nosubs | std::regex::extended);
  92             }
  93         }
  94
  95         void checkStream(TextInputStream      *stream,
  96                          TestReferenceChecker *checker) override
  97         {
  98             StringOutputStream filteredStream;
  99             {
 100                 TextReader  reader(stream);
 101                 TextWriter  writer(&filteredStream);
 102
 103                 // Filter the stream
 104                 std::string line;
 105                 while (reader.readLine(&line))
 106                 {
 107                     bool shouldSkip = false;
 108                     for (const auto &regexToSkip : regexesToSkip_)
 109                     {
 110                         if (std::regex_match(line.c_str(), regexToSkip))
 111                         {
 112                             shouldSkip = true;
 113                             break;
 114                         }
 115                     }
 116                     if (!shouldSkip)
 117                     {
 118                         writer.writeLine(line);
 119                     }
 120                 }
 121             }
 122             StringInputStream filteredStreamToCheck(filteredStream.toString());
 123             TextReader        reader(&filteredStreamToCheck);
 124             checker->checkTextBlock(reader.readAll(), "Contents");
 125         }
 126
 127         std::vector<std::regex> regexesToSkip_;
 128 };
 129
 130 }       // namespace
 131
 132 ITextBlockMatcher::~ITextBlockMatcher()
 133 {
 134 }
 135
 136 ITextBlockMatcherSettings::~ITextBlockMatcherSettings()
 137 {
 138 }
 139
 140 TextBlockMatcherPointer ExactTextMatch::createMatcher() const
 141 {
 142     return TextBlockMatcherPointer(std::make_unique<ExactTextMatcher>());
 143 }
 144
 145 TextBlockMatcherPointer NoTextMatch::createMatcher() const
 146 {
 147     return TextBlockMatcherPointer(std::make_unique<NoTextMatcher>());
 148 }
 149
 150 FilteringExactTextMatch::FilteringExactTextMatch(std::vector<std::string> linesToSkip)
 151     : linesToSkip_(std::move(linesToSkip))
 152 {}
 153
 154 void FilteringExactTextMatch::addRegexToSkip(const std::string &lineToSkip)
 155 {
 156     linesToSkip_.push_back(lineToSkip);
 157 }
 158
 159 TextBlockMatcherPointer FilteringExactTextMatch::createMatcher() const
 160 {
 161     return TextBlockMatcherPointer(std::make_unique<FilteringExactTextMatcher>(linesToSkip_));
 162 }
 163
 164 } // namespace test
 165 } // namespace gmx