fix: Runnign workflows now expect variables

Author: Alan Christie

tests/api_adapter.py

@@ -98,7 +98,11 @@ def get_workflow_by_name(self, *, name: str, version: str) -> Dict[str, Any]:
                 item = {"id": wfid, "workflow": value}
         return item
 
-    def create_running_workflow(self, *, workflow_id: str, project_id: str) -> str:
+    def create_running_workflow(
+        self, *, workflow_id: str, project_id: str, variables: Dict[str, Any]
+    ) -> str:
+        assert isinstance(variables, dict)
+
         UnitTestAPIAdapter.lock.acquire()
         with open(_RUNNING_WORKFLOW_PICKLE_FILE, "rb") as pickle_file:
             running_workflow = Unpickler(pickle_file).load()
@@ -110,6 +114,7 @@ def create_running_workflow(self, *, workflow_id: str, project_id: str) -> str:
             "success": False,
             "workflow": workflow_id,
             "project_id": project_id,
+            "variables": variables,
         }
         running_workflow[running_workflow_id] = record
 

tests/test_test_api_adapter.py

@@ -78,6 +78,7 @@ def test_create_running_workflow():
     response = utaa.create_running_workflow(
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
+        variables={"x": 1},
     )
 
     # Assert
@@ -90,7 +91,9 @@ def test_get_running_workflow():
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     wfid = response["id"]
     response = utaa.create_running_workflow(
-        workflow_id=wfid, project_id=TEST_PROJECT_ID
+        workflow_id=wfid,
+        project_id=TEST_PROJECT_ID,
+        variables={"x": 1},
     )
     rwfid = response["id"]
 
@@ -101,6 +104,7 @@ def test_get_running_workflow():
     rwf = response["running_workflow"]
     assert not rwf["done"]
     assert rwf["workflow"] == wfid
+    assert rwf["variables"] == {"x": 1}
 
 
 def test_set_running_workflow_done_when_success():
@@ -110,6 +114,7 @@ def test_set_running_workflow_done_when_success():
     response = utaa.create_running_workflow(
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
+        variables={},
     )
     rwfid = response["id"]
 
@@ -129,6 +134,7 @@ def test_set_running_workflow_done_when_failed():
     response = utaa.create_running_workflow(
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
+        variables={},
     )
     rwfid = response["id"]
 
@@ -148,6 +154,7 @@ def test_create_running_workflow_step():
     response = utaa.create_running_workflow(
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
+        variables={},
     )
 
     # Act
@@ -165,7 +172,9 @@ def test_get_running_workflow_step():
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     wfid = response["id"]
     response = utaa.create_running_workflow(
-        workflow_id=wfid, project_id=TEST_PROJECT_ID
+        workflow_id=wfid,
+        project_id=TEST_PROJECT_ID,
+        variables={},
     )
     rwfid = response["id"]
     response = utaa.create_running_workflow_step(
@@ -189,7 +198,9 @@ def test_get_running_workflow_steps():
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     wfid = response["id"]
     response = utaa.create_running_workflow(
-        workflow_id=wfid, project_id=TEST_PROJECT_ID
+        workflow_id=wfid,
+        project_id=TEST_PROJECT_ID,
+        variables={},
     )
     rwfid = response["id"]
     response = utaa.create_running_workflow_step(

tests/test_test_instance_launcher.py

@@ -30,6 +30,7 @@ def test_launch_nop(basic_launcher):
     response = utaa.create_running_workflow(
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
+        variables={},
     )
     response = utaa.create_running_workflow_step(
         running_workflow_id=response["id"], step="step-1"
@@ -59,6 +60,7 @@ def test_launch_nop_fail(basic_launcher):
     response = utaa.create_running_workflow(
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
+        variables={},
     )
     response = utaa.create_running_workflow_step(
         running_workflow_id=response["id"], step="step-1"
@@ -88,6 +90,7 @@ def test_launch_smiles_to_file(basic_launcher):
     response = utaa.create_running_workflow(
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
+        variables={},
     )
     response = utaa.create_running_workflow_step(
         running_workflow_id=response["id"], step="step-1"

tests/test_workflow_engine_examples.py

@@ -46,7 +46,7 @@ def basic_engine():
     print("Stopped")
 
 
-def start_workflow(md, da, workflow_file_name) -> str:
+def start_workflow(md, da, workflow_file_name, variables) -> str:
     """A convenience function to handle all the 'START' logic for a workflow.
     It is given the message dispatcher, data adapter, and the base-name of the
     workflow definition - i.e. the filename without the '.yaml' extension
@@ -72,7 +72,9 @@ def start_workflow(md, da, workflow_file_name) -> str:
     assert wfid
     print(f"Created workflow definition {wfid}")
     # 2.
-    response = da.create_running_workflow(workflow_id=wfid, project_id=TEST_PROJECT_ID)
+    response = da.create_running_workflow(
+        workflow_id=wfid, project_id=TEST_PROJECT_ID, variables=variables
+    )
     r_wfid = response["id"]
     assert r_wfid
     print(f"Created running workflow {r_wfid}")
@@ -122,7 +124,7 @@ def test_workflow_engine_example_two_step_nop(basic_engine):
     da, mq, md, _ = basic_engine
 
     # Act
-    r_wfid = start_workflow(md, da, "example-two-step-nop")
+    r_wfid = start_workflow(md, da, "example-two-step-nop", {})
 
     # Assert
     wait_for_workflow(da, mq, r_wfid)
@@ -141,7 +143,7 @@ def test_workflow_engine_example_nop_fail(basic_engine):
     da, mq, md, _ = basic_engine
 
     # Act
-    r_wfid = start_workflow(md, da, "example-nop-fail")
+    r_wfid = start_workflow(md, da, "example-nop-fail", {})
 
     # Assert
     wait_for_workflow(da, mq, r_wfid, expect_success=False)

workflow/workflow_abc.py

@@ -97,6 +97,7 @@ def create_running_workflow(
         *,
         workflow_id: str,
         project_id: str,
+        variables: Dict[str, Any],
     ) -> Dict[str, Any]:
         """Create a RunningWorkflow Record (from a Workflow)"""
         # Should return:
@@ -120,6 +121,7 @@ def get_running_workflow(self, *, running_workflow_id: str) -> Dict[str, Any]:
         #       "success": false,
         #       "workflow": {"id": "workflow-000"},
         #       "project_id": "project-000",
+        #       "variables": {"x": 1, "y": 2},
         #    }
         # }