2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2017,2018, 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.
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.
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.
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.
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.
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.
37 * Implements gmx::test::TestFileManager.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_testutils
44 #include "testfilemanager.h"
52 #include <gtest/gtest.h>
54 #include "gromacs/options/basicoptions.h"
55 #include "gromacs/options/ioptionscontainer.h"
56 #include "gromacs/utility/gmxassert.h"
57 #include "gromacs/utility/path.h"
59 #include "testutils/testoptions.h"
66 /********************************************************************
67 * TestFileManager::Impl
71 * Private implementation class for TestFileManager.
73 * \ingroup module_testutils
75 class TestFileManager::Impl
78 //! Global test input data path set with setDataInputDirectory().
79 static std::string s_inputDirectory
;
81 //! Global path to simulation input database set with setTestSimulationDataBaseDirectory().
82 static std::string s_simulationDatabaseDirectory
;
84 //! Global temporary output directory for tests, set with setGlobalOutputTempDirectory().
85 static const char *s_globalOutputTempDirectory
;
87 //! Container type for names of temporary files.
88 typedef std::set
<std::string
> FileNameList
;
90 /*! \brief Constructor
92 * \param path Value for the outputTempDirectory, typically
93 * set by default from s_globalOutputTempDirectory */
94 explicit Impl(const char *path
)
95 : outputTempDirectory_(path
)
97 GMX_RELEASE_ASSERT(Directory::exists(outputTempDirectory_
),
98 "Directory for tests' temporary files does not exist");
102 * Try to remove all temporary files.
104 * Does not throw; errors (e.g., missing files) are silently ignored.
108 //! List of unique paths returned by getTemporaryFilePath().
111 /*! \brief Temporary output directory local to the current
112 * test, set by a test with setOutputTempDirectory() if the
113 * global default is inappropriate. */
114 std::string outputTempDirectory_
;
117 std::string
TestFileManager::Impl::s_inputDirectory
;
118 std::string
TestFileManager::Impl::s_simulationDatabaseDirectory
;
119 const char *TestFileManager::Impl::s_globalOutputTempDirectory
= nullptr;
120 /** Controls whether TestFileManager should delete temporary files
121 after the test finishes. */
122 static bool g_bDeleteFilesAfterTest
= true;
125 GMX_TEST_OPTIONS(TestFileManagerOptions
, options
)
127 options
->addOption(BooleanOption("delete-temporary-files")
128 .store(&g_bDeleteFilesAfterTest
)
129 .description("At the end of each test case, delete temporary and output files"));
133 void TestFileManager::Impl::removeFiles()
135 FileNameList::const_iterator i
;
136 for (i
= files_
.begin(); i
!= files_
.end(); ++i
)
138 std::remove(i
->c_str());
143 /********************************************************************
147 TestFileManager::TestFileManager()
148 : impl_(new Impl(Impl::s_globalOutputTempDirectory
))
152 TestFileManager::~TestFileManager()
154 if (g_bDeleteFilesAfterTest
)
156 impl_
->removeFiles();
160 std::string
TestFileManager::getTemporaryFilePath(const char *suffix
)
162 /* Configure a temporary directory from CMake, so that temporary
163 * output from a test goes to a location relevant to that
164 * test. Currently, files whose names are returned by this method
165 * get cleaned up (by default) at the end of all tests.
167 std::string filename
=
168 Path::join(getOutputTempDirectory(),
169 getTestSpecificFileName(suffix
));
170 impl_
->files_
.insert(filename
);
174 std::string
TestFileManager::getTemporaryFilePath(const std::string
&suffix
)
176 return getTemporaryFilePath(suffix
.c_str());
179 std::string
TestFileManager::getTestSpecificFileNameRoot()
181 const ::testing::TestInfo
*test_info
=
182 ::testing::UnitTest::GetInstance()->current_test_info();
183 std::string filenameRoot
= std::string(test_info
->test_case_name())
184 + "_" + test_info
->name();
185 std::replace(filenameRoot
.begin(), filenameRoot
.end(), '/', '_');
189 std::string
TestFileManager::getTestSpecificFileName(const char *suffix
)
191 std::string filename
= getTestSpecificFileNameRoot();
192 if (suffix
[0] != '.')
194 filename
.append("_");
196 filename
.append(suffix
);
200 std::string
TestFileManager::getInputFilePath(const char *filename
)
202 // Check if file is present in local directory.
203 if (File::exists(Path::join(getInputDataDirectory(), filename
), File::returnFalseOnError
))
205 return Path::join(getInputDataDirectory(), filename
);
207 else if (File::exists(Path::join(getTestSimulationDatabaseDirectory(), filename
), File::returnFalseOnError
))
209 // Assume file is in global directory for simulation input files.
210 return Path::join(getTestSimulationDatabaseDirectory(), filename
);
214 // Assume file is present locally without full name (e.g. extension).
215 return Path::join(getInputDataDirectory(), filename
);
219 std::string
TestFileManager::getInputFilePath(const std::string
&filename
)
221 return getInputFilePath(filename
.c_str());
224 const char *TestFileManager::getInputDataDirectory()
226 GMX_RELEASE_ASSERT(!Impl::s_inputDirectory
.empty(), "Path for test input files is not set");
227 return Impl::s_inputDirectory
.c_str();
230 const char *TestFileManager::getGlobalOutputTempDirectory()
232 GMX_RELEASE_ASSERT(Impl::s_globalOutputTempDirectory
!= nullptr, "Global path for temporary output files from tests is not set");
233 return Impl::s_globalOutputTempDirectory
;
236 const char *TestFileManager::getOutputTempDirectory() const
238 return impl_
->outputTempDirectory_
.c_str();
241 const char *TestFileManager::getTestSimulationDatabaseDirectory()
243 GMX_RELEASE_ASSERT(!Impl::s_simulationDatabaseDirectory
.empty(), "Path for simulation input database directory is not set");
244 return Impl::s_simulationDatabaseDirectory
.c_str();
247 void TestFileManager::setInputDataDirectory(const std::string
&path
)
249 // There is no need to protect this by a mutex, as this is called in early
250 // initialization of the tests.
251 GMX_RELEASE_ASSERT(Directory::exists(path
),
252 "Test data directory does not exist");
253 Impl::s_inputDirectory
= path
;
256 void TestFileManager::setTestSimulationDatabaseDirectory(const std::string
&path
)
258 // There is no need to protect this by a mutex, as this is called in early
259 // initialization of the tests.
260 GMX_RELEASE_ASSERT(Directory::exists(path
),
261 "Simulation database directory does not exist");
262 Impl::s_simulationDatabaseDirectory
= path
;
265 void TestFileManager::setGlobalOutputTempDirectory(const char *path
)
267 // There is no need to protect this by a mutex, as this is called in early
268 // initialization of the tests.
269 GMX_RELEASE_ASSERT(Directory::exists(path
),
270 "Directory for tests' temporary files does not exist");
271 Impl::s_globalOutputTempDirectory
= path
;
274 void TestFileManager::setOutputTempDirectory(const std::string
&path
)
276 // There could be a need to protect this with a mutex, since it is
277 // intended to be used in test fixtures, not just during setup.
278 GMX_RELEASE_ASSERT(Directory::exists(path
),
279 "Directory for tests' temporary files does not exist");
280 impl_
->outputTempDirectory_
= path
;