manually merge PR114 to refactor unit test support helpers into a sub-package

git-svn-id: svn+ssh://svn.code.sf.net/p/migrid/code/trunk@6131 b75ad72c-e7d7-11dd-a971-7dbc132099af

Author: jonasbardino

tests/support.py renamed to tests/support/__init__.py

@@ -3,7 +3,7 @@
 #
 # --- BEGIN_HEADER ---
 #
-# support - helper functions for unit testing
+# __init__ - package marker
 # Copyright (C) 2003-2024  The MiG Project by the Science HPC Center at UCPH
 #
 # This file is part of MiG.
@@ -27,32 +27,29 @@
 
 """Supporting functions for the unit test framework"""
 
-from collections import defaultdict
 import difflib
 import errno
 import io
 import logging
 import os
-import re
 import shutil
 import stat
 import sys
 from unittest import TestCase, main as testmain
 
-TEST_BASE = os.path.dirname(__file__)
-TEST_FIXTURE_DIR = os.path.join(TEST_BASE, "fixture")
-TEST_OUTPUT_DIR = os.path.join(TEST_BASE, "output")
-MIG_BASE = os.path.realpath(os.path.join(TEST_BASE, ".."))
-PY2 = sys.version_info[0] == 2
+from tests.support.suppconst import MIG_BASE, TEST_BASE, TEST_FIXTURE_DIR, \
+    TEST_OUTPUT_DIR
+
+PY2 = (sys.version_info[0] == 2)
 
 # force defaults to a local environment
 os.environ['MIG_ENV'] = 'local'
 
-# All MiG related code will at some point include bits
-# from the mig module namespace. Rather than have this
-# knowledge spread through every test file, make the
-# sole responsbility of test files to find the support
-# file and configure the rest here.
+# All MiG related code will at some point include bits from the mig module
+# namespace. Rather than have this knowledge spread through every test file,
+# make the sole responsbility of test files to find the support file and
+# configure the rest here.
+
 sys.path.append(MIG_BASE)
 
 # provision an output directory up-front
@@ -63,13 +60,20 @@
         shutil.rmtree(TEST_OUTPUT_DIR)
         os.mkdir(TEST_OUTPUT_DIR)
 
+# Exports to expose at the top level from the support library.
+
+from tests.support.configsupp import FakeConfiguration
+from tests.support.loggersupp import FakeLogger
+
+
 # Basic global logging configuration for testing
 
 
 class BlackHole:
     """Arrange a stream that ignores all logging messages"""
 
     def write(self, message):
+        """NoOp to fake write"""
         pass
 
 
@@ -80,111 +84,6 @@ def write(self, message):
 logging.captureWarnings(True)
 
 
-class FakeLogger:
-    """An output capturing logger suitable for being passed to the
-    majority of MiG code by presenting an API compatible interface
-    with the common logger module.
-
-    An instance of this class is made available to test cases which
-    can pass it down into function calls and subsequenently make
-    assertions against any output strings hat were recorded during
-    execution while also avoiding noise hitting the console.
-    """
-
-    RE_UNCLOSEDFILE = re.compile(
-        'unclosed file <.*? name=\'(?P<location>.*?)\'( .*?)?>')
-
-    def __init__(self):
-        self.channels_dict = defaultdict(list)
-        self.forgive_by_channel = defaultdict(lambda: False)
-        self.unclosed_by_file = defaultdict(list)
-
-    def _append_as(self, channel, line):
-        self.channels_dict[channel].append(line)
-
-    def check_empty_and_reset(self):
-        channels_dict = self.channels_dict
-        forgive_by_channel = self.forgive_by_channel
-        unclosed_by_file = self.unclosed_by_file
-
-        # reset the record of any logged messages
-        self.channels_dict = defaultdict(list)
-        self.forgive_by_channel = defaultdict(lambda: False)
-        self.unclosed_by_file = defaultdict(list)
-
-        # complain loudly (and in detail) in the case of unclosed files
-        if len(unclosed_by_file) > 0:
-            messages = '\n'.join({' --> %s: line=%s, file=%s' % (fname, lineno, outname)
-                                  for fname, (lineno, outname) in unclosed_by_file.items()})
-            raise RuntimeError('unclosed files encountered:\n%s' % (messages,))
-
-        if channels_dict['error'] and not forgive_by_channel['error']:
-            raise RuntimeError('errors reported to logger:\n%s' % '\n'.join(channels_dict['error']))
-
-
-    def forgive_errors(self):
-        self.forgive_by_channel['error'] = True
-
-    # logger interface
-
-    def debug(self, line):
-        self._append_as('debug', line)
-
-    def error(self, line):
-        self._append_as('error', line)
-
-    def info(self, line):
-        self._append_as('info', line)
-
-    def warning(self, line):
-        self._append_as('warning', line)
-
-    def write(self, message):
-        channel, namespace, specifics = message.split(':', 2)
-
-        # ignore everything except warnings sent by the python runtime
-        if not (channel == 'WARNING' and namespace == 'py.warnings'):
-            return
-
-        filename_and_datatuple = FakeLogger.identify_unclosed_file(specifics)
-        if filename_and_datatuple is not None:
-            self.unclosed_by_file.update((filename_and_datatuple,))
-
-    @staticmethod
-    def identify_unclosed_file(specifics):
-        filename, lineno, exc_name, message = specifics.split(':', 3)
-
-        exc_name = exc_name.lstrip()
-        if exc_name != 'ResourceWarning':
-            return
-
-        matched = FakeLogger.RE_UNCLOSEDFILE.match(message.lstrip())
-        if matched is None:
-            return
-
-        relative_testfile = os.path.relpath(filename, start=MIG_BASE)
-        relative_outputfile = os.path.relpath(
-            matched.groups('location')[0], start=TEST_BASE)
-        return (relative_testfile, (lineno, relative_outputfile))
-
-
-class FakeConfiguration:
-    """A simple helper to pretend we have a real Configuration object with any
-    required attributes explicitly passed.
-    Automatically attaches a FakeLogger instance if no logger is provided in
-    kwargs.
-    """
-
-    def __init__(self, **kwargs):
-        """Initialise instance attributes to be any named args provided and a
-        FakeLogger instance attached if not provided.
-        """
-        self.__dict__.update(kwargs)
-        if not 'logger' in self.__dict__:
-            dummy_logger = FakeLogger()
-            self.__dict__.update({'logger': dummy_logger})
-
-
 class MigTestCase(TestCase):
     """Embellished base class for MiG test cases. Provides additional commonly
     used assertions as well as some basics for the standardised and idiomatic
@@ -202,11 +101,13 @@ def __init__(self, *args):
         self._skip_logging = False
 
     def setUp(self):
+        """Init before tests"""
         if not self._skip_logging:
             self._reset_logging(stream=self.logger)
         self.before_each()
 
     def tearDown(self):
+        """Clean up after tests"""
         self.after_each()
 
         if not self._skip_logging:
@@ -226,9 +127,11 @@ def tearDown(self):
 
     # hooks
     def after_each(self):
+        """After each test action hook"""
         pass
 
     def before_each(self):
+        """Before each test action hook"""
         pass
 
     def _reset_logging(self, stream):
@@ -238,13 +141,15 @@ def _reset_logging(self, stream):
 
     @property
     def logger(self):
+        """Init a fake logger if not already done"""
         if self._logger is None:
             self._logger = FakeLogger()
         return self._logger
 
     # custom assertions available for common use
 
     def assertFileContentIdentical(self, file_actual, file_expected):
+        """Make sure file_actual and file_expected are identical"""
         with io.open(file_actual) as f_actual, io.open(file_expected) as f_expected:
             lhs = f_actual.readlines()
             rhs = f_expected.readlines()
@@ -263,6 +168,7 @@ def assertFileContentIdentical(self, file_actual, file_expected):
                     ''.join(different_lines)))
 
     def assertPathExists(self, relative_path):
+        """Make sure file in relative_path exists"""
         assert not os.path.isabs(
             relative_path), "expected relative path within output folder"
         absolute_path = os.path.join(TEST_OUTPUT_DIR, relative_path)
@@ -275,6 +181,7 @@ def assertPathExists(self, relative_path):
             return "file"
 
     def assertPathWithin(self, path, start=None):
+        """Make sure path is within start directory"""
         if not is_path_within(path, start=start):
             raise AssertionError(
                 "path %s is not within directory %s" % (path, start))
@@ -288,6 +195,7 @@ def pretty_display_path(absolute_path):
 
 
 def is_path_within(path, start=None, _msg=None):
+    """Check if path is within start directory"""
     try:
         assert os.path.isabs(path), _msg
         relative = os.path.relpath(path, start=start)
@@ -297,29 +205,34 @@ def is_path_within(path, start=None, _msg=None):
 
 
 def cleanpath(relative_path, test_case, ensure_dir=False):
+    """Register post-test clean up of file in relative_path"""
     assert isinstance(test_case, MigTestCase)
     tmp_path = os.path.join(TEST_OUTPUT_DIR, relative_path)
     if ensure_dir:
         try:
             os.mkdir(tmp_path)
         except FileExistsError:
-            raise AssertionError("ABORT: use of unclean output path: %s" % relative_path)
+            raise AssertionError(
+                "ABORT: use of unclean output path: %s" % relative_path)
     test_case._cleanup_paths.add(tmp_path)
     return tmp_path
 
 
 def fixturepath(relative_path):
+    """Get absolute fixture path for relative_path"""
     tmp_path = os.path.join(TEST_FIXTURE_DIR, relative_path)
     return tmp_path
 
 
 def outputpath(relative_path):
+    """Get absolute output path for relative_path"""
     assert not os.path.isabs(relative_path)
     tmp_path = os.path.join(TEST_OUTPUT_DIR, relative_path)
     return tmp_path
 
 
 def temppath(relative_path, test_case, skip_clean=False):
+    """Get absolute temp path for relative_path"""
     assert isinstance(test_case, MigTestCase)
     tmp_path = os.path.join(TEST_OUTPUT_DIR, relative_path)
     if not skip_clean:

tests/support/configsupp.py

@@ -0,0 +1,47 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# --- BEGIN_HEADER ---
+#
+# configsupp - configuration helpers for unit tests
+# Copyright (C) 2003-2024  The MiG Project by the Science HPC Center at UCPH
+#
+# This file is part of MiG.
+#
+# MiG is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# MiG is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# -- END_HEADER ---
+#
+
+"""Configuration related details within the test support library."""
+
+from tests.support.loggersupp import FakeLogger
+
+
+class FakeConfiguration:
+    """A simple helper to pretend we have a real Configuration object with any
+    required attributes explicitly passed.
+    Automatically attaches a FakeLogger instance if no logger is provided in
+    kwargs.
+    """
+
+    def __init__(self, **kwargs):
+        """Initialise instance attributes to be any named args provided and a
+        FakeLogger instance attached if not provided.
+        """
+        self.__dict__.update(kwargs)
+        if not 'logger' in self.__dict__:
+            dummy_logger = FakeLogger()
+            self.__dict__.update({'logger': dummy_logger})