Improve the Summary of the Podman container status check

CMK-32330

Change-Id: I889200ee31de10e9c978de6a8e170bc5c5a17f29

Author: racicLuka

cmk/plugins/podman/agent_based/lib.py

@@ -29,6 +29,7 @@ class ContainerHealth(BaseModel, frozen=True):
 class SectionPodmanContainerState(BaseModel, frozen=True):
     status: str = Field(alias="Status")
     started_at: str = Field(alias="StartedAt")
+    finished_at: str = Field(alias="FinishedAt")
     exit_code: int = Field(alias="ExitCode", description="Exit code of the container.")
     health: ContainerHealth | None = Field(
         default=None,
@@ -66,6 +67,7 @@ class PodmanContainerNetworkSettings(BaseModel, frozen=True):
 
 
 class SectionPodmanContainerInspect(BaseModel, frozen=True):
+    name: str = Field(alias="Name", description="The name of the container.")
     state: SectionPodmanContainerState = Field(alias="State")
     restarts: int = Field(alias="RestartCount", description="Number of restarts of the container.")
     pod: str = Field(alias="Pod", description="The pod this container is part of, if any.")

cmk/plugins/podman/agent_based/podman_container_status.py

@@ -4,16 +4,10 @@
 # conditions defined in the file COPYING, which is part of this source code package.
 
 
+from datetime import datetime, UTC
 from typing import Literal, TypedDict
 
-from cmk.agent_based.v2 import (
-    CheckPlugin,
-    CheckResult,
-    DiscoveryResult,
-    Result,
-    Service,
-    State,
-)
+from cmk.agent_based.v2 import CheckPlugin, CheckResult, DiscoveryResult, Result, Service, State
 
 from .lib import SectionPodmanContainerInspect
 
@@ -47,6 +41,12 @@ def discover_podman_container_status(
     yield Service()
 
 
+def _format_exit_time(finished_at: str) -> str:
+    dt = datetime.fromisoformat(finished_at)
+    utc_dt = dt.astimezone(UTC)
+    return utc_dt.strftime("%Y-%m-%d %H:%M UTC")
+
+
 def check_podman_container_status(
     params: Params,
     section: SectionPodmanContainerInspect,
@@ -58,9 +58,16 @@ def check_podman_container_status(
         if section.state.status == "exited"
         else section.state.status
     )
+
+    if section.state.status == "exited":
+        exit_time = _format_exit_time(section.state.finished_at)
+        summary = f"Container {section.name} exited at {exit_time} (code {section.state.exit_code})"
+    else:
+        summary = status.capitalize().replace("_", " ")
+
     yield Result(
         state=State(params.get(status, 3)),
-        summary=f"{status.capitalize().replace('_', ' ')}",
+        summary=summary,
     )
 
     if section.pod:

tests/unit/cmk/plugins/podman/agent_based/lib.py

@@ -14,9 +14,11 @@
 )
 
 SECTION_RUNNING = SectionPodmanContainerInspect(
+    Name="test-container",
     State=SectionPodmanContainerState(
         Status="running",
         StartedAt="2025-08-01T13:00:00+02:00",
+        FinishedAt="0001-01-01T00:00:00Z",
         ExitCode=0,
         Health=ContainerHealth(
             Log=[HealthCheckLog(Output="testOutput", ExitCode=0)],
@@ -44,9 +46,11 @@
 )
 
 SECTION_PAUSED = SectionPodmanContainerInspect(
+    Name="test-container",
     State=SectionPodmanContainerState(
         Status="paused",
         StartedAt="2025-08-01T13:00:00+02:00",
+        FinishedAt="0001-01-01T00:00:00Z",
         ExitCode=0,
         Health=ContainerHealth(
             Log=[HealthCheckLog(Output="testOutput", ExitCode=0)],

tests/unit/cmk/plugins/podman/agent_based/test_podman_container_health.py

@@ -30,9 +30,11 @@
 )
 
 SECTION_NO_HEALTHCHECK = SectionPodmanContainerInspect(
+    Name="test-container",
     State=SectionPodmanContainerState(
         Status="running",
         StartedAt="2025-08-01T13:00:00+02:00",
+        FinishedAt="0001-01-01T00:00:00Z",
         ExitCode=0,
         Health=ContainerHealth(
             Log=[HealthCheckLog(Output="testOutput", ExitCode=0)],

tests/unit/cmk/plugins/podman/agent_based/test_podman_container_inspect.py

@@ -28,7 +28,7 @@
         '"Config": {"HealthcheckOnFailureAction": "none", '
         '"Hostname": "test-hostname", "Labels": {"key1": "value1", "key2": "value2"}, "User": "username"},'
         '"NetworkSettings": {"IPAddress": "192.168.1.100", "Gateway": "192.168.1.1", '
-        '"MacAddress": "00:11:22:33:44:55"}, "SocketUser": "hostuser"}'
+        '"MacAddress": "00:11:22:33:44:55"}, "SocketUser": "hostuser", "Name": "test-container"}'
     ]
 ]
 
@@ -41,17 +41,19 @@
         '"RestartCount": 5, "Pod": "", "Config": {"HealthcheckOnFailureAction": "none", '
         '"Hostname": "test-hostname", "Labels": {"key1": "value1", "key2": "value2"}, "User": "username"},'
         '"NetworkSettings": {"IPAddress": "192.168.1.100", "Gateway": "192.168.1.1", '
-        '"MacAddress": "00:11:22:33:44:55"}}'
+        '"MacAddress": "00:11:22:33:44:55"}, "Name": "test-container"}'
     ]
 ]
 
 
 def test_discover_podman_container_inspect() -> None:
     section = parse_podman_container_inspect(STRING_TABLE)
     assert section == SectionPodmanContainerInspect(
+        Name="test-container",
         State=SectionPodmanContainerState(
             Status="running",
             StartedAt="2025-08-01T13:00:00+02:00",
+            FinishedAt="0001-01-01T00:00:00Z",
             ExitCode=0,
             Health=ContainerHealth(Log=None, FailingStreak=0, Status="healthy"),
         ),
@@ -141,9 +143,11 @@ def test_host_label_function_image_labels(
     image_name: str, expected_labels: list[HostLabel]
 ) -> None:
     section = SectionPodmanContainerInspect(
+        Name="test-container",
         State=SectionPodmanContainerState(
             Status="running",
             StartedAt="2025-08-01T13:00:00+02:00",
+            FinishedAt="0001-01-01T00:00:00Z",
             ExitCode=0,
             Health=None,
         ),

tests/unit/cmk/plugins/podman/agent_based/test_podman_container_status.py

@@ -26,9 +26,11 @@
 from .lib import SECTION_PAUSED, SECTION_RUNNING
 
 SECTION_EXITED_WITH_ZERO = SectionPodmanContainerInspect(
+    Name="test-container",
     State=SectionPodmanContainerState(
         Status="exited",
         StartedAt="2025-08-01T13:00:00+02:00",
+        FinishedAt="2026-03-09T22:14:05Z",
         ExitCode=0,
         Health=ContainerHealth(
             Log=[HealthCheckLog(Output="testOutput", ExitCode=0)],
@@ -55,9 +57,11 @@
 )
 
 SECTION_EXITED_WITH_NON_ZERO = SectionPodmanContainerInspect(
+    Name="test-container",
     State=SectionPodmanContainerState(
         Status="exited",
         StartedAt="2025-08-01T13:00:00+02:00",
+        FinishedAt="2026-03-09T22:14:05Z",
         ExitCode=1,
         Health=ContainerHealth(
             Log=[HealthCheckLog(Output="testOutput", ExitCode=0)],
@@ -103,7 +107,10 @@ def test_discover_podman_container_status() -> None:
             SECTION_EXITED_WITH_ZERO,
             DEFAULT_CHECK_PARAMETERS,
             [
-                Result(state=State.OK, summary="Exited with zero"),
+                Result(
+                    state=State.OK,
+                    summary="Container test-container exited at 2026-03-09 22:14 UTC (code 0)",
+                ),
                 Result(state=State.OK, summary="Pod: Pod1"),
             ],
             id="Exited with zero -> OK. Contains Pod",
@@ -112,7 +119,10 @@ def test_discover_podman_container_status() -> None:
             SECTION_EXITED_WITH_NON_ZERO,
             DEFAULT_CHECK_PARAMETERS,
             [
-                Result(state=State.CRIT, summary="Exited with non zero"),
+                Result(
+                    state=State.CRIT,
+                    summary="Container test-container exited at 2026-03-09 22:14 UTC (code 1)",
+                ),
                 Result(state=State.OK, summary="Pod: Pod1"),
             ],
             id="Exited with non zero -> CRIT. Contains Pod",

tests/unit/cmk/plugins/podman/agent_based/test_podman_container_uptime.py

@@ -17,9 +17,7 @@
     SectionPodmanContainerInspect,
     SectionPodmanContainerState,
 )
-from cmk.plugins.podman.agent_based.podman_container_inspect import (
-    parse_podman_container_inspect,
-)
+from cmk.plugins.podman.agent_based.podman_container_inspect import parse_podman_container_inspect
 from cmk.plugins.podman.agent_based.podman_container_uptime import (
     calculate_uptime,
     check_podman_container_uptime,
@@ -78,9 +76,11 @@ def test_check_podman_container_uptime_no_running_container() -> None:
     [
         pytest.param(
             SectionPodmanContainerInspect(
+                Name="test-container",
                 State=SectionPodmanContainerState(
                     Status="running",
                     StartedAt="2025-06-01T13:00:00+02:00",
+                    FinishedAt="0001-01-01T00:00:00Z",
                     ExitCode=0,
                     Health=ContainerHealth(
                         Log=[HealthCheckLog(Output="testOutput", ExitCode=0)],
@@ -110,9 +110,11 @@ def test_check_podman_container_uptime_no_running_container() -> None:
         ),
         pytest.param(
             SectionPodmanContainerInspect(
+                Name="test-container",
                 State=SectionPodmanContainerState(
                     Status="running",
                     StartedAt="2025-06-01T13:00:00+00:00",
+                    FinishedAt="0001-01-01T00:00:00Z",
                     ExitCode=0,
                     Health=ContainerHealth(
                         Log=[HealthCheckLog(Output="testOutput", ExitCode=0)],
@@ -142,9 +144,11 @@ def test_check_podman_container_uptime_no_running_container() -> None:
         ),
         pytest.param(
             SectionPodmanContainerInspect(
+                Name="test-container",
                 State=SectionPodmanContainerState(
                     Status="running",
                     StartedAt="2025-06-01T13:00:00-01:00",
+                    FinishedAt="0001-01-01T00:00:00Z",
                     ExitCode=0,
                     Health=ContainerHealth(
                         Log=[HealthCheckLog(Output="testOutput", ExitCode=0)],