504 lines
18 KiB
Python
504 lines
18 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
from heat.common import template_format
|
|
from heat.common import exception
|
|
from heat.engine import parser
|
|
from heat.engine import hot
|
|
from heat.engine import parameters
|
|
from heat.engine import template
|
|
|
|
from heat.tests.common import HeatTestCase
|
|
from heat.tests import test_parser
|
|
from heat.tests import utils
|
|
|
|
|
|
hot_tpl_empty = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
''')
|
|
|
|
|
|
class HOTemplateTest(HeatTestCase):
|
|
"""Test processing of HOT templates."""
|
|
|
|
def test_defaults(self):
|
|
"""Test default content behavior of HOT template."""
|
|
|
|
tmpl = parser.Template(hot_tpl_empty)
|
|
# check if we get the right class
|
|
self.assertTrue(isinstance(tmpl, hot.HOTemplate))
|
|
try:
|
|
# test getting an invalid section
|
|
tmpl['foobar']
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
self.fail('Expected KeyError for invalid section')
|
|
|
|
# test defaults for valid sections
|
|
self.assertEqual(tmpl[hot.VERSION], '2013-05-23')
|
|
self.assertEqual(tmpl[hot.DESCRIPTION], 'No description')
|
|
self.assertEqual(tmpl[hot.PARAMETERS], {})
|
|
self.assertEqual(tmpl[hot.RESOURCES], {})
|
|
self.assertEqual(tmpl[hot.OUTPUTS], {})
|
|
|
|
def test_translate_parameters(self):
|
|
"""Test translation of parameters into internal engine format."""
|
|
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
parameters:
|
|
param1:
|
|
description: foo
|
|
type: string
|
|
default: boo
|
|
''')
|
|
|
|
expected = {'param1': {'Description': 'foo',
|
|
'Type': 'String',
|
|
'Default': 'boo'}}
|
|
|
|
tmpl = parser.Template(hot_tpl)
|
|
self.assertEqual(tmpl[hot.PARAMETERS], expected)
|
|
|
|
def test_translate_parameters_unsupported_type(self):
|
|
"""Test translation of parameters into internal engine format
|
|
|
|
This tests if parameters with a type not yet supported by engine
|
|
are also parsed.
|
|
"""
|
|
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
parameters:
|
|
param1:
|
|
description: foo
|
|
type: unsupported_type
|
|
''')
|
|
|
|
expected = {'param1': {'Description': 'foo',
|
|
'Type': 'UnsupportedType'}}
|
|
|
|
tmpl = parser.Template(hot_tpl)
|
|
self.assertEqual(tmpl[hot.PARAMETERS], expected)
|
|
|
|
def test_translate_parameters_length_range(self):
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
parameters:
|
|
wait_time:
|
|
description: application wait time
|
|
type: number
|
|
default: 150
|
|
constraints:
|
|
- range: { min: 120, max: 600}
|
|
description: min value 120 seconds, max value 600 seconds
|
|
key_name:
|
|
description: Name of an existing EC2 KeyPair
|
|
type: string
|
|
default: heat_key
|
|
constraints:
|
|
- length: {min: 1, max: 32}
|
|
description: length should be between 1 and 32
|
|
''')
|
|
|
|
expected = {
|
|
'wait_time': {
|
|
'Description': 'application wait time',
|
|
'Type': 'Number',
|
|
'Default': 150,
|
|
'MaxValue': [
|
|
(600, 'min value 120 seconds, max value 600 seconds')],
|
|
'MinValue': [
|
|
(120, 'min value 120 seconds, max value 600 seconds')]
|
|
},
|
|
'key_name': {
|
|
'Description': 'Name of an existing EC2 KeyPair',
|
|
'Type': 'String',
|
|
'Default': 'heat_key',
|
|
'MaxLength': [(32, u'length should be between 1 and 32')],
|
|
'MinLength': [(1, u'length should be between 1 and 32')]
|
|
}}
|
|
|
|
tmpl = parser.Template(hot_tpl)
|
|
self.assertEqual(expected, tmpl[hot.PARAMETERS])
|
|
|
|
def test_translate_parameters_allowed_values(self):
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
parameters:
|
|
instance_type:
|
|
description: instance type
|
|
type: string
|
|
default: m1.small
|
|
constraints:
|
|
- allowed_values: ["m1.tiny",
|
|
"m1.small",
|
|
"m1.medium", "m1.large", "m1.xlarge"]
|
|
description: must be a valid EC2 instance type.
|
|
''')
|
|
expected = {
|
|
'instance_type': {
|
|
'Description': 'instance type',
|
|
'Type': 'String',
|
|
'Default': 'm1.small',
|
|
'AllowedValues': [(["m1.tiny",
|
|
"m1.small",
|
|
"m1.medium",
|
|
"m1.large",
|
|
"m1.xlarge"],
|
|
'must be a valid EC2 instance type.')]}}
|
|
|
|
tmpl = parser.Template(hot_tpl)
|
|
self.assertEqual(expected, tmpl[hot.PARAMETERS])
|
|
|
|
def test_translate_parameters_allowed_patterns(self):
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
parameters:
|
|
db_name:
|
|
description: The WordPress database name
|
|
type: string
|
|
default: wordpress
|
|
constraints:
|
|
- length: { min: 1, max: 64 }
|
|
description: string lenght should between 1 and 64
|
|
- allowed_pattern: "[a-zA-Z]+"
|
|
description: Value must consist of characters only
|
|
- allowed_pattern: "[a-z]+[a-zA-Z]*"
|
|
description: Value must start with a lowercase character
|
|
''')
|
|
expected = {
|
|
'db_name': {
|
|
'Description': 'The WordPress database name',
|
|
'Type': 'String',
|
|
'Default': 'wordpress',
|
|
'MinLength': [(1, 'string lenght should between 1 and 64')],
|
|
'MaxLength': [(64, 'string lenght should between 1 and 64')],
|
|
'AllowedPattern': [
|
|
('[a-zA-Z]+',
|
|
'Value must consist of characters only'),
|
|
('[a-z]+[a-zA-Z]*',
|
|
'Value must start with a lowercase character')]}}
|
|
tmpl = parser.Template(hot_tpl)
|
|
self.assertEqual(expected, tmpl[hot.PARAMETERS])
|
|
|
|
def test_translate_parameters_hidden(self):
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
parameters:
|
|
user_roles:
|
|
description: User roles
|
|
type: comma_delimited_list
|
|
default: guest,newhire
|
|
hidden: TRUE
|
|
''')
|
|
expected = {
|
|
'user_roles': {
|
|
'Description': 'User roles',
|
|
'Type': 'CommaDelimitedList',
|
|
'Default': 'guest,newhire',
|
|
'NoEcho': True
|
|
}}
|
|
|
|
tmpl = parser.Template(hot_tpl)
|
|
self.assertEqual(expected, tmpl[hot.PARAMETERS])
|
|
|
|
def test_translate_resources(self):
|
|
"""Test translation of resources into internal engine format."""
|
|
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
resources:
|
|
resource1:
|
|
type: AWS::EC2::Instance
|
|
properties:
|
|
property1: value1
|
|
''')
|
|
|
|
expected = {'resource1': {'Type': 'AWS::EC2::Instance',
|
|
'Properties': {'property1': 'value1'}}}
|
|
|
|
tmpl = parser.Template(hot_tpl)
|
|
self.assertEqual(tmpl[hot.RESOURCES], expected)
|
|
|
|
def test_translate_outputs(self):
|
|
"""Test translation of outputs into internal engine format."""
|
|
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
outputs:
|
|
output1:
|
|
description: output1
|
|
value: value1
|
|
''')
|
|
|
|
expected = {'output1': {'Description': 'output1', 'Value': 'value1'}}
|
|
|
|
tmpl = parser.Template(hot_tpl)
|
|
self.assertEqual(tmpl[hot.OUTPUTS], expected)
|
|
|
|
def test_param_refs(self):
|
|
"""Test if parameter references work."""
|
|
params = {'foo': 'bar', 'blarg': 'wibble'}
|
|
snippet = {'properties': {'key1': {'get_param': 'foo'},
|
|
'key2': {'get_param': 'blarg'}}}
|
|
snippet_resolved = {'properties': {'key1': 'bar',
|
|
'key2': 'wibble'}}
|
|
tmpl = parser.Template(hot_tpl_empty)
|
|
self.assertEqual(tmpl.resolve_param_refs(snippet, params),
|
|
snippet_resolved)
|
|
snippet = {'properties': {'key1': {'Ref': 'foo'},
|
|
'key2': {'Ref': 'blarg'}}}
|
|
snippet_resolved = {'properties': {'key1': 'bar',
|
|
'key2': 'wibble'}}
|
|
tmpl = parser.Template(hot_tpl_empty)
|
|
self.assertEqual(snippet_resolved,
|
|
tmpl.resolve_param_refs(snippet, params))
|
|
|
|
def test_str_replace(self):
|
|
"""Test str_replace function."""
|
|
|
|
snippet = {'str_replace': {'template': 'Template var1 string var2',
|
|
'params': {'var1': 'foo', 'var2': 'bar'}}}
|
|
snippet_resolved = 'Template foo string bar'
|
|
|
|
tmpl = parser.Template(hot_tpl_empty)
|
|
|
|
self.assertEqual(snippet_resolved,
|
|
tmpl.resolve_replace(snippet))
|
|
|
|
def test_str_fn_replace(self):
|
|
"""Test Fn:Replace function."""
|
|
|
|
snippet = {'Fn::Replace': [{'$var1': 'foo', '$var2': 'bar'},
|
|
'Template $var1 string $var2']}
|
|
snippet_resolved = 'Template foo string bar'
|
|
|
|
tmpl = parser.Template(hot_tpl_empty)
|
|
|
|
self.assertEqual(tmpl.resolve_replace(snippet), snippet_resolved)
|
|
|
|
def test_str_replace_syntax(self):
|
|
"""
|
|
Test str_replace function syntax.
|
|
|
|
Pass wrong syntax (array instead of dictionary) to function and
|
|
validate that we get a TypeError.
|
|
"""
|
|
|
|
snippet = {'str_replace': [{'template': 'Template var1 string var2'},
|
|
{'params': {'var1': 'foo', 'var2': 'bar'}}]}
|
|
|
|
tmpl = parser.Template(hot_tpl_empty)
|
|
|
|
self.assertRaises(TypeError, tmpl.resolve_replace, snippet)
|
|
|
|
def test_str_replace_invalid_param_keys(self):
|
|
"""
|
|
Test str_replace function parameter keys.
|
|
|
|
Pass wrong parameters to function and verify that we get
|
|
a KeyError.
|
|
"""
|
|
|
|
snippet = {'str_replace': {'tmpl': 'Template var1 string var2',
|
|
'params': {'var1': 'foo', 'var2': 'bar'}}}
|
|
|
|
tmpl = parser.Template(hot_tpl_empty)
|
|
|
|
self.assertRaises(KeyError, tmpl.resolve_replace, snippet)
|
|
|
|
snippet = {'str_replace': {'tmpl': 'Template var1 string var2',
|
|
'parms': {'var1': 'foo', 'var2': 'bar'}}}
|
|
|
|
self.assertRaises(KeyError, tmpl.resolve_replace, snippet)
|
|
|
|
def test_str_replace_invalid_param_types(self):
|
|
"""
|
|
Test str_replace function parameter values.
|
|
|
|
Pass parameter values of wrong type to function and verify that we get
|
|
a TypeError.
|
|
"""
|
|
|
|
snippet = {'str_replace': {'template': 12345,
|
|
'params': {'var1': 'foo', 'var2': 'bar'}}}
|
|
|
|
tmpl = parser.Template(hot_tpl_empty)
|
|
|
|
self.assertRaises(TypeError, tmpl.resolve_replace, snippet)
|
|
|
|
snippet = {'str_replace': {'template': 'Template var1 string var2',
|
|
'params': ['var1', 'foo', 'var2', 'bar']}}
|
|
|
|
self.assertRaises(TypeError, tmpl.resolve_replace, snippet)
|
|
|
|
|
|
class StackTest(test_parser.StackTest):
|
|
"""Test stack function when stack was created from HOT template."""
|
|
|
|
@utils.stack_delete_after
|
|
def test_get_attr(self):
|
|
"""Test resolution of get_attr occurrences in HOT template."""
|
|
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
resources:
|
|
resource1:
|
|
type: GenericResourceType
|
|
''')
|
|
|
|
self.stack = parser.Stack(self.ctx, 'test_get_attr',
|
|
template.Template(hot_tpl))
|
|
self.stack.store()
|
|
self.stack.create()
|
|
self.assertEqual(self.stack.state,
|
|
(parser.Stack.CREATE, parser.Stack.COMPLETE))
|
|
|
|
snippet = {'Value': {'get_attr': ['resource1', 'foo']}}
|
|
resolved = hot.HOTemplate.resolve_attributes(snippet, self.stack)
|
|
# GenericResourceType has an attribute 'foo' which yields the resource
|
|
# name.
|
|
self.assertEqual(resolved, {'Value': 'resource1'})
|
|
# test invalid reference
|
|
self.assertRaises(exception.InvalidTemplateAttribute,
|
|
hot.HOTemplate.resolve_attributes,
|
|
{'Value': {'get_attr': ['resource1', 'NotThere']}},
|
|
self.stack)
|
|
|
|
snippet = {'Value': {'Fn::GetAtt': ['resource1', 'foo']}}
|
|
resolved = hot.HOTemplate.resolve_attributes(snippet, self.stack)
|
|
self.assertEqual({'Value': 'resource1'}, resolved)
|
|
|
|
@utils.stack_delete_after
|
|
def test_get_resource(self):
|
|
"""Test resolution of get_resource occurrences in HOT template."""
|
|
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
resources:
|
|
resource1:
|
|
type: GenericResourceType
|
|
''')
|
|
|
|
self.stack = parser.Stack(self.ctx, 'test_get_resource',
|
|
template.Template(hot_tpl))
|
|
self.stack.store()
|
|
self.stack.create()
|
|
self.assertEqual(self.stack.state,
|
|
(parser.Stack.CREATE, parser.Stack.COMPLETE))
|
|
|
|
snippet = {'value': {'get_resource': 'resource1'}}
|
|
resolved = hot.HOTemplate.resolve_resource_refs(snippet, self.stack)
|
|
self.assertEqual(resolved, {'value': 'resource1'})
|
|
|
|
|
|
class HOTParamValidatorTest(HeatTestCase):
|
|
"Test HOTParamValidator"
|
|
|
|
def test_multiple_constraint_descriptions(self):
|
|
len_desc = 'string length should between 8 and 16'
|
|
pattern_desc1 = 'Value must consist of characters only'
|
|
pattern_desc2 = 'Value must start with a lowercase character'
|
|
param = {
|
|
'db_name': {
|
|
'Description': 'The WordPress database name',
|
|
'Type': 'String',
|
|
'Default': 'wordpress',
|
|
'MinLength': [(8, len_desc)],
|
|
'MaxLength': [(16, len_desc)],
|
|
'AllowedPattern': [
|
|
('[a-zA-Z]+', pattern_desc1),
|
|
('[a-z]+[a-zA-Z]*', pattern_desc2)]}}
|
|
|
|
name = 'db_name'
|
|
schema = param['db_name']
|
|
|
|
def v(value):
|
|
hot.HOTParamSchema(schema).do_check(name, value,
|
|
[parameters.ALLOWED_VALUES,
|
|
parameters.ALLOWED_PATTERN,
|
|
parameters.MAX_LENGTH,
|
|
parameters.MIN_LENGTH])
|
|
return True
|
|
|
|
value = 'wp'
|
|
err = self.assertRaises(ValueError, v, value)
|
|
self.assertIn(len_desc, str(err))
|
|
|
|
value = 'abcdefghijklmnopq'
|
|
err = self.assertRaises(ValueError, v, value)
|
|
self.assertIn(len_desc, str(err))
|
|
|
|
value = 'abcdefgh1'
|
|
err = self.assertRaises(ValueError, v, value)
|
|
self.assertIn(pattern_desc1, str(err))
|
|
|
|
value = 'Abcdefghi'
|
|
err = self.assertRaises(ValueError, v, value)
|
|
self.assertIn(pattern_desc2, str(err))
|
|
|
|
value = 'abcdefghi'
|
|
self.assertTrue(v(value))
|
|
|
|
value = 'abcdefghI'
|
|
self.assertTrue(v(value))
|
|
|
|
def test_hot_template_validate_param(self):
|
|
len_desc = 'string length should between 8 and 16'
|
|
pattern_desc1 = 'Value must consist of characters only'
|
|
pattern_desc2 = 'Value must start with a lowercase character'
|
|
hot_tpl = template_format.parse('''
|
|
heat_template_version: 2013-05-23
|
|
parameters:
|
|
db_name:
|
|
description: The WordPress database name
|
|
type: string
|
|
default: wordpress
|
|
constraints:
|
|
- length: { min: 8, max: 16 }
|
|
description: %s
|
|
- allowed_pattern: "[a-zA-Z]+"
|
|
description: %s
|
|
- allowed_pattern: "[a-z]+[a-zA-Z]*"
|
|
description: %s
|
|
''' % (len_desc, pattern_desc1, pattern_desc2))
|
|
tmpl = parser.Template(hot_tpl)
|
|
|
|
def run_parameters(value):
|
|
parameters.Parameters("stack_testit", tmpl, {'db_name': value})
|
|
return True
|
|
|
|
value = 'wp'
|
|
err = self.assertRaises(ValueError, run_parameters, value)
|
|
self.assertIn(len_desc, str(err))
|
|
|
|
value = 'abcdefghijklmnopq'
|
|
err = self.assertRaises(ValueError, run_parameters, value)
|
|
self.assertIn(len_desc, str(err))
|
|
|
|
value = 'abcdefgh1'
|
|
err = self.assertRaises(ValueError, run_parameters, value)
|
|
self.assertIn(pattern_desc1, str(err))
|
|
|
|
value = 'Abcdefghi'
|
|
err = self.assertRaises(ValueError, run_parameters, value)
|
|
self.assertIn(pattern_desc2, str(err))
|
|
|
|
value = 'abcdefghi'
|
|
self.assertTrue(run_parameters(value))
|
|
|
|
value = 'abcdefghI'
|
|
self.assertTrue(run_parameters(value))
|