Merge pull request #12537 from timhoffm/pyplot-test-message

dstansby · web-flow · commit 4c3c724abda4 · 2018-11-03T12:49:49.000+01:00
Improve error message on failing test_pyplot_up_to_date
diff --git a/lib/matplotlib/tests/test_pyplot.py b/lib/matplotlib/tests/test_pyplot.py
@@ -1,3 +1,4 @@
+import difflib
 import subprocess
 import sys
 from pathlib import Path
@@ -16,7 +17,21 @@ def test_pyplot_up_to_date():
     try:
         subprocess.run([sys.executable, str(gen_script)], check=True)
         new_contents = Path(plt.__file__).read_text()
-        assert orig_contents == new_contents
+
+        if orig_contents != new_contents:
+            diff_msg = '\n'.join(
+                difflib.unified_diff(
+                    orig_contents.split('\n'), new_contents.split('\n'),
+                    fromfile='found pyplot.py',
+                    tofile='expected pyplot.py',
+                    n=0, lineterm=''))
+            pytest.fail(
+                "pyplot.py is not up-to-date. Please run "
+                "'python tools/boilerplate.py' to update pyplot.py. "
+                "This needs to be done from an environment where your "
+                "current working copy is installed (e.g. 'pip install -e'd). "
+                "Here is a diff of unexpected differences:\n%s" % diff_msg
+            )
     finally:
         Path(plt.__file__).write_text(orig_contents)
 
