0a7027ec5f1427dc61152080c24586779ce1d407
[alexxy/gromacs.git] / 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 setOutputTempDirectory().
79         static const char *s_outputTempDirectory;
80
81         //! Container type for names of temporary files.
82         typedef std::set<std::string> FileNameList;
83
84         /*! \brief
85          * Try to remove all temporary files.
86          *
87          * Does not throw; errors (e.g., missing files) are silently ignored.
88          */
89         void removeFiles();
90
91         //! List of unique paths returned by getTemporaryFilePath().
92         FileNameList            files_;
93 };
94
95 const char *TestFileManager::Impl::s_inputDirectory      = NULL;
96 const char *TestFileManager::Impl::s_outputTempDirectory = NULL;
97 /** Controls whether TestFileManager should delete temporary files
98     after the test finishes. */
99 static bool g_bDeleteFilesAfterTest = true;
100
101 //! \cond
102 GMX_TEST_OPTIONS(TestFileManagerOptions, options)
103 {
104     options->addOption(BooleanOption("delete-temporary-files")
105                            .store(&g_bDeleteFilesAfterTest)
106                            .description("At the end of each test case, delete temporary and output files"));
107 }
108 //! \endcond
109
110 void TestFileManager::Impl::removeFiles()
111 {
112     FileNameList::const_iterator i;
113     for (i = files_.begin(); i != files_.end(); ++i)
114     {
115         std::remove(i->c_str());
116     }
117     files_.clear();
118 }
119
120 /********************************************************************
121  * TestFileManager
122  */
123
124 TestFileManager::TestFileManager()
125     : impl_(new Impl())
126 {
127 }
128
129 TestFileManager::~TestFileManager()
130 {
131     if (g_bDeleteFilesAfterTest)
132     {
133         impl_->removeFiles();
134     }
135 }
136
137 std::string TestFileManager::getTemporaryFilePath(const char *suffix)
138 {
139     /* Configure a temporary directory from CMake, so that temporary
140      * output from a test goes to a location relevant to that
141      * test. Currently, files whose names are returned by this method
142      * get cleaned up (by default) at the end of all tests.
143      */
144     std::string filename =
145         Path::join(getOutputTempDirectory(),
146                    getTestSpecificFileName(suffix));
147     impl_->files_.insert(filename);
148     return filename;
149 }
150
151 std::string TestFileManager::getTestSpecificFileName(const char *suffix)
152 {
153     const ::testing::TestInfo *test_info =
154             ::testing::UnitTest::GetInstance()->current_test_info();
155     std::string                filename = std::string(test_info->test_case_name())
156         + "_" + test_info->name();
157     if (suffix[0] != '.')
158     {
159         filename.append("_");
160     }
161     filename.append(suffix);
162     std::replace(filename.begin(), filename.end(), '/', '_');
163     return filename;
164 }
165
166 std::string TestFileManager::getInputFilePath(const char *filename)
167 {
168     return Path::join(getInputDataDirectory(), filename);
169 }
170
171 const char *TestFileManager::getInputDataDirectory()
172 {
173     GMX_RELEASE_ASSERT(Impl::s_inputDirectory != NULL, "Path for test input files is not set");
174     return Impl::s_inputDirectory;
175 }
176
177 const char *TestFileManager::getOutputTempDirectory()
178 {
179     GMX_RELEASE_ASSERT(Impl::s_outputTempDirectory != NULL, "Path for temporary output files from tests is not set");
180     return Impl::s_outputTempDirectory;
181 }
182
183 void TestFileManager::setInputDataDirectory(const char *path)
184 {
185     // There is no need to protect this by a mutex, as this is called in early
186     // initialization of the tests.
187     GMX_RELEASE_ASSERT(Directory::exists(path),
188                        "Test data directory does not exist");
189     Impl::s_inputDirectory = path;
190 }
191
192 void TestFileManager::setOutputTempDirectory(const char *path)
193 {
194     // There is no need to protect this by a mutex, as this is called in early
195     // initialization of the tests.
196     GMX_RELEASE_ASSERT(Directory::exists(path),
197                        "Directory for tests' temporary files does not exist");
198     Impl::s_outputTempDirectory = path;
199 }
200
201 } // namespace test
202 } // namespace gmx