refactor: Further reafctoring (launcher params etc.)

Author: Alan Christie

tests/instance_launcher.py

@@ -126,9 +126,6 @@ def launch(self, launch_parameters: LaunchParameters) -> LaunchResult:
         self._msg_dispatcher.send(pod_message)
 
         return LaunchResult(
-            # The errors returned here are the launch errors, not the Job's errors.
-            error=0,
-            error_msg=None,
             instance_id=instance_id,
             task_id=task_id,
             command=" ".join(subprocess_cmd),

tests/test_test_instance_launcher.py

@@ -44,7 +44,7 @@ def test_launch_nop(basic_launcher):
         project_id=TEST_PROJECT_ID,
         application_id=DM_JOB_APPLICATION_ID,
         name="Test Instance",
-        launch_username="dlister",
+        launching_user_name="dlister",
         running_workflow_id=rwfid,
         running_workflow_step_id=rwfsid,
         specification={"collection": "workflow-engine-unit-test-jobs", "job": "nop"},
@@ -55,7 +55,7 @@ def test_launch_nop(basic_launcher):
     result = launcher.launch(lp)
 
     # Assert
-    assert result.error == 0
+    assert result.error_num == 0
     assert result.command.startswith("python ")
     assert result.command.endswith("tests/jobs/nop.py")
 
@@ -80,7 +80,7 @@ def test_launch_nop_fail(basic_launcher):
         project_id=TEST_PROJECT_ID,
         application_id=DM_JOB_APPLICATION_ID,
         name="Test Instance",
-        launch_username="dlister",
+        launching_user_name="dlister",
         running_workflow_id=rwfid,
         running_workflow_step_id=rwfsid,
         specification={
@@ -94,7 +94,7 @@ def test_launch_nop_fail(basic_launcher):
     result = launcher.launch(lp)
 
     # Assert
-    assert result.error == 0
+    assert result.error_num == 0
     assert result.command.startswith("python ")
     assert result.command.endswith("tests/jobs/nop-fail.py")
 
@@ -119,7 +119,7 @@ def test_launch_smiles_to_file(basic_launcher):
         project_id=TEST_PROJECT_ID,
         application_id=DM_JOB_APPLICATION_ID,
         name="Test Instance",
-        launch_username="dlister",
+        launching_user_name="dlister",
         running_workflow_id=rwfid,
         running_workflow_step_id=rwfsid,
         specification={
@@ -133,7 +133,7 @@ def test_launch_smiles_to_file(basic_launcher):
     result = launcher.launch(lp)
 
     # Assert
-    assert result.error == 0
+    assert result.error_num == 0
     assert result.command.startswith("python ")
     assert result.command.endswith(
         "tests/jobs/smiles-to-file.py --smiles C1=CC=CC=C1 --output output.smi"

workflow/workflow_abc.py

@@ -16,7 +16,7 @@ class LaunchParameters:
     project_id: str
     application_id: str
     name: str
-    launch_username: str
+    launching_user_name: str
     specification: dict[str, Any]
     specification_variables: dict[str, Any] | None = None
     debug: bool | None = None
@@ -30,9 +30,10 @@ class LaunchParameters:
 
 @dataclass
 class LaunchResult:
-    """Results returned from methods in the InstanceLauncher."""
+    """Results returned from methods in the InstanceLauncher.
+    Any error returned in this object is a launch error, not a Job error."""
 
-    error: int
+    error_num: int = 0
     error_msg: str | None = None
     instance_id: str | None = None
     task_id: str | None = None

workflow/workflow_engine.py

@@ -107,7 +107,7 @@ def _handle_workflow_start_message(self, r_wfid: str) -> None:
         assert "running_workflow" in response
         running_workflow = response["running_workflow"]
         assert "user_id" in running_workflow
-        launch_username: str = running_workflow["user_id"]
+        launching_user_name: str = running_workflow["user_id"]
         _LOGGER.debug("RunningWorkflow: %s", running_workflow)
         # Now get the workflow definition (to get all the steps)
         wfid = running_workflow["workflow"]["id"]
@@ -138,16 +138,16 @@ def _handle_workflow_start_message(self, r_wfid: str) -> None:
             project_id=project_id,
             application_id=DM_JOB_APPLICATION_ID,
             name=first_step_name,
-            launch_username=launch_username,
+            launching_user_name=launching_user_name,
             specification=json.loads(first_step["specification"]),
             specification_variables=variables,
             running_workflow_id=r_wfid,
             running_workflow_step_id=r_wfsid,
         )
         lr: LaunchResult = self._instance_launcher.launch(lp)
-        if lr.error:
+        if lr.error_num:
             self._set_step_error(
-                first_step_name, r_wfid, r_wfsid, lr.error, lr.error_msg
+                first_step_name, r_wfid, r_wfsid, lr.error_num, lr.error_msg
             )
         else:
             _LOGGER.info(
@@ -245,20 +245,20 @@ def _handle_pod_message(self, msg: PodMessage) -> None:
                         project_id=project_id,
                         application_id=DM_JOB_APPLICATION_ID,
                         name=next_step_name,
-                        launch_username=running_workflow["user_id"],
+                        launching_user_name=running_workflow["user_id"],
                         specification=json.loads(next_step["specification"]),
                         specification_variables=variables,
                         running_workflow_id=r_wfid,
                         running_workflow_step_id=r_wfsid,
                     )
                     lr = self._instance_launcher.launch(lp)
                     # Handle a launch error?
-                    if lr.error:
+                    if lr.error_num:
                         self._set_step_error(
                             next_step_name,
                             r_wfid,
                             r_wfsid,
-                            lr.error,
+                            lr.error_num,
                             lr.error_msg,
                         )
                     else: