src/testutils/testfileredirector.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2017,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 testfileredirector.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "testutils/testfileredirector.h"
  45
  46 #include <memory>
  47 #include <set>
  48 #include <string>
  49 #include <utility>
  50 #include <vector>
  51
  52 #include "gromacs/utility/stringstream.h"
  53
  54 #include "testutils/stringtest.h"
  55
  56 namespace gmx
  57 {
  58 namespace test
  59 {
  60
  61 /********************************************************************
  62  * TestFileInputRedirector
  63  */
  64
  65 TestFileInputRedirector::TestFileInputRedirector() {}
  66
  67 TestFileInputRedirector::~TestFileInputRedirector() {}
  68
  69 void TestFileInputRedirector::addExistingFile(const char* filename)
  70 {
  71     existingFiles_.insert(filename);
  72 }
  73
  74 bool TestFileInputRedirector::fileExists(const char* filename, File::NotFoundHandler onNotFound) const
  75 {
  76     if (existingFiles_.count(filename) == 0)
  77     {
  78         File::NotFoundInfo info(filename, "File not present in test", nullptr, false, 0);
  79         onNotFound(info);
  80         return false;
  81     }
  82     return true;
  83 }
  84
  85 /********************************************************************
  86  * TestFileOutputRedirector::Impl
  87  */
  88
  89 class TestFileOutputRedirector::Impl
  90 {
  91 public:
  92     typedef std::shared_ptr<StringOutputStream>         StringStreamPointer;
  93     typedef std::pair<std::string, StringStreamPointer> FileListEntry;
  94
  95     StringStreamPointer        stdoutStream_;
  96     std::vector<FileListEntry> fileList_;
  97 };
  98
  99 /********************************************************************
 100  * TestFileOutputRedirector
 101  */
 102
 103 TestFileOutputRedirector::TestFileOutputRedirector() : impl_(new Impl) {}
 104
 105 TestFileOutputRedirector::~TestFileOutputRedirector() {}
 106
 107 TextOutputStream& TestFileOutputRedirector::standardOutput()
 108 {
 109     if (!impl_->stdoutStream_)
 110     {
 111         impl_->stdoutStream_.reset(new StringOutputStream);
 112         impl_->fileList_.emplace_back("<stdout>", impl_->stdoutStream_);
 113     }
 114     return *impl_->stdoutStream_;
 115 }
 116
 117 TextOutputStreamPointer TestFileOutputRedirector::openTextOutputFile(const char* filename)
 118 {
 119     Impl::StringStreamPointer stream(new StringOutputStream);
 120     impl_->fileList_.emplace_back(filename, stream);
 121     return stream;
 122 }
 123
 124 void TestFileOutputRedirector::checkRedirectedFiles(TestReferenceChecker* checker)
 125 {
 126     std::vector<Impl::FileListEntry>::const_iterator i;
 127     for (i = impl_->fileList_.begin(); i != impl_->fileList_.end(); ++i)
 128     {
 129         StringTestBase::checkText(checker, i->second->toString(), i->first.c_str());
 130     }
 131 }
 132
 133 } // namespace test
 134 } // namespace gmx