Make pycfmodel available for Python3.10 (#100)

w0rmr1d3r · jsoucheiron · web-flow · commit 0201ffa60fb8 · 2022-05-19T15:06:52.000+02:00
* make pycfmodel available for Python3.10

* update version and changelog

* update changelog

* update changelog

* update version

* update cloudformation_actions.py

Co-authored-by: Ramon &lt;ramon.guimera@skyscanner.net&gt;
Co-authored-by: Jordi Soucheiron &lt;jsoucheiron@users.noreply.github.com&gt;
diff --git a/.github/workflows/lint-and-test.yml b/.github/workflows/lint-and-test.yml
@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.7', '3.8', '3.9']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 
     name: Python ${{ matrix.python-version }}
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,10 +3,11 @@ All notable changes to this project will be documented in this file.
 
 ## 0.20.0
 ### Additions
-- New `RDSDBSecurityGroup` and `RDSDBSecurityGroupIngress` resources
+- New `RDSDBSecurityGroup` and `RDSDBSecurityGroupIngress` resources [#103]
 ### Improvements
 - IAM Role is able to return its `AssumeRolePolicyDocument` as a list of `OptionallyNamedPolicyDocument`. [#102](https://github.com/Skyscanner/pycfmodel/pull/102)
 ### Updates
+- Compatible with Python3.10 [#100](https://github.com/Skyscanner/pycfmodel/pull/100)
 - Update `CLOUDFORMATION_ACTIONS`.
 
 ## 0.19.1
diff --git a/tests/resources/properties/test_policy_document.py b/tests/resources/properties/test_policy_document.py
@@ -73,18 +73,13 @@ def policy_document_not_principal():
         **{
             "Statement": [
                 {
-                    "Action": [
-                        "iam:Delete*",
-                        "s3:GetObject*",
-                    ],
+                    "Action": ["iam:Delete*", "s3:GetObject*"],
                     "Effect": "Allow",
                     "Resource": "arn:aws:s3:::fakebucketfakebucket/*",
                     "NotPrincipal": {"AWS": ["156460612806"]},
                 },
                 {
-                    "Action": [
-                        "s3:List*",
-                    ],
+                    "Action": ["s3:List*"],
                     "Effect": "Deny",
                     "Resource": "arn:aws:s3:::fakebucketfakebucket/*",
                     "NotPrincipal": {"AWS": ["156460612806"]},
@@ -287,13 +282,11 @@ def policy_document_not_action():
         **{
             "Statement": [
                 {
-                    "NotAction": [
-                        "rds:*",
-                    ],
+                    "NotAction": ["rds:*"],
                     "Effect": "Allow",
                     "Resource": "arn:aws:s3:::fakebucketfakebucket/*",
                     "NotPrincipal": {"AWS": ["156460612806"]},
-                },
+                }
             ]
         }
     )
@@ -315,8 +308,8 @@ def policy_document_condition_with_source_ip():
                     "Effect": "Allow",
                     "Principal": {"AWS": "*"},
                     "Resource": "arn:aws:s3:::fakebucketfakebucket/*",
-                },
-            ],
+                }
+            ]
         }
     )
 
@@ -332,8 +325,8 @@ def policy_document_condition_with_source_vpce():
                     "Effect": "Allow",
                     "Principal": {"AWS": "*"},
                     "Resource": "arn:aws:s3:::fakebucketfakebucket/*",
-                },
-            ],
+                }
+            ]
         }
     )
 
diff --git a/tests/resources/properties/test_statement_condition.py b/tests/resources/properties/test_statement_condition.py
@@ -155,10 +155,7 @@ def test_build_evaluator_null(function: str, arg_a: Any, arg_b: Any, params: Dic
 
 @pytest.mark.parametrize(
     "function, arg_a, arg_b, params, expected_output",
-    [
-        ("NumericEquals", "patata", 1, {"patata": 1}, True),
-        ("NumericEquals", "patata", 1, {"patata": 2}, False),
-    ],
+    [("NumericEquals", "patata", 1, {"patata": 1}, True), ("NumericEquals", "patata", 1, {"patata": 2}, False)],
 )
 def test_build_evaluator_numeric_equals(function: str, arg_a: Any, arg_b: Any, params: Dict, expected_output: bool):
     node = build_evaluator(function, arg_a, arg_b)
@@ -167,10 +164,7 @@ def test_build_evaluator_numeric_equals(function: str, arg_a: Any, arg_b: Any, p
 
 @pytest.mark.parametrize(
     "function, arg_a, arg_b, params, expected_output",
-    [
-        ("NumericNotEquals", "patata", 1, {"patata": 1}, False),
-        ("NumericNotEquals", "patata", 1, {"patata": 2}, True),
-    ],
+    [("NumericNotEquals", "patata", 1, {"patata": 1}, False), ("NumericNotEquals", "patata", 1, {"patata": 2}, True)],
 )
 def test_build_evaluator_numeric_not_equals(function: str, arg_a: Any, arg_b: Any, params: Dict, expected_output: bool):
     node = build_evaluator(function, arg_a, arg_b)
diff --git a/tests/resources/test_ec2_vpc_endpoint_policy.py b/tests/resources/test_ec2_vpc_endpoint_policy.py
@@ -12,14 +12,7 @@ def ec2_vpc_endpoint_policy():
             "Properties": {
                 "PolicyDocument": {
                     "Version": "2012-10-17",
-                    "Statement": [
-                        {
-                            "Effect": "Allow",
-                            "Principal": "*",
-                            "Action": ["s3:GetObject"],
-                            "Resource": "*",
-                        }
-                    ],
+                    "Statement": [{"Effect": "Allow", "Principal": "*", "Action": ["s3:GetObject"], "Resource": "*"}],
                 },
                 "RouteTableIds": [{"Ref": "routetableA"}, {"Ref": "routetableB"}],
                 "ServiceName": "com.amazonaws.eu-west-1.s3",
diff --git a/tests/resources/test_es_domain.py b/tests/resources/test_es_domain.py
@@ -6,12 +6,7 @@
 
 @pytest.fixture()
 def valid_empty_es_domain():
-    return ESDomain(
-        **{
-            "Type": "AWS::Elasticsearch::Domain",
-            "Properties": {},
-        }
-    )
+    return ESDomain(**{"Type": "AWS::Elasticsearch::Domain", "Properties": {}})
 
 
 @pytest.fixture()
@@ -168,14 +163,7 @@ def test_valid_es_domain_from_aws_documentation_examples_resource_can_be_built(
 
 def test_raise_error_if_invalid_fields_in_resource():
     with pytest.raises(ValidationError) as exc_info:
-        ESDomain(
-            **{
-                "Type": "AWS::Elasticsearch::Domain",
-                "Properties": {
-                    "DomainName": [],
-                },
-            }
-        )
+        ESDomain(**{"Type": "AWS::Elasticsearch::Domain", "Properties": {"DomainName": []}})
 
     assert exc_info.value.errors() == [
         {"loc": ("Properties", "DomainName"), "msg": "str type expected", "type": "type_error.str"},
diff --git a/tests/resources/test_generic_resoure.py b/tests/resources/test_generic_resoure.py
@@ -82,11 +82,7 @@ def test_generic_resource_with_bad_json_as_string_is_converted_to_a_string_prope
 
 
 def test_parse_generic_resource_without_properties():
-    resource = GenericResource.parse_obj(
-        {
-            "Type": "AWS::SNS::Topic",
-        }
-    )
+    resource = GenericResource.parse_obj({"Type": "AWS::SNS::Topic"})
     assert isinstance(resource, GenericResource)
     assert resource.Properties is None
     assert resource.Type == "AWS::SNS::Topic"
diff --git a/tests/resources/test_iam_role.py b/tests/resources/test_iam_role.py
@@ -18,10 +18,8 @@ def iam_role():
                         "Action": ["sts:AssumeRole"],
                         "Condition": {
                             "StringLike": {
-                                "iam:AssociatedResourceARN": [
-                                    "arn:aws:ec2:us-east-1:999999999999:instance/*",
-                                ]
-                            },
+                                "iam:AssociatedResourceARN": ["arn:aws:ec2:us-east-1:999999999999:instance/*"]
+                            }
                         },
                     },
                 },
@@ -69,9 +67,7 @@ def test_all_conditions(iam_role):
     }
 
     assert iam_role.assume_role_statement_conditions[0].StringLike == {
-        "iam:AssociatedResourceARN": [
-            "arn:aws:ec2:us-east-1:999999999999:instance/*",
-        ]
+        "iam:AssociatedResourceARN": ["arn:aws:ec2:us-east-1:999999999999:instance/*"]
     }
 
 
diff --git a/tests/resources/test_opensearch_domain.py b/tests/resources/test_opensearch_domain.py
@@ -9,12 +9,7 @@
 
 @pytest.fixture()
 def valid_empty_opensearch_domain():
-    return OpenSearchDomain(
-        **{
-            "Type": "AWS::OpenSearchService::Domain",
-            "Properties": {},
-        }
-    )
+    return OpenSearchDomain(**{"Type": "AWS::OpenSearchService::Domain", "Properties": {}})
 
 
 @pytest.fixture()
@@ -82,8 +77,8 @@ def valid_opensearch_domain_with_access_policies():
                             "Action": "es:*",
                             "Resource": "arn:aws:es:us-east-1:123456789012:domain/test/*",
                         }
-                    ],
-                },
+                    ]
+                }
             },
         }
     )
@@ -201,14 +196,7 @@ def test_valid_opensearch_domain_from_aws_documentation_examples_resource_can_be
 
 def test_raise_error_if_invalid_fields_in_resource():
     with pytest.raises(ValidationError) as exc_info:
-        OpenSearchDomain(
-            **{
-                "Type": "AWS::OpenSearchService::Domain",
-                "Properties": {
-                    "DomainName": [],
-                },
-            }
-        )
+        OpenSearchDomain(**{"Type": "AWS::OpenSearchService::Domain", "Properties": {"DomainName": []}})
 
     assert exc_info.value.errors() == [
         {"loc": ("Properties", "DomainName"), "msg": "str type expected", "type": "type_error.str"},
@@ -240,5 +228,5 @@ def test_can_obtain_policy_documents_from_inherited_method(valid_opensearch_doma
                 ]
             ),
             name=None,
-        ),
+        )
     ]
diff --git a/tests/resources/test_s3_bucket.py b/tests/resources/test_s3_bucket.py
@@ -20,10 +20,7 @@ def valid_s3_bucket():
                             "Id": "MyRule1",
                             "Status": "Enabled",
                             "Prefix": "MyPrefix",
-                            "Destination": {
-                                "Bucket": "arn:aws:s3:::my-replication-bucket",
-                                "StorageClass": "STANDARD",
-                            },
+                            "Destination": {"Bucket": "arn:aws:s3:::my-replication-bucket", "StorageClass": "STANDARD"},
                         },
                         {
                             "Status": "Enabled",
diff --git a/tests/resources/test_sns_topic_policy.py b/tests/resources/test_sns_topic_policy.py
@@ -15,13 +15,7 @@ def sns_topic_policy():
                     "Id": "MyTopicPolicy",
                     "Version": "2012-10-17",
                     "Statement": [
-                        {
-                            "Sid": "Stmt1",
-                            "Effect": "Allow",
-                            "Principal": "*",
-                            "Action": "sns:Publish",
-                            "Resource": "*",
-                        },
+                        {"Sid": "Stmt1", "Effect": "Allow", "Principal": "*", "Action": "sns:Publish", "Resource": "*"},
                         {
                             "Sid": "Stmt2",
                             "Effect": "Allow",
diff --git a/tests/test_resolver.py b/tests/test_resolver.py
@@ -317,30 +317,10 @@ def test_template_conditions():
 @pytest.mark.parametrize(
     "conditions, expected",
     [
-        (
-            {
-                "testCondition": {"Fn::Equals": [True, False]},
-            },
-            [],
-        ),
-        (
-            {
-                "testCondition": {"Fn::Equals": [True, True]},
-            },
-            ["test_resource_id"],
-        ),
-        (
-            {
-                "whatever": {"Fn::Equals": [True, False]},
-            },
-            ["test_resource_id"],
-        ),
-        (
-            {
-                "whatever": {"Fn::Equals": [True, True]},
-            },
-            ["test_resource_id"],
-        ),
+        ({"testCondition": {"Fn::Equals": [True, False]}}, []),
+        ({"testCondition": {"Fn::Equals": [True, True]}}, ["test_resource_id"]),
+        ({"whatever": {"Fn::Equals": [True, False]}}, ["test_resource_id"]),
+        ({"whatever": {"Fn::Equals": [True, True]}}, ["test_resource_id"]),
     ],
 )
 def test_resolve_include_resource_when_condition_is_true_or_doesnt_exist(conditions: Dict, expected: List):
@@ -352,10 +332,7 @@ def test_resolve_include_resource_when_condition_is_true_or_doesnt_exist(conditi
                 "Type": "AWS::IAM::Role",
                 "Condition": "testCondition",
                 "Properties": {
-                    "AssumeRolePolicyDocument": {
-                        "Version": "2012-10-17",
-                        "Statement": [],
-                    },
+                    "AssumeRolePolicyDocument": {"Version": "2012-10-17", "Statement": []},
                     "Path": "/",
                     "Policies": [],
                 },
@@ -382,10 +359,7 @@ def test_resolve_include_resource_when_condition_is_not_present():
             "test_resource_id": {
                 "Type": "AWS::IAM::Role",
                 "Properties": {
-                    "AssumeRolePolicyDocument": {
-                        "Version": "2012-10-17",
-                        "Statement": [],
-                    },
+                    "AssumeRolePolicyDocument": {"Version": "2012-10-17", "Statement": []},
                     "Path": "/",
                     "Policies": [],
                 },
@@ -591,10 +565,7 @@ def test_resolve_booleans():
                 "Properties": {
                     "Enabled": True,
                     "EnableKeyRotation": True,
-                    "KeyPolicy": {
-                        "Version": "2012-10-17",
-                        "Statement": [],
-                    },
+                    "KeyPolicy": {"Version": "2012-10-17", "Statement": []},
                 },
             }
         },
@@ -679,14 +650,7 @@ def test_resolve_booleans_different_properties_for_generic_resource():
 
 
 def test_resolve_template_with_a_valid_resource_without_properties():
-    template = {
-        "AWSTemplateFormatVersion": "2010-09-09",
-        "Resources": {
-            "MySNSTopic": {
-                "Type": "AWS::SNS::Topic",
-            }
-        },
-    }
+    template = {"AWSTemplateFormatVersion": "2010-09-09", "Resources": {"MySNSTopic": {"Type": "AWS::SNS::Topic"}}}
 
     model = parse(template).resolve()
     resource = model.Resources["MySNSTopic"]
diff --git a/tests/test_resource.py b/tests/test_resource.py
diff --git a/tests/test_types.py b/tests/test_types.py

Original file line number	Diff line number	Diff line change
`@@ -73,18 +73,13 @@ def policy_document_not_principal():`
`73`	`73`	`**{`
`74`	`74`	`"Statement": [`
`75`	`75`	`{`
`76`		`- "Action": [`
`77`		`- "iam:Delete*",`
`78`		`- "s3:GetObject*",`
`79`		`- ],`
	`76`	`+ "Action": ["iam:Delete", "s3:GetObject"],`
`80`	`77`	`"Effect": "Allow",`
`81`	`78`	`"Resource": "arn:aws:s3:::fakebucketfakebucket/*",`
`82`	`79`	`"NotPrincipal": {"AWS": ["156460612806"]},`
`83`	`80`	`},`
`84`	`81`	`{`
`85`		`- "Action": [`
`86`		`- "s3:List*",`
`87`		`- ],`
	`82`	`+ "Action": ["s3:List*"],`
`88`	`83`	`"Effect": "Deny",`
`89`	`84`	`"Resource": "arn:aws:s3:::fakebucketfakebucket/*",`
`90`	`85`	`"NotPrincipal": {"AWS": ["156460612806"]},`
`@@ -287,13 +282,11 @@ def policy_document_not_action():`
`287`	`282`	`**{`
`288`	`283`	`"Statement": [`
`289`	`284`	`{`
`290`		`- "NotAction": [`
`291`		`- "rds:*",`
`292`		`- ],`
	`285`	`+ "NotAction": ["rds:*"],`
`293`	`286`	`"Effect": "Allow",`
`294`	`287`	`"Resource": "arn:aws:s3:::fakebucketfakebucket/*",`
`295`	`288`	`"NotPrincipal": {"AWS": ["156460612806"]},`
`296`		`- },`
	`289`	`+ }`
`297`	`290`	`]`
`298`	`291`	`}`
`299`	`292`	`)`
`@@ -315,8 +308,8 @@ def policy_document_condition_with_source_ip():`
`315`	`308`	`"Effect": "Allow",`
`316`	`309`	`"Principal": {"AWS": "*"},`
`317`	`310`	`"Resource": "arn:aws:s3:::fakebucketfakebucket/*",`
`318`		`- },`
`319`		`- ],`
	`311`	`+ }`
	`312`	`+ ]`
`320`	`313`	`}`
`321`	`314`	`)`
`322`	`315`
`@@ -332,8 +325,8 @@ def policy_document_condition_with_source_vpce():`
`332`	`325`	`"Effect": "Allow",`
`333`	`326`	`"Principal": {"AWS": "*"},`
`334`	`327`	`"Resource": "arn:aws:s3:::fakebucketfakebucket/*",`
`335`		`- },`
`336`		`- ],`
	`328`	`+ }`
	`329`	`+ ]`
`337`	`330`	`}`
`338`	`331`	`)`
`339`	`332`