src/testutils/integrationtests.h

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