fix: handle all potential states from podman (#583)

Author: Alex-Izquierdo

src/aap_eda/services/activation/engine/messages.py

@@ -7,9 +7,9 @@
 )
 
 POD_COMPLETED = "Pod {pod_id} has successfully exited."
-POD_ERROR = "Pod {pod_id} status is unknown."
+POD_UNEXPECTED = "Pod {pod_id} is in an unexpected state: {pod_state}."
 POD_RUNNING = "Pod {pod_id} is running."
 POD_STOPPED = "Pod {pod_id} is stopped."
 POD_GENERIC_FAIL = "Pod {pod_id} exited with code {exit_code}."
 POD_NOT_RUNNING = "Pod {pod_id} is not running."
-POD_PAUSED = "Pod {pod_id} is paused."
+POD_WRONG_STATE = "Pod {pod_id} is in a wrong state: {pod_state}."

src/aap_eda/services/activation/engine/podman.py

@@ -170,7 +170,9 @@ def get_status(self, container_id: str) -> ContainerStatus:
         container = self.client.containers.get(container_id)
         error_msg = container.attrs.get("State").get("Error", "")
 
-        if container.status == "exited":
+        # Check container status
+        # Ref: https://github.com/containers/podman/blob/main/libpod/define/containerstate.go # noqa: E501
+        if container.status in ["exited", "stopped"]:
             exit_code = container.attrs.get("State").get("ExitCode")
             if exit_code == 0:
                 message = messages.POD_COMPLETED.format(
@@ -189,13 +191,15 @@ def get_status(self, container_id: str) -> ContainerStatus:
                 status=ActivationStatus.FAILED,
                 message=error_msg,
             )
-        if container.status == "running":
+
+        if container.status in ["running", "stopping"]:
             return ContainerStatus(
                 status=ActivationStatus.RUNNING,
                 message=messages.POD_RUNNING.format(
                     pod_id=container_id,
                 ),
             )
+
         if container.status == "created":
             if not error_msg:
                 error_msg = messages.POD_NOT_RUNNING.format(
@@ -206,19 +210,30 @@ def get_status(self, container_id: str) -> ContainerStatus:
                 status=ActivationStatus.FAILED,
                 message=error_msg,
             )
-        if container.status == "paused":
+
+        # Not expected statuses
+        if container.status in [
+            "paused",
+            "restarting",
+            "removing",
+            "dead",
+            "configured",
+            "unknown",
+        ]:
             return ContainerStatus(
                 status=ActivationStatus.FAILED,
-                message=messages.POD_PAUSED.format(
+                message=messages.POD_WRONG_STATE.format(
                     pod_id=container_id,
+                    pod_state=container.status,
                 ),
             )
 
-        # container.status == "unknown":
+        # undocumented status, fail safe
         return ContainerStatus(
             status=ActivationStatus.ERROR,
-            message=messages.POD_ERROR.format(
+            message=messages.POD_UNEXPECTED.format(
                 pod_id=container_id,
+                pod_state=container.status,
             ),
         )
 

tests/integration/services/activation/engine/test_podman.py

@@ -399,17 +399,18 @@ def test_engine_get_status(podman_engine):
 
     assert activation_status.status == ActivationStatus.FAILED
 
-    # when status in "paused"
-    container_mock.status = "paused"
-    activation_status = engine.get_status("container_id")
-
-    assert activation_status.status == ActivationStatus.FAILED
-
-    # when status in "unknown"
-    container_mock.status = "unknown"
-    activation_status = engine.get_status("container_id")
+    for unexpected_state in [
+        "paused",
+        "restarting",
+        "removing",
+        "dead",
+        "configured",
+        "unknown",
+    ]:
+        container_mock.status = unexpected_state
+        activation_status = engine.get_status("container_id")
 
-    assert activation_status.status == ActivationStatus.ERROR
+        assert activation_status.status == ActivationStatus.FAILED
 
     # when status in "exited"
     container_mock.status = "exited"
@@ -424,6 +425,14 @@ def test_engine_get_status(podman_engine):
 
         assert activation_status.status == value
 
+    # when status is stopped
+    container_mock.status = "stopped"
+    for key, value in expects:
+        container_mock.attrs = {"State": {"ExitCode": key}}
+        activation_status = engine.get_status("container_id")
+
+        assert activation_status.status == value
+
 
 @pytest.mark.django_db
 def test_engine_get_status_with_exception(podman_engine):