style: API Adapter no longer required create instance/task (these are internal to instance launcher)

Author: Alan Christie

tests/instance_launcher.py

@@ -80,7 +80,7 @@ def launch(self, launch_parameters: LaunchParameters) -> LaunchResult:
             running_workflow_step_id=launch_parameters.running_workflow_step_id
         )
         instance_id = response["id"]
-        response = self._api_adapter.create_task(instance_id=instance_id)
+        response = self._api_adapter.create_task()
         task_id = response["id"]
 
         # Apply variables to the step's Job command.

tests/test_test_api_adapter.py

@@ -272,7 +272,7 @@ def test_create_task():
     utaa = UnitTestWorkflowAPIAdapter()
 
     # Act
-    response = utaa.create_task(instance_id="instance-000")
+    response = utaa.create_task()
 
     # Assert
     assert "id" in response
@@ -281,7 +281,7 @@ def test_create_task():
 def test_create_and_get_task():
     # Arrange
     utaa = UnitTestWorkflowAPIAdapter()
-    response = utaa.create_task(instance_id="instance-000")
+    response = utaa.create_task()
     task_id = response["id"]
 
     # Act

tests/wapi_adapter.py

@@ -243,6 +243,36 @@ def get_running_workflow_steps(self, *, running_workflow_id: str) -> dict[str, A
                 steps.append(item)
         return {"count": len(steps), "running_workflow_steps": steps}
 
+    def get_instance(self, *, instance_id: str) -> dict[str, Any]:
+        UnitTestWorkflowAPIAdapter.lock.acquire()
+        with open(_INSTANCE_PICKLE_FILE, "rb") as pickle_file:
+            instances = Unpickler(pickle_file).load()
+        UnitTestWorkflowAPIAdapter.lock.release()
+
+        return {} if instance_id not in instances else instances[instance_id]
+
+    def get_task(self, *, task_id: str) -> dict[str, Any]:
+        UnitTestWorkflowAPIAdapter.lock.acquire()
+        with open(_TASK_PICKLE_FILE, "rb") as pickle_file:
+            tasks = Unpickler(pickle_file).load()
+        UnitTestWorkflowAPIAdapter.lock.release()
+
+        return {} if task_id not in tasks else tasks[task_id]
+
+    def get_job(self, *, collection: str, job: str, version: str) -> dict[str, Any]:
+        assert collection == _JOB_DEFINITIONS["collection"]
+        assert job in _JOB_DEFINITIONS["jobs"]
+        assert version
+
+        jd = _JOB_DEFINITIONS["jobs"][job]
+        response = {"command": jd["command"]}
+        if "variables" in jd:
+            response["variables"] = jd["variables"]
+        return response
+
+    # Methods required for the UnitTestInstanceLauncher
+    # but not exposed to (or required by) the Workflow Engine...
+
     def create_instance(self, *, running_workflow_step_id: str) -> dict[str, Any]:
         UnitTestWorkflowAPIAdapter.lock.acquire()
         with open(_INSTANCE_PICKLE_FILE, "rb") as pickle_file:
@@ -261,15 +291,7 @@ def create_instance(self, *, running_workflow_step_id: str) -> dict[str, Any]:
 
         return {"id": instance_id}
 
-    def get_instance(self, *, instance_id: str) -> dict[str, Any]:
-        UnitTestWorkflowAPIAdapter.lock.acquire()
-        with open(_INSTANCE_PICKLE_FILE, "rb") as pickle_file:
-            instances = Unpickler(pickle_file).load()
-        UnitTestWorkflowAPIAdapter.lock.release()
-
-        return {} if instance_id not in instances else instances[instance_id]
-
-    def create_task(self, *, instance_id: str) -> dict[str, Any]:
+    def create_task(self) -> dict[str, Any]:
         UnitTestWorkflowAPIAdapter.lock.acquire()
         with open(_TASK_PICKLE_FILE, "rb") as pickle_file:
             tasks = Unpickler(pickle_file).load()
@@ -287,22 +309,3 @@ def create_task(self, *, instance_id: str) -> dict[str, Any]:
         UnitTestWorkflowAPIAdapter.lock.release()
 
         return {"id": task_id}
-
-    def get_task(self, *, task_id: str) -> dict[str, Any]:
-        UnitTestWorkflowAPIAdapter.lock.acquire()
-        with open(_TASK_PICKLE_FILE, "rb") as pickle_file:
-            tasks = Unpickler(pickle_file).load()
-        UnitTestWorkflowAPIAdapter.lock.release()
-
-        return {} if task_id not in tasks else tasks[task_id]
-
-    def get_job(self, *, collection: str, job: str, version: str) -> dict[str, Any]:
-        assert collection == _JOB_DEFINITIONS["collection"]
-        assert job in _JOB_DEFINITIONS["jobs"]
-        assert version
-
-        jd = _JOB_DEFINITIONS["jobs"][job]
-        response = {"command": jd["command"]}
-        if "variables" in jd:
-            response["variables"] = jd["variables"]
-        return response

workflow/workflow_abc.py

@@ -210,15 +210,6 @@ def get_running_workflow_steps(self, *, running_workflow_id: str) -> dict[str, A
         # }
         # If there are not steps an empty dictionary should be returned and a count of 0
 
-    @abstractmethod
-    def create_instance(self, running_workflow_step_id: str) -> dict[str, Any]:
-        """Create an Instance Record (for a RunningWorkflowStep)"""
-        # Should return:
-        # {
-        #    "instance_id": "instance-00000000-0000-0000-0000-000000000001",
-        #    "task_id": "task-00000000-0000-0000-0000-000000000001",
-        # }
-
     @abstractmethod
     def get_instance(self, *, instance_id: str) -> dict[str, Any]:
         """Get an Instance Record"""
@@ -229,14 +220,6 @@ def get_instance(self, *, instance_id: str) -> dict[str, Any]:
         # }
         # If not present an empty dictionary should be returned.
 
-    @abstractmethod
-    def create_task(self, instance_id: str) -> dict[str, Any]:
-        """Create a Task Record (for an Instance)"""
-        # Should return:
-        # {
-        #    "id": "task-00000000-0000-0000-0000-000000000001",
-        # }
-
     @abstractmethod
     def get_task(self, *, task_id: str) -> dict[str, Any]:
         """Get a Task Record"""