src/testutils/integrationtests.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, 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 test fixture for integration tests
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_INTEGRATION_TESTS_MODULETEST_H
  44 #define GMX_INTEGRATION_TESTS_MODULETEST_H
  45
  46 #include <gtest/gtest.h>
  47
  48 #include "testutils/testfilemanager.h"
  49
  50 namespace gmx
  51 {
  52
  53 namespace test
  54 {
  55
  56 /*! \libinternal \brief
  57  * Test fixture for integration tests.
  58  *
  59  * Any method in this class may throw std::bad_alloc if out of memory.
  60  *
  61  * \inlibraryapi
  62  * \ingroup module_testutils
  63  */
  64 class IntegrationTestFixture : public ::testing::Test
  65 {
  66     protected:
  67         IntegrationTestFixture();
  68         virtual ~IntegrationTestFixture();
  69
  70         /*! \brief Accepts a string as input, writes it to a temporary
  71          * file and then reopens stdin to read the contents of that
  72          * string.
  73          *
  74          * \throws FileIOError  when the freopen() fails
  75          */
  76         void redirectStringToStdin(const char* theString);
  77
  78         /*! \brief Discards stdout while running a test
  79          *
  80          * \todo Implement this when the output routines are
  81          * sufficiently modular to permit it to work. */
  82         void redirectStdoutToDevNull();
  83         /*! \brief Discards stderr while running a test
  84          *
  85          * \todo Implement this when the output routines are
  86          * sufficiently modular to permit it to work. */
  87         void redirectStderrToDevNull();
  88
  89         /* TEST_F() constructs derived classes, and those classes
  90          * might need to access implementation details, so we
  91          * cannot use the private access specifer here. */
  92     protected:
  93
  94         /*! \brief Object that manages finding input files, writing
  95          * temporary output files and cleaning up files.
  96          */
  97         ::gmx::test::TestFileManager fileManager_;
  98
  99     public:
 100         //! Number of backup files to write
 101         static std::string s_maxBackup;
 102 };
 103
 104 } // namespace test
 105 } // namespace gmx
 106
 107 #endif