refactor: Further API refinements

Author: Alan Christie

tests/test_test_api_adapter.py

@@ -276,17 +276,3 @@ def test_create_task():
 
     # Assert
     assert "id" in response
-
-
-def test_create_and_get_task():
-    # Arrange
-    utaa = UnitTestWorkflowAPIAdapter()
-    response = utaa.create_task()
-    task_id = response["id"]
-
-    # Act
-    response = utaa.get_task(task_id=task_id)
-
-    # Assert
-    assert not response["done"]
-    assert response["exit_code"] == 0

tests/wapi_adapter.py

@@ -80,21 +80,6 @@ def __init__(self):
                 Pickler(pickle_file).dump({})
         UnitTestWorkflowAPIAdapter.lock.release()
 
-    def create_workflow(self, *, workflow_definition: dict[str, Any]) -> dict[str, Any]:
-        UnitTestWorkflowAPIAdapter.lock.acquire()
-        with open(_WORKFLOW_PICKLE_FILE, "rb") as pickle_file:
-            workflow = Unpickler(pickle_file).load()
-
-        next_id: int = len(workflow) + 1
-        workflow_definition_id: str = _WORKFLOW_DEFINITION_ID_FORMAT.format(id=next_id)
-        workflow[workflow_definition_id] = workflow_definition
-
-        with open(_WORKFLOW_PICKLE_FILE, "wb") as pickle_file:
-            Pickler(pickle_file).dump(workflow)
-        UnitTestWorkflowAPIAdapter.lock.release()
-
-        return {"id": workflow_definition_id}
-
     def get_workflow(self, *, workflow_id: str) -> dict[str, Any]:
         UnitTestWorkflowAPIAdapter.lock.acquire()
         with open(_WORKFLOW_PICKLE_FILE, "rb") as pickle_file:
@@ -103,40 +88,6 @@ def get_workflow(self, *, workflow_id: str) -> dict[str, Any]:
 
         return {"workflow": workflow[workflow_id]} if workflow_id in workflow else {}
 
-    def create_running_workflow(
-        self,
-        *,
-        user_id: str,
-        workflow_id: str,
-        project_id: str,
-        variables: dict[str, Any],
-    ) -> dict[str, Any]:
-        assert user_id
-        assert isinstance(variables, dict)
-
-        UnitTestWorkflowAPIAdapter.lock.acquire()
-        with open(_RUNNING_WORKFLOW_PICKLE_FILE, "rb") as pickle_file:
-            running_workflow = Unpickler(pickle_file).load()
-
-        next_id: int = len(running_workflow) + 1
-        running_workflow_id: str = _RUNNING_WORKFLOW_ID_FORMAT.format(id=next_id)
-        record = {
-            "user_id": user_id,
-            "user_api_token": "123456789",
-            "done": False,
-            "success": False,
-            "workflow": workflow_id,
-            "project_id": project_id,
-            "variables": variables,
-        }
-        running_workflow[running_workflow_id] = record
-
-        with open(_RUNNING_WORKFLOW_PICKLE_FILE, "wb") as pickle_file:
-            Pickler(pickle_file).dump(running_workflow)
-        UnitTestWorkflowAPIAdapter.lock.release()
-
-        return {"id": running_workflow_id}
-
     def get_running_workflow(self, *, running_workflow_id: str) -> dict[str, Any]:
         UnitTestWorkflowAPIAdapter.lock.acquire()
         with open(_RUNNING_WORKFLOW_PICKLE_FILE, "rb") as pickle_file:
@@ -251,14 +202,6 @@ def get_instance(self, *, instance_id: str) -> dict[str, Any]:
 
         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"]
@@ -270,9 +213,58 @@ def get_job(self, *, collection: str, job: str, version: str) -> dict[str, Any]:
             response["variables"] = jd["variables"]
         return response
 
-    # Methods required for the UnitTestInstanceLauncher
+    # Methods required for the UnitTestInstanceLauncher and other (internal) logic
     # but not exposed to (or required by) the Workflow Engine...
 
+    def create_workflow(self, *, workflow_definition: dict[str, Any]) -> dict[str, Any]:
+        UnitTestWorkflowAPIAdapter.lock.acquire()
+        with open(_WORKFLOW_PICKLE_FILE, "rb") as pickle_file:
+            workflow = Unpickler(pickle_file).load()
+
+        next_id: int = len(workflow) + 1
+        workflow_definition_id: str = _WORKFLOW_DEFINITION_ID_FORMAT.format(id=next_id)
+        workflow[workflow_definition_id] = workflow_definition
+
+        with open(_WORKFLOW_PICKLE_FILE, "wb") as pickle_file:
+            Pickler(pickle_file).dump(workflow)
+        UnitTestWorkflowAPIAdapter.lock.release()
+
+        return {"id": workflow_definition_id}
+
+    def create_running_workflow(
+        self,
+        *,
+        user_id: str,
+        workflow_id: str,
+        project_id: str,
+        variables: dict[str, Any],
+    ) -> dict[str, Any]:
+        assert user_id
+        assert isinstance(variables, dict)
+
+        UnitTestWorkflowAPIAdapter.lock.acquire()
+        with open(_RUNNING_WORKFLOW_PICKLE_FILE, "rb") as pickle_file:
+            running_workflow = Unpickler(pickle_file).load()
+
+        next_id: int = len(running_workflow) + 1
+        running_workflow_id: str = _RUNNING_WORKFLOW_ID_FORMAT.format(id=next_id)
+        record = {
+            "user_id": user_id,
+            "user_api_token": "123456789",
+            "done": False,
+            "success": False,
+            "workflow": workflow_id,
+            "project_id": project_id,
+            "variables": variables,
+        }
+        running_workflow[running_workflow_id] = record
+
+        with open(_RUNNING_WORKFLOW_PICKLE_FILE, "wb") as pickle_file:
+            Pickler(pickle_file).dump(running_workflow)
+        UnitTestWorkflowAPIAdapter.lock.release()
+
+        return {"id": running_workflow_id}
+
     def create_instance(self, *, running_workflow_step_id: str) -> dict[str, Any]:
         UnitTestWorkflowAPIAdapter.lock.acquire()
         with open(_INSTANCE_PICKLE_FILE, "rb") as pickle_file:

workflow/workflow_abc.py

@@ -74,18 +74,6 @@ class WorkflowAPIAdapter(ABC):
     Workflow, RunningWorkflow and RunningWorkflowStep records returning dictionary
     (API-like) responses."""
 
-    @abstractmethod
-    def create_workflow(
-        self,
-        *,
-        workflow_definition: dict[str, Any],
-    ) -> dict[str, Any]:
-        """Create a Workflow, getting an ID in return"""
-        # Should return:
-        # {
-        #    "id": "workflow-00000000-0000-0000-0000-000000000001",
-        # }
-
     @abstractmethod
     def get_workflow(
         self,
@@ -99,21 +87,6 @@ def get_workflow(
         # }
         # If not present an empty dictionary should be returned.
 
-    @abstractmethod
-    def create_running_workflow(
-        self,
-        *,
-        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:
-        # {
-        #    "id": "r-workflow-00000000-0000-0000-0000-000000000001",
-        # }
-
     @abstractmethod
     def get_running_workflow(self, *, running_workflow_id: str) -> dict[str, Any]:
         """Get a RunningWorkflow Record"""
@@ -220,17 +193,6 @@ def get_instance(self, *, instance_id: str) -> dict[str, Any]:
         # }
         # If not present an empty dictionary should be returned.
 
-    @abstractmethod
-    def get_task(self, *, task_id: str) -> dict[str, Any]:
-        """Get a Task Record"""
-        # Should return:
-        # {
-        #    "done": True,
-        #    "exit_code": 0,
-        #    [...],
-        # }
-        # If not present an empty dictionary should be returned.
-
     @abstractmethod
     def get_job(
         self,