src/testutils/textblockmatchers.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2018, 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 "gromacs/compat/make_unique.h"
  47 #include "gromacs/utility/gmxregex.h"
  48 #include "gromacs/utility/stringstream.h"
  49 #include "gromacs/utility/textreader.h"
  50 #include "gromacs/utility/textwriter.h"
  51
  52 #include "testutils/refdata.h"
  53
  54 namespace gmx
  55 {
  56 namespace test
  57 {
  58
  59 namespace
  60 {
  61
  62 class ExactTextMatcher : public ITextBlockMatcher
  63 {
  64     public:
  65         void checkStream(TextInputStream      *stream,
  66                          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*/,
  77                          TestReferenceChecker * /*checker*/) override
  78         {
  79         }
  80 };
  81
  82 class FilteringExactTextMatcher : public ITextBlockMatcher
  83 {
  84     public:
  85         FilteringExactTextMatcher(const std::vector<std::string> &linesToSkip)
  86             : linesToSkip_(linesToSkip) {}
  87         void checkStream(TextInputStream      *stream,
  88                          TestReferenceChecker *checker) override
  89         {
  90             StringOutputStream filteredStream;
  91             {
  92                 TextReader  reader(stream);
  93                 TextWriter  writer(&filteredStream);
  94                 // Filter the stream
  95                 std::string line;
  96                 while (reader.readLine(&line))
  97                 {
  98                     bool shouldSkip = false;
  99                     for (const auto &lineToSkip : linesToSkip_)
 100                     {
 101                         // TODO this is inefficient but we have no way
 102                         // to store pre-compiled Regex in a container
 103                         // right now.
 104                         Regex regexOfLineToSkip(lineToSkip);
 105                         if (regexMatch(line.c_str(), regexOfLineToSkip))
 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::string> linesToSkip_;
 123 };
 124
 125 }       // namespace
 126
 127 ITextBlockMatcher::~ITextBlockMatcher()
 128 {
 129 }
 130
 131 ITextBlockMatcherSettings::~ITextBlockMatcherSettings()
 132 {
 133 }
 134
 135 TextBlockMatcherPointer ExactTextMatch::createMatcher() const
 136 {
 137     return TextBlockMatcherPointer(compat::make_unique<ExactTextMatcher>());
 138 }
 139
 140 TextBlockMatcherPointer NoTextMatch::createMatcher() const
 141 {
 142     return TextBlockMatcherPointer(compat::make_unique<NoTextMatcher>());
 143 }
 144
 145 void FilteringExactTextMatch::addRegexToSkip(const std::string &lineToSkip)
 146 {
 147     linesToSkip_.push_back(lineToSkip);
 148 }
 149
 150 TextBlockMatcherPointer FilteringExactTextMatch::createMatcher() const
 151 {
 152     return TextBlockMatcherPointer(compat::make_unique<FilteringExactTextMatcher>(linesToSkip_));
 153 }
 154
 155 } // namespace test
 156 } // namespace gmx