forked from aws-cloudformation/cfn-lint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OnlyOne.py
98 lines (84 loc) · 3.89 KB
/
OnlyOne.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
"""
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0
"""
import cfnlint.helpers
from cfnlint.data import AdditionalSpecs
from cfnlint.rules import CloudFormationLintRule, RuleMatch
class OnlyOne(CloudFormationLintRule):
"""Check Properties Resource Configuration"""
id = "E2523"
shortdesc = "Check Properties that need only one of a list of properties"
description = (
"Making sure CloudFormation properties "
+ "that require only one property from a list. "
+ "One has to be specified."
)
source_url = "https://github.com/aws-cloudformation/cfn-python-lint"
tags = ["resources"]
def __init__(self):
"""Init"""
super().__init__()
onlyonespec = cfnlint.helpers.load_resource(AdditionalSpecs, "OnlyOne.json")
self.resource_types_specs = onlyonespec["ResourceTypes"]
self.property_types_specs = onlyonespec["PropertyTypes"]
for resource_type_spec in self.resource_types_specs:
self.resource_property_types.append(resource_type_spec)
for property_type_spec in self.property_types_specs:
self.resource_sub_property_types.append(property_type_spec)
def check(self, properties, onlyoneprops, path, cfn):
"""Check itself"""
matches = []
for onlyoneprop in onlyoneprops:
for safe_properties, safe_path in properties.items_safe(path):
property_sets = cfn.get_object_without_conditions(
safe_properties, onlyoneprop
)
for property_set in property_sets:
count = 0
for prop in onlyoneprop:
if prop in property_set["Object"]:
count += 1
if count != 1:
if property_set["Scenario"] is None:
message = "Only one of [{0}] should be specified for {1}"
matches.append(
RuleMatch(
path,
message.format(
", ".join(map(str, onlyoneprop)),
"/".join(map(str, safe_path)),
),
)
)
else:
scenario_text = " and ".join(
[
f'when condition "{k}" is {v}'
for (k, v) in property_set["Scenario"].items()
]
)
message = "Only one of [{0}] should be specified {1} at {2}"
matches.append(
RuleMatch(
path,
message.format(
", ".join(map(str, onlyoneprop)),
scenario_text,
"/".join(map(str, safe_path)),
),
)
)
return matches
def match_resource_sub_properties(self, properties, property_type, path, cfn):
"""Match for sub properties"""
matches = []
onlyoneprops = self.property_types_specs.get(property_type, {})
matches.extend(self.check(properties, onlyoneprops, path, cfn))
return matches
def match_resource_properties(self, properties, resource_type, path, cfn):
"""Check CloudFormation Properties"""
matches = []
onlyoneprops = self.resource_types_specs.get(resource_type, {})
matches.extend(self.check(properties, onlyoneprops, path, cfn))
return matches