Support unittesting via 'python setup.py test'

lib/vsc/install/shared_setup.py

@@ -24,19 +24,46 @@
 import shutil
 import sys
 import re
+
+try:
+    from unittest.suite import TestSuite
+except ImportError:
+    from unittest import TestSuite
+
 from distutils import log  # also for setuptools
 from distutils.dir_util import remove_tree
 
+from setuptools.command.test import test as TestCommand
+from setuptools.command.test import ScanningLoader
+
 # 0 : WARN (default), 1 : INFO, 2 : DEBUG
 log.set_verbosity(2)
 
 has_setuptools = None
 
+# available authors
+ag = ('Andy Georges', '[email protected]')
+eh = ('Ewan Higgs', '[email protected]')
+jt = ('Jens Timmermans', '[email protected]')
+kh = ('Kenneth Hoste', '[email protected]')
+kw = ('Kenneth Waegeman', '[email protected]')
+lm = ('Luis Fernando Munoz Meji?as', '[email protected]')
+sdw = ('Stijn De Weirdt', '[email protected]')
+wdp = ('Wouter Depypere', '[email protected]')
+wp = ('Ward Poelmans', '[email protected]')
+
+# FIXME: do we need this here? it won;t hurt, but still ...
+REGEXP_REMOVE_SUFFIX = re.compile(r'(\.(?:py|sh|pl))$')
 
 # We do need all setup files to be included in the source dir if we ever want to install
 # the package elsewhere.
 EXTRA_SDIST_FILES = ['setup.py']
 
+# Put unittests under this directory
+DEFAULT_TEST_SUITE = 'test'
+
+URL_GH_HPCUGENT = 'https://github.com/hpcugent/%(name)s'
+URL_GHUGENT_HPCUGENT = 'https://github.ugent.be/hpcugent/%(name)s'
 
 def find_extra_sdist_files():
     """Looks for files to append to the FileList that is used by the egg_info."""
@@ -122,20 +149,6 @@ class vsc_bdist_rpm_egg_info(vsc_egg_info):
     has_setuptools = False
 
 
-# available authors
-ag = ('Andy Georges', '[email protected]')
-jt = ('Jens Timmermans', '[email protected]')
-kh = ('Kenneth Hoste', '[email protected]')
-lm = ('Luis Fernando Munoz Meji?as', '[email protected]')
-sdw = ('Stijn De Weirdt', '[email protected]')
-wdp = ('Wouter Depypere', '[email protected]')
-kw = ('Kenneth Waegeman', '[email protected]')
-eh = ('Ewan Higgs', '[email protected]')
-
-
-# FIXME: do we need this here? it won;t hurt, but still ...
-REGEXP_REMOVE_SUFFIX = re.compile(r'(\.(?:py|sh|pl))$')
-
 class vsc_install_scripts(install_scripts):
     """Create the (fake) links for mympirun also remove .sh and .py extensions from the scripts."""
 
@@ -166,14 +179,131 @@ def find_package_modules (self, package, package_dir):
 
 
 class vsc_bdist_rpm(bdist_rpm):
-    """ Custom class to build the RPM, since the __inti__.py cannot be included for the packages that have namespace spread across all of the machine."""
+    """Custom class to build the RPM, since the __init__.py cannot be included for the packages that have namespace spread across all of the machine."""
     def run(self):
         log.error("vsc_bdist_rpm = %s" % (self.__dict__))
         SHARED_TARGET['cmdclass']['egg_info'] = vsc_bdist_rpm_egg_info  # changed to allow removal of files
         self.run_command('egg_info')  # ensure distro name is up-to-date
         orig_bdist_rpm.run(self)
 
 
+# private class variables to communicate
+# between VscScanningLoader and VscTestCommand
+# stored in __builtin__ because the .run_tests
+# reload and cleanup in the modules
+import __builtin__
+if not hasattr(__builtin__,'__test_filter'):
+    setattr(__builtin__, '__test_filter',  {
+        'module': None,
+        'function': None,
+        'allowmods': [],
+    })
+
+
+def filter_testsuites(testsuites):
+    """(Recursive) filtering of (suites of) tests"""
+    test_filter = getattr(__builtin__,'__test_filter')['function']
+
+    res = type(testsuites)()
+
+    for t in testsuites:
+        # t is either a test or testsuite of more tests
+        if isinstance(t, TestSuite):
+            res.addTest(filter_testsuites(t))
+        else:
+            if re.search(test_filter, t._testMethodName):
+                res.addTest(t)
+    return res
+
+
+class VscScanningLoader(ScanningLoader):
+    def loadTestsFromModule(self, module):
+        """Allow for filter"""
+        testsuites = ScanningLoader.loadTestsFromModule(self, module)
+        test_filter = getattr(__builtin__,'__test_filter')
+
+        res = testsuites
+
+        if test_filter['module'] is not None:
+            mod = module.__name__
+            if mod in test_filter['allowmods']:
+                # a parent name space
+                pass
+            elif re.search(test_filter['module'], mod):
+                if test_filter['function'] is not None:
+                    res = filter_testsuites(testsuites)
+                # add parents (and module itself)
+                pms = mod.split('.')
+                for pm_idx in range(len(pms)):
+                    pm = '.'.join(pms[:pm_idx])
+                    if not pm in test_filter['allowmods']:
+                        test_filter['allowmods'].append(pm)
+            else:
+                res = type(testsuites)()
+
+        return res
+
+
+class VscTestCommand(TestCommand):
+    """
+    The cmdclass for testing
+    """
+    user_options = TestCommand.user_options + [
+        ('test-filterf=', 'f', "Regex filter on test function names"),
+        ('test-filterm=', 'F', "Regex filter on test (sub)modules"),
+    ]
+
+    def initialize_options(self):
+        TestCommand.initialize_options(self)
+        self.test_filterm = None
+        self.test_filterf = None
+        self.test_loader = "vsc.install.shared_setup:VscScanningLoader"
+
+    def run_tests(self):
+        getattr(__builtin__,'__test_filter').update({
+            'function': self.test_filterf,
+            'module': self.test_filterm,
+        })
+
+        # should be setup.py
+        setup_py = os.path.abspath(sys.argv[0])
+        log.info('run_tests from %s' % setup_py)
+        base_dir = os.path.dirname(setup_py)
+
+        # make a lib dir to trick setup.py to package this properly
+        # and git ignore empty dirs, so recreate it if necessary
+        lib_dir = os.path.join(base_dir, 'lib')
+        if not os.path.exists(lib_dir):
+            os.mkdir(lib_dir)
+
+        test_dir = os.path.join(base_dir, DEFAULT_TEST_SUITE)
+        if os.path.isdir(test_dir):
+            sys.path.insert(0, test_dir)
+        else:
+            raise Exception("Can't find location of testsuite directory %s in %s" % (DEFAULT_TEST_SUITE, base_dir))
+
+        # make sure we can import the script as a module
+        scripts_dir = os.path.join(base_dir, 'bin')
+        if os.path.isdir(scripts_dir):
+            sys.path.insert(0, scripts_dir)
+
+        # and now the ugly bits: cleanup and restore vsc namespace
+        #   we use vsc namespace tools very early
+        #   need to make sure they are picked up from the paths as specified above
+        #   not to mix with installed and already loaded modules
+        loaded_vsc_modules = [mod for mod in sys.modules.keys() if mod == 'vsc' or mod.startswith('vsc.')]
+        reload_vsc_modules = []
+        for mod in loaded_vsc_modules:
+            if hasattr(sys.modules[mod], '__file__'):
+                # only actual modules
+                reload_vsc_modules.append(mod)
+            del(sys.modules[mod])
+        # reimport
+        for mod in reload_vsc_modules:
+            __import__(mod)
+
+        TestCommand.run_tests(self)
+
 # shared target config
 SHARED_TARGET = {
     'url': '',
@@ -184,6 +314,8 @@ def run(self):
         "egg_info": vsc_egg_info,
         "bdist_rpm": vsc_bdist_rpm,
     },
+    'cmdclass': {'test': VscTestCommand},
+    'test_suite': DEFAULT_TEST_SUITE,
 }
 
 
@@ -265,7 +397,7 @@ def build_setup_cfg_for_bdist_rpm(target):
     setup_cfg.close()
 
 
-def action_target(target, setupfn=setup, extra_sdist=[]):
+def action_target(target, setupfn=setup, extra_sdist=[], urltemplate=None):
     # EXTRA_SDIST_FILES.extend(extra_sdist)
 
     do_cleanup = True
@@ -283,6 +415,11 @@ def action_target(target, setupfn=setup, extra_sdist=[]):
     if do_cleanup:
         cleanup()
 
+    if urltemplate:
+        target['url'] = urltemplate % target
+        if 'github' in urltemplate:
+            target['download_url'] = "%s/tarball/master" % target['url']
+
     build_setup_cfg_for_bdist_rpm(target)
     x = parse_target(target)
 

setup.py

@@ -32,35 +32,36 @@
 @author: Andy Georges (Ghent University)
 @author: Kenneth Hoste (Ghent University)
 """
+
+# vsc-base setup.py needs vsc.install, which is currently shipped as part of vsc-base
+# vsc.install doesn't require vsc-base, so we could move it to it's own repo and only 
+# have this hack in the setup.py of vsc.install (and set it as build_requires)
+# until then...
 import os
 import sys
-
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)), "lib"))
 
+
 import vsc.install.shared_setup as shared_setup
-from vsc.install.shared_setup import ag, kh, jt, sdw
+from vsc.install.shared_setup import ag, kh, jt, sdw, URL_GH_HPCUGENT
 
 def remove_bdist_rpm_source_file():
     """List of files to remove from the (source) RPM."""
     return []
 
 shared_setup.remove_extra_bdist_rpm_files = remove_bdist_rpm_source_file
-shared_setup.SHARED_TARGET.update({
-    'url': 'https://github.com/hpcugent/vsc-base',
-    'download_url': 'https://github.com/hpcugent/vsc-base',
-    'zip_safe': True,
-})
 
 
 PACKAGE = {
     'name': 'vsc-base',
-    'version': '2.3.0',
+    'version': '2.3.1',
     'author': [sdw, jt, ag, kh],
     'maintainer': [sdw, jt, ag, kh],
     'packages': ['vsc', 'vsc.install', 'vsc.utils'],
     'scripts': ['bin/logdaemon.py', 'bin/startlogdaemon.sh', 'bin/bdist_rpm.sh', 'bin/optcomplete.bash'],
     'install_requires' : ['setuptools'],
+    'zip_safe': True,
 }
 
 if __name__ == '__main__':
-    shared_setup.action_target(PACKAGE)
+    shared_setup.action_target(PACKAGE, urltemplate=URL_GH_HPCUGENT)

test/runner.py

@@ -2,6 +2,9 @@
 import os
 import sys
 
+if __name__ == '__main__':
+    sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
+
 import test.asyncprocess as a
 import test.dateandtime as td
 import test.docs as tdo
@@ -22,11 +25,12 @@
 
 suite = unittest.TestSuite([x.suite() for x in (a, td, tg, tf, te, tm, trest, trun, tt, topt, wrapt, tdo)])
 
-try:
-    import xmlrunner
-    rs = xmlrunner.XMLTestRunner(output="test-reports").run(suite)
-except ImportError, err:
-    rs = unittest.TextTestRunner().run(suite)
+if __name__ == '__main__':
+    try:
+        import xmlrunner
+        rs = xmlrunner.XMLTestRunner(output="test-reports").run(suite)
+    except ImportError, err:
+        rs = unittest.TextTestRunner().run(suite)
 
-if not rs.wasSuccessful():
-    sys.exit(1)
+    if not rs.wasSuccessful():
+        sys.exit(1)