8000 Add support for Rules by nielslaukens · Pull Request #1412 · cloudtools/troposphere · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add support for Rules #1412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 30, 2019
Merged

Add support for Rules #1412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c38883f
Add support for Rules
nielslaukens Jun 3, 2019
79d3c21
Merge branch 'master' into feature/rules
Jun 28, 2019
9a250b7
Add Template.add_rule() function to be consistent with the Template API
Jun 28, 2019
7c0951a
Write doc for add_rule()
Jun 28, 2019
8ab1eea
Adapt test case to the add_rule() interface
Jun 28, 2019
4c75032
Add duplicate name check in add_rule
nielslaukens Jun 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions tests/test_template.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,5 +163,31 @@ def test_parameter_group(self):
})


class TestRules(unittest.TestCase):
def test_rules(self):
t = Template()
t.add_parameter("One")
t.add_parameter("Two")

rule = {
"Assertions": [
{
"Assert": {
"Fn::Equals": [
{"Ref": "One"},
{"Ref": "Two"},
],
},
},
],
}
t.add_rule("ValidateEqual", rule)

self.assertTrue("ValidateEqual" in t.rules)

rendered = t.to_dict()
self.assertEqual(rendered["Rules"]["ValidateEqual"], rule)


if __name__ == '__main__':
unittest.main()
19 changes: 19 additions & 0 deletions troposphere/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,7 @@ class Template(object):
'Mappings': (dict, False),
'Resources': (dict, False),
'Outputs': (dict, False),
'Rules': (dict, False),
}

def __init__(self, Description=None, Metadata=None): # noqa: N803
Expand All @@ -592,6 +593,7 @@ def __init__(self, Description=None, Metadata=None): # noqa: N803
self.outputs = {}
self.parameters = {}
self.resources = {}
self.rules = {}
self.version = None
self.transform = None

Expand Down Expand Up @@ -666,6 +668,21 @@ def add_resource(self, resource):
% MAX_RESOURCES)
return self._update(self.resources, resource)

def add_rule(self, name, rule):
"""
Add a Rule to the template to enforce extra constraints on the
parameters. As of June 2019 rules are undocumented in CloudFormation
but have the same syntax and behaviour as in ServiceCatalog:
https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html

:param rule: a dict with 'Assertions' (mandatory) and 'RuleCondition'
(optional) keys
"""
# TODO: check maximum number of Rules, and enforce limit.
if name in self.rules:
self.handle_duplicate_key(name)
self.rules[name] = rule

def set_version(self, version=None):
if version:
self.version = version
Expand Down Expand Up @@ -711,6 +728,8 @@ def to_dict(self):
t['AWSTemplateFormatVersion'] = self.version
if self.transform:
t['Transform'] = self.transform
if self.rules:
t['Rules'] = self.rules
t['Resources'] = self.resources

return encode_to_dict(t)
Expand Down
0