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