feat: Better running workflow and step records (errors and messages)

Author: Alan Christie

tests/api_adapter.py

@@ -149,7 +149,12 @@ def create_running_workflow(
         return {"id": running_workflow_id}
 
     def set_running_workflow_done(
-        self, *, running_workflow_id: str, success: bool
+        self,
+        *,
+        running_workflow_id: str,
+        success: bool,
+        error: Optional[int] = None,
+        error_msg: Optional[str] = None,
     ) -> None:
         UnitTestAPIAdapter.lock.acquire()
         with open(_RUNNING_WORKFLOW_PICKLE_FILE, "rb") as pickle_file:
@@ -158,6 +163,8 @@ def set_running_workflow_done(
         assert running_workflow_id in running_workflow
         running_workflow[running_workflow_id]["done"] = True
         running_workflow[running_workflow_id]["success"] = success
+        running_workflow[running_workflow_id]["error"] = error
+        running_workflow[running_workflow_id]["error_msg"] = error_msg
 
         with open(_RUNNING_WORKFLOW_PICKLE_FILE, "wb") as pickle_file:
             Pickler(pickle_file).dump(running_workflow)
@@ -213,7 +220,12 @@ def get_running_workflow_step(
         }
 
     def set_running_workflow_step_done(
-        self, *, running_workflow_step_id: str, success: bool
+        self,
+        *,
+        running_workflow_step_id: str,
+        success: bool,
+        error: Optional[int] = None,
+        error_msg: Optional[str] = None,
     ) -> None:
         UnitTestAPIAdapter.lock.acquire()
         with open(_RUNNING_WORKFLOW_STEP_PICKLE_FILE, "rb") as pickle_file:
@@ -222,6 +234,8 @@ def set_running_workflow_step_done(
         assert running_workflow_step_id in running_workflow_step
         running_workflow_step[running_workflow_step_id]["done"] = True
         running_workflow_step[running_workflow_step_id]["success"] = success
+        running_workflow_step[running_workflow_step_id]["error"] = error
+        running_workflow_step[running_workflow_step_id]["error_msg"] = error_msg
 
         with open(_RUNNING_WORKFLOW_STEP_PICKLE_FILE, "wb") as pickle_file:
             Pickler(pickle_file).dump(running_workflow_step)

tests/test_test_api_adapter.py

@@ -126,6 +126,8 @@ def test_set_running_workflow_done_when_success():
     response = utaa.get_running_workflow(running_workflow_id=rwfid)
     assert response["running_workflow"]["done"]
     assert response["running_workflow"]["success"]
+    assert response["running_workflow"]["error"] is None
+    assert response["running_workflow"]["error_msg"] is None
 
 
 def test_set_running_workflow_done_when_failed():
@@ -141,12 +143,16 @@ def test_set_running_workflow_done_when_failed():
     rwfid = response["id"]
 
     # Act
-    utaa.set_running_workflow_done(running_workflow_id=rwfid, success=False)
+    utaa.set_running_workflow_done(
+        running_workflow_id=rwfid, success=False, error=1, error_msg="Bang!"
+    )
 
     # Assert
     response = utaa.get_running_workflow(running_workflow_id=rwfid)
     assert response["running_workflow"]["done"]
     assert not response["running_workflow"]["success"]
+    assert response["running_workflow"]["error"] == 1
+    assert response["running_workflow"]["error_msg"] == "Bang!"
 
 
 def test_create_running_workflow_step():
@@ -169,6 +175,60 @@ def test_create_running_workflow_step():
     assert response["id"] == "r-workflow-step-00000000-0000-0000-0000-000000000001"
 
 
+def test_set_running_workflow_step_done_when_success():
+    # Arrange
+    utaa = UnitTestAPIAdapter()
+    response = utaa.create_workflow(workflow_definition={"name": "blah"})
+    response = utaa.create_running_workflow(
+        user_id="dlister",
+        workflow_id=response["id"],
+        project_id=TEST_PROJECT_ID,
+        variables={},
+    )
+    response = utaa.create_running_workflow_step(
+        running_workflow_id=response["id"], step="step-1"
+    )
+    rwfsid = response["id"]
+
+    # Act
+    utaa.set_running_workflow_step_done(running_workflow_step_id=rwfsid, success=True)
+
+    # Assert
+    response = utaa.get_running_workflow_step(running_workflow_step_id=rwfsid)
+    assert response["running_workflow_step"]["done"]
+    assert response["running_workflow_step"]["success"]
+    assert response["running_workflow_step"]["error"] is None
+    assert response["running_workflow_step"]["error_msg"] is None
+
+
+def test_set_running_workflow_step_done_when_failed():
+    # Arrange
+    utaa = UnitTestAPIAdapter()
+    response = utaa.create_workflow(workflow_definition={"name": "blah"})
+    response = utaa.create_running_workflow(
+        user_id="dlister",
+        workflow_id=response["id"],
+        project_id=TEST_PROJECT_ID,
+        variables={},
+    )
+    response = utaa.create_running_workflow_step(
+        running_workflow_id=response["id"], step="step-1"
+    )
+    rwfsid = response["id"]
+
+    # Act
+    utaa.set_running_workflow_step_done(
+        running_workflow_step_id=rwfsid, success=False, error=1, error_msg="Bang!"
+    )
+
+    # Assert
+    response = utaa.get_running_workflow_step(running_workflow_step_id=rwfsid)
+    assert response["running_workflow_step"]["done"]
+    assert not response["running_workflow_step"]["success"]
+    assert response["running_workflow_step"]["error"] == 1
+    assert response["running_workflow_step"]["error_msg"] == "Bang!"
+
+
 def test_get_running_workflow_step():
     # Arrange
     utaa = UnitTestAPIAdapter()

workflow/workflow_abc.py

@@ -108,9 +108,15 @@ def create_running_workflow(
 
     @abstractmethod
     def set_running_workflow_done(
-        self, *, running_workflow_id: str, success: bool
+        self,
+        *,
+        running_workflow_id: str,
+        success: bool,
+        error: Optional[int] = None,
+        error_msg: Optional[str] = None,
     ) -> None:
-        """Set the success value for a RunningWorkflow Record"""
+        """Set the success value for a RunningWorkflow Record.
+        If not successful an error code and message should be provided."""
 
     @abstractmethod
     def get_running_workflow(self, *, running_workflow_id: str) -> Dict[str, Any]:
@@ -121,6 +127,8 @@ def get_running_workflow(self, *, running_workflow_id: str) -> Dict[str, Any]:
         #       "user_id": "alan",
         #       "done": False,
         #       "success": false,
+        #       "error": None,
+        #       "error_msg": None,
         #       "workflow": {"id": "workflow-000"},
         #       "project_id": "project-000",
         #       "variables": {"x": 1, "y": 2},
@@ -151,15 +159,23 @@ def get_running_workflow_step(
         #       "step:": "step-1234",
         #       "done": False,
         #       "success": false,
-        #       "running_workflow": "r-workflow-000",
+        #       "error": None,
+        #       "error_msg": None,
+        #       "running_workflow": "r-workflow-00000000-0000-0000-0000-000000000001",
         #    },
         # }
 
     @abstractmethod
     def set_running_workflow_step_done(
-        self, *, running_workflow_step_id: str, success: bool
+        self,
+        *,
+        running_workflow_step_id: str,
+        success: bool,
+        error: Optional[int] = None,
+        error_msg: Optional[str] = None,
     ) -> None:
-        """Set the success value for a RunningWorkflowStep Record"""
+        """Set the success value for a RunningWorkflowStep Record,
+        If not successful an error code and message should be provided."""
 
     @abstractmethod
     def get_running_workflow_steps(
@@ -176,7 +192,9 @@ def get_running_workflow_steps(
         #               "step:": "step-1234",
         #               "done": False,
         #               "success": false,
-        #               "workflow": "workflow-000",
+        #               "error": None,
+        #               "error_msg": None,
+        #               "workflow": "workflow-00000000-0000-0000-0000-000000000001",
         #           }
         #       ...
         #    ]