localstack-core 4.11.2.dev14__py3-none-any.whl → 4.12.1.dev25__py3-none-any.whl

localstack/services/sns/provider.py

@@ -86,6 +86,7 @@ from localstack.utils.aws.arns import (
 from localstack.utils.collections import PaginatedList, select_from_typed_dict
 from localstack.utils.strings import short_uid, to_bytes, to_str
 
+from ...state import StateVisitor
 from .analytics import internal_api_calls
 
 # set up logger
@@ -118,6 +119,10 @@ class SnsProvider(SnsApi, ServiceLifecycleHook):
         self._publisher = PublishDispatcher()
         self._signature_cert_pem: str = SNS_SERVER_CERT
 
+    def accept_state_visitor(self, visitor: StateVisitor):
+        visitor.visit(sns_backends)
+        visitor.visit(sns_stores)
+
     def on_before_stop(self):
         self._publisher.shutdown()
 

localstack/services/sns/v2/models.py

@@ -7,6 +7,7 @@ from typing import Literal, TypedDict
 from localstack.aws.api.sns import (
     Endpoint,
     MessageAttributeMap,
+    PhoneNumber,
     PlatformApplication,
     PublishBatchRequestEntry,
     TopicAttributesMap,
@@ -28,6 +29,7 @@ class Topic(TypedDict, total=True):
     arn: str
     name: str
     attributes: TopicAttributesMap
+    data_protection_policy: str
     subscriptions: list[str]
 
 
@@ -192,5 +194,7 @@ class SnsStore(BaseStore):
 
     TAGS: TaggingService = CrossRegionAttribute(default=TaggingService)
 
+    PHONE_NUMBERS_OPTED_OUT: list[PhoneNumber] = CrossRegionAttribute(default=list)
+
 
 sns_stores = AccountRegionBundle("sns", SnsStore)

localstack/services/sns/v2/provider.py

@@ -10,14 +10,18 @@ from rolo import Request, Router, route
 
 from localstack.aws.api import CommonServiceException, RequestContext
 from localstack.aws.api.sns import (
+    ActionsList,
     AmazonResourceName,
     BatchEntryIdsNotDistinctException,
+    CheckIfPhoneNumberIsOptedOutResponse,
     ConfirmSubscriptionResponse,
     CreateEndpointResponse,
     CreatePlatformApplicationResponse,
     CreateTopicResponse,
+    DelegatesList,
     Endpoint,
     EndpointDisabledException,
+    GetDataProtectionPolicyResponse,
     GetEndpointAttributesResponse,
     GetPlatformApplicationAttributesResponse,
     GetSMSAttributesResponse,
@@ -26,6 +30,7 @@ from localstack.aws.api.sns import (
     InvalidParameterException,
     InvalidParameterValueException,
     ListEndpointsByPlatformApplicationResponse,
+    ListPhoneNumbersOptedOutResponse,
     ListPlatformApplicationsResponse,
     ListString,
     ListSubscriptionsByTopicResponse,
@@ -35,6 +40,7 @@ from localstack.aws.api.sns import (
     MapStringToString,
     MessageAttributeMap,
     NotFoundException,
+    OptInPhoneNumberResponse,
     PhoneNumber,
     PlatformApplication,
     PublishBatchRequestEntryList,
@@ -57,10 +63,12 @@ from localstack.aws.api.sns import (
     attributeValue,
     authenticateOnUnsubscribe,
     endpoint,
+    label,
     message,
     messageStructure,
     nextToken,
     protocol,
+    string,
     subject,
     subscriptionARN,
     topicARN,
@@ -84,6 +92,7 @@ from localstack.services.sns.constants import (
     SUBSCRIPTION_TOKENS_ENDPOINT,
     VALID_APPLICATION_PLATFORMS,
     VALID_MSG_ATTR_NAME_CHARS,
+    VALID_POLICY_ACTIONS,
     VALID_SUBSCRIPTION_ATTR_NAME,
 )
 from localstack.services.sns.filter import FilterPolicyValidator
@@ -118,6 +127,7 @@ from localstack.services.sns.v2.utils import (
     parse_and_validate_topic_arn,
     validate_subscription_attribute,
 )
+from localstack.state import StateVisitor
 from localstack.utils.aws.arns import (
     extract_account_id_from_arn,
     extract_region_from_arn,
@@ -142,6 +152,9 @@ class SnsProvider(SnsApi, ServiceLifecycleHook):
         self._publisher = PublishDispatcher()
         self._signature_cert_pem: str = SNS_SERVER_CERT
 
+    def accept_state_visitor(self, visitor: StateVisitor):
+        visitor.visit(sns_stores)
+
     def on_before_stop(self):
         self._publisher.shutdown()
 
@@ -202,6 +215,8 @@ class SnsProvider(SnsApi, ServiceLifecycleHook):
             if not name_match:
                 raise InvalidParameterException("Invalid parameter: Topic Name")
 
+        attributes["EffectiveDeliveryPolicy"] = _create_default_effective_delivery_policy()
+
         topic = _create_topic(name=name, attributes=attributes, context=context)
         if tags:
             self.tag_resource(context=context, resource_arn=topic_arn, tags=tags)
@@ -1073,6 +1088,116 @@ class SnsProvider(SnsApi, ServiceLifecycleHook):
 
         return GetSMSAttributesResponse(attributes=return_attributes)
 
+    #
+    # Phone number operations
+    #
+
+    def check_if_phone_number_is_opted_out(
+        self, context: RequestContext, phone_number: PhoneNumber, **kwargs
+    ) -> CheckIfPhoneNumberIsOptedOutResponse:
+        store = sns_stores[context.account_id][context.region]
+        return CheckIfPhoneNumberIsOptedOutResponse(
+            isOptedOut=phone_number in store.PHONE_NUMBERS_OPTED_OUT
+        )
+
+    def list_phone_numbers_opted_out(
+        self, context: RequestContext, next_token: string | None = None, **kwargs
+    ) -> ListPhoneNumbersOptedOutResponse:
+        store = self.get_store(context.account_id, context.region)
+        numbers_opted_out = PaginatedList(store.PHONE_NUMBERS_OPTED_OUT)
+        page, nxt = numbers_opted_out.get_page(
+            token_generator=lambda x: x,
+            next_token=next_token,
+            page_size=100,
+        )
+        phone_numbers = {"phoneNumbers": page, "nextToken": nxt}
+        return ListPhoneNumbersOptedOutResponse(**phone_numbers)
+
+    def opt_in_phone_number(
+        self, context: RequestContext, phone_number: PhoneNumber, **kwargs
+    ) -> OptInPhoneNumberResponse:
+        store = self.get_store(context.account_id, context.region)
+        if phone_number in store.PHONE_NUMBERS_OPTED_OUT:
+            store.PHONE_NUMBERS_OPTED_OUT.remove(phone_number)
+        return OptInPhoneNumberResponse()
+
+    #
+    # Permission operations
+    #
+
+    def add_permission(
+        self,
+        context: RequestContext,
+        topic_arn: topicARN,
+        label: label,
+        aws_account_id: DelegatesList,
+        action_name: ActionsList,
+        **kwargs,
+    ) -> None:
+        topic: Topic = self._get_topic(topic_arn, context)
+        policy = json.loads(topic["attributes"]["Policy"])
+        statement = next(
+            (statement for statement in policy["Statement"] if statement["Sid"] == label),
+            None,
+        )
+
+        if statement:
+            raise InvalidParameterException("Invalid parameter: Statement already exists")
+
+        if any(action not in VALID_POLICY_ACTIONS for action in action_name):
+            raise InvalidParameterException(
+                "Invalid parameter: Policy statement action out of service scope!"
+            )
+
+        principals = [
+            f"arn:{get_partition(context.region)}:iam::{account_id}:root"
+            for account_id in aws_account_id
+        ]
+        actions = [f"SNS:{action}" for action in action_name]
+
+        statement = {
+            "Sid": label,
+            "Effect": "Allow",
+            "Principal": {"AWS": principals[0] if len(principals) == 1 else principals},
+            "Action": actions[0] if len(actions) == 1 else actions,
+            "Resource": topic_arn,
+        }
+
+        policy["Statement"].append(statement)
+        topic["attributes"]["Policy"] = json.dumps(policy)
+
+    def remove_permission(
+        self, context: RequestContext, topic_arn: topicARN, label: label, **kwargs
+    ) -> None:
+        topic = self._get_topic(topic_arn, context)
+        policy = json.loads(topic["attributes"]["Policy"])
+        statements = policy["Statement"]
+        statements = [statement for statement in statements if statement["Sid"] != label]
+        policy["Statement"] = statements
+        topic["attributes"]["Policy"] = json.dumps(policy)
+
+    #
+    # Data Protection Policy operations
+    #
+
+    def get_data_protection_policy(
+        self, context: RequestContext, resource_arn: topicARN, **kwargs
+    ) -> GetDataProtectionPolicyResponse:
+        topic = self._get_topic(resource_arn, context)
+        return GetDataProtectionPolicyResponse(
+            DataProtectionPolicy=topic.get("data_protection_policy")
+        )
+
+    def put_data_protection_policy(
+        self,
+        context: RequestContext,
+        resource_arn: topicARN,
+        data_protection_policy: attributeValue,
+        **kwargs,
+    ) -> None:
+        topic = self._get_topic(resource_arn, context)
+        topic["data_protection_policy"] = data_protection_policy
+
     def list_tags_for_resource(
         self, context: RequestContext, resource_arn: AmazonResourceName, **kwargs
     ) -> ListTagsForResourceResponse:
@@ -1170,6 +1295,26 @@ def _default_attributes(topic: Topic, context: RequestContext) -> TopicAttribute
     return default_attributes
 
 
+def _create_default_effective_delivery_policy():
+    return json.dumps(
+        {
+            "http": {
+                "defaultHealthyRetryPolicy": {
+                    "minDelayTarget": 20,
+                    "maxDelayTarget": 20,
+                    "numRetries": 3,
+                    "numMaxDelayRetries": 0,
+                    "numNoDelayRetries": 0,
+                    "numMinDelayRetries": 0,
+                    "backoffFunction": "linear",
+                },
+                "disableSubscriptionOverrides": False,
+                "defaultRequestPolicy": {"headerContentType": "text/plain; charset=UTF-8"},
+            }
+        }
+    )
+
+
 def _create_default_topic_policy(topic: Topic, context: RequestContext) -> str:
     return json.dumps(
         {

localstack/services/sqs/constants.py

@@ -31,6 +31,12 @@ INTERNAL_QUEUE_ATTRIBUTES = [
     QueueAttributeName.QueueArn,
 ]
 
+#
+# If these attributes are set to their default values, they are effectively
+# deleted from the queue attributes and not returned in future calls to get_queue_attributes()
+#
+DELETE_IF_DEFAULT = {"KmsMasterKeyId": "", "KmsDataKeyReusePeriodSeconds": "300"}
+
 INVALID_STANDARD_QUEUE_ATTRIBUTES = [
     QueueAttributeName.FifoQueue,
     QueueAttributeName.ContentBasedDeduplication,

localstack/services/sqs/provider.py

@@ -101,6 +101,7 @@ from localstack.services.sqs.utils import (
     parse_queue_url,
 )
 from localstack.services.stores import AccountRegionBundle
+from localstack.state import StateVisitor
 from localstack.utils.aws.arns import parse_arn
 from localstack.utils.bootstrap import is_api_enabled
 from localstack.utils.cloudwatch.cloudwatch_util import (
@@ -659,6 +660,9 @@ class SqsProvider(SqsApi, ServiceLifecycleHook):
         self._router_rules = []
         self._init_cloudwatch_metrics_reporting()
 
+    def accept_state_visitor(self, visitor: StateVisitor):
+        visitor.visit(sqs_stores)
+
     @staticmethod
     def get_store(account_id: str, region: str) -> SqsStore:
         return sqs_stores[account_id][region]
@@ -1269,7 +1273,11 @@ class SqsProvider(SqsApi, ServiceLifecycleHook):
         for k, v in attributes.items():
             if k in sqs_constants.INTERNAL_QUEUE_ATTRIBUTES:
                 raise InvalidAttributeName(f"Unknown Attribute {k}.")
-            queue.attributes[k] = v
+            if k in sqs_constants.DELETE_IF_DEFAULT and v == sqs_constants.DELETE_IF_DEFAULT[k]:
+                if k in queue.attributes:
+                    del queue.attributes[k]
+            else:
+                queue.attributes[k] = v
 
         # Special cases
         if queue.attributes.get(QueueAttributeName.Policy) == "":

localstack/services/sqs/resource_providers/aws_sqs_queue.py

@@ -64,6 +64,35 @@ class SQSQueueProvider(ResourceProvider[SQSQueueProperties]):
     TYPE = "AWS::SQS::Queue"  # Autogenerated. Don't change
     SCHEMA = util.get_schema_path(Path(__file__))  # Autogenerated. Don't change
 
+    # Values used when a property is removed from a template and needs to be set to its default.
+    # If AWS changes their defaults in the future, our parity tests should break.
+    DEFAULT_ATTRIBUTE_VALUES = {
+        "ReceiveMessageWaitTimeSeconds": "0",
+        "DelaySeconds": "0",
+        "KmsMasterKeyId": "",
+        "RedrivePolicy": "",
+        "MessageRetentionPeriod": "345600",
+        "MaximumMessageSize": "262144",  # Note: CloudFormation sets this to 256KB on update, but 1MB on create
+        "VisibilityTimeout": "30",
+        "KmsDataKeyReusePeriodSeconds": "300",
+    }
+
+    # Private method for creating a unique queue name, if none is specified.
+    def _autogenerated_queue_name(self, request: ResourceRequest[SQSQueueProperties]) -> str:
+        queue_name = util.generate_default_name(request.stack_name, request.logical_resource_id)
+        isFifoQueue = request.desired_state.get("FifoQueue")
+
+        # Note that it's an SQS FIFO queue only if the FifoQueue property is set to boolean True, or the string "true"
+        # (case insensitive). If it's None (property was omitted) or False, or any type of string (e.g. a typo
+        # such as "Fasle"), then it's not a FIFO queue. This extra check is needed because the CloudFormation engine
+        # doesn't fully validate the FifoQueue property before passing it to the resource provider.
+        if (
+            isFifoQueue == True  # noqa: E712
+            or (isinstance(isFifoQueue, str) and isFifoQueue.lower() == "true")
+        ):
+            queue_name = f"{queue_name[:-5]}.fifo"
+        return queue_name
+
     def create(
         self,
         request: ResourceRequest[SQSQueueProperties],
@@ -74,8 +103,6 @@ class SQSQueueProvider(ResourceProvider[SQSQueueProperties]):
         Primary identifier fields:
           - /properties/QueueUrl
 
-
-
         Create-only properties:
           - /properties/FifoQueue
           - /properties/QueueName
@@ -92,26 +119,13 @@ class SQSQueueProvider(ResourceProvider[SQSQueueProperties]):
           - sqs:TagQueue
 
         """
-        # TODO: validations
+        # TODO: validations - what validations are needed?
         model = request.desired_state
         sqs = request.aws_client_factory.sqs
 
-        if model.get("FifoQueue", False):
-            model["FifoQueue"] = model["FifoQueue"]
-
-        queue_name = model.get("QueueName")
-        if not queue_name:
-            # TODO: verify patterns here
-            if model.get("FifoQueue"):
-                queue_name = util.generate_default_name(
-                    request.stack_name, request.logical_resource_id
-                )[:-5]
-                queue_name = f"{queue_name}.fifo"
-            else:
-                queue_name = util.generate_default_name(
-                    request.stack_name, request.logical_resource_id
-                )
-            model["QueueName"] = queue_name
+        # if no QueueName is specified, automatically generate one
+        if not model.get("QueueName"):
+            model["QueueName"] = self._autogenerated_queue_name(request)
 
         attributes = self._compile_sqs_queue_attributes(model)
         result = request.aws_client_factory.sqs.create_queue(
@@ -184,38 +198,30 @@ class SQSQueueProvider(ResourceProvider[SQSQueueProperties]):
         """
         sqs = request.aws_client_factory.sqs
         model = request.desired_state
+        prev_model = request.previous_state
 
         assert request.previous_state is not None
 
-        should_replace = (
-            request.desired_state.get("QueueName", request.previous_state["QueueName"])
-            != request.previous_state["QueueName"]
-        ) or (
-            request.desired_state.get("FifoQueue", request.previous_state.get("FifoQueue"))
-            != request.previous_state.get("FifoQueue")
+        queue_url = prev_model["QueueUrl"]
+        self._populate_missing_attributes_with_defaults(model)
+        sqs.set_queue_attributes(
+            QueueUrl=queue_url, Attributes=self._compile_sqs_queue_attributes(model)
         )
 
-        if not should_replace:
-            return ProgressEvent(OperationStatus.SUCCESS, resource_model=request.previous_state)
-
-        # TODO: copied from the create handler, extract?
-        if model.get("FifoQueue"):
-            queue_name = util.generate_default_name(
-                request.stack_name, request.logical_resource_id
-            )[:-5]
-            queue_name = f"{queue_name}.fifo"
-        else:
-            queue_name = util.generate_default_name(request.stack_name, request.logical_resource_id)
-
-        # replacement (TODO: find out if we should handle this in the provider or outside of it)
-        # delete old queue
-        sqs.delete_queue(QueueUrl=request.previous_state["QueueUrl"])
-        # create new queue (TODO: re-use create logic to make this more robust, e.g. for
-        #  auto-generated queue names)
-        model["QueueUrl"] = sqs.create_queue(QueueName=queue_name)["QueueUrl"]
-        model["Arn"] = sqs.get_queue_attributes(
-            QueueUrl=model["QueueUrl"], AttributeNames=["QueueArn"]
-        )["Attributes"]["QueueArn"]
+        (tags_to_remove, tags_to_add_or_update) = util.resource_tags_to_remove_or_update(
+            prev_model.get("Tags", []), model.get("Tags", [])
+        )
+        sqs.untag_queue(QueueUrl=queue_url, TagKeys=tags_to_remove)
+        sqs.tag_queue(QueueUrl=queue_url, Tags=tags_to_add_or_update)
+
+        model["QueueUrl"] = queue_url
+        model["Arn"] = request.previous_state["Arn"]
+
+        # For QueueName and FifoQueue, always use the value from the previous model. These fields
+        # are create-only, so they cannot be changed via an update (even though they might be omitted)
+        model["QueueName"] = prev_model.get("QueueName")
+        model["FifoQueue"] = prev_model.get("FifoQueue", False)
+
         return ProgressEvent(OperationStatus.SUCCESS, resource_model=model)
 
     def _compile_sqs_queue_attributes(self, properties: SQSQueueProperties) -> dict[str, str]:
@@ -250,6 +256,15 @@ class SQSQueueProvider(ResourceProvider[SQSQueueProperties]):
 
         return result
 
+    def _populate_missing_attributes_with_defaults(self, properties: SQSQueueProperties) -> None:
+        """
+        For any attribute that is missing from the desired state, populate it with the default value.
+        This is the only way to remove an attribute from an existing SQS queue's configuration.
+        :param properties: the properties passed from cloudformation
+        """
+        for k, v in self.DEFAULT_ATTRIBUTE_VALUES.items():
+            properties.setdefault(k, v)
+
     def list(
         self,
         request: ResourceRequest[SQSQueueProperties],

localstack/services/ssm/provider.py

@@ -78,6 +78,7 @@ from localstack.aws.api.ssm import (
 )
 from localstack.aws.connect import connect_to
 from localstack.services.moto import call_moto, call_moto_with_request
+from localstack.state import StateVisitor
 from localstack.utils.aws.arns import extract_resource_from_arn, is_arn
 from localstack.utils.bootstrap import is_api_enabled
 from localstack.utils.collections import remove_attributes
@@ -105,6 +106,11 @@ class InvalidParameterNameException(ValidationException):
 
 # TODO: check if _normalize_name(..) calls are still required here
 class SsmProvider(SsmApi, ABC):
+    def accept_state_visitor(self, visitor: StateVisitor):
+        from moto.ssm.models import ssm_backends
+
+        visitor.visit(ssm_backends)
+
     def get_parameters(
         self,
         context: RequestContext,