Skip to content

Merge out from main #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 28, 2025
Merged

Merge out from main #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a920a0
docs: Doc tweaks
Mar 28, 2025
1d2dad6
style: Consistent style with error numbers
Mar 28, 2025
b1f362b
Merge pull request #12 from InformaticsMatters/prototype-work-alan
alanbchristie Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions tests/test_test_api_adapter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ def test_set_running_workflow_done_when_success():
response, _ = utaa.get_running_workflow(running_workflow_id=rwfid)
assert response["done"]
assert response["success"]
assert response["error"] is None
assert response["error_num"] is None
assert response["error_msg"] is None


Expand All @@ -132,14 +132,14 @@ def test_set_running_workflow_done_when_failed():

# Act
utaa.set_running_workflow_done(
running_workflow_id=rwfid, success=False, error=1, error_msg="Bang!"
running_workflow_id=rwfid, success=False, error_num=1, error_msg="Bang!"
)

# Assert
response, _ = utaa.get_running_workflow(running_workflow_id=rwfid)
assert response["done"]
assert not response["success"]
assert response["error"] == 1
assert response["error_num"] == 1
assert response["error_msg"] == "Bang!"


Expand Down Expand Up @@ -210,7 +210,7 @@ def test_set_running_workflow_step_done_when_success():
response, _ = utaa.get_running_workflow_step(running_workflow_step_id=rwfsid)
assert response["done"]
assert response["success"]
assert response["error"] is None
assert response["error_num"] is None
assert response["error_msg"] is None
assert response["variables"] == {}

Expand All @@ -232,14 +232,14 @@ def test_set_running_workflow_step_done_when_failed():

# Act
utaa.set_running_workflow_step_done(
running_workflow_step_id=rwfsid, success=False, error=1, error_msg="Bang!"
running_workflow_step_id=rwfsid, success=False, error_num=1, error_msg="Bang!"
)

# Assert
response, _ = utaa.get_running_workflow_step(running_workflow_step_id=rwfsid)
assert response["done"]
assert not response["success"]
assert response["error"] == 1
assert response["error_num"] == 1
assert response["error_msg"] == "Bang!"


Expand Down
8 changes: 4 additions & 4 deletions tests/wapi_adapter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def set_running_workflow_done(
*,
running_workflow_id: str,
success: bool,
error: int | None = None,
error_num: int | None = None,
error_msg: str | None = None,
) -> None:
UnitTestWorkflowAPIAdapter.lock.acquire()
Expand All @@ -115,7 +115,7 @@ 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_num"] = error_num
running_workflow[running_workflow_id]["error_msg"] = error_msg

with open(_RUNNING_WORKFLOW_PICKLE_FILE, "wb") as pickle_file:
Expand Down Expand Up @@ -184,7 +184,7 @@ def set_running_workflow_step_done(
*,
running_workflow_step_id: str,
success: bool,
error: int | None = None,
error_num: int | None = None,
error_msg: str | None = None,
) -> None:
UnitTestWorkflowAPIAdapter.lock.acquire()
Expand All @@ -194,7 +194,7 @@ 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_num"] = error_num
running_workflow_step[running_workflow_step_id]["error_msg"] = error_msg

with open(_RUNNING_WORKFLOW_STEP_PICKLE_FILE, "wb") as pickle_file:
Expand Down
19 changes: 7 additions & 12 deletions workflow/workflow_abc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@ def get_running_workflow(
# "running_user_api_token": "123456789",
# "done": False,
# "success": false,
# "error": None,
# "error_msg": None,
# "error_num": 0,
# "error_msg": "",
# "workflow": {
# "id": "workflow-000",
# },
Expand All @@ -155,7 +155,7 @@ def set_running_workflow_done(
*,
running_workflow_id: str,
success: bool,
error: int | None = None,
error_num: int | None = None,
error_msg: str | None = None,
) -> None:
"""Set the success value for a RunningWorkflow Record.
Expand Down Expand Up @@ -184,8 +184,8 @@ def get_running_workflow_step(
# "name:": "step-1234",
# "done": False,
# "success": false,
# "error": None,
# "error_msg": None,
# "error_num": 0,
# "error_msg": "",
# "variables": {
# "x": 1,
# "y": 2,
Expand Down Expand Up @@ -213,7 +213,7 @@ def set_running_workflow_step_done(
*,
running_workflow_step_id: str,
success: bool,
error: int | None = None,
error_num: int | None = None,
error_msg: str | None = None,
) -> None:
"""Set the success value for a RunningWorkflowStep Record,
Expand All @@ -224,12 +224,7 @@ def get_instance(self, *, instance_id: str) -> tuple[dict[str, Any], int]:
"""Get an Instance Record"""
# For a RunningWorkflowStep Instance it should return:
# {
# "id": "instance-00000000-0000-0000-0000-000000000001",
# "running_workflow_step": {
# "id": "r-workflow-step-00000000-0000-0000-0000-000000000001",
# "step": "step-1234",
# },
# [...],
# "running_workflow_step_id": "r-workflow-step-00000000-0000-0000-0000-000000000001",
# }
# If not present an empty dictionary should be returned.

Expand Down
4 changes: 2 additions & 2 deletions workflow/workflow_engine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,13 +438,13 @@ def _set_step_error(
self._wapi_adapter.set_running_workflow_step_done(
running_workflow_step_id=r_wfsid,
success=False,
error=error,
error_num=error,
error_msg=error_msg,
)
# We must also set the running workflow as done (failed)
self._wapi_adapter.set_running_workflow_done(
running_workflow_id=r_wfid,
success=False,
error=error,
error_num=error,
error_msg=error_msg,
)
Loading