Skip to content

update validation for dead letter queue #2324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 21, 2022
Merged

update validation for dead letter queue #2324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions samtranslator/model/sam_resources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,6 +593,12 @@ def _validate_dlq(self):
"'DeadLetterQueue' requires Type and TargetArn properties to be specified.".format(valid_dlq_types),
)

if not (isinstance(self.DeadLetterQueue.get("Type"), str)):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you update this method to validate that the DeadLetterQueue is of type Dict, and if not raise a validation error.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know this is necessary as this is already handled by sam. And this error is thrown when DeadLetterQueue is not dict Type of property 'DeadLetterQueue' is invalid.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure where I can find this error, but I found this usage where we just check that the self.DeadLetterQueue is not None

serverless-application-model/samtranslator/model/sam_resources.py

Lines 139 to 140 in cae2729

if self.DeadLetterQueue:
self._validate_dlq()

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @jonife for the clarification

raise InvalidResourceException(
self.logical_id,
"'DeadLetterQueue' property 'Type' should be of type str.",
)

# Validate required Types
if not self.DeadLetterQueue["Type"] in self.dead_letter_queue_policy_actions:
raise InvalidResourceException(
Expand Down
17 changes: 17 additions & 0 deletions tests/translator/input/error_function_with_invalid_dlq_property_type.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Transform: "AWS::Serverless-2016-10-31"
Parameter:
DeadLetterQueueType:
Type: String
Default: SQS

Resources:
MySqsDlqLambdaFunction:
Type: AWS::Serverless::Function
Properties:
Handler: index.handler
Runtime: python2.7
CodeUri: s3://sam-demo-bucket/hello.zip
DeadLetterQueue:
Type:
Ref: DeadLetterQueueType
TargetArn: arn
8 changes: 8 additions & 0 deletions tests/translator/output/error_function_with_invalid_dlq_property_type.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"errors": [
{
"errorMessage": "Invalid Serverless Application Specification document. Number of errors found: 1. Resource with id [MySqsDlqLambdaFunction] is invalid. 'DeadLetterQueue' property 'Type' should be of type str."
}
],
"errorMessage": "Invalid Serverless Application Specification document. Number of errors found: 1. Resource with id [MySqsDlqLambdaFunction] is invalid. 'DeadLetterQueue' property 'Type' should be of type str."
}