src/testutils/testfilemanager.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::test::TestFileManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 /*! \libinternal \defgroup module_testutils Unit Testing Utilities (testutils)
  44  * \brief
  45  * Common helper classes and functions for writing unit tests.
  46  *
  47  * To build unit tests using these utilities, libxml2 is required.
  48  *
  49  * \ingroup group_utilitymodules
  50  */
  51 #ifndef GMX_TESTUTILS_TESTFILEMANAGER_H
  52 #define GMX_TESTUTILS_TESTFILEMANAGER_H
  53
  54 #include <string>
  55
  56 #include "gromacs/utility/common.h"
  57
  58 namespace gmx
  59 {
  60 /*! \libinternal \brief
  61  * Testing utilities namespace.
  62  *
  63  * This namespace contains utilities for writing unit tests, mostly from the
  64  * \ref module_testutils module.
  65  */
  66 namespace test
  67 {
  68
  69 /*! \libinternal \brief
  70  * Helper for tests that need output files.
  71  *
  72  * To be used as a member in a test fixture class, this class provides
  73  * getTemporaryFilePath() method that returns a path for creating file names
  74  * for temporary files.  The returned path contains the name of the running
  75  * test, making it unique across tests.  Additionally, this class takes care of
  76  * removing any temporary files (i.e., all paths returned by
  77  * getTemporaryFilePath()) at test teardown (i.e., when the
  78  * TestFileManager is destructed).
  79  *
  80  * Functions getInputFilePath() and getInputDataDirectory() provide means to
  81  * access data files that are located in the test source directory.
  82  * This is used to provide input files for the tests, and also to store test
  83  * reference data persistently (see TestReferenceData).
  84  *
  85  * \inlibraryapi
  86  * \ingroup module_testutils
  87  */
  88 class TestFileManager
  89 {
  90     public:
  91         /*! \brief Constructor */
  92         TestFileManager();
  93         /*! \brief Frees internal storage and deletes any accessed
  94          * file paths
  95          *
  96          * Any errors (e.g., missing files) encountered while deleting the
  97          * files are ignored.
  98          */
  99         ~TestFileManager();
 100
 101         /*! \brief
 102          * Creates a name for a temporary file within a single unit test.
 103          *
 104          * \param[in] suffix  Suffix to add to the file name (should contain an
 105          *      extension if one is desired).
 106          * \returns   Temporary file name that includes the test name and
 107          *      \p suffix.
 108          *
 109          * This method should only be called from within a Google Test test.
 110          * Two calls with the same \p suffix return the same string within the
 111          * same test.
 112          */
 113         std::string getTemporaryFilePath(const char *suffix);
 114
 115         /*! \brief
 116          * Creates a file name for use within a single unit test.
 117          *
 118          * \param[in] suffix  Suffix to add to the file name (should contain an
 119          *      extension if one is desired).
 120          * \returns   File name that includes the test name and
 121          *      \p suffix.
 122          *
 123          * This method should only be called from within a Google Test test.
 124          * Two calls with the same \p suffix return the same string within the
 125          * same test.
 126          * Intended to produce distinct names for files that may be stored in
 127          * the same directory for multiple tests.
 128          */
 129         static std::string getTestSpecificFileName(const char *suffix);
 130
 131         /*! \brief
 132          * Returns the path to a test input file.
 133          *
 134          * \param[in] filename  Relative path/filename to a test input file.
 135          * \returns Path to \p filename under the test input data directory.
 136          */
 137         static std::string getInputFilePath(const char *filename);
 138
 139         /*! \brief
 140          * Returns the path to the test input directory.
 141          *
 142          * \returns Path to input data directory for the test executable.
 143          */
 144         static const char *getInputDataDirectory();
 145
 146         /*! \brief
 147          * Returns the path to the test output temporary directory.
 148          *
 149          * \returns Path to output temporary directory for the test executable.
 150          */
 151         static const char *getOutputTempDirectory();
 152
 153         /*! \brief
 154          * Sets the test input directory.
 155          *
 156          * \param[in] path  Path from which test input data is looked up from.
 157          *
 158          * \p path must name an existing directory.
 159          *
 160          * This function is automatically called by unittest_main.cpp through
 161          * initTestUtils().
 162          */
 163         static void setInputDataDirectory(const char *path);
 164
 165         /*! \brief
 166          * Sets the test output temporary directory.
 167          *
 168          * \param[in] path  Path at which test should write temporary files
 169          *
 170          * \p path must name an existing directory.
 171          *
 172          * This function is automatically called by unittest_main.cpp through
 173          * initTestUtils().
 174          */
 175         static void setOutputTempDirectory(const char *path);
 176
 177     private:
 178         class Impl;
 179
 180         PrivateImplPointer<Impl> impl_;
 181 };
 182
 183 } // namespace test
 184 } // namespace gmx
 185
 186 #endif