src/testutils/testfilemanager.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,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 /*! \internal \file
  36  * \brief
  37  * Implements gmx::test::TestFileManager.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "testfilemanager.h"
  43
  44 #include <cstdio>
  45
  46 #include <algorithm>
  47 #include <set>
  48 #include <string>
  49
  50 #include <gtest/gtest.h>
  51
  52 #include "gromacs/fileio/path.h"
  53 #include "gromacs/options/options.h"
  54 #include "gromacs/options/basicoptions.h"
  55 #include "gromacs/utility/gmxassert.h"
  56
  57 #include "testutils/testoptions.h"
  58
  59 namespace gmx
  60 {
  61 namespace test
  62 {
  63
  64 /********************************************************************
  65  * TestFileManager::Impl
  66  */
  67
  68 /*! \internal \brief
  69  * Private implementation class for TestFileManager.
  70  *
  71  * \ingroup module_testutils
  72  */
  73 class TestFileManager::Impl
  74 {
  75     public:
  76         //! Global test input data path set with setDataInputDirectory().
  77         static const char *s_inputDirectory;
  78
  79         //! Global temporary output directory for tests, set with setGlobalOutputTempDirectory().
  80         static const char *s_globalOutputTempDirectory;
  81
  82         //! Container type for names of temporary files.
  83         typedef std::set<std::string> FileNameList;
  84
  85         /*! \brief Constructor
  86          *
  87          * \param path Value for the outputTempDirectory, typically
  88          * set by default from s_globalOutputTempDirectory */
  89         explicit Impl(const char *path)
  90             : outputTempDirectory_(path)
  91         {
  92             GMX_RELEASE_ASSERT(Directory::exists(outputTempDirectory_),
  93                                "Directory for tests' temporary files does not exist");
  94         }
  95
  96         /*! \brief
  97          * Try to remove all temporary files.
  98          *
  99          * Does not throw; errors (e.g., missing files) are silently ignored.
 100          */
 101         void removeFiles();
 102
 103         //! List of unique paths returned by getTemporaryFilePath().
 104         FileNameList            files_;
 105
 106         /*! \brief Temporary output directory local to the current
 107          * test, set by a test with setOutputTempDirectory() if the
 108          * global default is inappropriate. */
 109         std::string outputTempDirectory_;
 110 };
 111
 112 const char *TestFileManager::Impl::s_inputDirectory            = NULL;
 113 const char *TestFileManager::Impl::s_globalOutputTempDirectory = NULL;
 114 /** Controls whether TestFileManager should delete temporary files
 115     after the test finishes. */
 116 static bool g_bDeleteFilesAfterTest = true;
 117
 118 //! \cond
 119 GMX_TEST_OPTIONS(TestFileManagerOptions, options)
 120 {
 121     options->addOption(BooleanOption("delete-temporary-files")
 122                            .store(&g_bDeleteFilesAfterTest)
 123                            .description("At the end of each test case, delete temporary and output files"));
 124 }
 125 //! \endcond
 126
 127 void TestFileManager::Impl::removeFiles()
 128 {
 129     FileNameList::const_iterator i;
 130     for (i = files_.begin(); i != files_.end(); ++i)
 131     {
 132         std::remove(i->c_str());
 133     }
 134     files_.clear();
 135 }
 136
 137 /********************************************************************
 138  * TestFileManager
 139  */
 140
 141 TestFileManager::TestFileManager()
 142     : impl_(new Impl(Impl::s_globalOutputTempDirectory))
 143 {
 144 }
 145
 146 TestFileManager::~TestFileManager()
 147 {
 148     if (g_bDeleteFilesAfterTest)
 149     {
 150         impl_->removeFiles();
 151     }
 152 }
 153
 154 std::string TestFileManager::getTemporaryFilePath(const char *suffix)
 155 {
 156     /* Configure a temporary directory from CMake, so that temporary
 157      * output from a test goes to a location relevant to that
 158      * test. Currently, files whose names are returned by this method
 159      * get cleaned up (by default) at the end of all tests.
 160      */
 161     std::string filename =
 162         Path::join(getOutputTempDirectory(),
 163                    getTestSpecificFileName(suffix));
 164     impl_->files_.insert(filename);
 165     return filename;
 166 }
 167
 168 std::string TestFileManager::getTemporaryFilePath(const std::string &suffix)
 169 {
 170     return getTemporaryFilePath(suffix.c_str());
 171 }
 172
 173 std::string TestFileManager::getTestSpecificFileNameRoot()
 174 {
 175     const ::testing::TestInfo *test_info =
 176             ::testing::UnitTest::GetInstance()->current_test_info();
 177     std::string                filenameRoot = std::string(test_info->test_case_name())
 178         + "_" + test_info->name();
 179     std::replace(filenameRoot.begin(), filenameRoot.end(), '/', '_');
 180     return filenameRoot;
 181 }
 182
 183 std::string TestFileManager::getTestSpecificFileName(const char *suffix)
 184 {
 185     std::string filename = getTestSpecificFileNameRoot();
 186     if (suffix[0] != '.')
 187     {
 188         filename.append("_");
 189     }
 190     filename.append(suffix);
 191     return filename;
 192 }
 193
 194 std::string TestFileManager::getInputFilePath(const char *filename)
 195 {
 196     return Path::join(getInputDataDirectory(), filename);
 197 }
 198
 199 const char *TestFileManager::getInputDataDirectory()
 200 {
 201     GMX_RELEASE_ASSERT(Impl::s_inputDirectory != NULL, "Path for test input files is not set");
 202     return Impl::s_inputDirectory;
 203 }
 204
 205 const char *TestFileManager::getGlobalOutputTempDirectory()
 206 {
 207     GMX_RELEASE_ASSERT(Impl::s_globalOutputTempDirectory != NULL, "Global path for temporary output files from tests is not set");
 208     return Impl::s_globalOutputTempDirectory;
 209 }
 210
 211 const char *TestFileManager::getOutputTempDirectory() const
 212 {
 213     return impl_->outputTempDirectory_.c_str();
 214 }
 215
 216 void TestFileManager::setInputDataDirectory(const char *path)
 217 {
 218     // There is no need to protect this by a mutex, as this is called in early
 219     // initialization of the tests.
 220     GMX_RELEASE_ASSERT(Directory::exists(path),
 221                        "Test data directory does not exist");
 222     Impl::s_inputDirectory = path;
 223 }
 224
 225 void TestFileManager::setGlobalOutputTempDirectory(const char *path)
 226 {
 227     // There is no need to protect this by a mutex, as this is called in early
 228     // initialization of the tests.
 229     GMX_RELEASE_ASSERT(Directory::exists(path),
 230                        "Directory for tests' temporary files does not exist");
 231     Impl::s_globalOutputTempDirectory = path;
 232 }
 233
 234 void TestFileManager::setOutputTempDirectory(const std::string &path)
 235 {
 236     // There could be a need to protect this with a mutex, since it is
 237     // intended to be used in test fixtures, not just during setup.
 238     GMX_RELEASE_ASSERT(Directory::exists(path),
 239                        "Directory for tests' temporary files does not exist");
 240     impl_->outputTempDirectory_ = path;
 241 }
 242
 243 } // namespace test
 244 } // namespace gmx