quick setup: Fix error when fetching non-existent background jobs

Instead of returning a status 400 (Bad request) when a background job
does not exist, return a status 404 (Not found)

CMK-21809

Change-Id: Ib65ab31e76924129c0e92e233d810f09e2af3c99

Author: lpetrora

cmk/gui/openapi/endpoints/quick_setup/__init__.py

@@ -57,7 +57,11 @@
     validate_stage_formspecs,
     verify_custom_validators_and_recap_stage,
 )
-from cmk.gui.quick_setup.handlers.utils import form_spec_parse, ValidationErrors
+from cmk.gui.quick_setup.handlers.utils import (
+    form_spec_parse,
+    MKJobNotFoundException,
+    ValidationErrors,
+)
 from cmk.gui.quick_setup.v0_unstable._registry import quick_setup_registry
 from cmk.gui.quick_setup.v0_unstable.definitions import QuickSetupSaveRedirect
 from cmk.gui.quick_setup.v0_unstable.predefined import build_formspec_map_from_stages
@@ -409,8 +413,16 @@ def fetch_quick_setup_stage_action_result(params: Mapping[str, Any]) -> Response
                 )
             )
         )
+
     else:
-        action_result = StageActionResult.load_from_job_result(job_id=action_background_job_id)
+        try:
+            action_result = StageActionResult.load_from_job_result(job_id=action_background_job_id)
+
+        except MKJobNotFoundException:
+            return _serve_error(
+                "Job not found", f"Background job '{action_background_job_id}' not found", 404
+            )
+
     return _serve_action_result(action_result)
 
 
@@ -556,7 +568,14 @@ def complete_quick_setup_action(params: Mapping[str, Any], mode: QuickSetupActio
 def fetch_quick_setup_action_result(params: Mapping[str, Any]) -> Response:
     """Fetch the Quick action background job result"""
     action_background_job_id = params["job_id"]
-    action_result = CompleteActionResult.load_from_job_result(job_id=action_background_job_id)
+    try:
+        action_result = CompleteActionResult.load_from_job_result(job_id=action_background_job_id)
+
+    except MKJobNotFoundException:
+        return _serve_error(
+            "Job not found", f"Background job '{action_background_job_id}' not found", 404
+        )
+
     return _serve_action_result(action_result)
 
 

cmk/gui/quick_setup/handlers/setup.py

@@ -39,6 +39,7 @@
     InfoLogger,
     JobBasedProgressLogger,
     LOAD_WAIT_LABEL,
+    MKJobNotFoundException,
     NEXT_BUTTON_ARIA_LABEL,
     NEXT_BUTTON_LABEL,
     PREV_BUTTON_ARIA_LABEL,
@@ -263,7 +264,7 @@ class CompleteActionResult(BaseModel):
     def load_from_job_result(cls, job_id: str) -> "CompleteActionResult":
         work_dir = str(Path(BackgroundJobDefines.base_dir) / job_id)
         if not os.path.exists(work_dir):
-            raise MKInternalError(None, _("Action result not found"))
+            raise MKJobNotFoundException(None, _("Action result not found"))
         content = store.load_text_from_file(cls._file_path(work_dir))
         try:
             return cls.model_validate_json(content)

cmk/gui/quick_setup/handlers/stage.py

@@ -44,6 +44,7 @@
     InfoLogger,
     JobBasedProgressLogger,
     LOAD_WAIT_LABEL,
+    MKJobNotFoundException,
     NEXT_BUTTON_ARIA_LABEL,
     NEXT_BUTTON_LABEL,
     PREV_BUTTON_ARIA_LABEL,
@@ -229,7 +230,7 @@ class StageActionResult(BaseModel, frozen=False):
     def load_from_job_result(cls, job_id: str) -> "StageActionResult":
         work_dir = str(Path(BackgroundJobDefines.base_dir) / job_id)
         if not os.path.exists(work_dir):
-            raise MKInternalError(None, _("Stage action result not found"))
+            raise MKJobNotFoundException(None, _("Stage action result not found"))
         content = store.load_text_from_file(cls._file_path(work_dir))
         try:
             return cls.model_validate_json(content)

cmk/gui/quick_setup/handlers/utils.py

@@ -10,6 +10,7 @@
 from pydantic import BaseModel
 
 from cmk.gui.background_job import BackgroundProcessInterface
+from cmk.gui.exceptions import MKInternalError
 from cmk.gui.form_specs.vue.form_spec_visitor import (
     serialize_data_for_frontend,
     transform_to_disk_model,
@@ -260,3 +261,7 @@ def validate_custom_validators(
 class BackgroundJobException(BaseModel):
     message: str
     traceback: str
+
+
+class MKJobNotFoundException(MKInternalError):
+    pass

tests/testlib/unit/rest_api_client.py

@@ -3043,6 +3043,20 @@ def edit_quick_setup(
             expect_ok=expect_ok,
         )
 
+    def get_stage_action_result(self, job_id: str, expect_ok: bool = True) -> Response:
+        return self.request(
+            "get",
+            url=f"/objects/quick_setup_stage_action_result/{job_id}",
+            expect_ok=expect_ok,
+        )
+
+    def get_action_result(self, job_id: str, expect_ok: bool = True) -> Response:
+        return self.request(
+            "get",
+            url=f"/objects/quick_setup_action_result/{job_id}",
+            expect_ok=expect_ok,
+        )
+
 
 class ConfigurationEntityClient(RestApiClient):
     domain: API_DOMAIN = "configuration_entity"

tests/unit/cmk/gui/openapi/test_openapi_quick_setup.py

@@ -813,3 +813,15 @@ def test_fail_validate_permission(clients: ClientRegistry) -> None:
         resp.json["detail"]
         == "Action with id 'action' requires 'impossible_permisson' permissions."
     )
+
+
+def test_stage_action_result_should_return_404(clients: ClientRegistry) -> None:
+    resp = clients.QuickSetup.get_stage_action_result("foo", expect_ok=False)
+    assert resp.status_code == 404
+    assert resp.json["detail"] == "Background job 'foo' not found"
+
+
+def test_action_result_should_return_404(clients: ClientRegistry) -> None:
+    resp = clients.QuickSetup.get_action_result("foo", expect_ok=False)
+    assert resp.status_code == 404
+    assert resp.json["detail"] == "Background job 'foo' not found"