Merge branch 'fix_execute_graph_outputs' into 'main'

fix "outputs" argument of execute_graph

See merge request !82

src/ewoksppf/bindings.py

@@ -527,9 +527,9 @@ class EwoksWorkflow(Workflow):
         timeout: Optional[float] = None,
         **execute_options,
     ):
-        if outputs and outputs != [{"all": True}] or not merge_outputs:
+        if outputs and ((outputs != [{"all": True}] or not merge_outputs)):
             raise ValueError(
-                "The Pypushflow binding can only return the merged results of all tasks"
+                "the Pypushflow engine can only return the merged results of all tasks"
             )
         self._stop_actor.reset()
         with self._run_context(**execute_options) as execinfo:
@@ -541,7 +541,7 @@ class EwoksWorkflow(Workflow):
             self._stop_actor.join(timeout=timeout)
             result = self._stop_actor.outData
             if result is None:
-                return None
+                return dict()
             info = result.pop(ppfrunscript.INFOKEY, dict())
             result = self.__parse_result(result)
             ex = result.get("WorkflowException")
@@ -556,7 +556,10 @@ class EwoksWorkflow(Workflow):
                 else:
                     execinfo["error_traceback"] = "".join(ex["traceBack"])
             if ex is None or not raise_on_error:
-                return result
+                if outputs:
+                    return result
+                else:
+                    return dict()
             else:
                 print("\n".join(ex["traceBack"]), file=sys.stderr)
                 raise RuntimeError(ex["errorMessage"])

src/ewoksppf/tests/test_examples.py

@@ -15,5 +15,5 @@ def test_execute_graph(graph_name, scheme, ppf_log_config, tmpdir):
     else:
         varinfo = None
     ewoksgraph = load_graph(graph)
-    result = execute_graph(graph, varinfo=varinfo, timeout=10)
+    result = execute_graph(graph, varinfo=varinfo, timeout=10, outputs=[{"all": True}])
     assert_execute_graph_default_result(ewoksgraph, result, expected, varinfo)

src/ewoksppf/tests/test_ppf_end.py

@@ -58,6 +58,6 @@ def workflow():
 
 def test_ppf_end(ppf_log_config):
     graph, expected = workflow()
-    result = execute_graph(graph)
+    result = execute_graph(graph, outputs=[{"all": True}])
     for k, v in expected.items():
         assert result[k] == v, k

src/ewoksppf/tests/test_ppf_workflow1.py

@@ -30,5 +30,5 @@ def workflow1():
 def test_workflow1(ppf_log_config, tmpdir):
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow1()
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo)

src/ewoksppf/tests/test_ppf_workflow10.py

@@ -57,7 +57,7 @@ def test_workflow10(limit, scheme, ppf_log_config, tmpdir):
         varinfo = {}
     inputs = {"value": 1, "limit": limit}
     graph, expected = workflow10(inputs)
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     if scheme:
         assert_execute_graph_values(result, expected, varinfo)
     else:

src/ewoksppf/tests/test_ppf_workflow11.py

@@ -132,5 +132,5 @@ def workflow11():
 def test_workflow11(ppf_log_config, tmpdir):
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow11()
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow12.py

@@ -95,5 +95,5 @@ def test_workflow12(startvalue, ppf_log_config, tmpdir):
     withsubmodel_startvalue = 1
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow12(startvalue, withsubmodel_startvalue)
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow13.py

@@ -92,5 +92,5 @@ def test_workflow13(startvalue, ppf_log_config, tmpdir):
     withlastnode_startvalue = 1
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow13(startvalue, withlastnode_startvalue)
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow14.py

@@ -118,5 +118,5 @@ def workflow14():
 def test_workflow14(ppf_log_config, tmpdir):
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow14()
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow15.py

@@ -106,5 +106,5 @@ def test_workflow15(ppf_log_config, tmpdir):
     """Test connecting nodes from submodels directly"""
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow15()
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow16.py

@@ -135,5 +135,5 @@ def test_workflow16(ppf_log_config, tmpdir):
     """Test connecting nodes from sub-submodels to the top model"""
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow16()
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow17.py

@@ -50,6 +50,6 @@ def workflow17(doloop=True):
 def test_workflow17(doloop, ppf_log_config):
     """Test 2 unconditional upstream tasks, one coming from a feedback loop"""
     graph, expected = workflow17(doloop=doloop)
-    result = execute_graph(graph)
+    result = execute_graph(graph, outputs=[{"all": True}])
     for k, v in expected.items():
         assert result[k] == v, k

src/ewoksppf/tests/test_ppf_workflow18.py

@@ -50,5 +50,5 @@ def test_workflow18(dotask4, ppf_log_config, tmpdir):
     """Test conditional links"""
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow18(dotask4=dotask4)
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow19.py

@@ -77,5 +77,5 @@ def test_workflow19(ppf_log_config, tmpdir):
     """Test 2 unconditional upstream tasks, one coming from a feedback loop"""
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow19()
-    result = execute_graph(graph)
+    result = execute_graph(graph, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow2.py

@@ -29,7 +29,9 @@ def workflow2():
 def test_workflow2(ppf_log_config, tmpdir):
     varinfo = {"root_uri": str(tmpdir)}
     graph, expected = workflow2()
-    result = execute_graph(graph, varinfo=varinfo, raise_on_error=False)
+    result = execute_graph(
+        graph, varinfo=varinfo, raise_on_error=False, outputs=[{"all": True}]
+    )
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)
     err_msg = "Task 'Python Error Handler Test' failed"
     assert result["WorkflowException"]["errorMessage"] == err_msg

src/ewoksppf/tests/test_ppf_workflow20.py

@@ -29,7 +29,10 @@ def test_workflow20(persist, ppf_log_config, tmpdir):
         varinfo = None
     graph = workflow20()
     result = execute_graph(
-        graph, inputs=[{"name": "value", "value": 5}], varinfo=varinfo
+        graph,
+        inputs=[{"name": "value", "value": 5}],
+        varinfo=varinfo,
+        outputs=[{"all": True}],
     )
     expected = {"_ppfdict": {"value": 7}}
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow21.py

@@ -168,7 +168,9 @@ def test_workflow21(args, on_error, persist, ppf_log_config, tmpdir):
         varinfo = None
     graph = workflow21(on_error=on_error)
     inputs = [{"name": k, "value": v} for k, v in args["inputs"].items()]
-    result = execute_graph(graph, inputs=inputs, varinfo=varinfo)
+    result = execute_graph(
+        graph, inputs=inputs, varinfo=varinfo, outputs=[{"all": True}]
+    )
     assert result
     assert result["return_value"] == args["return_value"]
 

src/ewoksppf/tests/test_ppf_workflow22.py

@@ -97,5 +97,5 @@ def test_ppf_workflow22(ppf_log_config, tmpdir):
 
     graph, expected = workflow()
     varinfo = {"root_uri": str(tmpdir)}
-    result = execute_graph(graph, varinfo=varinfo)
+    result = execute_graph(graph, varinfo=varinfo, outputs=[{"all": True}])
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow23.py

@@ -96,5 +96,7 @@ def test_ppf_workflow23(on_error, ppf_log_config, tmpdir):
         {"name": "groups", "value": set()},
     ]
     varinfo = {"root_uri": str(tmpdir)}
-    result = execute_graph(graph, inputs=inputs, varinfo=varinfo)
+    result = execute_graph(
+        graph, inputs=inputs, varinfo=varinfo, outputs=[{"all": True}]
+    )
     assert_execute_graph_default_result(graph, result, expected, varinfo=varinfo)

src/ewoksppf/tests/test_ppf_workflow24.py

@@ -159,7 +159,9 @@ def test_ppf_workflow24(ppf_log_config):
         {"name": "succeeded", "value": tuple()},
         {"name": "raise_on_names", "value": tuple()},
     ]
-    result = execute_graph(workflow(), inputs=inputs, raise_on_error=False)
+    result = execute_graph(
+        workflow(), inputs=inputs, raise_on_error=False, outputs=[{"all": True}]
+    )
     succeeded = "task1", "task2", "task3"
     assert result["_ppfdict"]["succeeded"] == succeeded
     assert "WorkflowException" not in result["_ppfdict"]
@@ -168,7 +170,9 @@ def test_ppf_workflow24(ppf_log_config):
         {"name": "succeeded", "value": tuple()},
         {"name": "raise_on_names", "value": ("task3",)},
     ]
-    result = execute_graph(workflow(), inputs=inputs, raise_on_error=False)
+    result = execute_graph(
+        workflow(), inputs=inputs, raise_on_error=False, outputs=[{"all": True}]
+    )
     succeeded = "task1", "task2", "subtask1", "subtask2", "subtask3"
     assert result["_ppfdict"]["succeeded"] == succeeded
     errorMessage = result["_ppfdict"]["WorkflowException"]["errorMessage"]
@@ -178,7 +182,9 @@ def test_ppf_workflow24(ppf_log_config):
         {"name": "succeeded", "value": tuple()},
         {"name": "raise_on_names", "value": ("task3", "subtask2")},
     ]
-    result = execute_graph(workflow(), inputs=inputs, raise_on_error=False)
+    result = execute_graph(
+        workflow(), inputs=inputs, raise_on_error=False, outputs=[{"all": True}]
+    )
     succeeded = (
         "task1",
         "task2",
@@ -195,7 +201,9 @@ def test_ppf_workflow24(ppf_log_config):
         {"name": "succeeded", "value": tuple()},
         {"name": "raise_on_names", "value": ("task3", "subtask3", "subsubtask1")},
     ]
-    result = execute_graph(workflow(), inputs=inputs, raise_on_error=False)
+    result = execute_graph(
+        workflow(), inputs=inputs, raise_on_error=False, outputs=[{"all": True}]
+    )
     succeeded = "task1", "task2", "subtask1", "subtask2", "subsub_handler"
     assert result["_ppfdict"]["succeeded"] == succeeded
     errorMessage = result["_ppfdict"]["WorkflowException"]["errorMessage"]