test: Fix instance creation

Author: Alan Christie

tests/instance_launcher.py

@@ -82,12 +82,18 @@ def launch(self, *, launch_parameters: LaunchParameters) -> LaunchResult:
                 <= launch_parameters.total_number_of_replicas
             )
 
+        # Create an Instance record (and dummy Task ID)
+        response = self._api_adapter.create_instance()
+        instance_id = response["id"]
+        task_id = "task-00000000-0000-0000-0000-000000000001"
+
         # Create a running workflow step
         assert launch_parameters.running_workflow_id
         assert launch_parameters.step_name
         response, _ = self._api_adapter.create_running_workflow_step(
             running_workflow_id=launch_parameters.running_workflow_id,
             step=launch_parameters.step_name,
+            instance_id=instance_id,
             replica=launch_parameters.step_replication_number,
             replicas=launch_parameters.total_number_of_replicas,
         )
@@ -99,10 +105,11 @@ def launch(self, *, launch_parameters: LaunchParameters) -> LaunchResult:
                 running_workflow_step_id=rwfs_id, variables=launch_parameters.variables
             )
 
-        # Create an Instance record (and dummy Task ID)
-        response = self._api_adapter.create_instance(running_workflow_step_id=rwfs_id)
-        instance_id = response["id"]
-        task_id = "task-00000000-0000-0000-0000-000000000001"
+        # Now add the running workflow ID ot the instance record.
+        self._api_adapter.set_instance_running_workflow_id(
+            instance_id=instance_id,
+            running_workflow_step_id=rwfs_id,
+        )
 
         # Get the job defitnion.
         # This is expected to exist in the tests/job-definitions directory.

tests/test_test_wapi_adapter.py

@@ -5,6 +5,8 @@
 from tests.config import TEST_PROJECT_ID
 from tests.wapi_adapter import UnitTestWorkflowAPIAdapter
 
+_I_ID: str = "instance-00000000-0000-0000-0000-000000000000"
+
 
 def test_get_nop_job():
     # Arrange
@@ -177,7 +179,7 @@ def test_create_running_workflow_step():
 
     # Act
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
 
     # Assert
@@ -195,7 +197,7 @@ def test_set_running_workflow_step_variables():
         variables={},
     )
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
     rwfsid = response["id"]
 
@@ -220,7 +222,7 @@ def test_set_running_workflow_step_done_when_success():
         variables={},
     )
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
     rwfsid = response["id"]
 
@@ -247,7 +249,7 @@ def test_set_running_workflow_step_done_when_failed():
         variables={},
     )
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
     rwfsid = response["id"]
 
@@ -277,7 +279,7 @@ def test_get_running_workflow_step():
     )
     rwfid = response["id"]
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=rwfid, step="step-1"
+        running_workflow_id=rwfid, step="step-1", instance_id=_I_ID
     )
     rwfsid = response["id"]
 
@@ -306,7 +308,7 @@ def test_get_running_workflow_step_with_prior_step():
     response, _ = utaa.create_running_workflow_step(
         running_workflow_id=rwfid,
         step="step-1",
-        prior_running_workflow_step_id="r-workflow-step-111",
+        instance_id=_I_ID,
     )
     rwfsid = response["id"]
 
@@ -317,8 +319,6 @@ def test_get_running_workflow_step_with_prior_step():
     assert response["name"] == "step-1"
     assert not response["done"]
     assert response["running_workflow"]["id"] == rwfid
-    assert "prior_running_workflow_step" in response
-    assert response["prior_running_workflow_step"]["id"] == "r-workflow-step-111"
 
 
 def test_create_instance():
@@ -332,7 +332,7 @@ def test_create_instance():
         variables={},
     )
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
     rwfs_id = response["id"]
 
@@ -354,7 +354,7 @@ def test_create_and_get_instance():
         variables={},
     )
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
     rwfs_id = response["id"]
     response = utaa.create_instance(running_workflow_step_id=rwfs_id)
@@ -378,7 +378,7 @@ def test_create_instance_and_get_step_instance_directory():
         variables={},
     )
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
     rwfs_id = response["id"]
     response = utaa.create_instance(running_workflow_step_id=rwfs_id)
@@ -405,7 +405,7 @@ def test_create_instance_and_get_step_instance_directory_by_name():
     )
     rwf_id = response["id"]
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=rwf_id, step="step-1"
+        running_workflow_id=rwf_id, step="step-1", instance_id=_I_ID
     )
     rwfs_id = response["id"]
     response = utaa.create_instance(running_workflow_step_id=rwfs_id)
@@ -438,7 +438,7 @@ def test_get_running_workflow_step_by_name():
     )
     rwf_id = response["id"]
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=rwf_id, step="step-2"
+        running_workflow_id=rwf_id, step="step-2", instance_id=_I_ID
     )
     rwfs_id = response["id"]
 
@@ -464,7 +464,7 @@ def test_mock_get_running_workflow_step_output_values_for_output():
         variables={},
     )
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
 
     # Act
@@ -494,7 +494,7 @@ def test_basic_get_running_workflow_step_output_values_for_output_when_step_vari
         variables={},
     )
     response, _ = utaa.create_running_workflow_step(
-        running_workflow_id=response["id"], step="step-1"
+        running_workflow_id=response["id"], step="step-1", instance_id=_I_ID
     )
 
     # Act

tests/wapi_adapter.py

@@ -159,9 +159,9 @@ def create_running_workflow_step(
         *,
         running_workflow_id: str,
         step: str,
+        instance_id: str,
         replica: int = 0,
         replicas: int = 1,
-        prior_running_workflow_step_id: str | None = None,
     ) -> tuple[dict[str, Any], int]:
         assert replica >= 0
         assert replicas > replica
@@ -182,11 +182,8 @@ def create_running_workflow_step(
             "replicas": replicas,
             "variables": {},
             "running_workflow": {"id": running_workflow_id},
+            "instance_id": instance_id,
         }
-        if prior_running_workflow_step_id:
-            record["prior_running_workflow_step"] = {
-                "id": prior_running_workflow_step_id
-            }
         running_workflow_step[running_workflow_step_id] = record
 
         with open(_RUNNING_WORKFLOW_STEP_PICKLE_FILE, "wb") as pickle_file:
@@ -347,17 +344,30 @@ def create_running_workflow(
 
         return {"id": running_workflow_id}
 
-    def create_instance(self, *, running_workflow_step_id: str) -> dict[str, Any]:
+    def create_instance(self) -> dict[str, Any]:
         UnitTestWorkflowAPIAdapter.lock.acquire()
         with open(_INSTANCE_PICKLE_FILE, "rb") as pickle_file:
             instances = Unpickler(pickle_file).load()
 
         next_id: int = len(instances) + 1
         instance_id: str = _INSTANCE_ID_FORMAT.format(id=next_id)
-        record = {
-            "running_workflow_step_id": running_workflow_step_id,
-        }
-        instances[instance_id] = record
+
+        with open(_INSTANCE_PICKLE_FILE, "wb") as pickle_file:
+            Pickler(pickle_file).dump(instances)
+
+        UnitTestWorkflowAPIAdapter.lock.release()
+
+        return {"id": instance_id}
+
+    def set_instance_running_workflow_id(
+        self, *, instance_id: str, running_workflow_step_id: str
+    ) -> None:
+        UnitTestWorkflowAPIAdapter.lock.acquire()
+        with open(_INSTANCE_PICKLE_FILE, "rb") as pickle_file:
+            instances = Unpickler(pickle_file).load()
+
+        assert instance_id in instances
+        instances["running_workflow_step_id"] = running_workflow_step_id
 
         with open(_INSTANCE_PICKLE_FILE, "wb") as pickle_file:
             Pickler(pickle_file).dump(instances)
@@ -374,8 +384,6 @@ def create_instance(self, *, running_workflow_step_id: str) -> dict[str, Any]:
 
         UnitTestWorkflowAPIAdapter.lock.release()
 
-        return {"id": instance_id}
-
     def get_running_workflow_steps(self, *, running_workflow_id: str) -> dict[str, Any]:
         UnitTestWorkflowAPIAdapter.lock.acquire()
         with open(_RUNNING_WORKFLOW_STEP_PICKLE_FILE, "rb") as pickle_file: