e1aeabaa03
If a resource is conditionally defined, depending on it raises an error in the case it's not defined. This patch fixes that by checking if the resource is present in the template regardless of the conditions. Change-Id: Iefae1fcea720bee4ed69ad1a5fe403d52d54433c Closes-Bug: #1649900
383 lines
15 KiB
Python
383 lines
15 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 collections
|
|
import copy
|
|
import itertools
|
|
import operator
|
|
|
|
import six
|
|
|
|
from heat.common import exception
|
|
from heat.common.i18n import repr_wrapper
|
|
from heat.engine import function
|
|
from heat.engine import properties
|
|
|
|
|
|
__all__ = ['ResourceDefinition']
|
|
|
|
|
|
@repr_wrapper
|
|
class ResourceDefinition(object):
|
|
"""A definition of a resource, independent of any template format."""
|
|
|
|
class Diff(object):
|
|
"""A diff between two versions of the same resource definition."""
|
|
|
|
def __init__(self, old_defn, new_defn):
|
|
if not (isinstance(old_defn, ResourceDefinition) and
|
|
isinstance(new_defn, ResourceDefinition)):
|
|
raise TypeError
|
|
|
|
self.old_defn = old_defn
|
|
self.new_defn = new_defn
|
|
|
|
def properties_changed(self):
|
|
"""Return True if the resource properties have changed."""
|
|
return self.old_defn._properties != self.new_defn._properties
|
|
|
|
def metadata_changed(self):
|
|
"""Return True if the resource metadata has changed."""
|
|
return self.old_defn._metadata != self.new_defn._metadata
|
|
|
|
def update_policy_changed(self):
|
|
"""Return True if the resource update policy has changed."""
|
|
return self.old_defn._update_policy != self.new_defn._update_policy
|
|
|
|
def __bool__(self):
|
|
"""Return True if anything has changed."""
|
|
return (self.properties_changed() or
|
|
self.metadata_changed() or
|
|
self.update_policy_changed())
|
|
|
|
__nonzero__ = __bool__
|
|
|
|
DELETION_POLICIES = (
|
|
DELETE, RETAIN, SNAPSHOT,
|
|
) = (
|
|
'Delete', 'Retain', 'Snapshot',
|
|
)
|
|
|
|
def __init__(self, name, resource_type, properties=None, metadata=None,
|
|
depends=None, deletion_policy=None, update_policy=None,
|
|
description=None, external_id=None, condition=None):
|
|
"""Initialise with the parsed definition of a resource.
|
|
|
|
Any intrinsic functions present in any of the sections should have been
|
|
parsed into Function objects before constructing the definition.
|
|
|
|
:param name: The name of the resource (for use in error messages)
|
|
:param resource_type: The resource type
|
|
:param properties: A dictionary of supplied property values
|
|
:param metadata: The supplied metadata
|
|
:param depends: A list of resource names on which this resource depends
|
|
:param deletion_policy: The deletion policy for the resource
|
|
:param update_policy: A dictionary of supplied update policies
|
|
:param description: A string describing the resource
|
|
:param external_id: A uuid of an external resource
|
|
:param condition: A condition name associated with the resource
|
|
"""
|
|
self.name = name
|
|
self.resource_type = resource_type
|
|
self.description = description or ''
|
|
self._properties = properties
|
|
self._metadata = metadata
|
|
self._depends = depends
|
|
self._deletion_policy = deletion_policy
|
|
self._update_policy = update_policy
|
|
self._external_id = external_id
|
|
self._condition = condition
|
|
|
|
self._hash = hash(self.resource_type)
|
|
self._rendering = None
|
|
|
|
assert isinstance(self.description, six.string_types)
|
|
|
|
if properties is not None:
|
|
assert isinstance(properties, (collections.Mapping,
|
|
function.Function))
|
|
self._hash ^= _hash_data(properties)
|
|
|
|
if metadata is not None:
|
|
assert isinstance(metadata, (collections.Mapping,
|
|
function.Function))
|
|
self._hash ^= _hash_data(metadata)
|
|
|
|
if depends is not None:
|
|
assert isinstance(depends, (collections.Sequence,
|
|
function.Function))
|
|
assert not isinstance(depends, six.string_types)
|
|
self._hash ^= _hash_data(depends)
|
|
|
|
if deletion_policy is not None:
|
|
assert deletion_policy in self.DELETION_POLICIES
|
|
self._hash ^= _hash_data(deletion_policy)
|
|
|
|
if update_policy is not None:
|
|
assert isinstance(update_policy, (collections.Mapping,
|
|
function.Function))
|
|
self._hash ^= _hash_data(update_policy)
|
|
|
|
if external_id is not None:
|
|
assert isinstance(external_id, (six.string_types,
|
|
function.Function))
|
|
self._hash ^= _hash_data(external_id)
|
|
self._deletion_policy = self.RETAIN
|
|
|
|
if condition is not None:
|
|
assert isinstance(condition, (six.string_types, bool,
|
|
function.Function))
|
|
self._hash ^= _hash_data(condition)
|
|
|
|
def freeze(self, **overrides):
|
|
"""Return a frozen resource definition, with all functions resolved.
|
|
|
|
This return a new resource definition with fixed data (containing no
|
|
intrinsic functions). Named arguments passed to this method override
|
|
the values passed as arguments to the constructor.
|
|
"""
|
|
if getattr(self, '_frozen', False) and not overrides:
|
|
return self
|
|
|
|
def arg_item(attr_name):
|
|
name = attr_name.lstrip('_')
|
|
if name in overrides:
|
|
value = overrides[name]
|
|
if not value and getattr(self, attr_name) is None:
|
|
value = None
|
|
else:
|
|
value = function.resolve(getattr(self, attr_name))
|
|
|
|
return name, value
|
|
|
|
args = ('name', 'resource_type', '_properties', '_metadata',
|
|
'_depends', '_deletion_policy', '_update_policy',
|
|
'description', '_external_id', '_condition')
|
|
|
|
defn = type(self)(**dict(arg_item(a) for a in args))
|
|
defn._frozen = True
|
|
return defn
|
|
|
|
def reparse(self, stack, template):
|
|
"""Reinterpret the resource definition in the context of a new stack.
|
|
|
|
This returns a new resource definition, with all of the functions
|
|
parsed in the context of the specified stack and template.
|
|
"""
|
|
assert not getattr(self, '_frozen', False
|
|
), "Cannot re-parse a frozen definition"
|
|
|
|
def reparse_snippet(snippet):
|
|
return template.parse(stack, copy.deepcopy(snippet))
|
|
|
|
return type(self)(
|
|
self.name, self.resource_type,
|
|
properties=reparse_snippet(self._properties),
|
|
metadata=reparse_snippet(self._metadata),
|
|
depends=reparse_snippet(self._depends),
|
|
deletion_policy=reparse_snippet(self._deletion_policy),
|
|
update_policy=reparse_snippet(self._update_policy),
|
|
external_id=reparse_snippet(self._external_id),
|
|
condition=self._condition)
|
|
|
|
def dep_attrs(self, resource_name):
|
|
"""Iterate over attributes of a given resource that this references.
|
|
|
|
Return an iterator over dependent attributes for specified
|
|
resource_name in resources' properties and metadata fields.
|
|
"""
|
|
return itertools.chain(function.dep_attrs(self._properties,
|
|
resource_name),
|
|
function.dep_attrs(self._metadata,
|
|
resource_name))
|
|
|
|
def dependencies(self, stack):
|
|
"""Return the Resource objects in given stack on which this depends."""
|
|
def path(section):
|
|
return '.'.join([self.name, section])
|
|
|
|
def get_resource(res_name):
|
|
if res_name not in stack:
|
|
if res_name in stack.t.get(stack.t.RESOURCES):
|
|
# The resource is conditionally defined, allow dependencies
|
|
# on it
|
|
return
|
|
raise exception.InvalidTemplateReference(resource=res_name,
|
|
key=self.name)
|
|
return stack[res_name]
|
|
|
|
def strict_func_deps(data, datapath):
|
|
return six.moves.filter(
|
|
lambda r: getattr(r, 'strict_dependency', True),
|
|
function.dependencies(data, datapath))
|
|
|
|
explicit_depends = [] if self._depends is None else self._depends
|
|
prop_deps = strict_func_deps(self._properties, path('Properties'))
|
|
metadata_deps = strict_func_deps(self._metadata, path('Metadata'))
|
|
|
|
# (ricolin) External resource should not depend on any other resources.
|
|
# This operation is not allowed for now.
|
|
if self.external_id():
|
|
if explicit_depends:
|
|
raise exception.InvalidExternalResourceDependency(
|
|
external_id=self.external_id(),
|
|
resource_type=self.resource_type
|
|
)
|
|
return itertools.chain()
|
|
|
|
return itertools.chain(
|
|
filter(None, (get_resource(dep) for dep in explicit_depends)),
|
|
prop_deps, metadata_deps)
|
|
|
|
def properties(self, schema, context=None):
|
|
"""Return a Properties object representing the resource properties.
|
|
|
|
The Properties object is constructed from the given schema, and may
|
|
require a context to validate constraints.
|
|
"""
|
|
return properties.Properties(schema, self._properties or {},
|
|
function.resolve, self.name, context,
|
|
section='Properties')
|
|
|
|
def deletion_policy(self):
|
|
"""Return the deletion policy for the resource.
|
|
|
|
The policy will be one of those listed in DELETION_POLICIES.
|
|
"""
|
|
return function.resolve(self._deletion_policy) or self.DELETE
|
|
|
|
def update_policy(self, schema, context=None):
|
|
"""Return a Properties object representing the resource update policy.
|
|
|
|
The Properties object is constructed from the given schema, and may
|
|
require a context to validate constraints.
|
|
"""
|
|
return properties.Properties(schema, self._update_policy or {},
|
|
function.resolve, self.name, context,
|
|
section='UpdatePolicy')
|
|
|
|
def metadata(self):
|
|
"""Return the resource metadata."""
|
|
return function.resolve(self._metadata) or {}
|
|
|
|
def external_id(self):
|
|
"""Return the external resource id."""
|
|
return function.resolve(self._external_id)
|
|
|
|
def condition(self):
|
|
"""Return the name of the conditional inclusion rule, if any.
|
|
|
|
Returns None if the resource is included unconditionally.
|
|
"""
|
|
return function.resolve(self._condition)
|
|
|
|
def render_hot(self):
|
|
"""Return a HOT snippet for the resource definition."""
|
|
if self._rendering is None:
|
|
attrs = {
|
|
'type': 'resource_type',
|
|
'properties': '_properties',
|
|
'metadata': '_metadata',
|
|
'deletion_policy': '_deletion_policy',
|
|
'update_policy': '_update_policy',
|
|
'depends_on': '_depends',
|
|
'external_id': '_external_id',
|
|
'condition': '_condition'
|
|
}
|
|
|
|
def rawattrs():
|
|
"""Get an attribute with function objects stripped out."""
|
|
for key, attr in attrs.items():
|
|
value = getattr(self, attr)
|
|
if value is not None:
|
|
yield key, copy.deepcopy(value)
|
|
|
|
self._rendering = dict(rawattrs())
|
|
|
|
return self._rendering
|
|
|
|
def __sub__(self, previous):
|
|
"""Calculate the difference between this definition and a previous one.
|
|
|
|
Return a Diff object that can be used to establish differences between
|
|
this definition and a previous definition of the same resource.
|
|
"""
|
|
if not isinstance(previous, ResourceDefinition):
|
|
return NotImplemented
|
|
|
|
return self.Diff(previous, self)
|
|
|
|
def __eq__(self, other):
|
|
"""Compare this resource definition for equality with another.
|
|
|
|
Two resource definitions are considered to be equal if they can be
|
|
generated from the same template snippet. The name of the resource is
|
|
ignored, as are the actual values that any included functions resolve
|
|
to.
|
|
"""
|
|
if not isinstance(other, ResourceDefinition):
|
|
return NotImplemented
|
|
|
|
return self.render_hot() == other.render_hot()
|
|
|
|
def __ne__(self, other):
|
|
"""Compare this resource definition for inequality with another.
|
|
|
|
See __eq__() for the definition of equality.
|
|
"""
|
|
equal = self.__eq__(other)
|
|
if equal is NotImplemented:
|
|
return NotImplemented
|
|
|
|
return not equal
|
|
|
|
def __hash__(self):
|
|
"""Return a hash value for this resource definition.
|
|
|
|
Resource definitions that compare equal will have the same hash. (In
|
|
particular, the resource name is *not* taken into account.) See
|
|
the __eq__() method for the definition of equality.
|
|
"""
|
|
return self._hash
|
|
|
|
def __repr__(self):
|
|
"""Return a string representation of the resource definition."""
|
|
|
|
def arg_repr(arg_name):
|
|
return '='.join([arg_name, repr(getattr(self, '_%s' % arg_name))])
|
|
|
|
args = ('properties', 'metadata', 'depends',
|
|
'deletion_policy', 'update_policy', 'condition')
|
|
data = {
|
|
'classname': type(self).__name__,
|
|
'name': repr(self.name),
|
|
'type': repr(self.resource_type),
|
|
'args': ', '.join(arg_repr(n) for n in args)
|
|
}
|
|
return '%(classname)s(%(name)s, %(type)s, %(args)s)' % data
|
|
|
|
|
|
def _hash_data(data):
|
|
"""Return a stable hash value for an arbitrary parsed-JSON data snippet."""
|
|
if isinstance(data, function.Function):
|
|
data = copy.deepcopy(data)
|
|
|
|
if not isinstance(data, six.string_types):
|
|
if isinstance(data, collections.Sequence):
|
|
return hash(tuple(_hash_data(d) for d in data))
|
|
|
|
if isinstance(data, collections.Mapping):
|
|
item_hashes = (hash(k) ^ _hash_data(v) for k, v in data.items())
|
|
return six.moves.reduce(operator.xor, item_hashes, 0)
|
|
|
|
return hash(data)
|