506919fcf6
Adds an optional flag that causes template-validate to recursively validate nested stacks and expose a schema of the parameters for all stacks in the tree. This uses a similar method to stack preview in that it builds the tree in memory so we can then walk it and extract the parameter data we need. Change-Id: I7e3d752124997a0a7b8ff53e774ed8034dd2f81d Co-Authored-By: Jay Dobies <jdobies@redhat.com> Implements-blueprint: nested-validation
245 lines
10 KiB
Python
245 lines
10 KiB
Python
# 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.
|
|
|
|
|
|
import six
|
|
|
|
from heatclient import exc
|
|
|
|
from heat_integrationtests.functional import functional_base
|
|
|
|
|
|
class StackTemplateValidateTest(functional_base.FunctionalTestsBase):
|
|
|
|
random_template = '''
|
|
heat_template_version: 2014-10-16
|
|
description: the stack description
|
|
parameters:
|
|
aparam:
|
|
type: number
|
|
default: 10
|
|
description: the param description
|
|
resources:
|
|
myres:
|
|
type: OS::Heat::RandomString
|
|
properties:
|
|
length: {get_param: aparam}
|
|
'''
|
|
|
|
parent_template = '''
|
|
heat_template_version: 2014-10-16
|
|
description: the parent template
|
|
parameters:
|
|
pparam:
|
|
type: number
|
|
default: 5
|
|
description: the param description
|
|
resources:
|
|
nres:
|
|
type: mynested.yaml
|
|
properties:
|
|
aparam: {get_param: pparam}
|
|
'''
|
|
|
|
parent_template_noprop = '''
|
|
heat_template_version: 2014-10-16
|
|
description: the parent template
|
|
resources:
|
|
nres:
|
|
type: mynested.yaml
|
|
'''
|
|
|
|
random_template_groups = '''
|
|
heat_template_version: 2014-10-16
|
|
description: the stack description
|
|
parameters:
|
|
aparam:
|
|
type: number
|
|
default: 10
|
|
description: the param description
|
|
bparam:
|
|
type: string
|
|
default: foo
|
|
cparam:
|
|
type: string
|
|
default: secret
|
|
hidden: true
|
|
parameter_groups:
|
|
- label: str_params
|
|
description: The string params
|
|
parameters:
|
|
- bparam
|
|
- cparam
|
|
resources:
|
|
myres:
|
|
type: OS::Heat::RandomString
|
|
properties:
|
|
length: {get_param: aparam}
|
|
'''
|
|
|
|
def test_template_validate_basic(self):
|
|
ret = self.client.stacks.validate(template=self.random_template)
|
|
expected = {'Description': 'the stack description',
|
|
'Parameters': {
|
|
'aparam': {'Default': 10,
|
|
'Description': 'the param description',
|
|
'Label': 'aparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}}}
|
|
self.assertEqual(expected, ret)
|
|
|
|
def test_template_validate_override_default(self):
|
|
env = {'parameters': {'aparam': 5}}
|
|
ret = self.client.stacks.validate(template=self.random_template,
|
|
environment=env)
|
|
expected = {'Description': 'the stack description',
|
|
'Parameters': {
|
|
'aparam': {'Default': 10,
|
|
'Value': 5,
|
|
'Description': 'the param description',
|
|
'Label': 'aparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}}}
|
|
self.assertEqual(expected, ret)
|
|
|
|
def test_template_validate_override_none(self):
|
|
env = {'resource_registry': {
|
|
'OS::Heat::RandomString': 'OS::Heat::None'}}
|
|
ret = self.client.stacks.validate(template=self.random_template,
|
|
environment=env)
|
|
expected = {'Description': 'the stack description',
|
|
'Parameters': {
|
|
'aparam': {'Default': 10,
|
|
'Description': 'the param description',
|
|
'Label': 'aparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}}}
|
|
self.assertEqual(expected, ret)
|
|
|
|
def test_template_validate_basic_required_param(self):
|
|
tmpl = self.random_template.replace('default: 10', '')
|
|
ret = self.client.stacks.validate(template=tmpl)
|
|
expected = {'Description': 'the stack description',
|
|
'Parameters': {
|
|
'aparam': {'Description': 'the param description',
|
|
'Label': 'aparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}}}
|
|
self.assertEqual(expected, ret)
|
|
|
|
def test_template_validate_fail_version(self):
|
|
fail_template = self.random_template.replace('2014-10-16', 'invalid')
|
|
ex = self.assertRaises(exc.HTTPBadRequest,
|
|
self.client.stacks.validate,
|
|
template=fail_template)
|
|
self.assertIn('The template version is invalid', six.text_type(ex))
|
|
|
|
def test_template_validate_parameter_groups(self):
|
|
ret = self.client.stacks.validate(template=self.random_template_groups)
|
|
expected = {'Description': 'the stack description',
|
|
'ParameterGroups':
|
|
[{'description': 'The string params',
|
|
'label': 'str_params',
|
|
'parameters': ['bparam', 'cparam']}],
|
|
'Parameters':
|
|
{'aparam':
|
|
{'Default': 10,
|
|
'Description': 'the param description',
|
|
'Label': 'aparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'},
|
|
'bparam':
|
|
{'Default': 'foo',
|
|
'Description': '',
|
|
'Label': 'bparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'String'},
|
|
'cparam':
|
|
{'Default': 'secret',
|
|
'Description': '',
|
|
'Label': 'cparam',
|
|
'NoEcho': 'true',
|
|
'Type': 'String'}}}
|
|
self.assertEqual(expected, ret)
|
|
|
|
def test_template_validate_nested_off(self):
|
|
files = {'mynested.yaml': self.random_template}
|
|
ret = self.client.stacks.validate(template=self.parent_template,
|
|
files=files)
|
|
expected = {'Description': 'the parent template',
|
|
'Parameters': {
|
|
'pparam': {'Default': 5,
|
|
'Description': 'the param description',
|
|
'Label': 'pparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}}}
|
|
self.assertEqual(expected, ret)
|
|
|
|
def test_template_validate_nested_on(self):
|
|
files = {'mynested.yaml': self.random_template}
|
|
ret = self.client.stacks.validate(template=self.parent_template_noprop,
|
|
files=files,
|
|
show_nested=True)
|
|
expected = {'Description': 'the parent template',
|
|
'Parameters': {},
|
|
'NestedParameters': {
|
|
'nres': {'Description': 'the stack description',
|
|
'Parameters': {'aparam': {'Default': 10,
|
|
'Description':
|
|
'the param '
|
|
'description',
|
|
'Label': 'aparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}},
|
|
'Type': 'mynested.yaml'}}}
|
|
self.assertEqual(expected, ret)
|
|
|
|
def test_template_validate_nested_on_multiple(self):
|
|
# parent_template -> nested_template -> random_template
|
|
nested_template = self.random_template.replace(
|
|
'OS::Heat::RandomString', 'mynested2.yaml')
|
|
files = {'mynested.yaml': nested_template,
|
|
'mynested2.yaml': self.random_template}
|
|
ret = self.client.stacks.validate(template=self.parent_template,
|
|
files=files,
|
|
show_nested=True)
|
|
|
|
n_param2 = {'myres': {'Description': 'the stack description',
|
|
'Parameters': {'aparam': {'Default': 10,
|
|
'Description':
|
|
'the param '
|
|
'description',
|
|
'Label': 'aparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}},
|
|
'Type': 'mynested2.yaml'}}
|
|
expected = {'Description': 'the parent template',
|
|
'Parameters': {
|
|
'pparam': {'Default': 5,
|
|
'Description': 'the param description',
|
|
'Label': 'pparam',
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}},
|
|
'NestedParameters': {
|
|
'nres': {'Description': 'the stack description',
|
|
'Parameters': {'aparam': {'Default': 10,
|
|
'Description':
|
|
'the param '
|
|
'description',
|
|
'Label': 'aparam',
|
|
'Value': 5,
|
|
'NoEcho': 'false',
|
|
'Type': 'Number'}},
|
|
'NestedParameters': n_param2,
|
|
'Type': 'mynested.yaml'}}}
|
|
self.assertEqual(expected, ret)
|