localstack-core 4.6.1.dev60__py3-none-any.whl → 4.10.1.dev12__py3-none-any.whl

localstack/services/cloudformation/engine/v2/change_set_model_describer.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
 import json
-from typing import Final, Optional
+from typing import Final
 
 import localstack.aws.api.cloudformation as cfn_api
+from localstack.aws.api.cloudformation import Replacement
 from localstack.services.cloudformation.engine.v2.change_set_model import (
     NodeIntrinsicFunction,
     NodeProperty,
@@ -19,6 +20,7 @@ from localstack.services.cloudformation.engine.v2.change_set_model_preproc impor
     PreprocResource,
 )
 from localstack.services.cloudformation.v2.entities import ChangeSet
+from localstack.utils.numbers import is_number
 
 CHANGESET_KNOWN_AFTER_APPLY: Final[str] = "{{changeSet:KNOWN_AFTER_APPLY}}"
 
@@ -34,7 +36,7 @@ class ChangeSetModelDescriber(ChangeSetModelPreproc):
     ):
         super().__init__(change_set=change_set)
         self._include_property_values = include_property_values
-        self._changes = list()
+        self._changes = []
 
     def get_changes(self) -> cfn_api.Changes:
         self._changes.clear()
@@ -75,7 +77,7 @@ class ChangeSetModelDescriber(ChangeSetModelPreproc):
             resource_name=logical_name_of_resource,
             node_template=self._change_set.update_model.node_template,
         )
-        node_property: Optional[NodeProperty] = self._get_node_property_for(
+        node_property: NodeProperty | None = self._get_node_property_for(
             property_name=attribute_name, node_resource=node_resource
         )
         if node_property is not None:
@@ -95,11 +97,27 @@ class ChangeSetModelDescriber(ChangeSetModelPreproc):
 
         return value
 
+    def visit_node_intrinsic_function(self, node_intrinsic_function: NodeIntrinsicFunction):
+        """
+        Intrinsic function results are always strings when referring to the describe output
+        """
+        # TODO: what about other places?
+        # TODO: should this be put in the preproc?
+        delta = super().visit_node_intrinsic_function(node_intrinsic_function)
+        if is_number(delta.before):
+            delta.before = str(delta.before)
+        if is_number(delta.after):
+            delta.after = str(delta.after)
+        return delta
+
     def visit_node_intrinsic_function_fn_join(
         self, node_intrinsic_function: NodeIntrinsicFunction
     ) -> PreprocEntityDelta:
-        # TODO: investigate the behaviour and impact of this logic with the user defining
-        #       {{changeSet:KNOWN_AFTER_APPLY}} string literals as delimiters or arguments.
+        delta_args = super().visit(node_intrinsic_function.arguments)
+        if isinstance(delta_args.after, list) and CHANGESET_KNOWN_AFTER_APPLY in delta_args.after:
+            delta_args.after = CHANGESET_KNOWN_AFTER_APPLY
+            return delta_args
+
         delta = super().visit_node_intrinsic_function_fn_join(
             node_intrinsic_function=node_intrinsic_function
         )
@@ -111,13 +129,39 @@ class ChangeSetModelDescriber(ChangeSetModelPreproc):
             delta.after = CHANGESET_KNOWN_AFTER_APPLY
         return delta
 
+    def visit_node_intrinsic_function_fn_select(
+        self, node_intrinsic_function: NodeIntrinsicFunction
+    ):
+        # TODO: should this not _ALWAYS_ return CHANGESET_KNOWN_AFTER_APPLY?
+        arguments_delta = self.visit(node_intrinsic_function.arguments)
+        delta = PreprocEntityDelta()
+        if not is_nothing(arguments_delta.before):
+            idx = arguments_delta.before[0]
+            arr = arguments_delta.before[1]
+            try:
+                delta.before = arr[int(idx)]
+            except Exception:
+                delta.before = CHANGESET_KNOWN_AFTER_APPLY
+
+        if not is_nothing(arguments_delta.after):
+            idx = arguments_delta.after[0]
+            arr = arguments_delta.after[1]
+            try:
+                delta.after = arr[int(idx)]
+            except Exception:
+                delta.after = CHANGESET_KNOWN_AFTER_APPLY
+
+        return delta
+
     def _register_resource_change(
         self,
         logical_id: str,
         type_: str,
-        physical_id: Optional[str],
-        before_properties: Optional[PreprocProperties],
-        after_properties: Optional[PreprocProperties],
+        physical_id: str | None,
+        before_properties: PreprocProperties | None,
+        after_properties: PreprocProperties | None,
+        # TODO: remove default
+        requires_replacement: bool = False,
     ) -> None:
         action = cfn_api.ChangeAction.Modify
         if before_properties is None:
@@ -131,20 +175,29 @@ class ChangeSetModelDescriber(ChangeSetModelPreproc):
         resource_change["ResourceType"] = type_
         if physical_id:
             resource_change["PhysicalResourceId"] = physical_id
-        if self._include_property_values and before_properties is not None:
-            before_context_properties = {PropertiesKey: before_properties.properties}
-            before_context_properties_json_str = json.dumps(before_context_properties)
-            resource_change["BeforeContext"] = before_context_properties_json_str
-        if self._include_property_values and after_properties is not None:
-            after_context_properties = {PropertiesKey: after_properties.properties}
-            after_context_properties_json_str = json.dumps(after_context_properties)
-            resource_change["AfterContext"] = after_context_properties_json_str
+        if self._include_property_values:
+            if before_properties is not None:
+                before_context_properties = {PropertiesKey: before_properties.properties}
+                before_context_properties_json_str = json.dumps(before_context_properties)
+                resource_change["BeforeContext"] = before_context_properties_json_str
+
+            if after_properties is not None:
+                after_context_properties = {PropertiesKey: after_properties.properties}
+                after_context_properties_json_str = json.dumps(after_context_properties)
+                resource_change["AfterContext"] = after_context_properties_json_str
+
+        if action == cfn_api.ChangeAction.Modify:
+            # TODO: handle "Conditional" case
+            resource_change["Replacement"] = (
+                Replacement.True_ if requires_replacement else Replacement.False_
+            )
+
         self._changes.append(
             cfn_api.Change(Type=cfn_api.ChangeType.Resource, ResourceChange=resource_change)
         )
 
     def _describe_resource_change(
-        self, name: str, before: Optional[PreprocResource], after: Optional[PreprocResource]
+        self, name: str, before: PreprocResource | None, after: PreprocResource | None
     ) -> None:
         if before == after:
             # unchanged: nothing to do.
@@ -159,6 +212,7 @@ class ChangeSetModelDescriber(ChangeSetModelPreproc):
                     type_=before.resource_type,
                     before_properties=before.properties,
                     after_properties=after.properties,
+                    requires_replacement=after.requires_replacement,
                 )
             # Case: type migration.
             # TODO: Add test to assert that on type change the resources are replaced.
@@ -213,3 +267,28 @@ class ChangeSetModelDescriber(ChangeSetModelPreproc):
         if not is_nothing(after_resource) and after_resource.physical_resource_id is None:
             after_resource.physical_resource_id = CHANGESET_KNOWN_AFTER_APPLY
         return delta
+
+    def visit_node_intrinsic_function_fn_import_value(
+        self, node_intrinsic_function: NodeIntrinsicFunction
+    ) -> PreprocEntityDelta:
+        delta = super().visit_node_intrinsic_function_fn_import_value(
+            node_intrinsic_function=node_intrinsic_function
+        )
+        after_value = delta.after
+        if is_nothing(after_value) and self._include_property_values:
+            # TODO find correct way to obtain parent resource
+            resource_name = node_intrinsic_function.scope.split("/")[2]
+            export_name = node_intrinsic_function.arguments.value
+
+            self._change_set.status_reason = f"[WARN] --include-property-values option can return incomplete ChangeSet data because: ChangeSet creation failed for resource [{resource_name}] because: No export named {export_name}"
+            delta.after = CHANGESET_KNOWN_AFTER_APPLY
+
+        return delta
+
+    def visit_node_intrinsic_function_fn_split(
+        self, node_intrinsic_function: NodeIntrinsicFunction
+    ) -> PreprocEntityDelta:
+        delta = super().visit_node_intrinsic_function_fn_split(node_intrinsic_function)
+        if isinstance(delta.after, list) and ":".join(delta.after) == CHANGESET_KNOWN_AFTER_APPLY:
+            delta.after = [CHANGESET_KNOWN_AFTER_APPLY]
+        return delta