Refactor tests

lpsinger · lpsinger · commit ccb1229a8f1d · 2022-10-19T08:24:59.000-04:00
diff --git a/lib/matplotlib/tests/test_sphinxext.py b/lib/matplotlib/tests/test_sphinxext.py
@@ -122,7 +122,10 @@ def test_plot_html_show_source_link(tmpdir):
     assert "index-1.py" not in [p.name for p in html_dir2.iterdir()]
 
 
-def test_show_source_link_true(tmpdir):
+@pytest.mark.parametrize('plot_html_show_source_link', [0, 1])
+def test_show_source_link_true(tmpdir, plot_html_show_source_link):
+    # Test that a source link is generated if :show-source-link: is true,
+    # whether or not plot_html_show_source_link is true.
     source_dir = Path(tmpdir) / 'src'
     source_dir.mkdir()
     parent = Path(__file__).parent
@@ -135,19 +138,16 @@ def test_show_source_link_true(tmpdir):
 
     plt.plot(range(2))
 """)
-    # Make sure source scripts are created by default
-    html_dir1 = source_dir / '_build' / 'html1'
-    build_sphinx_html(source_dir, doctree_dir, html_dir1)
-    assert "index-1.py" in [p.name for p in html_dir1.iterdir()]
-    # Make sure source scripts are still created when
-    # plot_html_show_source_link` is False
-    html_dir2 = source_dir / '_build' / 'html2'
-    build_sphinx_html(source_dir, doctree_dir, html_dir2,
-                      extra_args=['-D', 'plot_html_show_source_link=0'])
-    assert "index-1.py" in [p.name for p in html_dir1.iterdir()]
+    html_dir = source_dir / '_build' / 'html'
+    build_sphinx_html(source_dir, doctree_dir, html_dir, extra_args=[
+        '-D', f'plot_html_show_source_link={plot_html_show_source_link}'])
+    assert "index-1.py" in [p.name for p in html_dir.iterdir()]
 
 
-def test_show_source_link_false(tmpdir):
+@pytest.mark.parametrize('plot_html_show_source_link', [0, 1])
+def test_show_source_link_false(tmpdir, plot_html_show_source_link):
+    # Test that a source link is NOT generated if :show-source-link: is false,
+    # whether or not plot_html_show_source_link is true.
     source_dir = Path(tmpdir) / 'src'
     source_dir.mkdir()
     parent = Path(__file__).parent
@@ -160,16 +160,10 @@ def test_show_source_link_false(tmpdir):
 
     plt.plot(range(2))
 """)
-    # Make sure source scripts are NOT created
-    html_dir1 = source_dir / '_build' / 'html1'
-    build_sphinx_html(source_dir, doctree_dir, html_dir1)
-    assert "index-1.py" not in [p.name for p in html_dir1.iterdir()]
-    # Make sure source scripts are still NOT created when
-    # plot_html_show_source_link` is False
-    html_dir2 = source_dir / '_build' / 'html2'
-    build_sphinx_html(source_dir, doctree_dir, html_dir2,
-                      extra_args=['-D', 'plot_html_show_source_link=0'])
-    assert "index-1.py" not in [p.name for p in html_dir2.iterdir()]
+    html_dir = source_dir / '_build' / 'html'
+    build_sphinx_html(source_dir, doctree_dir, html_dir, extra_args=[
+        '-D', f'plot_html_show_source_link={plot_html_show_source_link}'])
+    assert "index-1.py" not in [p.name for p in html_dir.iterdir()]
 
 
 def build_sphinx_html(source_dir, doctree_dir, html_dir, extra_args=None):
