fix: buildrun status false failed (#1300)

Sometimes the buildrun status is considered failed when in reality it is
not failed. This should address that. It is because of some transient
state in the buildrun conditions.

Author: olevski

components/renku_data_services/session/crs.py

@@ -4,7 +4,7 @@
 
 from pydantic import BaseModel, Field, RootModel
 
-from renku_data_services.session.cr_shipwright_buildrun import Build, Git, ParamValue, Strategy, Toleration
+from renku_data_services.session.cr_shipwright_buildrun import Build, Condition, Git, ParamValue, Strategy, Toleration
 from renku_data_services.session.cr_shipwright_buildrun import Model as _BuildRun
 from renku_data_services.session.cr_shipwright_buildrun import Output as BuildOutput
 from renku_data_services.session.cr_shipwright_buildrun import Retention1 as Retention

components/renku_data_services/session/k8s_client.py

@@ -1,6 +1,7 @@
 """An abstraction over the kr8s kubernetes client and the k8s-watcher."""
 
 from collections.abc import AsyncIterable
+from logging import getLogger
 from typing import TYPE_CHECKING
 
 import httpx
@@ -19,11 +20,13 @@
     DUMMY_TASK_RUN_USER_ID,
     TASK_RUN_GVK,
 )
-from renku_data_services.session.crs import BuildRun, TaskRun
+from renku_data_services.session.crs import BuildRun, Condition, TaskRun
 
 if TYPE_CHECKING:
     from renku_data_services.k8s.clients import K8sClusterClientsPool
 
+logger = getLogger(__name__)
+
 
 # NOTE The type ignore below is because the kr8s library has no type stubs, they claim pyright better handles type hints
 class ShipwrightBuildRunV1Beta1Kr8s(APIObject):
@@ -215,6 +218,7 @@ async def update_image_build_status(
         k8s_build = await self.get_build_run(name=buildrun_name, user_id=user_id)
 
         if k8s_build is None:
+            logger.warning(f"Buildrun {buildrun_name} considered failed because we cannot find it in the cluster.")
             return models.ShipwrightBuildStatusUpdate(
                 update=models.ShipwrightBuildStatusUpdateContent(status=models.BuildStatus.failed)
             ), None
@@ -246,44 +250,48 @@ async def update_image_build_status(
         # So I needed something to keep mypy happy. The real name of the field is "type"
         condition = next(filter(lambda c: c.type == "Succeeded", conditions or []), None)
 
-        if condition is not None and condition.status not in ["True", "False"]:
-            # The buildrun is still running or pending
-            return models.ShipwrightBuildStatusUpdate(update=None), k8s_build.frontend_variant
-
-        buildSpec = k8s_build_status.buildSpec
-        output = buildSpec.output if buildSpec else None
-        result_image = output.image if output else "unknown"
-
-        source = buildSpec.source if buildSpec else None
-        git_obj = source.git if source else None
-        result_repository_url = git_obj.url if git_obj else "unknown"
-
-        source_2 = k8s_build_status.source
-        git_obj_2 = source_2.git if source_2 else None
-        result_repository_git_commit_sha = git_obj_2.commitSha if git_obj_2 else None
-        result_repository_git_commit_sha = result_repository_git_commit_sha or "unknown"
-
-        if condition is not None and condition.reason == "Succeeded" and condition.status == "True":
-            return models.ShipwrightBuildStatusUpdate(
-                update=models.ShipwrightBuildStatusUpdateContent(
-                    status=models.BuildStatus.succeeded,
-                    completed_at=completion_time,
-                    result=models.BuildResult(
+        match condition:
+            case Condition(reason="Succeeded", status="True"):
+                buildSpec = k8s_build_status.buildSpec
+                output = buildSpec.output if buildSpec else None
+                result_image = output.image if output else "unknown"
+
+                source = buildSpec.source if buildSpec else None
+                git_obj = source.git if source else None
+                result_repository_url = git_obj.url if git_obj else "unknown"
+
+                source_2 = k8s_build_status.source
+                git_obj_2 = source_2.git if source_2 else None
+                result_repository_git_commit_sha = git_obj_2.commitSha if git_obj_2 else None
+                result_repository_git_commit_sha = result_repository_git_commit_sha or "unknown"
+                return models.ShipwrightBuildStatusUpdate(
+                    update=models.ShipwrightBuildStatusUpdateContent(
+                        status=models.BuildStatus.succeeded,
                         completed_at=completion_time,
-                        image=result_image,
-                        repository_url=result_repository_url,
-                        repository_git_commit_sha=result_repository_git_commit_sha,
-                    ),
-                )
-            ), k8s_build.frontend_variant
-        else:
-            return models.ShipwrightBuildStatusUpdate(
-                update=models.ShipwrightBuildStatusUpdateContent(
-                    status=models.BuildStatus.failed,
-                    completed_at=completion_time,
-                    error_reason=condition.reason if condition is not None else None,
+                        result=models.BuildResult(
+                            completed_at=completion_time,
+                            image=result_image,
+                            repository_url=result_repository_url,
+                            repository_git_commit_sha=result_repository_git_commit_sha,
+                        ),
+                    )
+                ), k8s_build.frontend_variant
+            case Condition(status="False", type="Succeeded"):
+                logger.info(f"Buildrun {buildrun_name} failed with condition {condition}")
+                return models.ShipwrightBuildStatusUpdate(
+                    update=models.ShipwrightBuildStatusUpdateContent(
+                        status=models.BuildStatus.failed,
+                        completed_at=completion_time,
+                        error_reason=condition.reason if condition is not None else None,
+                    )
+                ), k8s_build.frontend_variant
+            case None:
+                logger.warning(
+                    f"Buildrun {buildrun_name} is missing Succeeded condition, considered to be in progress."
                 )
-            ), k8s_build.frontend_variant
+                return models.ShipwrightBuildStatusUpdate(update=None), k8s_build.frontend_variant
+            case _:
+                return models.ShipwrightBuildStatusUpdate(update=None), k8s_build.frontend_variant
 
     async def get_image_build_logs(
         self, buildrun_name: str, user_id: str, max_log_lines: int | None = None