feat: Major refactor of API responses (to align with DM)

Author: Alan Christie

tests/instance_launcher.py

@@ -74,7 +74,6 @@ def launch(self, launch_parameters: LaunchParameters) -> LaunchResult:
         response, _ = self._api_adapter.get_running_workflow_step(
             running_workflow_step_id=launch_parameters.running_workflow_step_id
         )
-        assert "running_workflow_step" in response
         # Now simulate the creation of a Task and Instance record
         response = self._api_adapter.create_instance(
             running_workflow_step_id=launch_parameters.running_workflow_step_id

tests/test_test_api_adapter.py

@@ -53,7 +53,7 @@ def test_get_workflow():
     wf, _ = utaa.get_workflow(workflow_id=wfid)
 
     # Assert
-    assert wf["workflow"]["name"] == "blah"
+    assert wf["name"] == "blah"
 
 
 def test_create_running_workflow():
@@ -90,10 +90,9 @@ def test_get_running_workflow():
     response, _ = utaa.get_running_workflow(running_workflow_id=rwfid)
 
     # Assert
-    rwf = response["running_workflow"]
-    assert not rwf["done"]
-    assert rwf["workflow"] == wfid
-    assert rwf["variables"] == {"x": 1}
+    assert not response["done"]
+    assert response["workflow"]["id"] == wfid
+    assert response["variables"] == {"x": 1}
 
 
 def test_set_running_workflow_done_when_success():
@@ -113,10 +112,10 @@ def test_set_running_workflow_done_when_success():
 
     # Assert
     response, _ = utaa.get_running_workflow(running_workflow_id=rwfid)
-    assert response["running_workflow"]["done"]
-    assert response["running_workflow"]["success"]
-    assert response["running_workflow"]["error"] is None
-    assert response["running_workflow"]["error_msg"] is None
+    assert response["done"]
+    assert response["success"]
+    assert response["error"] is None
+    assert response["error_msg"] is None
 
 
 def test_set_running_workflow_done_when_failed():
@@ -138,10 +137,10 @@ def test_set_running_workflow_done_when_failed():
 
     # Assert
     response, _ = utaa.get_running_workflow(running_workflow_id=rwfid)
-    assert response["running_workflow"]["done"]
-    assert not response["running_workflow"]["success"]
-    assert response["running_workflow"]["error"] == 1
-    assert response["running_workflow"]["error_msg"] == "Bang!"
+    assert response["done"]
+    assert not response["success"]
+    assert response["error"] == 1
+    assert response["error_msg"] == "Bang!"
 
 
 def test_create_running_workflow_step():
@@ -184,10 +183,10 @@ def test_set_running_workflow_step_done_when_success():
 
     # Assert
     response, _ = utaa.get_running_workflow_step(running_workflow_step_id=rwfsid)
-    assert response["running_workflow_step"]["done"]
-    assert response["running_workflow_step"]["success"]
-    assert response["running_workflow_step"]["error"] is None
-    assert response["running_workflow_step"]["error_msg"] is None
+    assert response["done"]
+    assert response["success"]
+    assert response["error"] is None
+    assert response["error_msg"] is None
 
 
 def test_set_running_workflow_step_done_when_failed():
@@ -212,10 +211,10 @@ def test_set_running_workflow_step_done_when_failed():
 
     # Assert
     response, _ = utaa.get_running_workflow_step(running_workflow_step_id=rwfsid)
-    assert response["running_workflow_step"]["done"]
-    assert not response["running_workflow_step"]["success"]
-    assert response["running_workflow_step"]["error"] == 1
-    assert response["running_workflow_step"]["error_msg"] == "Bang!"
+    assert response["done"]
+    assert not response["success"]
+    assert response["error"] == 1
+    assert response["error_msg"] == "Bang!"
 
 
 def test_get_running_workflow_step():
@@ -239,10 +238,9 @@ def test_get_running_workflow_step():
     response, _ = utaa.get_running_workflow_step(running_workflow_step_id=rwfsid)
 
     # Assert
-    rwfs = response["running_workflow_step"]
-    assert rwfs["step"] == "step-1"
-    assert not rwfs["done"]
-    assert rwfs["running_workflow"] == rwfid
+    assert response["step"] == "step-1"
+    assert not response["done"]
+    assert response["running_workflow"] == rwfid
 
 
 def test_create_instance():

tests/test_test_instance_launcher.py

@@ -1,5 +1,3 @@
-import json
-
 import pytest
 
 pytestmark = pytest.mark.unit

tests/test_workflow_engine_examples.py

@@ -62,13 +62,12 @@ def start_workflow(md, da, workflow_file_name, variables) -> str:
     with open(workflow_path, "r", encoding="utf8") as wf_file:
         wf_definition = yaml.load(wf_file, Loader=yaml.FullLoader)
     assert wf_definition
-    wfid = da.create_workflow(workflow_definition=wf_definition)
-    assert wfid
-    print(f"Created workflow definition {wfid}")
+    wf_response = da.create_workflow(workflow_definition=wf_definition)
+    print(f"Created workflow definition {wf_response}")
     # 2.
     response = da.create_running_workflow(
         user_id="dlister",
-        workflow_id=wfid,
+        workflow_id=wf_response["id"],
         project_id=TEST_PROJECT_ID,
         variables=variables,
     )
@@ -111,9 +110,7 @@ def wait_for_workflow(
     done = False
     while not done:
         response, _ = da.get_running_workflow(running_workflow_id=r_wfid)
-        assert "running_workflow" in response
-        r_wf = response["running_workflow"]
-        if r_wf["done"]:
+        if response["done"]:
             done = True
         else:
             attempts += 1
@@ -122,8 +119,8 @@ def wait_for_workflow(
             time.sleep(completion_poll_period_s)
     # When we get here the workflow must have finished (not timed-out),
     # and it must have passed (or failed) according the the caller's expectation.
-    assert r_wf["done"]
-    assert r_wf["success"] == expect_success
+    assert response["done"]
+    assert response["success"] == expect_success
 
 
 def test_workflow_engine_example_two_step_nop(basic_engine):
@@ -141,8 +138,8 @@ def test_workflow_engine_example_two_step_nop(basic_engine):
     response = da.get_running_workflow_steps(running_workflow_id=r_wfid)
     assert response["count"] == 2
     for step in response["running_workflow_steps"]:
-        assert step["running_workflow_step"]["done"]
-        assert step["running_workflow_step"]["success"]
+        assert step["done"]
+        assert step["success"]
 
 
 def test_workflow_engine_example_nop_fail(basic_engine):
@@ -158,8 +155,8 @@ def test_workflow_engine_example_nop_fail(basic_engine):
     # Check we only have one RunningWorkflowStep, and it failed
     response = da.get_running_workflow_steps(running_workflow_id=r_wfid)
     assert response["count"] == 1
-    assert response["running_workflow_steps"][0]["running_workflow_step"]["done"]
-    assert not response["running_workflow_steps"][0]["running_workflow_step"]["success"]
+    assert response["running_workflow_steps"][0]["done"]
+    assert not response["running_workflow_steps"][0]["success"]
 
 
 def test_workflow_engine_example_smiles_to_file(basic_engine):
@@ -180,8 +177,9 @@ def test_workflow_engine_example_smiles_to_file(basic_engine):
     # Additional, detailed checks...
     # Check we only have one RunningWorkflowStep, and it succeeded
     response = da.get_running_workflow_steps(running_workflow_id=r_wfid)
+    print(f"^^^^^^ response={response}")
     assert response["count"] == 1
-    assert response["running_workflow_steps"][0]["running_workflow_step"]["done"]
-    assert response["running_workflow_steps"][0]["running_workflow_step"]["success"]
+    assert response["running_workflow_steps"][0]["done"]
+    assert response["running_workflow_steps"][0]["success"]
     # This test should generate a file in the simulated project directory
     assert project_file_exists(output_file)

tests/wapi_adapter.py

@@ -83,9 +83,9 @@ def get_workflow(self, *, workflow_id: str) -> dict[str, Any]:
             workflow = Unpickler(pickle_file).load()
         UnitTestWorkflowAPIAdapter.lock.release()
 
-        response = (
-            {"workflow": workflow[workflow_id]} if workflow_id in workflow else {}
-        )
+        response = workflow[workflow_id] if workflow_id in workflow else {}
+        if response:
+            response["id"] = workflow_id
         return response, 0
 
     def get_running_workflow(self, *, running_workflow_id: str) -> dict[str, Any]:
@@ -96,7 +96,9 @@ def get_running_workflow(self, *, running_workflow_id: str) -> dict[str, Any]:
 
         if running_workflow_id not in running_workflow:
             return {}
-        return {"running_workflow": running_workflow[running_workflow_id]}, 0
+        response = running_workflow[running_workflow_id]
+        response["id"] = running_workflow_id
+        return response, 0
 
     def set_running_workflow_done(
         self,
@@ -155,9 +157,9 @@ def get_running_workflow_step(
 
         if running_workflow_step_id not in running_workflow_step:
             return {}, 0
-        return {
-            "running_workflow_step": running_workflow_step[running_workflow_step_id]
-        }, 0
+        response = running_workflow_step[running_workflow_step_id]
+        response["id"] = running_workflow_step_id
+        return response, 0
 
     def set_running_workflow_step_done(
         self,
@@ -243,8 +245,8 @@ def create_running_workflow(
             "user_api_token": "123456789",
             "done": False,
             "success": False,
-            "workflow": workflow_id,
-            "project_id": project_id,
+            "workflow": {"id": workflow_id},
+            "project": {"id": project_id},
             "variables": variables,
         }
         running_workflow[running_workflow_id] = record
@@ -282,6 +284,7 @@ def get_running_workflow_steps(self, *, running_workflow_id: str) -> dict[str, A
         steps = []
         for key, value in running_workflow_step.items():
             if value["running_workflow"] == running_workflow_id:
-                item = {"running_workflow_step": value, "id": key}
+                item = value
+                item["id"] = key
                 steps.append(item)
         return {"count": len(steps), "running_workflow_steps": steps}

workflow/workflow_abc.py

@@ -83,14 +83,12 @@ def get_workflow(
         """Get a Workflow Record by ID."""
         # If present this should return:
         # {
-        #    "workflow": {
-        #       "name": "workflow-name",
-        #       "steps": [
-        #          {
-        #            "name": "step-name"
-        #          }
-        #       ]
-        #    }
+        #    "name": "workflow-name",
+        #    "steps": [
+        #      {
+        #        "name": "step-name"
+        #       }
+        #     ]
         # }
         # If not present an empty dictionary should be returned.
         #
@@ -106,7 +104,6 @@ def get_running_workflow(
         """Get a RunningWorkflow Record"""
         # Should return:
         # {
-        #    "running_workflow": {
         #       "name": "workflow-name",
         #       "user_id": "alan",
         #       "user_api_token": "123456789",
@@ -124,7 +121,6 @@ def get_running_workflow(
         #          "x": 1,
         #          "y": 2,
         #       },
-        #    }
         # }
         # If not present an empty dictionary should be returned.
 
@@ -160,7 +156,6 @@ def get_running_workflow_step(
         """Get a RunningWorkflowStep Record"""
         # Should return:
         # {
-        #    "running_workflow_step": {
         #       "step:": "step-1234",
         #       "done": False,
         #       "success": false,
@@ -169,7 +164,6 @@ def get_running_workflow_step(
         #       "running_workflow": {
         #          "id": "r-workflow-00000000-0000-0000-0000-000000000001"
         #       },
-        #    },
         # }
         # If not present an empty dictionary should be returned.