Cleanup rule rewrite (#3122)

kddejong · kddejong · commit fdcb28dfe814 · 2024-05-03T09:04:38.000-07:00
diff --git a/src/cfnlint/rules/resources/properties/AnyOf.py b/src/cfnlint/rules/resources/properties/AnyOf.py
@@ -0,0 +1,20 @@
+"""
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: MIT-0
+"""
+
+from cfnlint.rules import CloudFormationLintRule
+
+
+class AnyOf(CloudFormationLintRule):
+    """Check Properties Resource Configuration"""
+
+    id = "E3017"
+    shortdesc = "Check Properties that need at least one of a list of properties"
+    description = (
+        "Making sure CloudFormation properties "
+        + "that require at least one property from a list. "
+        + "More than one can be included."
+    )
+    source_url = "https://github.com/aws-cloudformation/cfn-python-lint"
+    tags = ["resources"]
diff --git a/src/cfnlint/rules/resources/properties/DependentExcluded.py b/src/cfnlint/rules/resources/properties/DependentExcluded.py
@@ -9,7 +9,7 @@
 class DependentExcluded(CloudFormationLintRule):
     """Check Required Resource Configuration"""
 
-    id = "E3023"
+    id = "E3020"
     shortdesc = (
         "Validate that when a property is specified another property should be excluded"
     )
diff --git a/src/cfnlint/rules/resources/properties/DependentRequired.py b/src/cfnlint/rules/resources/properties/DependentRequired.py
@@ -9,7 +9,7 @@
 class DependentExcluded(CloudFormationLintRule):
     """Check Required Resource Configuration"""
 
-    id = "E3024"
+    id = "E3021"
     shortdesc = (
         "Validate that when a property is specified that "
         "other properties should be included"
diff --git a/src/cfnlint/rules/resources/properties/Enum.py b/src/cfnlint/rules/resources/properties/Enum.py
@@ -7,7 +7,7 @@
 from cfnlint.rules import CloudFormationLintRule
 
 
-class AllowedValue(CloudFormationLintRule):
+class Enum(CloudFormationLintRule):
     """Check if properties have a valid value"""
 
     id = "E3030"
diff --git a/src/cfnlint/rules/resources/properties/MinMax.py b/src/cfnlint/rules/resources/properties/MinMax.py
@@ -12,7 +12,7 @@
 from cfnlint.rules import CloudFormationLintRule
 
 
-class NumberSize(CloudFormationLintRule):
+class MinMax(CloudFormationLintRule):
     """Check if a Number has a length within the limit"""
 
     id = "E3034"
diff --git a/src/cfnlint/rules/resources/properties/MinMaxLength.py b/src/cfnlint/rules/resources/properties/MinMaxLength.py
@@ -14,7 +14,7 @@
 from cfnlint.rules import CloudFormationLintRule
 
 
-class StringSize(CloudFormationLintRule):
+class MinMaxLength(CloudFormationLintRule):
     """Check if a String has a length within the limit"""
 
     id = "E3033"
diff --git a/src/cfnlint/rules/resources/properties/OnlyOne.py b/src/cfnlint/rules/resources/properties/OnlyOne.py
@@ -9,7 +9,7 @@
 class OnlyOne(CloudFormationLintRule):
     """Check Properties Resource Configuration"""
 
-    id = "E2523"
+    id = "E3018"
     shortdesc = "Check Properties that need only one of a list of properties"
     description = (
         "Making sure CloudFormation properties "
diff --git a/src/cfnlint/rules/resources/properties/Pattern.py b/src/cfnlint/rules/resources/properties/Pattern.py
@@ -9,7 +9,7 @@
 from cfnlint.rules import CloudFormationLintRule
 
 
-class AllowedPattern(CloudFormationLintRule):
+class Pattern(CloudFormationLintRule):
     """Check if properties have a valid value"""
 
     id = "E3031"
diff --git a/src/cfnlint/rules/resources/properties/Properties.py b/src/cfnlint/rules/resources/properties/Properties.py
@@ -28,9 +28,10 @@ def __init__(self):
         super().__init__()
         self.rule_set = {
             "additionalProperties": "E3002",
+            "anyOf": "E3017",
             "properties": "E3002",
-            "dependentExcluded": "E3023",
-            "dependentRequired": "E3024",
+            "dependentExcluded": "E3020",
+            "dependentRequired": "E3021",
             "required": "E3003",
             "requiredXor": "E3014",
             "requiredOr": "E3015",
@@ -46,9 +47,9 @@ def __init__(self):
             "maxItems": "E3032",
             "minItems": "E3032",
             "pattern": "E3031",
-            "oneOf": "E2523",
+            "oneOf": "E3018",
             "cfnLint": "E1101",
-            "tagging": "E3021",
+            "tagging": "E3024",
         }
         self.child_rules = dict.fromkeys(list(self.rule_set.values()))
 
diff --git a/src/cfnlint/rules/resources/properties/Tagging.py b/src/cfnlint/rules/resources/properties/Tagging.py
@@ -12,7 +12,7 @@
 
 
 class Tagging(CloudFormationLintRule):
-    id = "E3021"
+    id = "E3024"
     shortdesc = "Validate tag configuration"
     description = (
         "Validates tag values to make sure they have unique keys "
diff --git a/src/cfnlint/rules/resources/properties/Type.py b/src/cfnlint/rules/resources/properties/Type.py
@@ -8,7 +8,7 @@
 from cfnlint.rules import CloudFormationLintRule
 
 
-class ValuePrimitiveType(CloudFormationLintRule):
+class Type(CloudFormationLintRule):
     """Check if Resource PrimitiveTypes are correct"""
 
     id = "E3012"
diff --git a/src/cfnlint/rules/resources/properties/UniqueItems.py b/src/cfnlint/rules/resources/properties/UniqueItems.py
@@ -7,7 +7,7 @@
 from cfnlint.rules import CloudFormationLintRule
 
 
-class ListDuplicates(CloudFormationLintRule):
+class UniqueItems(CloudFormationLintRule):
     """Check if duplicates exist in a List"""
 
     id = "E3037"
diff --git a/src/cfnlint/rules/resources/properties/UniqueItemsAllowed.py b/src/cfnlint/rules/resources/properties/UniqueItemsAllowed.py
@@ -6,7 +6,7 @@
 from cfnlint.rules import CloudFormationLintRule
 
 
-class ListDuplicatesAllowed(CloudFormationLintRule):
+class UniqueItemsAllowed(CloudFormationLintRule):
     """Check if duplicates exist in a List"""
 
     id = "I3037"
diff --git a/src/cfnlint/rules/resources/route53/RecordSet.py b/src/cfnlint/rules/resources/route53/RecordSet.py
@@ -12,7 +12,7 @@
 class RecordSet(CloudFormationLintRule):
     """Check Route53 Recordset Configuration"""
 
-    id = "E3020"
+    id = "E3023"
     shortdesc = "Validate Route53 RecordSets"
     description = "Check if all RecordSets are correctly configured"
     source_url = "https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html"
diff --git a/test/unit/module/formatters/test_formatters.py b/test/unit/module/formatters/test_formatters.py
@@ -27,7 +27,7 @@
 from cfnlint.jsonschema import StandardValidator
 from cfnlint.rules import Match, Rules
 from cfnlint.rules.functions.SubUnneeded import SubUnneeded
-from cfnlint.rules.resources.properties.ValuePrimitiveType import ValuePrimitiveType
+from cfnlint.rules.resources.properties.Type import Type
 from cfnlint.rules.resources.UpdateReplacePolicyDeletionPolicyOnStatefulResourceTypes import (
     UpdateReplacePolicyDeletionPolicyOnStatefulResourceTypes,
 )
@@ -83,7 +83,7 @@ def setUp(self) -> None:
                 18,
                 27,
                 self.filename,
-                ValuePrimitiveType(),
+                Type(),
                 "'5' is not of type 'integer'",
             ),
         ]
diff --git a/test/unit/rules/resources/properties/test_enum.py b/test/unit/rules/resources/properties/test_enum.py
@@ -9,22 +9,22 @@
 
 from cfnlint.jsonschema import CfnTemplateValidator
 from cfnlint.rules.parameters.AllowedValue import AllowedValue as ParameterAllowedValue
-from cfnlint.rules.resources.properties.AllowedValue import AllowedValue
+from cfnlint.rules.resources.properties.Enum import Enum
 
 
 @pytest.fixture(scope="module")
 def rule():
-    rule = AllowedValue()
+    rule = Enum()
     rule.child_rules["W2030"] = ParameterAllowedValue()
-    yield AllowedValue()
+    yield Enum()
 
 
 @pytest.fixture(scope="module")
 def validator():
     yield CfnTemplateValidator(schema={})
 
 
-def test_allowed_value(rule, validator):
+def test_validate(rule, validator):
     assert len(list(rule.enum(validator, ["foo", "bar"], "foo", {}))) == 0
     assert len(list(rule.enum(validator, ["foo"], "bar", {}))) == 1
 
diff --git a/test/unit/rules/resources/properties/test_min_max.py b/test/unit/rules/resources/properties/test_min_max.py
@@ -9,14 +9,14 @@
 
 from cfnlint.jsonschema import CfnTemplateValidator
 from cfnlint.rules.parameters.NumberSize import NumberSize as ParameterNumberSize
-from cfnlint.rules.resources.properties.NumberSize import NumberSize
+from cfnlint.rules.resources.properties.MinMax import MinMax
 
 
 @pytest.fixture
 def rule():
-    rule = NumberSize()
+    rule = MinMax()
     rule.child_rules["W3034"] = ParameterNumberSize()
-    yield NumberSize()
+    yield MinMax()
 
 
 @pytest.fixture(scope="module")
diff --git a/test/unit/rules/resources/properties/test_min_max_length.py b/test/unit/rules/resources/properties/test_min_max_length.py
@@ -8,12 +8,12 @@
 import pytest
 
 from cfnlint.jsonschema import CfnTemplateValidator
-from cfnlint.rules.resources.properties.StringSize import StringSize
+from cfnlint.rules.resources.properties.MinMaxLength import MinMaxLength
 
 
 @pytest.fixture(scope="module")
 def rule():
-    yield StringSize()
+    yield MinMaxLength()
 
 
 @pytest.fixture(scope="module")
diff --git a/test/unit/rules/resources/properties/test_pattern.py b/test/unit/rules/resources/properties/test_pattern.py
@@ -11,12 +11,12 @@
 from cfnlint.rules.parameters.AllowedPattern import (
     AllowedPattern as ParameterAllowedPattern,
 )
-from cfnlint.rules.resources.properties.AllowedPattern import AllowedPattern
+from cfnlint.rules.resources.properties.Pattern import Pattern
 
 
 @pytest.fixture(scope="module")
 def rule():
-    rule = AllowedPattern()
+    rule = Pattern()
     rule.child_rules["W2031"] = ParameterAllowedPattern()
     yield rule
 
@@ -26,7 +26,7 @@ def validator():
     yield CfnTemplateValidator(schema={})
 
 
-def test_allowed_pattern(rule, validator):
+def test_validate(rule, validator):
     assert len(list(rule.pattern(validator, ".*", "foo", {}))) == 0
     assert len(list(rule.pattern(validator, "foo", "bar", {}))) == 1
 
@@ -53,7 +53,7 @@ def test_allowed_pattern(rule, validator):
     assert len(errs) == 0
 
 
-def test_allowed_pattern_exceptions(rule, validator):
+def test_pattern_exceptions(rule, validator):
     rule.configure({"exceptions": ["AWS::"]})
 
     assert len(list(rule.pattern(validator, "foo", "Another AWS::Instance", {}))) == 1
diff --git a/test/unit/rules/resources/properties/test_unique_items.py b/test/unit/rules/resources/properties/test_unique_items.py
@@ -6,16 +6,14 @@
 import pytest
 
 from cfnlint.jsonschema import CfnTemplateValidator
-from cfnlint.rules.resources.properties.ListDuplicates import ListDuplicates
-from cfnlint.rules.resources.properties.ListDuplicatesAllowed import (
-    ListDuplicatesAllowed,
-)
+from cfnlint.rules.resources.properties.UniqueItems import UniqueItems
+from cfnlint.rules.resources.properties.UniqueItemsAllowed import UniqueItemsAllowed
 
 
 @pytest.fixture(scope="module")
 def rule():
-    rule = ListDuplicates()
-    rule.child_rules["I3037"] = ListDuplicatesAllowed()
+    rule = UniqueItems()
+    rule.child_rules["I3037"] = UniqueItemsAllowed()
     yield rule
 
 
diff --git a/test/unit/rules/resources/properties/test_value_primitive_type.py b/test/unit/rules/resources/properties/test_value_primitive_type.py
@@ -8,15 +8,15 @@
 from cfnlint.jsonschema import CfnTemplateValidator
 
 # ruff: noqa: E501
-from cfnlint.rules.resources.properties.ValuePrimitiveType import ValuePrimitiveType
+from cfnlint.rules.resources.properties.Type import Type
 
 
-class TestValuePrimtiveType(BaseRuleTestCase):
+class TestType(BaseRuleTestCase):
     """Test Primitive Value Types for Json Schema non strict"""
 
     def setUp(self):
         """Setup"""
-        self.rule = ValuePrimitiveType()
+        self.rule = Type()
         self.rule.config["strict"] = False
         self.validator = CfnTemplateValidator()
 

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`class DependentExcluded(CloudFormationLintRule):`
`10`	`10`	`"""Check Required Resource Configuration"""`
`11`	`11`
`12`		`- id = "E3023"`
	`12`	`+ id = "E3020"`
`13`	`13`	`shortdesc = (`
`14`	`14`	`"Validate that when a property is specified another property should be excluded"`
`15`	`15`	`)`