Rework test command for matplotlib

HolgerPeters · HolgerPeters · commit fd17148b2f1a · 2015-03-04T13:04:07.000+01:00
- specifiy parameters properly using user_options
- add parameters used by travis to be passed on to nose
diff --git a/.travis.yml b/.travis.yml
@@ -6,8 +6,7 @@ env:
     - secure: E7OCdqhZ+PlwJcn+Hd6ns9TDJgEUXiUNEI0wu7xjxB2vBRRIKtZMbuaZjd+iKDqCKuVOJKu0ClBUYxmgmpLicTwi34CfTUYt6D4uhrU+8hBBOn1iiK51cl/aBvlUUrqaRLVhukNEBGZcyqAjXSA/Qsnp2iELEmAfOUa92ZYo1sk=
     - secure: "dfjNqGKzQG5bu3FnDNwLG8H/C4QoieFo4PfFmZPdM2RY7WIzukwKFNT6kiDfOrpwt+2bR7FhzjOGlDECGtlGOtYPN8XuXGjhcP4a4IfakdbDfF+D3NPIpf5VlE6776k0VpvcZBTMYJKNFIMc7QPkOwjvNJ2aXyfe3hBuGlKJzQU="
     - BUILD_DOCS=false
-    - TEST_ARGS=--no-pep8
-    - NUMPY=numpy
+    - TEST_ARGS=--omit-pep8
 
 language: python
 
@@ -19,7 +18,7 @@ matrix:
     - python: 3.3
     - python: 3.4
     - python: 2.7
-      env: TEST_ARGS=--pep8
+      env: TEST_ARGS=--pep8-only
     - python: 2.7
       env: BUILD_DOCS=true
 
@@ -60,7 +59,7 @@ script:
       export MPL_REPO_DIR=$PWD  # needed for pep8-conformance test of the examples
       mkdir ../tmp_test_dir
       cd ../tmp_test_dir
-      gdb -return-child-result -batch -ex r -ex bt --args python ../matplotlib/tests.py -sv --processes=8 --process-timeout=300 $TEST_ARGS
+      gdb -return-child-result -batch -ex r -ex bt --args python setup.py test --nocapture --nose-verbose --processes=8 --process-timeout=300 $TEST_ARGS
     else
       cd doc
       python make.py html --small --warningsaserrors
diff --git a/setup.py b/setup.py
@@ -8,6 +8,7 @@
 # This needs to be the very first thing to use distribute
 from distribute_setup import use_setuptools
 use_setuptools()
+from setuptools.command.test import test as TestCommand
 
 import sys
 
@@ -121,20 +122,77 @@
     'Topic :: Scientific/Engineering :: Visualization',
     ]
 
-from setuptools.command.test import test as TestCommand
+
 class NoseTestCommand(TestCommand):
+    """Invoke unit tests using nose after an in-place build."""
+
+    description = "Invoke unit tests using nose after an in-place build."
+    user_options = [
+        ("pep8-only", None, "pep8 checks"),
+        ("omit-pep8", None, "Do not perform pep8 checks"),
+        ("nocapture", None, "do not capture stdout (nosetests)"),
+        ("nose-verbose", None, "be verbose (nosetests)"),
+        ("processes=", None, "number of processes (nosetests)"),
+        ("process-timeout=", None, "process timeout (nosetests)"),
+    ]
+
+    def initialize_options(self):
+        self.pep8_only = None
+        self.omit_pep8 = None
+
+        # parameters passed to nose tests
+        self.processes = None
+        self.process_timeout = None
+        self.nose_verbose = None
+        self.nocapture = None
+
     def finalize_options(self):
-        TestCommand.finalize_options(self)
         self.test_args = []
-        self.test_suite = True
+        if self.pep8_only:
+            self.pep8_only = True
+        if self.omit_pep8:
+            self.omit_pep8 = True
+
+        if self.pep8_only and self.omit_pep8:
+            from distutils.errors import DistutilsOptionError
+            raise DistutilsOptionError(
+                "You are using several options for the test command in an "
+                "incompatible manner. Please use either one of --pep8-only,"
+                "--omit-pep8"
+            )
+
+        if self.processes:
+            self.test_args.append("--processes={prc}".format(
+                prc=self.processes))
+
+        if self.process_timeout:
+            self.test_args.append("--process-timeout={tout}".format(
+                tout=self.process_timeout))
+
+        if self.nose_verbose:
+            self.test_args.append("--verbose")
+
+        if self.nocapture:
+            self.test_args.append("--nocapture")
+
+    def run(self):
+        if self.distribution.install_requires:
+            self.distribution.fetch_build_eggs(
+                self.distribution.install_requires)
+        if self.distribution.tests_require:
+            self.distribution.fetch_build_eggs(self.distribution.tests_require)
+
+        self.announce('running unittests with nose')
+        self.with_project_on_sys_path(self.run_tests)
+
 
     def run_tests(self):
         try:
             import matplotlib
             matplotlib.use('agg')
             import nose
             from matplotlib.testing.noseclasses import KnownFailure
-            from matplotlib import default_test_modules
+            from matplotlib import default_test_modules as testmodules
             from matplotlib import font_manager
             import time
             # Make sure the font caches are created before starting any possibly
@@ -150,15 +208,14 @@ def run_tests(self):
             from nose.plugins import multiprocess
             multiprocess._instantiate_plugins = plugins
 
-            if '--no-pep8' in sys.argv:
-                default_test_modules.remove('matplotlib.tests.test_coding_standards')
-                sys.argv.remove('--no-pep8')
-            elif '--pep8' in sys.argv:
-                default_test_modules = ['matplotlib.tests.test_coding_standards']
-                sys.argv.remove('--pep8')
+            if self.omit_pep8:
+                testmodules.remove('matplotlib.tests.test_coding_standards')
+            elif self.pep8_only:
+                testmodules = ['matplotlib.tests.test_coding_standards']
+
             nose.main(addplugins=[x() for x in plugins],
-                      defaultTest=default_test_modules,
-                      argv=['nosetests'],
+                      defaultTest=testmodules,
+                      argv=['nosetests'] + self.test_args,
                       exit=False)
         except ImportError:
             sys.exit(-1)
diff --git a/tests.py b/tests.py
