feat: Running workflows now expect a user ID

Author: Alan Christie

tests/api_adapter.py

@@ -99,8 +99,14 @@ def get_workflow_by_name(self, *, name: str, version: str) -> Dict[str, Any]:
         return item
 
     def create_running_workflow(
-        self, *, workflow_id: str, project_id: str, variables: Dict[str, Any]
+        self,
+        *,
+        user_id: str,
+        workflow_id: str,
+        project_id: str,
+        variables: Dict[str, Any],
     ) -> str:
+        assert user_id
         assert isinstance(variables, dict)
 
         UnitTestAPIAdapter.lock.acquire()
@@ -110,6 +116,7 @@ def create_running_workflow(
         next_id: int = len(running_workflow) + 1
         running_workflow_id: str = _RUNNING_WORKFLOW_ID_FORMAT.format(id=next_id)
         record = {
+            "user_id": user_id,
             "done": False,
             "success": False,
             "workflow": workflow_id,

tests/test_test_api_adapter.py

@@ -76,6 +76,7 @@ def test_create_running_workflow():
 
     # Act
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
         variables={"x": 1},
@@ -91,6 +92,7 @@ def test_get_running_workflow():
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     wfid = response["id"]
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=wfid,
         project_id=TEST_PROJECT_ID,
         variables={"x": 1},
@@ -112,6 +114,7 @@ def test_set_running_workflow_done_when_success():
     utaa = UnitTestAPIAdapter()
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
         variables={},
@@ -132,6 +135,7 @@ def test_set_running_workflow_done_when_failed():
     utaa = UnitTestAPIAdapter()
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
         variables={},
@@ -152,6 +156,7 @@ def test_create_running_workflow_step():
     utaa = UnitTestAPIAdapter()
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
         variables={},
@@ -172,6 +177,7 @@ def test_get_running_workflow_step():
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     wfid = response["id"]
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=wfid,
         project_id=TEST_PROJECT_ID,
         variables={},
@@ -198,6 +204,7 @@ def test_get_running_workflow_steps():
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     wfid = response["id"]
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=wfid,
         project_id=TEST_PROJECT_ID,
         variables={},

tests/test_test_instance_launcher.py

@@ -28,7 +28,9 @@ def test_launch_nop(basic_launcher):
     utaa = basic_launcher[0]
     launcher = basic_launcher[1]
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
+    rwfid = response["id"]
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
         variables={},
@@ -41,7 +43,7 @@ def test_launch_nop(basic_launcher):
     # Act
     result = launcher.launch(
         project_id=TEST_PROJECT_ID,
-        running_workflow_id="r-workflow-00000000-0000-0000-0000-000000000001",
+        running_workflow_id=rwfid,
         running_workflow_step_id=rwfsid,
         step_specification=json.dumps(
             {"collection": "workflow-engine-unit-test-jobs", "job": "nop"}
@@ -61,10 +63,12 @@ def test_launch_nop_fail(basic_launcher):
     launcher = basic_launcher[1]
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
         variables={},
     )
+    rwfid = response["id"]
     response = utaa.create_running_workflow_step(
         running_workflow_id=response["id"], step="step-1"
     )
@@ -73,7 +77,7 @@ def test_launch_nop_fail(basic_launcher):
     # Act
     result = launcher.launch(
         project_id=TEST_PROJECT_ID,
-        running_workflow_id="r-workflow-00000000-0000-0000-0000-000000000001",
+        running_workflow_id=rwfid,
         running_workflow_step_id=rwfsid,
         step_specification=json.dumps(
             {"collection": "workflow-engine-unit-test-jobs", "job": "nop-fail"}
@@ -93,10 +97,12 @@ def test_launch_smiles_to_file(basic_launcher):
     launcher = basic_launcher[1]
     response = utaa.create_workflow(workflow_definition={"name": "blah"})
     response = utaa.create_running_workflow(
+        user_id="dlister",
         workflow_id=response["id"],
         project_id=TEST_PROJECT_ID,
         variables={},
     )
+    rwfid = response["id"]
     response = utaa.create_running_workflow_step(
         running_workflow_id=response["id"], step="step-1"
     )
@@ -105,7 +111,7 @@ def test_launch_smiles_to_file(basic_launcher):
     # Act
     result = launcher.launch(
         project_id=TEST_PROJECT_ID,
-        running_workflow_id="r-workflow-00000000-0000-0000-0000-000000000001",
+        running_workflow_id=rwfid,
         running_workflow_step_id=rwfsid,
         step_specification=json.dumps(
             {

tests/test_workflow_engine_examples.py

@@ -68,7 +68,10 @@ def start_workflow(md, da, workflow_file_name, variables) -> str:
     print(f"Created workflow definition {wfid}")
     # 2.
     response = da.create_running_workflow(
-        workflow_id=wfid, project_id=TEST_PROJECT_ID, variables=variables
+        user_id="dlister",
+        workflow_id=wfid,
+        project_id=TEST_PROJECT_ID,
+        variables=variables,
     )
     r_wfid = response["id"]
     assert r_wfid

workflow/workflow_abc.py

@@ -98,6 +98,7 @@ def create_running_workflow(
         workflow_id: str,
         project_id: str,
         variables: Dict[str, Any],
+        user_id: str,
     ) -> Dict[str, Any]:
         """Create a RunningWorkflow Record (from a Workflow)"""
         # Should return:
@@ -117,6 +118,7 @@ def get_running_workflow(self, *, running_workflow_id: str) -> Dict[str, Any]:
         # Should return:
         # {
         #    "running_workflow": {
+        #       "user_id": "alan",
         #       "done": False,
         #       "success": false,
         #       "workflow": {"id": "workflow-000"},