src/testutils/include/testutils/testfileredirector.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,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 /*! \libinternal \file
  36  * \brief
  37  * Declares generic mock implementations for interfaces in fileredirector.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS_TESTFILEREDIRECTOR_H
  44 #define GMX_TESTUTILS_TESTFILEREDIRECTOR_H
  45
  46 #include <memory>
  47 #include <set>
  48 #include <string>
  49
  50 #include "gromacs/utility/classhelpers.h"
  51 #include "gromacs/utility/fileredirector.h"
  52
  53 namespace gmx
  54 {
  55 namespace test
  56 {
  57
  58 class TestReferenceChecker;
  59
  60 /*! \libinternal \brief
  61  * In-memory implementation for IFileInputRedirector for tests.
  62  *
  63  * By default, this implementation will return `false` for all file existence
  64  * checks.  To return `true` for a specific path, use addExistingFile().
  65  *
  66  * \inlibraryapi
  67  * \ingroup module_testutils
  68  */
  69 class TestFileInputRedirector : public IFileInputRedirector
  70 {
  71 public:
  72     TestFileInputRedirector();
  73     ~TestFileInputRedirector() override;
  74
  75     /*! \brief
  76      * Marks the provided path as an existing file.
  77      *
  78      * \throws std::bad_alloc if out of memory.
  79      *
  80      * Further checks for existence of the given path will return `true`.
  81      */
  82     void addExistingFile(const char* filename);
  83
  84     // From IFileInputRedirector
  85     bool fileExists(const char* filename, File::NotFoundHandler onNotFound) const override;
  86
  87 private:
  88     std::set<std::string> existingFiles_;
  89
  90     GMX_DISALLOW_COPY_AND_ASSIGN(TestFileInputRedirector);
  91 };
  92
  93 /*! \libinternal \brief
  94  * In-memory implementation of IFileOutputRedirector for tests.
  95  *
  96  * This class redirects all output files to in-memory buffers, and supports
  97  * checking the contents of these files using the reference data framework.
  98  *
  99  * \ingroup module_testutils
 100  */
 101 class TestFileOutputRedirector : public IFileOutputRedirector
 102 {
 103 public:
 104     TestFileOutputRedirector();
 105     ~TestFileOutputRedirector() override;
 106
 107     /*! \brief
 108      * Checks contents of all redirected files (including stdout).
 109      *
 110      * This method should not be called if the redirector will still be
 111      * used for further output in the test.  Behavior is not designed for
 112      * checking in the middle of the test, although that could potentially
 113      * be changed if necessary.
 114      */
 115     void checkRedirectedFiles(TestReferenceChecker* checker);
 116
 117     // From IFileOutputRedirector
 118     TextOutputStream&       standardOutput() override;
 119     TextOutputStreamPointer openTextOutputFile(const char* filename) override;
 120
 121 private:
 122     class Impl;
 123
 124     std::unique_ptr<Impl> impl_;
 125 };
 126
 127 } // namespace test
 128 } // namespace gmx
 129
 130 #endif