test: Unit Test DB adapter now able to save and get workflows

Author: Alan Christie

tests/database_adapter.py

@@ -13,18 +13,35 @@
     _JOB_DEFINITIONS: Dict[str, Any] = yaml.load(jd_file, Loader=yaml.FullLoader)
 assert _JOB_DEFINITIONS
 
+_WORKFLOW_DEFINITION_ID_FORMAT: str = "workflow-00000000-0000-0000-0000-{id:012d}"
+
 
 class UnitTestDatabaseAdapter(DatabaseAdapter):
-    """A minimal Database adapter simply to serve-up Job Definitions
-    from the job-definitions/job-definitions.yaml file."""
+    """A minimal Database adapter. It serves-up Job Definitions
+    from the job-definitions/job-definitions.yaml file and provides basic
+    (in-memory) storage for Workflow Definitions and related tables."""
+
+    def __init__(self):
+        super().__init__()
+        # A map of workflow definitions, keyed by workflow definition ID.
+        self._workflow_definitions: Dict[str, Dict[str, Any]] = {}
+
+    def save_workflow(self, *, workflow_definition: Dict[str, Any]) -> str:
+        next_id: int = len(self._workflow_definitions) + 1
+        workflow_definition_id: str = _WORKFLOW_DEFINITION_ID_FORMAT.format(id=next_id)
+        self._workflow_definitions[workflow_definition_id] = workflow_definition
+        return workflow_definition_id
 
     def get_workflow(self, *, workflow_definition_id: str) -> Optional[Dict[str, Any]]:
-        return {}
+        return self._workflow_definitions.get(workflow_definition_id, None)
 
     def get_workflow_by_name(
         self, *, name: str, version: str
     ) -> Optional[Dict[str, Any]]:
-        return {}
+        return next(
+            (wd for wd in self._workflow_definitions.values() if wd["name"] == name),
+            None,
+        )
 
     def get_job(
         self, *, collection: str, job: str, version: str

tests/test_test_database_adapter.py

@@ -18,3 +18,51 @@ def test_get_nop_job():
 
     # Assert
     assert jd["command"] == "python --version"
+
+
+def test_get_unknown_workflow():
+    # Arrange
+    utda = UnitTestDatabaseAdapter()
+
+    # Act
+    wfid = utda.get_workflow(
+        workflow_definition_id="workflow-00000000-0000-0000-0000-000000000001"
+    )
+
+    # Assert
+    assert wfid is None
+
+
+def test_save_workflow():
+    # Arrange
+    utda = UnitTestDatabaseAdapter()
+
+    # Act
+    wfid = utda.save_workflow(workflow_definition={"name": "blah"})
+
+    # Assert
+    assert wfid == "workflow-00000000-0000-0000-0000-000000000001"
+
+
+def test_get_workflow():
+    # Arrange
+    utda = UnitTestDatabaseAdapter()
+    wfid = utda.save_workflow(workflow_definition={"name": "blah"})
+
+    # Act
+    wf = utda.get_workflow(workflow_definition_id=wfid)
+
+    # Assert
+    assert wf == {"name": "blah"}
+
+
+def test_get_workflow_by_name():
+    # Arrange
+    utda = UnitTestDatabaseAdapter()
+    wfid = utda.save_workflow(workflow_definition={"name": "blah"})
+
+    # Act
+    wf = utda.get_workflow_by_name(name="blah", version="1.0.0")
+
+    # Assert
+    assert wf == {"name": "blah"}

workflow/workflow_abc.py

@@ -63,6 +63,14 @@ class DatabaseAdapter(ABC):
     is responsible for creating RunningWorkflow and RunningWorkflowStep
     records for example."""
 
+    @abstractmethod
+    def save_workflow(
+        self,
+        *,
+        workflow_definition: Dict[str, Any],
+    ) -> str:
+        """Save a Workflow, getting an ID in return"""
+
     @abstractmethod
     def get_workflow(
         self,