Defer exceptions in calculating node_data()

When generating the node_data() for a resource, catch and store any
exceptions (other than InvalidTemplateAttribute) encountered while
getting attributes. Re-raise the exception at the point where we try to
read the attribute value, including where we try to serialise the
NodeData object to store in the database.

In convergence, we generate and immediately serialise the NodeData, so
this should result in no substantial change in behaviour there.

In other situations (e.g. when we're just loading the data to show the
stack), this prevents an error in attribute calculation from aborting
the whole operation. The exception will still be raised if (and only if)
the erroneous attribute is accessed, but may be handled more
appropriately. For example, errors in calculating output values are
handled by reporting an error only for that particular output.

Change-Id: Idc97aee87405cc13e83be3373078b52e725850ea
Co-Authored-By: Zane Bitter <>
Closes-Bug: #1712280
This commit is contained in:
Thomas Herve 2017-09-22 16:44:51 +02:00 committed by Zane Bitter
parent 63f6a71071
commit 4f4932c790
3 changed files with 77 additions and 4 deletions

View File

@ -51,13 +51,20 @@ class NodeData(object):
def attributes(self):
"""Return a dict of all available top-level attribute values."""
return {k: v
for k, v in self._attributes.items()
if isinstance(k, six.string_types)}
attrs = {k: v
for k, v in self._attributes.items()
if isinstance(k, six.string_types)}
for v in six.itervalues(attrs):
if isinstance(v, Exception):
raise v
return attrs
def attribute(self, attr_name):
"""Return the specified attribute value."""
return self._attributes[attr_name]
val = self._attributes[attr_name]
if isinstance(val, Exception):
raise val
return val
def attribute_names(self):
"""Iterate over valid top-level attribute names."""
@ -73,6 +80,10 @@ class NodeData(object):
This is the format that is serialised and stored in the database's
for v in six.itervalues(self._attributes):
if isinstance(v, Exception):
raise v
return {
'id': self.primary_key,

View File

@ -1037,7 +1037,15 @@ class Resource(status.ResourceStatus):
yield attr, self.FnGetAtt(*path)
except exception.InvalidTemplateAttribute as ita:
# Attribute doesn't exist, so don't store it. Whatever
# tries to access it will get another
# InvalidTemplateAttribute exception at that point'%s', ita)
except Exception as exc:
# Store the exception that occurred. It will be
# re-raised when something tries to access it, or when
# we try to serialise the NodeData.
yield attr, exc
load_all = not self.stack.in_convergence_check
dep_attrs = self.referenced_attrs(stk_defn,

View File

@ -99,3 +99,57 @@ outputs:
actual_output_value = self.client.stacks.output_show(
stack_identifier, 'output_value')['output']
self.assertEqual(expected_output_value, actual_output_value)
nested_template = '''
heat_template_version: 2015-10-15
type: 1.yaml
value: { get_attr: [parent, resource_output_a] }
description: 'parent a'
value: { get_attr: [parent, resource_output_b] }
description: 'parent b'
error_template = '''
heat_template_version: 2015-10-15
type: OS::Heat::TestResource
value: 'a'
type: OS::Heat::TestResource
value: 'b'
description: 'Output of resource a'
value: { get_attr: [test_resource_a, output] }
description: 'Output of resource b'
value: { get_param: foo }
def test_output_error_nested(self):
stack_identifier = self.stack_create(
files={'1.yaml': self.error_template}
self.update_stack(stack_identifier, template=self.nested_template,
files={'1.yaml': self.error_template})
expected_list = [{u'output_key': u'resource_output_a',
u'output_value': u'a',
u'description': u'parent a'},
{u'output_key': u'resource_output_b',
u'output_value': None,
u'output_error': u'Error in parent output '
u'resource_output_b: The Parameter'
u' (foo) was not provided.',
u'description': u'parent b'}]
actual_list = self.client.stacks.get(stack_identifier).outputs
sorted_actual_list = sorted(actual_list, key=lambda x: x['output_key'])
self.assertEqual(expected_list, sorted_actual_list)