localstack-core 4.3.1.dev6__py3-none-any.whl → 4.3.1.dev27__py3-none-any.whl

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

@@ -7,12 +7,16 @@ import localstack.aws.api.cloudformation as cfn_api
 from localstack.services.cloudformation.engine.v2.change_set_model import (
     ChangeSetEntity,
     ChangeType,
+    ConditionKey,
+    ExportKey,
     NodeArray,
     NodeCondition,
     NodeDivergence,
     NodeIntrinsicFunction,
     NodeMapping,
     NodeObject,
+    NodeOutput,
+    NodeOutputs,
     NodeParameter,
     NodeProperties,
     NodeProperty,
@@ -26,6 +30,7 @@ from localstack.services.cloudformation.engine.v2.change_set_model import (
     TerminalValueModified,
     TerminalValueRemoved,
     TerminalValueUnchanged,
+    ValueKey,
 )
 from localstack.services.cloudformation.engine.v2.change_set_model_visitor import (
     ChangeSetModelVisitor,
@@ -47,14 +52,20 @@ class ChangeSetModelDescriber(ChangeSetModelVisitor):
     _node_template: Final[NodeTemplate]
     _changes: Final[cfn_api.Changes]
     _describe_unit_cache: dict[Scope, DescribeUnit]
+    _include_property_values: Final[cfn_api.IncludePropertyValues | None]
 
-    def __init__(self, node_template: NodeTemplate):
+    def __init__(
+        self,
+        node_template: NodeTemplate,
+        include_property_values: cfn_api.IncludePropertyValues | None = None,
+    ):
         self._node_template = node_template
         self._changes = list()
         self._describe_unit_cache = dict()
-        self.visit(self._node_template)
+        self._include_property_values = include_property_values
 
     def get_changes(self) -> cfn_api.Changes:
+        self.visit(self._node_template)
         return self._changes
 
     @staticmethod
@@ -112,12 +123,13 @@ class ChangeSetModelDescriber(ChangeSetModelVisitor):
             return parameter_unit
 
         # TODO: check for KNOWN AFTER APPLY values for logical ids coming from intrinsic functions as arguments.
-        #   node_resource = self._get_node_resource_for(
-        #       resource_name=logica_id, node_template=self._node_template
-        #   )
-        limitation_str = "Cannot yet compute Ref values for Resources"
-        resource_unit = DescribeUnit(before_context=limitation_str, after_context=limitation_str)
-        return resource_unit
+        node_resource = self._get_node_resource_for(
+            resource_name=logica_id, node_template=self._node_template
+        )
+        resource_unit = self.visit(node_resource)
+        before_context = resource_unit.before_context
+        after_context = resource_unit.after_context
+        return DescribeUnit(before_context=before_context, after_context=after_context)
 
     def _resolve_mapping(self, map_name: str, top_level_key: str, second_level_key) -> DescribeUnit:
         # TODO: add support for nested intrinsic functions, and KNOWN AFTER APPLY logical ids.
@@ -210,29 +222,37 @@ class ChangeSetModelDescriber(ChangeSetModelVisitor):
         arguments_unit = self.visit(node_intrinsic_function.arguments)
         # TODO: validate the return value according to the spec.
         before_argument_list = arguments_unit.before_context
-        before_logical_name_of_resource = before_argument_list[0]
-        before_attribute_name = before_argument_list[1]
-        before_node_resource = self._get_node_resource_for(
-            resource_name=before_logical_name_of_resource, node_template=self._node_template
-        )
-        node_property: TerminalValue = self._get_node_property_for(
-            property_name=before_attribute_name, node_resource=before_node_resource
-        )
+        after_argument_list = arguments_unit.after_context
+
+        before_context = None
+        if before_argument_list:
+            before_logical_name_of_resource = before_argument_list[0]
+            before_attribute_name = before_argument_list[1]
+            before_node_resource = self._get_node_resource_for(
+                resource_name=before_logical_name_of_resource, node_template=self._node_template
+            )
+            before_node_property = self._get_node_property_for(
+                property_name=before_attribute_name, node_resource=before_node_resource
+            )
+            before_property_unit = self.visit(before_node_property)
+            before_context = before_property_unit.before_context
 
-        before_context = node_property.value.value
-        if node_property.change_type != ChangeType.UNCHANGED:
+        after_context = None
+        if after_argument_list:
             after_context = CHANGESET_KNOWN_AFTER_APPLY
-        else:
-            after_context = node_property.value.value
+            # TODO: the following is the logic to resolve the attribute in the `after` template
+            #  this should be moved to the new base class and then be masked in this describer.
+            # after_logical_name_of_resource = after_argument_list[0]
+            # after_attribute_name = after_argument_list[1]
+            # after_node_resource = self._get_node_resource_for(
+            #     resource_name=after_logical_name_of_resource, node_template=self._node_template
+            # )
+            # after_node_property = self._get_node_property_for(
+            #     property_name=after_attribute_name, node_resource=after_node_resource
+            # )
+            # after_property_unit = self.visit(after_node_property)
+            # after_context = after_property_unit.after_context
 
-        match node_intrinsic_function.change_type:
-            case ChangeType.MODIFIED:
-                return DescribeUnit(before_context=before_context, after_context=after_context)
-            case ChangeType.CREATED:
-                return DescribeUnit(after_context=after_context)
-            case ChangeType.REMOVED:
-                return DescribeUnit(before_context=before_context)
-        # Unchanged
         return DescribeUnit(before_context=before_context, after_context=after_context)
 
     def visit_node_intrinsic_function_fn_equals(
@@ -342,12 +362,16 @@ class ChangeSetModelDescriber(ChangeSetModelVisitor):
 
         # TODO: add tests with created and deleted parameters and verify this logic holds.
         before_logical_id = arguments_unit.before_context
-        before_unit = self._resolve_reference(logica_id=before_logical_id)
-        before_context = before_unit.before_context
+        before_context = None
+        if before_logical_id is not None:
+            before_unit = self._resolve_reference(logica_id=before_logical_id)
+            before_context = before_unit.before_context
 
         after_logical_id = arguments_unit.after_context
-        after_unit = self._resolve_reference(logica_id=after_logical_id)
-        after_context = after_unit.after_context
+        after_context = None
+        if after_logical_id is not None:
+            after_unit = self._resolve_reference(logica_id=after_logical_id)
+            after_context = after_unit.after_context
 
         return DescribeUnit(before_context=before_context, after_context=after_context)
 
@@ -406,21 +430,71 @@ class ChangeSetModelDescriber(ChangeSetModelVisitor):
         )
         return DescribeUnit(before_context=before_context, after_context=after_context)
 
+    def visit_node_output(self, node_output: NodeOutput) -> DescribeUnit:
+        # This logic is not required for Describe operations,
+        # and should be ported a new base for this class type.
+        change_type = node_output.change_type
+        value_unit = self.visit(node_output.value)
+
+        condition_unit = None
+        if node_output.condition_reference is not None:
+            condition_unit = self._resolve_resource_condition_reference(
+                node_output.condition_reference
+            )
+            condition_before = condition_unit.before_context
+            condition_after = condition_unit.after_context
+            if not condition_before and condition_after:
+                change_type = ChangeType.CREATED
+            elif condition_before and not condition_after:
+                change_type = ChangeType.REMOVED
+
+        export_unit = None
+        if node_output.export is not None:
+            export_unit = self.visit(node_output.export)
+
+        before_context = None
+        after_context = None
+        if change_type != ChangeType.REMOVED:
+            after_context = {"Name": node_output.name, ValueKey: value_unit.after_context}
+            if export_unit:
+                after_context[ExportKey] = export_unit.after_context
+            if condition_unit:
+                after_context[ConditionKey] = condition_unit.after_context
+        if change_type != ChangeType.CREATED:
+            before_context = {"Name": node_output.name, ValueKey: value_unit.before_context}
+            if export_unit:
+                before_context[ExportKey] = export_unit.before_context
+            if condition_unit:
+                before_context[ConditionKey] = condition_unit.before_context
+        return DescribeUnit(before_context=before_context, after_context=after_context)
+
+    def visit_node_outputs(self, node_outputs: NodeOutputs) -> DescribeUnit:
+        # This logic is not required for Describe operations,
+        # and should be ported a new base for this class type.
+        before_context = list()
+        after_context = list()
+        for node_output in node_outputs.outputs:
+            output_unit = self.visit(node_output)
+            output_before = output_unit.before_context
+            output_after = output_unit.after_context
+            if output_before:
+                before_context.append(output_before)
+            if output_after:
+                after_context.append(output_after)
+        return DescribeUnit(before_context=before_context, after_context=after_context)
+
     def visit_node_resource(self, node_resource: NodeResource) -> DescribeUnit:
-        condition_unit = self._resolve_resource_condition_reference(
-            node_resource.condition_reference
-        )
-        condition_before = condition_unit.before_context
-        condition_after = condition_unit.after_context
-        if not condition_before and condition_after:
-            change_type = ChangeType.CREATED
-        elif condition_before and not condition_after:
-            change_type = ChangeType.REMOVED
-        else:
-            change_type = node_resource.change_type
-        if change_type == ChangeType.UNCHANGED:
-            # TODO
-            return None
+        change_type = node_resource.change_type
+        if node_resource.condition_reference is not None:
+            condition_unit = self._resolve_resource_condition_reference(
+                node_resource.condition_reference
+            )
+            condition_before = condition_unit.before_context
+            condition_after = condition_unit.after_context
+            if not condition_before and condition_after:
+                change_type = ChangeType.CREATED
+            elif condition_before and not condition_after:
+                change_type = ChangeType.REMOVED
 
         resource_change = cfn_api.ResourceChange()
         resource_change["LogicalResourceId"] = node_resource.name
@@ -432,28 +506,28 @@ class ChangeSetModelDescriber(ChangeSetModelVisitor):
         )
 
         properties_describe_unit = self.visit(node_resource.properties)
-        match change_type:
-            case ChangeType.MODIFIED:
-                resource_change["Action"] = cfn_api.ChangeAction.Modify
-                resource_change["BeforeContext"] = properties_describe_unit.before_context
-                resource_change["AfterContext"] = properties_describe_unit.after_context
-            case ChangeType.CREATED:
-                resource_change["Action"] = cfn_api.ChangeAction.Add
-                resource_change["AfterContext"] = properties_describe_unit.after_context
-            case ChangeType.REMOVED:
-                resource_change["Action"] = cfn_api.ChangeAction.Remove
-                resource_change["BeforeContext"] = properties_describe_unit.before_context
-
-        self._changes.append(
-            cfn_api.Change(Type=cfn_api.ChangeType.Resource, ResourceChange=resource_change)
-        )
 
-        # TODO
-        return None
+        if change_type != ChangeType.UNCHANGED:
+            match change_type:
+                case ChangeType.MODIFIED:
+                    resource_change["Action"] = cfn_api.ChangeAction.Modify
+                    resource_change["BeforeContext"] = properties_describe_unit.before_context
+                    resource_change["AfterContext"] = properties_describe_unit.after_context
+                case ChangeType.CREATED:
+                    resource_change["Action"] = cfn_api.ChangeAction.Add
+                    resource_change["AfterContext"] = properties_describe_unit.after_context
+                case ChangeType.REMOVED:
+                    resource_change["Action"] = cfn_api.ChangeAction.Remove
+                    resource_change["BeforeContext"] = properties_describe_unit.before_context
+            self._changes.append(
+                cfn_api.Change(Type=cfn_api.ChangeType.Resource, ResourceChange=resource_change)
+            )
 
-    # def visit_node_resources(self, node_resources: NodeResources) -> DescribeUnit:
-    #     for node_resource in node_resources.resources:
-    #         if node_resource.change_type != ChangeType.UNCHANGED:
-    #             self.visit_node_resource(node_resource=node_resource)
-    #     # TODO
-    #     return None
+        before_context = None
+        after_context = None
+        # TODO: reconsider what is the describe unit return value for a resource type.
+        if change_type != ChangeType.CREATED:
+            before_context = node_resource.name
+        if change_type != ChangeType.REMOVED:
+            after_context = node_resource.name
+        return DescribeUnit(before_context=before_context, after_context=after_context)

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

@@ -0,0 +1,170 @@
+import logging
+import uuid
+from typing import Final
+
+from localstack.aws.api.cloudformation import ChangeAction
+from localstack.constants import INTERNAL_AWS_SECRET_ACCESS_KEY
+from localstack.services.cloudformation.engine.v2.change_set_model import (
+    NodeIntrinsicFunction,
+    NodeResource,
+    NodeTemplate,
+    TerminalValue,
+)
+from localstack.services.cloudformation.engine.v2.change_set_model_describer import (
+    ChangeSetModelDescriber,
+    DescribeUnit,
+)
+from localstack.services.cloudformation.resource_provider import (
+    Credentials,
+    OperationStatus,
+    ProgressEvent,
+    ResourceProviderExecutor,
+    ResourceProviderPayload,
+    get_resource_type,
+)
+
+LOG = logging.getLogger(__name__)
+
+
+class ChangeSetModelExecutor(ChangeSetModelDescriber):
+    account_id: Final[str]
+    region: Final[str]
+
+    def __init__(
+        self,
+        node_template: NodeTemplate,
+        account_id: str,
+        region: str,
+        stack_name: str,
+        stack_id: str,
+    ):
+        super().__init__(node_template)
+        self.account_id = account_id
+        self.region = region
+        self.stack_name = stack_name
+        self.stack_id = stack_id
+        self.resources = {}
+
+    def execute(self) -> dict:
+        self.visit(self._node_template)
+        return self.resources
+
+    def visit_node_resource(self, node_resource: NodeResource) -> DescribeUnit:
+        resource_provider_executor = ResourceProviderExecutor(
+            stack_name=self.stack_name, stack_id=self.stack_id
+        )
+
+        # TODO: investigate effects on type changes
+        properties_describe_unit = self.visit_node_properties(node_resource.properties)
+        LOG.info("SRW: describe unit: %s", properties_describe_unit)
+
+        action = node_resource.change_type.to_action()
+        if action is None:
+            raise RuntimeError(
+                f"Action should always be present, got change type: {node_resource.change_type}"
+            )
+
+        # TODO
+        resource_type = get_resource_type({"Type": "AWS::SSM::Parameter"})
+        payload = self.create_resource_provider_payload(
+            properties_describe_unit,
+            action,
+            node_resource.name,
+            resource_type,
+        )
+        resource_provider = resource_provider_executor.try_load_resource_provider(resource_type)
+
+        extra_resource_properties = {}
+        if resource_provider is not None:
+            # TODO: stack events
+            event = resource_provider_executor.deploy_loop(
+                resource_provider, extra_resource_properties, payload
+            )
+        else:
+            event = ProgressEvent(OperationStatus.SUCCESS, resource_model={})
+
+        self.resources.setdefault(node_resource.name, {"Properties": {}})
+        match event.status:
+            case OperationStatus.SUCCESS:
+                # merge the resources state with the external state
+                # TODO: this is likely a duplicate of updating from extra_resource_properties
+                self.resources[node_resource.name]["Properties"].update(event.resource_model)
+                self.resources[node_resource.name].update(extra_resource_properties)
+                # XXX for legacy delete_stack compatibility
+                self.resources[node_resource.name]["LogicalResourceId"] = node_resource.name
+                self.resources[node_resource.name]["Type"] = resource_type
+            case any:
+                raise NotImplementedError(f"Event status '{any}' not handled")
+
+        return DescribeUnit(before_context=None, after_context={})
+
+    def visit_node_intrinsic_function_fn_get_att(
+        self, node_intrinsic_function: NodeIntrinsicFunction
+    ) -> DescribeUnit:
+        arguments_unit = self.visit(node_intrinsic_function.arguments)
+        before_arguments_list = arguments_unit.before_context
+        after_arguments_list = arguments_unit.after_context
+        if before_arguments_list:
+            logical_name_of_resource = before_arguments_list[0]
+            attribute_name = before_arguments_list[1]
+            before_node_resource = self._get_node_resource_for(
+                resource_name=logical_name_of_resource, node_template=self._node_template
+            )
+            node_property: TerminalValue = self._get_node_property_for(
+                property_name=attribute_name, node_resource=before_node_resource
+            )
+            before_context = self.visit(node_property.value).before_context
+        else:
+            before_context = None
+
+        if after_arguments_list:
+            logical_name_of_resource = after_arguments_list[0]
+            attribute_name = after_arguments_list[1]
+            after_node_resource = self._get_node_resource_for(
+                resource_name=logical_name_of_resource, node_template=self._node_template
+            )
+            node_property: TerminalValue = self._get_node_property_for(
+                property_name=attribute_name, node_resource=after_node_resource
+            )
+            after_context = self.visit(node_property.value).after_context
+        else:
+            after_context = None
+
+        return DescribeUnit(before_context=before_context, after_context=after_context)
+
+    def create_resource_provider_payload(
+        self,
+        describe_unit: DescribeUnit,
+        action: ChangeAction,
+        logical_resource_id: str,
+        resource_type: str,
+    ) -> ResourceProviderPayload:
+        # FIXME: use proper credentials
+        creds: Credentials = {
+            "accessKeyId": self.account_id,
+            "secretAccessKey": INTERNAL_AWS_SECRET_ACCESS_KEY,
+            "sessionToken": "",
+        }
+        resource_provider_payload: ResourceProviderPayload = {
+            "awsAccountId": self.account_id,
+            "callbackContext": {},
+            "stackId": self.stack_name,
+            "resourceType": resource_type,
+            "resourceTypeVersion": "000000",
+            # TODO: not actually a UUID
+            "bearerToken": str(uuid.uuid4()),
+            "region": self.region,
+            "action": str(action),
+            "requestData": {
+                "logicalResourceId": logical_resource_id,
+                "resourceProperties": describe_unit.after_context["Properties"],
+                "previousResourceProperties": describe_unit.before_context["Properties"],
+                "callerCredentials": creds,
+                "providerCredentials": creds,
+                "systemTags": {},
+                "previousSystemTags": {},
+                "stackTags": {},
+                "previousStackTags": {},
+            },
+        }
+        return resource_provider_payload

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

@@ -10,6 +10,8 @@ from localstack.services.cloudformation.engine.v2.change_set_model import (
     NodeMapping,
     NodeMappings,
     NodeObject,
+    NodeOutput,
+    NodeOutputs,
     NodeParameter,
     NodeParameters,
     NodeProperties,
@@ -53,6 +55,12 @@ class ChangeSetModelVisitor(abc.ABC):
     def visit_node_mappings(self, node_mappings: NodeMappings):
         self.visit_children(node_mappings)
 
+    def visit_node_outputs(self, node_outputs: NodeOutputs):
+        self.visit_children(node_outputs)
+
+    def visit_node_output(self, node_output: NodeOutput):
+        self.visit_children(node_output)
+
     def visit_node_parameters(self, node_parameters: NodeParameters):
         self.visit_children(node_parameters)
 

localstack/services/cloudformation/v2/provider.py

@@ -1,3 +1,4 @@
+import logging
 from copy import deepcopy
 
 from localstack.aws.api import RequestContext, handler
@@ -5,12 +6,18 @@ from localstack.aws.api.cloudformation import (
     ChangeSetNameOrId,
     ChangeSetNotFoundException,
     ChangeSetType,
+    ClientRequestToken,
     CreateChangeSetInput,
     CreateChangeSetOutput,
     DescribeChangeSetOutput,
+    DisableRollback,
+    ExecuteChangeSetOutput,
+    ExecutionStatus,
     IncludePropertyValues,
+    InvalidChangeSetStatusException,
     NextToken,
     Parameter,
+    RetainExceptOnCreate,
     StackNameOrId,
     StackStatus,
 )
@@ -27,6 +34,9 @@ from localstack.services.cloudformation.engine.template_utils import resolve_sta
 from localstack.services.cloudformation.engine.v2.change_set_model_describer import (
     ChangeSetModelDescriber,
 )
+from localstack.services.cloudformation.engine.v2.change_set_model_executor import (
+    ChangeSetModelExecutor,
+)
 from localstack.services.cloudformation.engine.validations import ValidationError
 from localstack.services.cloudformation.provider import (
     ARN_CHANGESET_REGEX,
@@ -41,6 +51,8 @@ from localstack.services.cloudformation.stores import (
 )
 from localstack.utils.collections import remove_attributes
 
+LOG = logging.getLogger(__name__)
+
 
 class CloudformationProviderV2(CloudformationProvider):
     @handler("CreateChangeSet", expand=False)
@@ -178,7 +190,12 @@ class CloudformationProviderV2(CloudformationProvider):
 
         # create change set for the stack and apply changes
         change_set = StackChangeSet(
-            context.account_id, context.region, stack, req_params, transformed_template
+            context.account_id,
+            context.region,
+            stack,
+            req_params,
+            transformed_template,
+            change_set_type=change_set_type,
         )
         # only set parameters for the changeset, then switch to stack on execute_change_set
         change_set.template_body = template_body
@@ -233,14 +250,61 @@ class CloudformationProviderV2(CloudformationProvider):
 
         return CreateChangeSetOutput(StackId=change_set.stack_id, Id=change_set.change_set_id)
 
+    @handler("ExecuteChangeSet")
+    def execute_change_set(
+        self,
+        context: RequestContext,
+        change_set_name: ChangeSetNameOrId,
+        stack_name: StackNameOrId | None = None,
+        client_request_token: ClientRequestToken | None = None,
+        disable_rollback: DisableRollback | None = None,
+        retain_except_on_create: RetainExceptOnCreate | None = None,
+        **kwargs,
+    ) -> ExecuteChangeSetOutput:
+        change_set = find_change_set(
+            context.account_id,
+            context.region,
+            change_set_name,
+            stack_name=stack_name,
+            active_only=True,
+        )
+        if not change_set:
+            raise ChangeSetNotFoundException(f"ChangeSet [{change_set_name}] does not exist")
+        if change_set.metadata.get("ExecutionStatus") != ExecutionStatus.AVAILABLE:
+            LOG.debug("Change set %s not in execution status 'AVAILABLE'", change_set_name)
+            raise InvalidChangeSetStatusException(
+                f"ChangeSet [{change_set.metadata['ChangeSetId']}] cannot be executed in its current status of [{change_set.metadata.get('Status')}]"
+            )
+        stack_name = change_set.stack.stack_name
+        LOG.debug(
+            'Executing change set "%s" for stack "%s" with %s resources ...',
+            change_set_name,
+            stack_name,
+            len(change_set.template_resources),
+        )
+        if not change_set.update_graph:
+            raise RuntimeError("Programming error: no update graph found for change set")
+
+        change_set_executor = ChangeSetModelExecutor(
+            change_set.update_graph,
+            account_id=context.account_id,
+            region=context.region,
+            stack_name=change_set.stack.stack_name,
+            stack_id=change_set.stack.stack_id,
+        )
+        new_resources = change_set_executor.execute()
+        change_set.stack.set_stack_status(f"{change_set.change_set_type or 'UPDATE'}_COMPLETE")
+        change_set.stack.resources = new_resources
+        return ExecuteChangeSetOutput()
+
     @handler("DescribeChangeSet")
     def describe_change_set(
         self,
         context: RequestContext,
         change_set_name: ChangeSetNameOrId,
-        stack_name: StackNameOrId = None,
-        next_token: NextToken = None,
-        include_property_values: IncludePropertyValues = None,
+        stack_name: StackNameOrId | None = None,
+        next_token: NextToken | None = None,
+        include_property_values: IncludePropertyValues | None = None,
         **kwargs,
     ) -> DescribeChangeSetOutput:
         # TODO add support for include_property_values
@@ -261,8 +325,10 @@ class CloudformationProviderV2(CloudformationProvider):
         if not change_set:
             raise ChangeSetNotFoundException(f"ChangeSet [{change_set_name}] does not exist")
 
-        change_set_describer = ChangeSetModelDescriber(node_template=change_set.update_graph)
-        resource_changes = change_set_describer.get_resource_changes()
+        change_set_describer = ChangeSetModelDescriber(
+            node_template=change_set.update_graph, include_property_values=include_property_values
+        )
+        resource_changes = change_set_describer.get_changes()
 
         attrs = [
             "ChangeSetType",