Merge pull request #1351 from mammo0/fix-reset-tag-with-extends

Fix for reset tag used with extends

Author: p12tic

newsfragments/fix_reset-tag_with_extends.bugfix

@@ -0,0 +1 @@
+Fixed !reset and !override tags used used with extended compose file

podman_compose.py

@@ -1519,7 +1519,7 @@ def flat_deps(services: dict[str, Any], with_extends: bool = False) -> None:
 
 
 class OverrideTag(yaml.YAMLObject):
-    yaml_dumper = yaml.Dumper
+    yaml_dumper = yaml.SafeDumper
     yaml_loader = yaml.SafeLoader
     yaml_tag = '!override'
 
@@ -1548,7 +1548,7 @@ def to_yaml(cls, dumper: Any, data: OverrideTag) -> str:
 
 
 class ResetTag(yaml.YAMLObject):
-    yaml_dumper = yaml.Dumper
+    yaml_dumper = yaml.SafeDumper
     yaml_loader = yaml.SafeLoader
     yaml_tag = '!reset'
 
@@ -2214,17 +2214,34 @@ def config_hash(self, service: dict[str, Any]) -> str:
             return service["_config_hash"]
 
         # Use a stable representation of the service configuration
-        jsonable_service = self.original_service(service)
+        jsonable_service = self.original_configuration(service)
         config_str = json.dumps(jsonable_service, sort_keys=True)
         service["_config_hash"] = hashlib.sha256(config_str.encode('utf-8')).hexdigest()
         return service["_config_hash"]
 
-    def original_service(self, service: dict[str, Any]) -> dict[str, Any]:
+    def original_configuration(self, configuration: dict[Any, Any]) -> dict[str, Any]:
         """
-        Returns the original service configuration without any overrides or resets.
-        This is used to compare the original service configuration with the current one.
+        Returns the original configuration without any overrides or resets.
+        This is used to get a stable representation of the configuration.
+        (can be converted to a JSON string)
         """
-        return {k: v for k, v in service.items() if isinstance(k, str) and not k.startswith("_")}
+        return {
+            # recurse if the value is also a dictionary
+            key: self.original_configuration(value) if isinstance(value, dict) else value
+            # iterate over the configuration items
+            for key, value in configuration.items()
+            # filter
+            if (
+                # only string keys
+                isinstance(key, str)
+                # which do not start with an underscore
+                and not key.startswith("_")
+                # also exclude !override
+                and not isinstance(value, OverrideTag)
+                # and !reset tags
+                and not isinstance(value, ResetTag)
+            )
+        }
 
     def resolve_pod_name(self) -> str | None:
         # Priorities:
@@ -2459,12 +2476,14 @@ def _parse_compose_file(self) -> None:
         if not getattr(args, "no_normalize", None):
             compose = normalize_final(compose, self.dirname)
         self.merged_yaml = yaml.safe_dump(compose)
-        merged_json_b = json.dumps(compose, separators=(",", ":")).encode("utf-8")
+        merged_json_b = json.dumps(
+            self.original_configuration(compose), separators=(",", ":")
+        ).encode("utf-8")
         self.yaml_hash = hashlib.sha256(merged_json_b).hexdigest()
         compose["_dirname"] = dirname
         # debug mode
         if len(files) > 1:
-            log.debug(" ** merged:\n%s", json.dumps(compose, indent=2))
+            log.debug(" ** merged:\n%s", json.dumps(self.original_configuration(compose), indent=2))
         # ver = compose.get('version')
 
         self._parse_x_podman_settings(compose, self.environ)

tests/integration/merge/reset_and_override_tags/reset_tag_attribute_w_extends/__init__.py

@@ -0,0 +1,4 @@
+webapp:
+  image: nopush/podman-compose-test
+  ports:
+    - "8000:8000"

tests/integration/merge/reset_and_override_tags/reset_tag_attribute_w_extends/common-services.yml

@@ -0,0 +1,7 @@
+version: "3"
+services:
+  web:
+    extends:
+      file: common-services.yml
+      service: webapp
+    ports: !reset []

tests/integration/merge/reset_and_override_tags/reset_tag_attribute_w_extends/docker-compose.yml

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: GPL-2.0
+
+import json
+import os
+import unittest
+from io import BytesIO
+
+from tests.integration.test_utils import RunSubprocessMixin
+from tests.integration.test_utils import podman_compose_path
+from tests.integration.test_utils import test_path
+
+
+def compose_yaml_path() -> str:
+    return os.path.join(
+        os.path.join(
+            test_path(), "merge", "reset_and_override_tags", "reset_tag_attribute_w_extends"
+        ),
+        "docker-compose.yml",
+    )
+
+
+class TestComposeResetTagAttributeWithExtends(unittest.TestCase, RunSubprocessMixin):
+    def test_reset_w_extends(self) -> None:  # when file is Dockerfile for building the image
+        try:
+            self.run_subprocess_assert_returncode(
+                [
+                    podman_compose_path(),
+                    "-f",
+                    compose_yaml_path(),
+                    "up",
+                ],
+            )
+            output, _ = self.run_subprocess_assert_returncode([
+                podman_compose_path(),
+                "-f",
+                compose_yaml_path(),
+                "ps",
+            ])
+            self.assertIn("reset_tag_attribute_w_extends_web_1", str(output))
+
+            output, _ = self.run_subprocess_assert_returncode([
+                "podman",
+                "inspect",
+                "reset_tag_attribute_w_extends_web_1",
+            ])
+            inspect = json.load(BytesIO(output))
+
+            self.assertEqual(len(inspect), 1)
+            self.assertIn("NetworkSettings", inspect[0])
+            self.assertIn("Ports", inspect[0]["NetworkSettings"])
+            self.assertEqual(len(inspect[0]["NetworkSettings"]["Ports"]), 0)
+        finally:
+            self.run_subprocess_assert_returncode([
+                podman_compose_path(),
+                "-f",
+                compose_yaml_path(),
+                "down",
+            ])

tests/integration/merge/reset_and_override_tags/reset_tag_attribute_w_extends/test_podman_compose_extends_w_file.py

@@ -92,7 +92,7 @@ def test_parse_compose_file_when_multiple_composes(self, input, override, expect
 
         actual_compose = {}
         if podman_compose.services:
-            actual_compose = podman_compose.original_service(
+            actual_compose = podman_compose.original_configuration(
                 podman_compose.services["test-service"]
             )
         self.assertEqual(actual_compose, expected)
@@ -160,7 +160,9 @@ def test_parse_compose_file_when_multiple_composes_keys_command_entrypoint(
 
             actual = {}
             if podman_compose.services:
-                actual = podman_compose.original_service(podman_compose.services["test-service"])
+                actual = podman_compose.original_configuration(
+                    podman_compose.services["test-service"]
+                )
             self.assertEqual(actual, expected)
 
 

tests/unit/test_can_merge_build.py

@@ -123,7 +123,7 @@ def test_parse_compose_file_when_single_compose(self, input, expected):
 
         actual_compose = {}
         if podman_compose.services:
-            actual_compose = podman_compose.original_service(
+            actual_compose = podman_compose.original_configuration(
                 podman_compose.services["test-service"]
             )
         self.assertEqual(actual_compose, expected)
@@ -239,7 +239,7 @@ def test_parse_when_multiple_composes(self, input, override, expected):
 
         actual_compose = {}
         if podman_compose.services:
-            actual_compose = podman_compose.original_service(
+            actual_compose = podman_compose.original_configuration(
                 podman_compose.services["test-service"]
             )
         self.assertEqual(actual_compose, expected)