2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
37 * Declares generic mock implementations for interfaces in fileredirector.h.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_testutils
43 #ifndef GMX_TESTUTILS_TESTFILEREDIRECTOR_H
44 #define GMX_TESTUTILS_TESTFILEREDIRECTOR_H
49 #include "gromacs/utility/classhelpers.h"
50 #include "gromacs/utility/fileredirector.h"
57 class TestReferenceChecker
;
59 /*! \libinternal \brief
60 * In-memory implementation for IFileInputRedirector for tests.
62 * By default, this implementation will return `false` for all file existence
63 * checks. To return `true` for a specific path, use addExistingFile().
66 * \ingroup module_testutils
68 class TestFileInputRedirector
: public IFileInputRedirector
71 TestFileInputRedirector();
72 ~TestFileInputRedirector() override
;
75 * Marks the provided path as an existing file.
77 * \throws std::bad_alloc if out of memory.
79 * Further checks for existence of the given path will return `true`.
81 void addExistingFile(const char* filename
);
83 // From IFileInputRedirector
84 bool fileExists(const char* filename
, File::NotFoundHandler onNotFound
) const override
;
87 std::set
<std::string
> existingFiles_
;
89 GMX_DISALLOW_COPY_AND_ASSIGN(TestFileInputRedirector
);
92 /*! \libinternal \brief
93 * In-memory implementation of IFileOutputRedirector for tests.
95 * This class redirects all output files to in-memory buffers, and supports
96 * checking the contents of these files using the reference data framework.
98 * \ingroup module_testutils
100 class TestFileOutputRedirector
: public IFileOutputRedirector
103 TestFileOutputRedirector();
104 ~TestFileOutputRedirector() override
;
107 * Checks contents of all redirected files (including stdout).
109 * This method should not be called if the redirector will still be
110 * used for further output in the test. Behavior is not designed for
111 * checking in the middle of the test, although that could potentially
112 * be changed if necessary.
114 void checkRedirectedFiles(TestReferenceChecker
* checker
);
116 // From IFileOutputRedirector
117 TextOutputStream
& standardOutput() override
;
118 TextOutputStreamPointer
openTextOutputFile(const char* filename
) override
;
123 PrivateImplPointer
<Impl
> impl_
;