refactor: DB adapter now API adapter

Author: Alan Christie

tests/database_adapter.py renamed to tests/api_adapter.py

@@ -3,7 +3,7 @@
 
 import yaml
 
-from workflow.workflow_abc import DatabaseAdapter
+from workflow.workflow_abc import APIAdapter
 
 # Load the Unit test Job Definitions file now.
 _JOB_DEFINITION_FILE: str = os.path.join(
@@ -20,8 +20,8 @@
 )
 
 
-class UnitTestDatabaseAdapter(DatabaseAdapter):
-    """A minimal Database adapter. It serves-up Job Definitions
+class UnitTestAPIAdapter(APIAdapter):
+    """A minimal API 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."""
 

tests/test_test_database_adapter.py renamed to tests/test_test_api_adapter.py

@@ -4,15 +4,15 @@
 
 pytestmark = pytest.mark.unit
 
-from tests.database_adapter import UnitTestDatabaseAdapter
+from tests.api_adapter import UnitTestAPIAdapter
 
 
 def test_get_nop_job():
     # Arrange
-    utda = UnitTestDatabaseAdapter()
+    utaa = UnitTestAPIAdapter()
 
     # Act
-    jd = utda.get_job(
+    jd = utaa.get_job(
         collection="workflow-engine-unit-test-jobs", job="nop", version="1.0.0"
     )
 
@@ -22,10 +22,10 @@ def test_get_nop_job():
 
 def test_get_unknown_workflow():
     # Arrange
-    utda = UnitTestDatabaseAdapter()
+    utaa = UnitTestAPIAdapter()
 
     # Act
-    wfd = utda.get_workflow(
+    wfd = utaa.get_workflow(
         workflow_definition_id="workflow-00000000-0000-0000-0000-000000000001"
     )
 
@@ -35,35 +35,35 @@ def test_get_unknown_workflow():
 
 def test_save_workflow():
     # Arrange
-    utda = UnitTestDatabaseAdapter()
+    utaa = UnitTestAPIAdapter()
 
     # Act
-    wfid = utda.save_workflow(workflow_definition={"name": "blah"})
+    wfid = utaa.save_workflow(workflow_definition={"name": "blah"})
 
     # Assert
     assert wfid == {"id": "workflow-00000000-0000-0000-0000-000000000001"}
 
 
 def test_get_workflow():
     # Arrange
-    utda = UnitTestDatabaseAdapter()
-    response = utda.save_workflow(workflow_definition={"name": "blah"})
+    utaa = UnitTestAPIAdapter()
+    response = utaa.save_workflow(workflow_definition={"name": "blah"})
     wfid = response["id"]
 
     # Act
-    wf = utda.get_workflow(workflow_definition_id=wfid)
+    wf = utaa.get_workflow(workflow_definition_id=wfid)
 
     # Assert
     assert wf["workflow"]["name"] == "blah"
 
 
 def test_get_workflow_by_name():
     # Arrange
-    utda = UnitTestDatabaseAdapter()
-    _ = utda.save_workflow(workflow_definition={"name": "blah"})
+    utaa = UnitTestAPIAdapter()
+    _ = utaa.save_workflow(workflow_definition={"name": "blah"})
 
     # Act
-    response = utda.get_workflow_by_name(name="blah", version="1.0.0")
+    response = utaa.get_workflow_by_name(name="blah", version="1.0.0")
 
     # Assert
     assert response["workflow"]["name"] == "blah"

tests/test_worflow_validator.py

@@ -4,7 +4,7 @@
 
 pytestmark = pytest.mark.unit
 
-from tests.database_adapter import UnitTestDatabaseAdapter
+from tests.api_adapter import UnitTestAPIAdapter
 from tests.message_dispatcher import UnitTestMessageDispatcher
 from tests.message_queue import UnitTestMessageQueue
 from tests.test_decoder_minimal import _MINIMAL_WORKFLOW
@@ -15,10 +15,10 @@
 def basic_validator():
     # A 'basic' unit-test WorkflowAdapter needs a DB adapter and Message Dispatcher.
     # For testing outside of the DM the Message Dispatcher also needs a Message Queue
-    db_adapter = UnitTestDatabaseAdapter()
+    api_adapter = UnitTestAPIAdapter()
     msg_queue = UnitTestMessageQueue()
     msg_dispatcher = UnitTestMessageDispatcher(msg_queue=msg_queue)
-    return WorkflowValidator(db_adapter=db_adapter, msg_dispatcher=msg_dispatcher)
+    return WorkflowValidator(api_adapter=api_adapter, msg_dispatcher=msg_dispatcher)
 
 
 def test_validate_minimal_for_create(basic_validator):

tests/test_workflow_engine_with_examples.py

@@ -8,7 +8,7 @@
 
 from informaticsmatters.protobuf.datamanager.workflow_message_pb2 import WorkflowMessage
 
-from tests.database_adapter import UnitTestDatabaseAdapter
+from tests.api_adapter import UnitTestAPIAdapter
 from tests.instance_launcher import UnitTestInstanceLauncher
 from tests.message_dispatcher import UnitTestMessageDispatcher
 from tests.message_queue import UnitTestMessageQueue
@@ -17,16 +17,20 @@
 
 @pytest.fixture
 def basic_engine():
-    utda = UnitTestDatabaseAdapter()
-    utmq = UnitTestMessageQueue()
-    utmd = UnitTestMessageDispatcher(msg_queue=utmq)
-    util = UnitTestInstanceLauncher(msg_dispatcher=utmd)
-    return [utda, utmd, WorkflowEngine(db_adapter=utda, instance_launcher=util)]
+    api_adapter = UnitTestAPIAdapter()
+    message_queue = UnitTestMessageQueue()
+    message_dispatcher = UnitTestMessageDispatcher(msg_queue=message_queue)
+    instance_launcher = UnitTestInstanceLauncher(msg_dispatcher=message_dispatcher)
+    return [
+        api_adapter,
+        message_dispatcher,
+        WorkflowEngine(api_adapter=api_adapter, instance_launcher=instance_launcher),
+    ]
 
 
 def test_workflow_engine_with_example_1(basic_engine):
     # Arrange
-    da, md, engine = basic_engine
+    da, md, _ = basic_engine
     # LOAD THE EXAMPLE-1 WORKFLOW DEFINITION INTO THE DATABASE
     # TODO
     # SIMULATE THE API CREATION OF A RUNNING WORKFLOW FROM THE WORKFLOW

workflow/workflow_abc.py

@@ -55,13 +55,10 @@ def launch(
         # the Data Manager will not permit the use of this parameter.
 
 
-class DatabaseAdapter(ABC):
-    """The DatabaseAdapter will not need to provide a save/commit service.
-    Instead it should be assumed that new database records are the
-    responsibility of the governing application code. The WE simply has
-    to implement engine logic and launch instance. The InstanceLauncher
-    is responsible for creating RunningWorkflow and RunningWorkflowStep
-    records for example."""
+class APIAdapter(ABC):
+    """The APIAdapter providing read/write access to the Model. It provides
+    the ability to create and retrieve Workflow, RunningWorkflow and RunningWorkflowStep
+    records returning dictionary (API-like) responses."""
 
     @abstractmethod
     def save_workflow(

workflow/workflow_engine.py

@@ -3,7 +3,7 @@
 
 from google.protobuf.message import Message
 
-from .workflow_abc import DatabaseAdapter, InstanceLauncher
+from .workflow_abc import APIAdapter, InstanceLauncher
 
 
 class WorkflowEngine:
@@ -15,11 +15,11 @@ class WorkflowEngine:
     def __init__(
         self,
         *,
-        db_adapter: DatabaseAdapter,
+        api_adapter: APIAdapter,
         instance_launcher: InstanceLauncher,
     ):
         # Keep the dependent objects
-        self._db_adapter = db_adapter
+        self._api_adapter = api_adapter
         self._instance_launcher = instance_launcher
 
     def handle_message(self, msg: Message) -> None:

workflow/worklfow_validator.py

@@ -6,7 +6,7 @@
 from typing import Any, Dict, List, Optional
 
 from .decoder import validate_schema
-from .workflow_abc import DatabaseAdapter, MessageDispatcher
+from .workflow_abc import APIAdapter, MessageDispatcher
 
 
 class ValidationLevel(Enum):
@@ -52,12 +52,10 @@ class WorkflowValidator:
     to check workflow content prior to creation and execution.
     """
 
-    def __init__(
-        self, *, db_adapter: DatabaseAdapter, msg_dispatcher: MessageDispatcher
-    ):
-        assert db_adapter
+    def __init__(self, *, api_adapter: APIAdapter, msg_dispatcher: MessageDispatcher):
+        assert api_adapter
 
-        self._db_adapter = db_adapter
+        self._api_adapter = api_adapter
         self._msg_dispatcher = msg_dispatcher
 
     def validate(