Watcher: fix some doc typos

[ganeti-local] / test / testutils.py

diff --git a/test/testutils.py b/test/testutils.py
index 737962e..fd95c76 100644 (file)
--- a/test/testutils.py
+++ b/test/testutils.py
@@ -22,14 +22,51 @@
 """Utilities for unit testing"""
 
 import os
+import sys
+import stat
+import tempfile
 import unittest
+import logging
 
 from ganeti import utils
 
 
+def GetSourceDir():
+  return os.environ.get("TOP_SRCDIR", ".")
+
+
+class GanetiTestProgram(unittest.TestProgram):
+  def runTests(self):
+    """
+
+    """
+    logging.basicConfig(filename=os.devnull)
+
+    sys.stderr.write("Running %s\n" % self.progName)
+    sys.stderr.flush()
+
+    return unittest.TestProgram.runTests(self)
+
+
 class GanetiTestCase(unittest.TestCase):
+  """Helper class for unittesting.
+
+  This class defines a few utility functions that help in building
+  unittests. Child classes must call the parent setup and cleanup.
+
+  """
+  def setUp(self):
+    self._temp_files = []
+
+  def tearDown(self):
+    while self._temp_files:
+      try:
+        utils.RemoveFile(self._temp_files.pop())
+      except EnvironmentError, err:
+        pass
+
   def assertFileContent(self, file_name, expected_content):
-    """Checks the content of a file is what we expect.
+    """Checks that the content of a file is what we expect.
 
     @type file_name: str
     @param file_name: the file whose contents we should check
@@ -40,6 +77,29 @@ class GanetiTestCase(unittest.TestCase):
     actual_content = utils.ReadFile(file_name)
     self.assertEqual(actual_content, expected_content)
 
+  def assertFileMode(self, file_name, expected_mode):
+    """Checks that the mode of a file is what we expect.
+
+    @type file_name: str
+    @param file_name: the file whose contents we should check
+    @type expected_mode: int
+    @param expected_mode: the mode we expect
+
+    """
+    st = os.stat(file_name)
+    actual_mode = stat.S_IMODE(st.st_mode)
+    self.assertEqual(actual_mode, expected_mode)
+
+  def assertEqualValues(self, first, second, msg=None):
+    """Compares two values whether they're equal.
+
+    Tuples are automatically converted to lists before comparing.
+
+    """
+    return self.assertEqual(UnifyValueType(first),
+                            UnifyValueType(second),
+                            msg=msg)
+
   @staticmethod
   def _TestDataFilename(name):
     """Returns the filename of a given test data file.
@@ -52,10 +112,7 @@ class GanetiTestCase(unittest.TestCase):
         be used in 'make distcheck' rules
 
     """
-    prefix = os.environ.get("srcdir", "")
-    if prefix:
-      prefix = prefix + "/test/"
-    return "%sdata/%s" % (prefix, name)
+    return "%s/test/data/%s" % (GetSourceDir(), name)
 
   @classmethod
   def _ReadTestData(cls, name):
@@ -65,5 +122,32 @@ class GanetiTestCase(unittest.TestCase):
     proper test file name.
 
     """
-
     return utils.ReadFile(cls._TestDataFilename(name))
+
+  def _CreateTempFile(self):
+    """Creates a temporary file and adds it to the internal cleanup list.
+
+    This method simplifies the creation and cleanup of temporary files
+    during tests.
+
+    """
+    fh, fname = tempfile.mkstemp(prefix="ganeti-test", suffix=".tmp")
+    os.close(fh)
+    self._temp_files.append(fname)
+    return fname
+
+
+def UnifyValueType(data):
+  """Converts all tuples into lists.
+
+  This is useful for unittests where an external library doesn't keep types.
+
+  """
+  if isinstance(data, (tuple, list)):
+    return [UnifyValueType(i) for i in data]
+
+  elif isinstance(data, dict):
+    return dict([(UnifyValueType(key), UnifyValueType(value))
+                 for (key, value) in data.iteritems()])
+
+  return data