src/testutils/include/testutils/interactivetest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2017,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  * Provides helper classes for testing interactive prompts.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS_INTERACTIVETEST_H
  44 #define GMX_TESTUTILS_INTERACTIVETEST_H
  45
  46 #include <memory>
  47
  48 #include "gromacs/utility/arrayref.h"
  49
  50 namespace gmx
  51 {
  52
  53 class TextInputStream;
  54 class TextOutputStream;
  55
  56 namespace test
  57 {
  58
  59 class TestReferenceChecker;
  60
  61 /*! \libinternal \brief
  62  * Helper class for testing interactive sessions.
  63  *
  64  * The calling test can set the user input using setInputLines() (and possibly
  65  * setLastNewline()), pass the streams from inputStream() and outputStream() to
  66  * the code that executes the interactive session, and then call checkSession()
  67  * after the session is finished.
  68  * The input is provided from the array set with setInputLines(), and all
  69  * output is checked using the reference data framework.
  70  * The reference XML data can be viewed with the XSLT stylesheet to show
  71  * exactly how the session went.
  72  *
  73  * \inlibraryapi
  74  * \ingroup module_testutils
  75  */
  76 class InteractiveTestHelper
  77 {
  78 public:
  79     /*! \brief
  80      * Initializes the helper.
  81      *
  82      * \param[in] checker  Parent reference checker to use.
  83      *
  84      * The helper creates a compound item under \p checker for the
  85      * interactive session it tests.
  86      */
  87     explicit InteractiveTestHelper(gmx::test::TestReferenceChecker checker);
  88     ~InteractiveTestHelper();
  89
  90     //! Sets whether the last input line contains a newline (by default, it does).
  91     void setLastNewline(bool bInclude);
  92     /*! \brief
  93      * Sets the input lines for the interactive session.
  94      *
  95      * Calls to TextInputStream::readLine() will return strings from this
  96      * array in sequence.
  97      * Newlines are added at the end automatically (except for the last
  98      * line if `setLastNewLine(false)` has been called).
  99      * If there are more `readLine()` calls than there are input lines,
 100      * the remaining calls return end-of-input.
 101      */
 102     void setInputLines(const ArrayRef<const char* const>& inputLines);
 103
 104     //! Returns the input stream for the session.
 105     TextInputStream& inputStream();
 106     //! Returns the output stream for the session.
 107     TextOutputStream& outputStream();
 108
 109     /*! \brief
 110      * Finalizes the checking for the session.
 111      *
 112      * This must be called after all input and output from a session has
 113      * occurred, as the helper will not otherwise know when output after
 114      * the last input has finished.  This method also checks that the
 115      * required number of input lines were read in the session.
 116      */
 117     void checkSession();
 118
 119 private:
 120     class Impl;
 121
 122     std::unique_ptr<Impl> impl_;
 123 };
 124 } // namespace test
 125 } // namespace gmx
 126
 127 #endif