4 # Copyright (C) 2006, 2007, 2008 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 """Utilities for unit testing"""
29 from ganeti import utils
33 return os.environ.get("TOP_SRCDIR", ".")
36 class GanetiTestCase(unittest.TestCase):
37 """Helper class for unittesting.
39 This class defines a few utility functions that help in building
40 unittests. Child classes must call the parent setup and cleanup.
47 while self._temp_files:
49 utils.RemoveFile(self._temp_files.pop())
50 except EnvironmentError, err:
53 def assertFileContent(self, file_name, expected_content):
54 """Checks that the content of a file is what we expect.
57 @param file_name: the file whose contents we should check
58 @type expected_content: str
59 @param expected_content: the content we expect
62 actual_content = utils.ReadFile(file_name)
63 self.assertEqual(actual_content, expected_content)
65 def assertFileMode(self, file_name, expected_mode):
66 """Checks that the mode of a file is what we expect.
69 @param file_name: the file whose contents we should check
70 @type expected_mode: int
71 @param expected_mode: the mode we expect
74 st = os.stat(file_name)
75 actual_mode = stat.S_IMODE(st.st_mode)
76 self.assertEqual(actual_mode, expected_mode)
79 def _TestDataFilename(name):
80 """Returns the filename of a given test data file.
83 @param name: the 'base' of the file name, as present in
84 the test/data directory
86 @return: the full path to the filename, such that it can
87 be used in 'make distcheck' rules
90 return "%s/test/data/%s" % (GetSourceDir(), name)
93 def _ReadTestData(cls, name):
94 """Returns the contents of a test data file.
96 This is just a very simple wrapper over utils.ReadFile with the
97 proper test file name.
101 return utils.ReadFile(cls._TestDataFilename(name))
103 def _CreateTempFile(self):
104 """Creates a temporary file and adds it to the internal cleanup list.
106 This method simplifies the creation and cleanup of temporary files
110 fh, fname = tempfile.mkstemp(prefix="ganeti-test", suffix=".tmp")
112 self._temp_files.append(fname)