REFACT(plot.TC): PYTESTize and parametrize

Author: ankostis

test/test_graphkit.py

@@ -3,11 +3,6 @@
 
 import math
 import pickle
-import os.path as osp
-import shutil
-import sys
-import tempfile
-
 
 from pprint import pprint
 from operator import add
@@ -109,82 +104,6 @@ def test_network_deep_merge():
     pprint(net3({'a': 1, 'b': 2, 'c': 4}))
 
 
-def test_plotting():
-    pipeline = compose(name="netop")(
-        operation(name="add", needs=["a", "b1"], provides=["ab1"])(add),
-        operation(name="sub", needs=["a", modifiers.optional("b2")], provides=["ab2"])(lambda a, b=1: a-b),
-        operation(name="abb", needs=["ab1", "ab2"], provides=["asked"])(add),
-    )
-    inputs = {'a': 1, 'b1': 2}
-    solution=pipeline(inputs)
-
-
-    ## Generate all formats
-    #  (not needing to save files)
-    #
-    # ...these are not working on my PC, or travis.
-    forbidden_formats = ".dia .hpgl .mif .mp .pcl .pic .vtx .xlib".split()
-    prev_dot = None
-    for ext in network.supported_plot_formats():
-        if ext in forbidden_formats:
-            continue
-
-        dot = pipeline.plot(inputs=inputs, solution=solution, outputs=['asked', 'b1'])
-        assert dot
-        assert dot != prev_dot
-        prev_dot = dot
-
-        dot = pipeline.plot()
-        assert dot
-        assert dot != prev_dot
-        prev_dot = dot
-
-    ## Try saving one file.
-    #
-    tdir = tempfile.mkdtemp()
-    fpath = osp.join(tdir, "workflow.png")
-    try:
-        dot = pipeline.plot(fpath, inputs=inputs, solution=solution, outputs=['asked', 'b1'])
-        assert osp.exists(fpath)
-        assert dot
-    finally:
-        shutil.rmtree(tdir, ignore_errors=True)
-
-    ## Try matplotlib Window, but
-    # without opening a Window.
-    #
-    if sys.version_info < (3, 5):
-        # On PY< 3.5 it fails with:
-        #   nose.proxy.TclError: no display name and no $DISPLAY environment variable
-        # eg https://travis-ci.org/ankostis/graphkit/jobs/593957996
-        import matplotlib
-        matplotlib.use("Agg")
-    # do not open window in headless travis
-    assert pipeline.plot(show=-1)
-
-    ## Try Jupyter SVG.
-    #
-    # but latest ipython-7+ dropped < PY3.4
-    if sys.version_info >= (3, 5):
-        assert "display.SVG" in str(type(pipeline.plot(jupyter=True)))
-
-    try:
-        pipeline.plot('bad.format')
-        assert False, "Should had failed writting arbitrary file format!"
-    except ValueError as ex:
-        assert "Unknown file format" in str(ex)
-
-        ## Check help msg lists all siupported formats
-        for ext in network.supported_plot_formats():
-            assert ext in str(ex)
-
-
-def test_plotting_docstring():
-    common_formats = ".png .dot .jpg .jpeg .pdf .svg".split()
-    for ext in common_formats:
-        assert ext in network.plot_graph.__doc__
-
-
 def test_input_based_pruning():
     # Tests to make sure we don't need to pass graph inputs if we're provided
     # with data further downstream in the graph as an input.

test/test_plot.py

@@ -0,0 +1,106 @@
+# Copyright 2016, Yahoo Inc.
+# Licensed under the terms of the Apache License, Version 2.0. See the LICENSE file associated with the project for terms.
+
+from operator import add
+
+import pytest
+import sys
+
+from graphkit import compose, network, operation
+from graphkit.modifiers import optional
+
+
+@pytest.fixture
+def pipeline():
+    return compose(name="netop")(
+        operation(name="add", needs=["a", "b1"], provides=["ab1"])(add),
+        operation(name="sub", needs=["a", optional("b2")], provides=["ab2"])(
+            lambda a, b=1: a - b
+        ),
+        operation(name="abb", needs=["ab1", "ab2"], provides=["asked"])(add),
+    )
+
+
+@pytest.fixture(params=[{"a": 1}, {"a": 1, "b1": 2}])
+def inputs(request):
+    return {"a": 1, "b1": 2}
+
+
+@pytest.fixture(params=[None, ("a", "b1")])
+def input_names(request):
+    return request.param
+
+
+@pytest.fixture(params=[None, ["asked", "b1"]])
+def outputs(request):
+    return request.param
+
+
+@pytest.fixture(params=[None, 1])
+def solution(pipeline, inputs, outputs, request):
+    return request.param and pipeline(inputs, outputs)
+
+
+###### TEST CASES #######
+##
+
+
+def test_plotting_docstring():
+    common_formats = ".png .dot .jpg .jpeg .pdf .svg".split()
+    for ext in common_formats:
+        assert ext in network.plot_graph.__doc__
+
+
+def test_plot_formats(pipeline, input_names, outputs, solution, tmp_path):
+    ## Generate all formats  (not needing to save files)
+
+    # ...these are not working on my PC, or travis.
+    forbidden_formats = ".dia .hpgl .mif .mp .pcl .pic .vtx .xlib".split()
+    prev_dot = None
+    for ext in network.supported_plot_formats():
+        if ext not in forbidden_formats:
+            dot = pipeline.plot(inputs=input_names, outputs=outputs, solution=solution)
+            assert dot
+            assert ext == ".jpg" or dot != prev_dot
+            prev_dot = dot
+
+
+def test_plot_bad_format(pipeline, tmp_path):
+    with pytest.raises(ValueError, match="Unknown file format") as exinfo:
+        pipeline.plot(filename="bad.format")
+
+    ## Check help msg lists all siupported formats
+    for ext in network.supported_plot_formats():
+        assert exinfo.match(ext)
+
+
+def test_plot_write_file(pipeline, tmp_path):
+    # Try saving a file from one format.
+
+    fpath = tmp_path / "workflow.png"
+
+    dot = pipeline.plot(str(fpath))
+    assert fpath.exists()
+    assert dot
+
+
+def test_plot_matplib(pipeline, tmp_path):
+    ## Try matplotlib Window, but # without opening a Window.
+
+    if sys.version_info < (3, 5):
+        # On PY< 3.5 it fails with:
+        #   nose.proxy.TclError: no display name and no $DISPLAY environment variable
+        # eg https://travis-ci.org/ankostis/graphkit/jobs/593957996
+        import matplotlib
+
+        matplotlib.use("Agg")
+    # do not open window in headless travis
+    assert pipeline.plot(show=-1)
+
+
+@pytest.mark.skipif(sys.version_info < (3, 5), reason="ipython-7+ dropped PY3.4-")
+def test_plot_jupyter(pipeline, tmp_path):
+    ## Try returned  Jupyter SVG.
+
+    dot = pipeline.plot(jupyter=True)
+    assert "display.SVG" in str(type(dot))