-
Notifications
You must be signed in to change notification settings - Fork 590
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New rule W0510 to validate transform order (#3151)
* New rule W0510 to validate transform order
- Loading branch information
Showing
8 changed files
with
108 additions
and
0 deletions.
There are no files selected for viewing
39 changes: 39 additions & 0 deletions
39
src/cfnlint/rules/transforms/LanguageExtensionsBeforeSAM.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
""" | ||
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
SPDX-License-Identifier: MIT-0 | ||
""" | ||
|
||
from cfnlint.rules import CloudFormationLintRule, RuleMatch | ||
|
||
|
||
class LanguageExtensionsBeforeSAM(CloudFormationLintRule): | ||
"""Check if Serverless Resources exist without the Serverless Transform""" | ||
|
||
id = "W0510" | ||
shortdesc = "Put LanguageExtensions before SAM transform" | ||
description = ( | ||
"If using language extensions with SAM, you should add AWS::LanguageExtensions " | ||
"before the serverless transform (that is, before AWS::Serverless-2016-10-31)" | ||
) | ||
source_url = "https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification-template-anatomy.html" | ||
tags = ["transforms"] | ||
|
||
def match(self, cfn): | ||
matches = [] | ||
|
||
if isinstance(cfn.transform_pre["Transform"], list): | ||
flag = False | ||
for i, transform in enumerate(cfn.transform_pre["Transform"]): | ||
if transform == "AWS::Serverless-2016-10-31": | ||
flag = True | ||
if transform == "AWS::LanguageExtensions" and flag: | ||
matches.append( | ||
RuleMatch( | ||
["Transform", i], | ||
( | ||
"Place 'AWS::LanguageExtensions' before " | ||
"'AWS::Serverless-2016-10-31'" | ||
), | ||
) | ||
) | ||
return matches |
Empty file.
10 changes: 10 additions & 0 deletions
10
test/fixtures/templates/bad/transforms/language_extensions_with_sam.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Transform: | ||
- AWS::Serverless-2016-10-31 | ||
- AWS::LanguageExtensions | ||
Resources: | ||
MyFunction: | ||
Type: AWS::Serverless::Function | ||
Properties: | ||
Handler: index.handler | ||
Runtime: nodejs20.x | ||
CodeUri: 's3://testBucket/mySourceCode.zip' |
6 changes: 6 additions & 0 deletions
6
test/fixtures/templates/good/transforms/language_extensions_with_other.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Transform: | ||
- MyOtherTransform | ||
- AWS::LanguageExtensions | ||
Resources: | ||
Bucket: | ||
Type: AWS::S3::Bucket |
10 changes: 10 additions & 0 deletions
10
test/fixtures/templates/good/transforms/language_extensions_with_sam.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Transform: | ||
- AWS::LanguageExtensions | ||
- AWS::Serverless-2016-10-31 | ||
Resources: | ||
MyFunction: | ||
Type: AWS::Serverless::Function | ||
Properties: | ||
Handler: index.handler | ||
Runtime: nodejs20.x | ||
CodeUri: 's3://testBucket/mySourceCode.zip' |
8 changes: 8 additions & 0 deletions
8
test/fixtures/templates/good/transforms/string_transform.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
Transform: AWS::Serverless-2016-10-31 | ||
Resources: | ||
MyFunction: | ||
Type: AWS::Serverless::Function | ||
Properties: | ||
Handler: index.handler | ||
Runtime: nodejs20.x | ||
CodeUri: 's3://testBucket/mySourceCode.zip' |
Empty file.
35 changes: 35 additions & 0 deletions
35
test/unit/rules/transforms/test_language_extensions_before_sam.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
""" | ||
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
SPDX-License-Identifier: MIT-0 | ||
""" | ||
|
||
from test.unit.rules import BaseRuleTestCase | ||
|
||
from cfnlint.rules.transforms.LanguageExtensionsBeforeSAM import ( | ||
LanguageExtensionsBeforeSAM, # pylint: disable=E0401 | ||
) | ||
|
||
|
||
class TestLanguageExtensionsBeforeSAM(BaseRuleTestCase): | ||
"""Test template limit size""" | ||
|
||
def setUp(self): | ||
"""Setup""" | ||
super(TestLanguageExtensionsBeforeSAM, self).setUp() | ||
self.collection.register(LanguageExtensionsBeforeSAM()) | ||
self.success_templates = [ | ||
"test/fixtures/templates/good/transforms/language_extensions_with_sam.yaml", | ||
"test/fixtures/templates/good/transforms/string_transform.yaml", | ||
"test/fixtures/templates/good/transforms/language_extensions_with_other.yaml", | ||
] | ||
|
||
def test_file_positive(self): | ||
"""Test Positive""" | ||
self.helper_file_positive() | ||
|
||
def test_file_negative(self): | ||
"""Test failure""" | ||
self.helper_file_negative( | ||
"test/fixtures/templates/bad/transforms/language_extensions_with_sam.yaml", | ||
1, | ||
) |