""" Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: MIT-0 """ import hashlib import json from cfnlint.helpers import RESOURCE_SPECS from cfnlint.rules import CloudFormationLintRule, RuleMatch class ListDuplicatesAllowed(CloudFormationLintRule): """Check if duplicates exist in a List""" id = "I3037" shortdesc = "Check if a list that allows duplicates has any duplicates" description = ( "Certain lists support duplicate items." "Provide an alert when list of strings or numbers have repeats." ) source_url = "https://github.com/aws-cloudformation/cfn-python-lint/blob/main/docs/rules.md#rules-1" tags = ["resources", "property", "list"] def initialize(self, cfn): """Initialize the rule""" for resource_type_spec in RESOURCE_SPECS.get(cfn.regions[0]).get( "ResourceTypes" ): self.resource_property_types.append(resource_type_spec) for property_type_spec in RESOURCE_SPECS.get(cfn.regions[0]).get( "PropertyTypes" ): self.resource_sub_property_types.append(property_type_spec) def _check_duplicates(self, values, path, scenario=None): """Check for Duplicates""" matches = [] list_items = [] if isinstance(values, list): for index, value in enumerate(values): value_hash = hashlib.sha1( json.dumps(value, sort_keys=True).encode("utf-8") ).hexdigest() if value_hash in list_items: if not scenario: message = "List has a duplicate value at {0}" matches.append( RuleMatch( path + [index], message.format("/".join(map(str, path + [index]))), ) ) else: scenario_text = " and ".join( [f'condition "{k}" is {v}' for (k, v) in scenario.items()] ) message = "List has a duplicate value at {0} when {1}" matches.append( RuleMatch( path, message.format("/".join(map(str, path)), scenario_text), ) ) list_items.append(value_hash) return matches def check_duplicates(self, values, path, cfn): """Check for duplicates""" matches = [] if isinstance(values, list): matches.extend(self._check_duplicates(values, path)) elif isinstance(values, dict): props = cfn.get_object_without_conditions(values) for prop in props: matches.extend( self._check_duplicates( prop.get("Object"), path, prop.get("Scenario") ) ) return matches def check(self, cfn, properties, value_specs, path): """Check itself""" matches = [] for p_value, p_path in properties.items_safe(path[:]): for prop in p_value: if prop in value_specs: property_type = value_specs.get(prop).get("Type") primitive_type = value_specs.get(prop).get("PrimitiveItemType") duplicates_allowed = value_specs.get(prop).get( "DuplicatesAllowed", False ) if ( property_type == "List" and duplicates_allowed and primitive_type in ["String", "Integer"] ): matches.extend( self.check_duplicates(p_value[prop], p_path + [prop], cfn) ) return matches def match_resource_sub_properties(self, properties, property_type, path, cfn): """Match for sub properties""" matches = [] specs = ( RESOURCE_SPECS.get(cfn.regions[0]) .get("PropertyTypes") .get(property_type, {}) .get("Properties", {}) ) matches.extend(self.check(cfn, properties, specs, path)) return matches def match_resource_properties(self, properties, resource_type, path, cfn): """Check CloudFormation Properties""" matches = [] specs = ( RESOURCE_SPECS.get(cfn.regions[0]) .get("ResourceTypes") .get(resource_type, {}) .get("Properties", {}) ) matches.extend(self.check(cfn, properties, specs, path)) return matches
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
AllowedPattern.py | File | 5.76 KB | 0644 |
|
AllowedValue.py | File | 4.8 KB | 0644 |
|
AtLeastOne.py | File | 4.11 KB | 0644 |
|
AvailabilityZone.py | File | 3.41 KB | 0644 |
|
BasedOnValue.py | File | 6.33 KB | 0644 |
|
Exclusive.py | File | 3.98 KB | 0644 |
|
ImageId.py | File | 2.37 KB | 0644 |
|
Inclusive.py | File | 3.7 KB | 0644 |
|
JsonSize.py | File | 6.08 KB | 0644 |
|
ListDuplicates.py | File | 4.39 KB | 0644 |
|
ListDuplicatesAllowed.py | File | 4.76 KB | 0644 |
|
ListSize.py | File | 4.88 KB | 0644 |
|
NumberSize.py | File | 4.88 KB | 0644 |
|
OnlyOne.py | File | 3.89 KB | 0644 |
|
Password.py | File | 3.63 KB | 0644 |
|
Properties.py | File | 27.49 KB | 0644 |
|
PropertiesTemplated.py | File | 2.44 KB | 0644 |
|
Required.py | File | 4.1 KB | 0644 |
|
RequiredBasedOnValue.py | File | 831 B | 0644 |
|
StringSize.py | File | 4.52 KB | 0644 |
|
UnwantedBasedOnValue.py | File | 837 B | 0644 |
|
ValuePrimitiveType.py | File | 11.6 KB | 0644 |
|
ValueRefGetAtt.py | File | 11.96 KB | 0644 |
|
__init__.py | File | 106 B | 0644 |
|