openstack
/
heat
Code Issues Proposed changes

Never cache the 'show' attribute 

The 'show' attribute is used to get all data about a resource. There are
folks using this in lieu of having access to the underlying OpenStack APIs
themselves. By not caching it, we ensure that they will always see a live
value, even once we start storing attribute values in the database when
modifying a resource.

Change-Id: Id81a56f7d774bc18a2b5d62c80b369f1c12bcc5c
Co-Authored-By: Crag Wolfe <cwolfe@redhat.com>
Related-Bug: #1660831
This commit is contained in:
Zane Bitter 2017-06-21 20:04:01 -04:00
parent a5ac2c3b1d
commit f47efe532d
2 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
heat/engine/resource.py
View File

@ -123,6 +123,7 @@ class Resource(status.ResourceStatus):
base_attributes_schema = { base_attributes_schema = {
SHOW: attributes.Schema( SHOW: attributes.Schema(
_("Detailed information about resource."), _("Detailed information about resource."),
cache_mode=attributes.Schema.CACHE_NONE,
type=attributes.Schema.MAP type=attributes.Schema.MAP
) )
} }

24
heat/tests/openstack/neutron/test_neutron.py
View File

@ -16,6 +16,7 @@ from neutronclient.common import exceptions as qe
import six import six
from heat.common import exception from heat.common import exception
from heat.engine import attributes
from heat.engine import properties from heat.engine import properties
from heat.engine.resources.openstack.neutron import net from heat.engine.resources.openstack.neutron import net
from heat.engine.resources.openstack.neutron import neutron as nr from heat.engine.resources.openstack.neutron import neutron as nr
@ -95,6 +96,9 @@ class NeutronTest(common.HeatTestCase):
def test_resolve_attribute(self): def test_resolve_attribute(self):
res = self._get_some_neutron_resource() res = self._get_some_neutron_resource()
res.attributes_schema.update(
{'attr2': attributes.Schema(type=attributes.Schema.STRING)})
res.attributes = res._init_attributes()
side_effect = [{'attr1': 'val1', 'attr2': 'val2'}, side_effect = [{'attr1': 'val1', 'attr2': 'val2'},
{'attr1': 'val1', 'attr2': 'val2'}, {'attr1': 'val1', 'attr2': 'val2'},
{'attr1': 'val1', 'attr2': 'val2'}, {'attr1': 'val1', 'attr2': 'val2'},
@ -103,19 +107,23 @@ class NeutronTest(common.HeatTestCase):
res.resource_id = 'resource_id' res.resource_id = 'resource_id'
self.assertEqual({'attr1': 'val1', 'attr2': 'val2'}, self.assertEqual({'attr1': 'val1', 'attr2': 'val2'},
res.FnGetAtt('show')) res.FnGetAtt('show'))
self.assertEqual('val2', res._resolve_all_attributes('attr2')) self.assertEqual('val2', res.attributes['attr2'])
self.assertRaises(KeyError, res._resolve_all_attributes, 'attr3') self.assertRaises(KeyError, res._resolve_all_attributes, 'attr3')
self.assertIsNone(res._resolve_all_attributes('attr2')) self.assertIsNone(res._resolve_all_attributes('attr1'))
res.resource_id = None res.resource_id = None
# use local cached object # use local cached object for non-show attribute
self.assertEqual({'attr1': 'val1', 'attr2': 'val2'}, self.assertEqual('val2',
res.FnGetAtt('show')) res.FnGetAtt('attr2'))
# reset cache, so resolver should be used again # but the 'show' attribute is never cached
# and return None due to resource_id is None
res.attributes.reset_resolved_values()
self.assertIsNone(res.FnGetAtt('show')) self.assertIsNone(res.FnGetAtt('show'))
# remove 'attr2' from res.attributes cache
res.attributes.reset_resolved_values()
# _resolve_attribute (in NeutronResource class) returns None
# due to no resource_id
self.assertIsNone(res.FnGetAtt('attr2'))
def test_needs_replace_failed(self): def test_needs_replace_failed(self):
res = self._get_some_neutron_resource() res = self._get_some_neutron_resource()
res.state_set(res.CREATE, res.FAILED) res.state_set(res.CREATE, res.FAILED)