localstack-core 4.7.1.dev49__py3-none-any.whl → 4.10.1.dev12__py3-none-any.whl

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

@@ -9,6 +9,7 @@ from typing import Any, Final, Generic, TypeVar
 from botocore.exceptions import ClientError
 
 from localstack import config
+from localstack.aws.api.cloudformation import ResourceStatus
 from localstack.aws.api.ec2 import AvailabilityZoneList, DescribeAvailabilityZonesResult
 from localstack.aws.connect import connect_to
 from localstack.services.cloudformation.engine.v2.change_set_model import (
@@ -29,6 +30,7 @@ from localstack.services.cloudformation.engine.v2.change_set_model import (
     NodeProperties,
     NodeProperty,
     NodeResource,
+    NodeResources,
     NodeTemplate,
     Nothing,
     NothingType,
@@ -44,6 +46,7 @@ from localstack.services.cloudformation.engine.v2.change_set_model_visitor impor
     ChangeSetModelVisitor,
 )
 from localstack.services.cloudformation.engine.v2.resolving import (
+    REGEX_DYNAMIC_REF,
     extract_dynamic_reference,
     perform_dynamic_reference_lookup,
 )
@@ -52,7 +55,9 @@ from localstack.services.cloudformation.stores import (
     exports_map,
 )
 from localstack.services.cloudformation.v2.entities import ChangeSet
+from localstack.services.cloudformation.v2.types import ResolvedResource
 from localstack.utils.aws.arns import get_partition
+from localstack.utils.numbers import to_number
 from localstack.utils.objects import get_value_from_path
 from localstack.utils.run import to_str
 from localstack.utils.strings import to_bytes
@@ -73,7 +78,11 @@ _PSEUDO_PARAMETERS: Final[set[str]] = {
 
 TBefore = TypeVar("TBefore")
 TAfter = TypeVar("TAfter")
+_T = TypeVar("_T")
 
+REGEX_OUTPUT_APIGATEWAY = re.compile(
+    rf"^(https?://.+\.execute-api\.)(?:[^-]+-){{2,3}}\d\.(amazonaws\.com|{_AWS_URL_SUFFIX})/?(.*)$"
+)
 MOCKED_REFERENCE = "unknown"
 
 VALID_LOGICAL_RESOURCE_ID_RE = re.compile(r"^[A-Za-z0-9]+$")
@@ -113,6 +122,7 @@ class PreprocResource:
     properties: PreprocProperties
     depends_on: list[str] | None
     requires_replacement: bool
+    status: ResourceStatus | None
 
     def __init__(
         self,
@@ -123,6 +133,7 @@ class PreprocResource:
         properties: PreprocProperties,
         depends_on: list[str] | None,
         requires_replacement: bool,
+        status: ResourceStatus | None = None,
     ):
         self.logical_id = logical_id
         self.physical_resource_id = physical_resource_id
@@ -131,6 +142,7 @@ class PreprocResource:
         self.properties = properties
         self.depends_on = depends_on
         self.requires_replacement = requires_replacement
+        self.status = status
 
     @staticmethod
     def _compare_conditions(c1: bool, c2: bool):
@@ -215,6 +227,8 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
     def process(self) -> None:
         self._setup_runtime_cache()
         node_template = self._change_set.update_model.node_template
+        node_conditions = self._change_set.update_model.node_template.conditions
+        self.visit(node_conditions)
         self.visit(node_template)
         self._save_runtime_cache()
 
@@ -260,16 +274,16 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
                 f"No deployed instances of resource '{resource_logical_id}' were found"
             )
         properties = resolved_resource.get("Properties", {})
-        # support structured properties, e.g. NestedStack.Outputs.OutputName
+        # TODO support structured properties, e.g. NestedStack.Outputs.OutputName
         property_value: Any | None = get_value_from_path(properties, property_name)
 
         if property_value:
-            if not isinstance(property_value, str):
-                # TODO: is this correct? If there is a bug in the logic here, it's probably
-                #  better to know about it with a clear error message than to receive some form
-                #  of message about trying to use a dictionary in place of a string
+            if not isinstance(property_value, (str, list, dict)):
+                # Str: Standard expected type. TODO validate bools and numbers
+                # List: Multiple resource types can return a list of values e.g. AWS::EC2::VPC.
+                # Dict: Custom resources in CloudFormation can return arbitrary data structures.
                 raise RuntimeError(
-                    f"Accessing property '{property_name}' from '{resource_logical_id}' resulted in a non-string value"
+                    f"Accessing property '{property_name}' from '{resource_logical_id}' resulted in a non-string value nor list"
                 )
             return property_value
         elif config.CFN_IGNORE_UNSUPPORTED_RESOURCE_TYPES:
@@ -395,10 +409,63 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
             return PreprocEntityDelta(before=before, after=after)
         delta = super().visit(change_set_entity=change_set_entity)
         if isinstance(delta, PreprocEntityDelta):
+            delta = self._maybe_perform_replacements(delta)
             self._before_cache[entity_scope] = delta.before
             self._after_cache[entity_scope] = delta.after
         return delta
 
+    def _maybe_perform_replacements(self, delta: PreprocEntityDelta) -> PreprocEntityDelta:
+        delta = self._maybe_perform_static_replacements(delta)
+        delta = self._maybe_perform_dynamic_replacements(delta)
+        return delta
+
+    def _maybe_perform_static_replacements(self, delta: PreprocEntityDelta) -> PreprocEntityDelta:
+        return self._maybe_perform_on_delta(delta, self._perform_static_replacements)
+
+    def _maybe_perform_dynamic_replacements(self, delta: PreprocEntityDelta) -> PreprocEntityDelta:
+        return self._maybe_perform_on_delta(delta, self._perform_dynamic_replacements)
+
+    def _maybe_perform_on_delta(
+        self, delta: PreprocEntityDelta | None, f: Callable[[_T], _T]
+    ) -> PreprocEntityDelta | None:
+        if isinstance(delta.before, str):
+            delta.before = f(delta.before)
+        if isinstance(delta.after, str):
+            delta.after = f(delta.after)
+        return delta
+
+    def _perform_dynamic_replacements(self, value: _T) -> _T:
+        if not isinstance(value, str):
+            return value
+
+        if dynamic_ref := extract_dynamic_reference(value):
+            new_value = perform_dynamic_reference_lookup(
+                reference=dynamic_ref,
+                account_id=self._change_set.account_id,
+                region_name=self._change_set.region_name,
+            )
+            if new_value:
+                # We need to use a function here, to avoid backslash processing by regex.
+                # From the regex sub documentation:
+                # repl can be a string or a function; if it is a string, any backslash escapes in it are processed.
+                # Using a function, we can avoid this processing.
+                return REGEX_DYNAMIC_REF.sub(lambda _: new_value, value)
+
+        return value
+
+    @staticmethod
+    def _perform_static_replacements(value: str) -> str:
+        api_match = REGEX_OUTPUT_APIGATEWAY.match(value)
+        if api_match and value not in config.CFN_STRING_REPLACEMENT_DENY_LIST:
+            prefix = api_match[1]
+            host = api_match[2]
+            path = api_match[3]
+            port = localstack_host().port
+            value = f"{prefix}{host}:{port}/{path}"
+            return value
+
+        return value
+
     def _cached_apply(
         self, scope: Scope, arguments_delta: PreprocEntityDelta, resolver: Callable[[Any], Any]
     ) -> PreprocEntityDelta:
@@ -447,6 +514,9 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
 
         return PreprocEntityDelta(before=before, after=after)
 
+    def visit_node_property(self, node_property: NodeProperty) -> PreprocEntityDelta:
+        return self.visit(node_property.value)
+
     def visit_terminal_value_modified(
         self, terminal_value_modified: TerminalValueModified
     ) -> PreprocEntityDelta:
@@ -486,9 +556,9 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
             delta: PreprocEntityDelta = self.visit(change_set_entity=change_set_entity)
             delta_before = delta.before
             delta_after = delta.after
-            if not is_nothing(before) and not is_nothing(delta_before) and delta_before is not None:
+            if not is_nothing(before) and not is_nothing(delta_before):
                 before[name] = delta_before
-            if not is_nothing(after) and not is_nothing(delta_after) and delta_after is not None:
+            if not is_nothing(after) and not is_nothing(delta_after):
                 after[name] = delta_after
         return PreprocEntityDelta(before=before, after=after)
 
@@ -499,13 +569,49 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
             arguments_list = arguments.split(".")
         else:
             arguments_list = arguments
+
+        if len(arguments_list) < 2:
+            raise ValidationError(
+                "Template error: every Fn::GetAtt object requires two non-empty parameters, the resource name and the resource attribute"
+            )
+
         logical_name_of_resource = arguments_list[0]
-        attribute_name = arguments_list[1]
+        attribute_name = ".".join(arguments_list[1:])
 
         node_resource = self._get_node_resource_for(
             resource_name=logical_name_of_resource,
             node_template=self._change_set.update_model.node_template,
         )
+
+        if not is_nothing(node_resource.condition_reference):
+            condition = self._get_node_condition_if_exists(node_resource.condition_reference.value)
+            evaluation_result = self._resolve_condition(condition.name)
+
+            if select_before and not evaluation_result.before:
+                raise ValidationError(
+                    f"Template format error: Unresolved resource dependencies [{logical_name_of_resource}] in the Resources block of the template"
+                )
+
+            if not select_before and not evaluation_result.after:
+                raise ValidationError(
+                    f"Template format error: Unresolved resource dependencies [{logical_name_of_resource}] in the Resources block of the template"
+                )
+
+        # Custom Resources can mutate their definition
+        # So the preproc should search first in the resource values and then check the template
+        if select_before:
+            value = self._before_deployed_property_value_of(
+                resource_logical_id=logical_name_of_resource,
+                property_name=attribute_name,
+            )
+        else:
+            value = self._after_deployed_property_value_of(
+                resource_logical_id=logical_name_of_resource,
+                property_name=attribute_name,
+            )
+        if value is not None:
+            return value
+
         node_property: NodeProperty | None = self._get_node_property_for(
             property_name=attribute_name, node_resource=node_resource
         )
@@ -513,19 +619,7 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
             # The property is statically defined in the template and its value can be computed.
             property_delta = self.visit(node_property)
             value = property_delta.before if select_before else property_delta.after
-        else:
-            # The property is not statically defined and must therefore be available in
-            # the properties deployed set.
-            if select_before:
-                value = self._before_deployed_property_value_of(
-                    resource_logical_id=logical_name_of_resource,
-                    property_name=attribute_name,
-                )
-            else:
-                value = self._after_deployed_property_value_of(
-                    resource_logical_id=logical_name_of_resource,
-                    property_name=attribute_name,
-                )
+
         return value
 
     def visit_node_intrinsic_function_fn_get_att(
@@ -554,6 +648,12 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
             return args[0] == args[1]
 
         arguments_delta = self.visit(node_intrinsic_function.arguments)
+
+        if isinstance(arguments_delta.after, list) and len(arguments_delta.after) != 2:
+            raise ValidationError(
+                "Template error: every Fn::Equals object requires a list of 2 string parameters."
+            )
+
         delta = self._cached_apply(
             scope=node_intrinsic_function.scope,
             arguments_delta=arguments_delta,
@@ -630,8 +730,12 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
     def visit_node_intrinsic_function_fn_not(
         self, node_intrinsic_function: NodeIntrinsicFunction
     ) -> PreprocEntityDelta:
-        def _compute_fn_not(arg: bool) -> bool:
-            return not arg
+        def _compute_fn_not(arg: list[bool] | bool) -> bool:
+            # Is the argument ever a lone boolean?
+            if isinstance(arg, list):
+                return not arg[0]
+            else:
+                return not arg
 
         arguments_delta = self.visit(node_intrinsic_function.arguments)
         delta = self._cached_apply(
@@ -779,13 +883,27 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
     ):
         # TODO: add further support for schema validation
         def _compute_fn_select(args: list[Any]) -> Any:
-            values: list[Any] = args[1]
+            values = args[1]
+            # defer evaluation if the selection list contains unresolved elements (e.g., unresolved intrinsics)
+            if isinstance(values, list) and not all(isinstance(value, str) for value in values):
+                raise RuntimeError("Fn::Select list contains unresolved elements")
+
             if not isinstance(values, list) or not values:
-                raise RuntimeError(f"Invalid arguments list value for Fn::Select: '{values}'")
+                raise ValidationError(
+                    "Template error: Fn::Select requires a list argument with two elements: an integer index and a list"
+                )
+            try:
+                index: int = int(args[0])
+            except ValueError as e:
+                raise ValidationError(
+                    "Template error: Fn::Select requires a list argument with two elements: an integer index and a list"
+                ) from e
+
             values_len = len(values)
-            index: int = int(args[0])
-            if not isinstance(index, int) or index < 0 or index > values_len:
-                raise RuntimeError(f"Invalid or out of range index value for Fn::Select: '{index}'")
+            if index < 0 or index >= values_len:
+                raise ValidationError(
+                    "Template error: Fn::Select requires a list argument with two elements: an integer index and a list"
+                )
             selection = values[index]
             return selection
 
@@ -812,6 +930,17 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
             return split_string
 
         arguments_delta = self.visit(node_intrinsic_function.arguments)
+
+        if not (
+            is_nothing(arguments_delta.after)
+            or isinstance(arguments_delta.after, list)
+            and len(arguments_delta.after) == 2
+        ):
+            raise ValidationError(
+                "Template error: every Fn::Split object requires two parameters, "
+                "(1) a string delimiter and (2) a string to be split or a function that returns a string to be split."
+            )
+
         delta = self._cached_apply(
             scope=node_intrinsic_function.scope,
             arguments_delta=arguments_delta,
@@ -911,6 +1040,10 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
         return PreprocEntityDelta(before=before_parameters, after=after_parameters)
 
     def visit_node_parameter(self, node_parameter: NodeParameter) -> PreprocEntityDelta:
+        if not VALID_LOGICAL_RESOURCE_ID_RE.match(node_parameter.name):
+            raise ValidationError(
+                f"Template format error: Parameter name {node_parameter.name} is non alphanumeric."
+            )
         dynamic_value = node_parameter.dynamic_value
         dynamic_delta = self.visit(dynamic_value)
 
@@ -924,8 +1057,11 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
 
         def _resolve_parameter_type(value: str, type_: str) -> Any:
             match type_:
-                case "List<String>":
+                case "List<String>" | "CommaDelimitedList":
                     return [item.strip() for item in value.split(",")]
+                case "Number":
+                    # TODO: validate the parameter type at template parse time (or whatever is in parity with AWS) so we know this cannot fail
+                    return to_number(value)
             return value
 
         if not is_nothing(after):
@@ -942,11 +1078,17 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
         return delta
 
     def _resource_physical_resource_id_from(
-        self, logical_resource_id: str, resolved_resources: dict
-    ) -> str:
+        self, logical_resource_id: str, resolved_resources: dict[str, ResolvedResource]
+    ) -> str | None:
         # TODO: typing around resolved resources is needed and should be reflected here.
         resolved_resource = resolved_resources.get(logical_resource_id, {})
-        physical_resource_id: str | None = resolved_resource.get("PhysicalResourceId")
+        if resolved_resource.get("ResourceStatus") not in {
+            ResourceStatus.CREATE_COMPLETE,
+            ResourceStatus.UPDATE_COMPLETE,
+        }:
+            return None
+
+        physical_resource_id = resolved_resource.get("PhysicalResourceId")
         if not isinstance(physical_resource_id, str):
             raise RuntimeError(f"No PhysicalResourceId found for resource '{logical_resource_id}'")
         return physical_resource_id
@@ -965,6 +1107,9 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
         self, node_intrinsic_function: NodeIntrinsicFunction
     ) -> PreprocEntityDelta:
         def _compute_fn_ref(logical_id: str) -> PreprocEntityDelta:
+            if logical_id == "AWS::NoValue":
+                return Nothing
+
             reference_delta: PreprocEntityDelta = self._resolve_reference(logical_id=logical_id)
             if isinstance(before := reference_delta.before, PreprocResource):
                 reference_delta.before = before.physical_resource_id
@@ -1013,25 +1158,6 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
                 after.append(delta_after)
         return PreprocEntityDelta(before=before, after=after)
 
-    def visit_node_property(self, node_property: NodeProperty) -> PreprocEntityDelta:
-        # TODO: what about other positions?
-        value = self.visit(node_property.value)
-        if not is_nothing(value.before):
-            if dynamic_ref := extract_dynamic_reference(value.before):
-                value.before = perform_dynamic_reference_lookup(
-                    reference=dynamic_ref,
-                    account_id=self._change_set.account_id,
-                    region_name=self._change_set.region_name,
-                )
-        if not is_nothing(value.after):
-            if dynamic_ref := extract_dynamic_reference(value.after):
-                value.after = perform_dynamic_reference_lookup(
-                    reference=dynamic_ref,
-                    account_id=self._change_set.account_id,
-                    region_name=self._change_set.region_name,
-                )
-        return value
-
     def visit_node_properties(
         self, node_properties: NodeProperties
     ) -> PreprocEntityDelta[PreprocProperties, PreprocProperties]:
@@ -1077,6 +1203,20 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
             after = after_delta.after
         return PreprocEntityDelta(before=before, after=after)
 
+    def visit_node_resources(self, node_resources: NodeResources):
+        """
+        Skip resources where they conditionally evaluate to False
+        """
+        for node_resource in node_resources.resources:
+            if not is_nothing(node_resource.condition_reference):
+                condition_delta = self._resolve_resource_condition_reference(
+                    node_resource.condition_reference
+                )
+                condition_after = condition_delta.after
+                if condition_after is False:
+                    continue
+            self.visit(node_resource)
+
     def visit_node_resource(
         self, node_resource: NodeResource
     ) -> PreprocEntityDelta[PreprocResource, PreprocResource]:
@@ -1187,6 +1327,14 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
         before: list[PreprocOutput] = []
         after: list[PreprocOutput] = []
         for node_output in node_outputs.outputs:
+            if not is_nothing(node_output.condition_reference):
+                condition_delta = self._resolve_resource_condition_reference(
+                    node_output.condition_reference
+                )
+                condition_after = condition_delta.after
+                if condition_after is False:
+                    continue
+
             output_delta: PreprocEntityDelta[PreprocOutput, PreprocOutput] = self.visit(node_output)
             output_before = output_delta.before
             output_after = output_delta.after
@@ -1216,3 +1364,8 @@ class ChangeSetModelPreproc(ChangeSetModelVisitor):
             resolver=_compute_fn_import_value,
         )
         return delta
+
+    def visit_node_intrinsic_function_fn_transform(
+        self, node_intrinsic_function: NodeIntrinsicFunction
+    ):
+        raise RuntimeError("Fn::Transform should have been handled by the Transformer")