Split thread tests from other interactive tests

richardsheridan · richardsheridan · commit fd97233b0581 · 2020-10-24T09:15:32.000-04:00
ignore wx
diff --git a/lib/matplotlib/tests/test_backends_interactive.py b/lib/matplotlib/tests/test_backends_interactive.py
@@ -146,8 +146,51 @@ def check_alt_backend(alt_backend):
     # FIXME: This should be enabled everywhere once Qt5 is fixed on macOS to
     # not resize incorrectly.
     assert_equal(result.getvalue(), result_after.getvalue())
+"""
+_test_timeout = 10  # Empirically, 1s is not enough on Travis.
+
+
+@pytest.mark.parametrize("backend", _get_testable_interactive_backends())
+@pytest.mark.parametrize("toolbar", ["toolbar2", "toolmanager"])
+@pytest.mark.flaky(reruns=3)
+def test_interactive_backend(backend, toolbar):
+    if backend == "macosx":
+        if toolbar == "toolmanager":
+            pytest.skip("toolmanager is not implemented for macosx.")
+        if toolbar == "toolbar2" and os.environ.get('TRAVIS'):
+            # See https://github.com/matplotlib/matplotlib/issues/18213
+            pytest.skip("toolbar2 for macosx is buggy on Travis.")
+
+    proc = subprocess.run(
+        [sys.executable, "-c", _test_script,
+         json.dumps({"toolbar": toolbar})],
+        env={**os.environ, "MPLBACKEND": backend, "SOURCE_DATE_EPOCH": "0"},
+        timeout=_test_timeout,
+        stdout=subprocess.PIPE, universal_newlines=True)
+    if proc.returncode:
+        pytest.fail("The subprocess returned with non-zero exit status "
+                    f"{proc.returncode}.")
+    assert proc.stdout.count("CloseEvent") == 1
+
+
+_thread_test_script = """\
+import json
+import sys
+import threading
+from unittest import TestCase
+
+from matplotlib import pyplot as plt, rcParams
+rcParams.update({
+    "webagg.open_in_browser": False,
+    "webagg.port_retries": 1,
+})
+if len(sys.argv) >= 2:  # Second argument is json-encoded rcParams.
+    rcParams.update(json.loads(sys.argv[1]))
+assert_equal = TestCase().assertEqual
+assert_raises = TestCase().assertRaises
 
-# Test artists and drawing does not crash from thread (no other guarantees)
+# Test artist creation and drawing does not crash from thread
+# No other guarantees!
 fig, ax = plt.subplots()
 # plt.pause needed vs plt.show(block=False) at least on toolbar2-tkagg
 plt.pause(0.1)
@@ -159,6 +202,7 @@ def thread_artist_work():
         ax.plot([1,3,6])
     except:
         # Propagate error to main thread
+        import sys
         global exc_info
         exc_info = sys.exc_info()
 
@@ -167,6 +211,7 @@ def thread_draw_work():
         fig.canvas.draw()
     except:
         # Propagate error to main thread
+        import sys
         global exc_info
         exc_info = sys.exc_info()
 
@@ -181,38 +226,30 @@ def thread_draw_work():
 t = threading.Thread(target=thread_draw_work)
 fig.canvas.mpl_connect("close_event", print)
 t.start()
-plt.pause(0.1)  # flush_events fails on at least Tkagg (bpo-41176)
+plt.pause(0.1)  # flush_events fails here on at least Tkagg (bpo-41176)
 t.join()
 plt.close()
 fig.canvas.flush_events()  # pause doesn't process events after close
 
 if exc_info:  # Raise thread error
     raise exc_info[1].with_traceback(exc_info[2])
 """
-_test_timeout = 10  # Empirically, 1s is not enough on Travis.
 
 
 @pytest.mark.parametrize("backend", _get_testable_interactive_backends())
-@pytest.mark.parametrize("toolbar", ["toolbar2", "toolmanager"])
 @pytest.mark.flaky(reruns=3)
-def test_interactive_backend(backend, toolbar):
-    if backend == "macosx":
-        if toolbar == "toolmanager":
-            pytest.skip("toolmanager is not implemented for macosx.")
-        if toolbar == "toolbar2" and os.environ.get('TRAVIS'):
-            # See https://github.com/matplotlib/matplotlib/issues/18213
-            pytest.skip("toolbar2 for macosx is buggy on Travis.")
-
+def test_interactive_thread_safety(backend):
     proc = subprocess.run(
-        [sys.executable, "-c", _test_script,
-         json.dumps({"toolbar": toolbar})],
+        [sys.executable, "-c", _thread_test_script],
         env={**os.environ, "MPLBACKEND": backend, "SOURCE_DATE_EPOCH": "0"},
         timeout=_test_timeout,
         stdout=subprocess.PIPE, universal_newlines=True)
     if proc.returncode:
+        if backend == "wx":
+            pytest.xfail("Ignoring deprecated wx failure. Use wxagg.")
         pytest.fail("The subprocess returned with non-zero exit status "
                     f"{proc.returncode}.")
-    assert proc.stdout.count("CloseEvent") == 2
+    assert proc.stdout.count("CloseEvent") == 1
 
 
 @pytest.mark.skipif('TF_BUILD' in os.environ,
