TST: add the request fixture to check_figures_equal

tacaswell · tacaswell · commit dbb78a0265c2 · 2020-03-06T09:27:38.000-05:00
If you stacked `pytest.mark.parametrize` with check_figures_equal
every set of parameters would write to the same file.  This makes
post-hoc debugging hard and causes intermittent CI failures.
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -388,15 +388,14 @@ def decorator(func):
         _, result_dir = _image_directories(func)
 
         @pytest.mark.parametrize("ext", extensions)
-        def wrapper(*args, ext, **kwargs):
+        def wrapper(*args, ext, request, **kwargs):
+            fn = request.node.name
             try:
                 fig_test = plt.figure("test")
                 fig_ref = plt.figure("reference")
                 func(*args, fig_test=fig_test, fig_ref=fig_ref, **kwargs)
-                test_image_path = result_dir / (func.__name__ + "." + ext)
-                ref_image_path = result_dir / (
-                    func.__name__ + "-expected." + ext
-                )
+                test_image_path = result_dir / (fn + "." + ext)
+                ref_image_path = result_dir / (fn + "-expected." + ext)
                 fig_test.savefig(test_image_path)
                 fig_ref.savefig(ref_image_path)
                 _raise_on_image_difference(
@@ -411,7 +410,9 @@ def wrapper(*args, ext, **kwargs):
             parameters=([param
                          for param in sig.parameters.values()
                          if param.name not in {"fig_test", "fig_ref"}]
-                        + [inspect.Parameter("ext", POSITIONAL_OR_KEYWORD)])
+                        + [inspect.Parameter("ext", POSITIONAL_OR_KEYWORD),
+                           inspect.Parameter("request", POSITIONAL_OR_KEYWORD),
+                          ])
         )
         wrapper.__signature__ = new_sig
 
