Pytest compatible knownfailif and image_comparison decorators

Kojoley · Kojoley · commit bbaf7dc23fa9 · 2016-07-24T01:12:12.000+03:00
diff --git a/conftest.py b/conftest.py
@@ -0,0 +1,27 @@
+from __future__ import (absolute_import, division, print_function,
+                        unicode_literals)
+
+import inspect
+import pytest
+
+import matplotlib
+matplotlib.use('agg')
+
+from matplotlib.testing.decorators import ImageComparisonTest
+
+
+def pytest_configure(config):
+    matplotlib._called_from_pytest = True
+
+
+def pytest_unconfigure(config):
+    matplotlib._called_from_pytest = False
+
+
+def pytest_pycollect_makeitem(collector, name, obj):
+    if inspect.isclass(obj):
+        if issubclass(obj, ImageComparisonTest):
+            # Workaround `image_compare` decorator as it returns class
+            # instead of function and this confuses pytest because it crawls
+            # original names and sees 'test_*', but not 'Test*' in that case
+            return pytest.Class(name, parent=collector)
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -30,6 +30,15 @@
      make_test_filename
 
 
+def knownfail(msg):
+    # TODO: This is temporary solution until migration to `pytest`
+    if getattr(matplotlib, '_called_from_pytest', False):
+        import pytest
+        pytest.xfail(msg)
+    else:
+        raise KnownFailureTest(msg)
+
+
 def knownfailureif(fail_condition, msg=None, known_exception_class=None ):
     """
 
@@ -42,6 +51,13 @@ def knownfailureif(fail_condition, msg=None, known_exception_class=None ):
     if the exception is an instance of this class. (Default = None)
 
     """
+    # TODO: This is temporary solution until migration to `pytest`
+    if getattr(matplotlib, '_called_from_pytest', False):
+        import pytest
+        strict = fail_condition and fail_condition != 'indeterminate'
+        return pytest.mark.xfail(condition=fail_condition, reason=msg,
+                                 raises=known_exception_class, strict=strict)
+
     # based on numpy.testing.dec.knownfailureif
     if msg is None:
         msg = 'Test known to fail'
@@ -264,7 +280,7 @@ def do_test(fignum, actual_fname, expected_fname):
                                 '(RMS %(rms).3f)'%err)
                     except ImageComparisonFailure:
                         if not check_freetype_version(self._freetype_version):
-                            raise KnownFailureTest(
+                            knownfail(
                                 "Mismatched version of freetype.  Test requires '%s', you have '%s'" %
                                 (self._freetype_version, ft2font.__freetype_version__))
                         raise
