Create a unique identifier for stacks
Change-Id: I1517502a2a5d9a96803565297315e7b276f2e974 Signed-off-by: Zane Bitter <zbitter@redhat.com>
This commit is contained in:
Zane Bitter
parent
8e1d4ef210
commit
4465694e0d
115
heat/engine/identifier.py
Normal file
115
heat/engine/identifier.py
Normal file
@ -0,0 +1,115 @@
|
||||
# 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.
|
||||
|
||||
import re
|
||||
import urllib
|
||||
import collections
|
||||
|
||||
|
||||
class HeatIdentifier(collections.Mapping):
|
||||
|
||||
FIELDS = (
|
||||
TENANT, STACK_NAME, STACK_ID, PATH
|
||||
) = (
|
||||
'tenant', 'stack_name', 'stack_id', 'path'
|
||||
)
|
||||
path_re = re.compile(r'stacks/([^/]+)/([^/]+)(.*)')
|
||||
|
||||
def __init__(self, tenant, stack_name, stack_id, path=''):
|
||||
'''
|
||||
Initialise a HeatIdentifier from a Tenant ID, Stack name, Stack ID
|
||||
and optional path. If a path is supplied and it does not begin with
|
||||
"/", a "/" will be prepended.
|
||||
'''
|
||||
if path and not path.startswith('/'):
|
||||
path = '/' + path
|
||||
|
||||
self.identity = {
|
||||
self.TENANT: tenant,
|
||||
self.STACK_NAME: stack_name,
|
||||
self.STACK_ID: str(stack_id),
|
||||
self.PATH: path,
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def from_arn(cls, arn):
|
||||
'''
|
||||
Return a new HeatIdentifier generated by parsing the supplied ARN.
|
||||
'''
|
||||
fields = arn.split(':')
|
||||
if len(fields) < 6 or fields[0].lower() != 'arn':
|
||||
raise ValueError('"%s" is not a valid ARN' % arn)
|
||||
|
||||
id_fragment = ':'.join(fields[5:])
|
||||
path = cls.path_re.match(id_fragment)
|
||||
|
||||
if fields[1] != 'openstack' or fields[2] != 'heat' or not path:
|
||||
raise ValueError('"%s" is not a valid Heat ARN' % arn)
|
||||
|
||||
return cls(urllib.unquote(fields[4]),
|
||||
urllib.unquote(path.group(1)),
|
||||
urllib.unquote(path.group(2)),
|
||||
urllib.unquote(path.group(3)))
|
||||
|
||||
def arn(self):
|
||||
'''
|
||||
Return an ARN of the form:
|
||||
arn:openstack:heat::<tenant>:stacks/<stack_name>/<stack_id><path>
|
||||
'''
|
||||
return 'arn:openstack:heat::%s:%s' % (urllib.quote(self.tenant, ''),
|
||||
self._tenant_path())
|
||||
|
||||
def url_path(self):
|
||||
'''
|
||||
Return a URL-encoded path segment of a URL in the form:
|
||||
/<tenant>/stacks/<stack_name>/<stack_id><path>
|
||||
'''
|
||||
return '/%s/%s' % (urllib.quote(self.tenant, ''), self._tenant_path())
|
||||
|
||||
def _tenant_path(self):
|
||||
'''
|
||||
Return a URL-encoded path segment of a URL within a particular tenant,
|
||||
in the form:
|
||||
stacks/<stack_name>/<stack_id><path>
|
||||
'''
|
||||
return 'stacks/%s/%s%s' % (urllib.quote(self.stack_name, ''),
|
||||
urllib.quote(self.stack_id, ''),
|
||||
urllib.quote(self.path))
|
||||
|
||||
def __getattr__(self, attr):
|
||||
'''
|
||||
Return one of the components of the identity when accessed as an
|
||||
attribute.
|
||||
'''
|
||||
if attr not in self.FIELDS:
|
||||
raise AttributeError('Unknown attribute "%s"' % attr)
|
||||
|
||||
return self.identity[attr]
|
||||
|
||||
def __getitem__(self, key):
|
||||
'''Return one of the components of the identity.'''
|
||||
if key not in self.FIELDS:
|
||||
raise KeyError('Unknown attribute "%s"' % key)
|
||||
|
||||
return self.identity[key]
|
||||
|
||||
def __len__(self):
|
||||
'''Return the number of components in an identity.'''
|
||||
return len(self.FIELDS)
|
||||
|
||||
def __contains__(self, key):
|
||||
return key in self.FIELDS
|
||||
|
||||
def __iter__(self):
|
||||
return iter(self.FIELDS)
|
||||
@ -21,6 +21,7 @@ import copy
|
||||
from heat.common import exception
|
||||
from heat.engine import checkeddict
|
||||
from heat.engine import dependencies
|
||||
from heat.engine import identifier
|
||||
from heat.engine import resources
|
||||
from heat.db import api as db_api
|
||||
|
||||
@ -321,6 +322,13 @@ class Stack(object):
|
||||
|
||||
return self.id
|
||||
|
||||
def identifier(self):
|
||||
'''
|
||||
Return an identifier for this stack.
|
||||
'''
|
||||
return identifier.HeatIdentifier(self.context.tenant,
|
||||
self.name, self.id)
|
||||
|
||||
def __iter__(self):
|
||||
'''
|
||||
Return an iterator over this template's resources in the order that
|
||||
|
||||
228
heat/tests/test_identifier.py
Normal file
228
heat/tests/test_identifier.py
Normal file
@ -0,0 +1,228 @@
|
||||
# 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.
|
||||
|
||||
|
||||
import nose
|
||||
import unittest
|
||||
from nose.plugins.attrib import attr
|
||||
import mox
|
||||
import json
|
||||
|
||||
from heat.engine import identifier
|
||||
|
||||
|
||||
@attr(tag=['unit', 'identifier'])
|
||||
@attr(speed='fast')
|
||||
class IdentifierTest(unittest.TestCase):
|
||||
|
||||
def test_attrs(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
self.assertEqual(hi.tenant, 't')
|
||||
self.assertEqual(hi.stack_name, 's')
|
||||
self.assertEqual(hi.stack_id, 'i')
|
||||
self.assertEqual(hi.path, '/p')
|
||||
|
||||
def test_path_default(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i')
|
||||
self.assertEqual(hi.path, '')
|
||||
|
||||
def test_items(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
self.assertEqual(hi['tenant'], 't')
|
||||
self.assertEqual(hi['stack_name'], 's')
|
||||
self.assertEqual(hi['stack_id'], 'i')
|
||||
self.assertEqual(hi['path'], '/p')
|
||||
|
||||
def test_invalid_attr(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
hi.identity['foo'] = 'bar'
|
||||
self.assertRaises(AttributeError, getattr, hi, 'foo')
|
||||
|
||||
def test_invalid_item(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
hi.identity['foo'] = 'bar'
|
||||
self.assertRaises(KeyError, lambda o, k: o[k], hi, 'foo')
|
||||
|
||||
def test_arn(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
self.assertEqual(hi.arn(), 'arn:openstack:heat::t:stacks/s/i/p')
|
||||
|
||||
def test_arn_id_int(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 42, 'p')
|
||||
self.assertEqual(hi.arn(), 'arn:openstack:heat::t:stacks/s/42/p')
|
||||
|
||||
def test_arn_parse(self):
|
||||
arn = 'arn:openstack:heat::t:stacks/s/i/p'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.tenant, 't')
|
||||
self.assertEqual(hi.stack_name, 's')
|
||||
self.assertEqual(hi.stack_id, 'i')
|
||||
self.assertEqual(hi.path, '/p')
|
||||
|
||||
def test_arn_parse_path_default(self):
|
||||
arn = 'arn:openstack:heat::t:stacks/s/i'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.tenant, 't')
|
||||
self.assertEqual(hi.stack_name, 's')
|
||||
self.assertEqual(hi.stack_id, 'i')
|
||||
self.assertEqual(hi.path, '')
|
||||
|
||||
def test_arn_parse_upper(self):
|
||||
arn = 'ARN:openstack:heat::t:stacks/s/i/p'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.stack_name, 's')
|
||||
|
||||
def test_arn_parse_arn_invalid(self):
|
||||
arn = 'urn:openstack:heat::t:stacks/s/i'
|
||||
self.assertRaises(ValueError, identifier.HeatIdentifier.from_arn, arn)
|
||||
|
||||
def test_arn_parse_os_invalid(self):
|
||||
arn = 'arn:aws:heat::t:stacks/s/i'
|
||||
self.assertRaises(ValueError, identifier.HeatIdentifier.from_arn, arn)
|
||||
|
||||
def test_arn_parse_heat_invalid(self):
|
||||
arn = 'arn:openstack:cool::t:stacks/s/i'
|
||||
self.assertRaises(ValueError, identifier.HeatIdentifier.from_arn, arn)
|
||||
|
||||
def test_arn_parse_stacks_invalid(self):
|
||||
arn = 'arn:openstack:heat::t:sticks/s/i'
|
||||
self.assertRaises(ValueError, identifier.HeatIdentifier.from_arn, arn)
|
||||
|
||||
def test_arn_parse_missing_field(self):
|
||||
arn = 'arn:openstack:heat::t:stacks/s'
|
||||
self.assertRaises(ValueError, identifier.HeatIdentifier.from_arn, arn)
|
||||
|
||||
def test_arn_parse_empty_field(self):
|
||||
arn = 'arn:openstack:heat::t:stacks//i'
|
||||
self.assertRaises(ValueError, identifier.HeatIdentifier.from_arn, arn)
|
||||
|
||||
def test_arn_round_trip(self):
|
||||
hii = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
hio = identifier.HeatIdentifier.from_arn(hii.arn())
|
||||
self.assertEqual(hio.tenant, hii.tenant)
|
||||
self.assertEqual(hio.stack_name, hii.stack_name)
|
||||
self.assertEqual(hio.stack_id, hii.stack_id)
|
||||
self.assertEqual(hio.path, hii.path)
|
||||
|
||||
def test_arn_parse_round_trip(self):
|
||||
arn = 'arn:openstack:heat::t:stacks/s/i/p'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.arn(), arn)
|
||||
|
||||
def test_dict_round_trip(self):
|
||||
hii = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
hio = identifier.HeatIdentifier(**dict(hii))
|
||||
self.assertEqual(hio.tenant, hii.tenant)
|
||||
self.assertEqual(hio.stack_name, hii.stack_name)
|
||||
self.assertEqual(hio.stack_id, hii.stack_id)
|
||||
self.assertEqual(hio.path, hii.path)
|
||||
|
||||
def test_url_path(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
self.assertEqual(hi.url_path(), '/t/stacks/s/i/p')
|
||||
|
||||
def test_url_path_default(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i')
|
||||
self.assertEqual(hi.url_path(), '/t/stacks/s/i')
|
||||
|
||||
def test_tenant_escape(self):
|
||||
hi = identifier.HeatIdentifier(':/', 's', 'i')
|
||||
self.assertEqual(hi.tenant, ':/')
|
||||
self.assertEqual(hi.url_path(), '/%3A%2F/stacks/s/i')
|
||||
self.assertEqual(hi.arn(), 'arn:openstack:heat::%3A%2F:stacks/s/i')
|
||||
|
||||
def test_name_escape(self):
|
||||
hi = identifier.HeatIdentifier('t', ':/', 'i')
|
||||
self.assertEqual(hi.stack_name, ':/')
|
||||
self.assertEqual(hi.url_path(), '/t/stacks/%3A%2F/i')
|
||||
self.assertEqual(hi.arn(), 'arn:openstack:heat::t:stacks/%3A%2F/i')
|
||||
|
||||
def test_id_escape(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', ':/')
|
||||
self.assertEqual(hi.stack_id, ':/')
|
||||
self.assertEqual(hi.url_path(), '/t/stacks/s/%3A%2F')
|
||||
self.assertEqual(hi.arn(), 'arn:openstack:heat::t:stacks/s/%3A%2F')
|
||||
|
||||
def test_path_escape(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i', ':/')
|
||||
self.assertEqual(hi.path, '/:/')
|
||||
self.assertEqual(hi.url_path(), '/t/stacks/s/i/%3A/')
|
||||
self.assertEqual(hi.arn(), 'arn:openstack:heat::t:stacks/s/i/%3A/')
|
||||
|
||||
def test_tenant_decode(self):
|
||||
arn = 'arn:openstack:heat::%3A%2F:stacks/s/i'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.tenant, ':/')
|
||||
|
||||
def test_name_decode(self):
|
||||
arn = 'arn:openstack:heat::t:stacks/%3A%2F/i'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.stack_name, ':/')
|
||||
|
||||
def test_id_decode(self):
|
||||
arn = 'arn:openstack:heat::t:stacks/s/%3A%2F'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.stack_id, ':/')
|
||||
|
||||
def test_path_decode(self):
|
||||
arn = 'arn:openstack:heat::t:stacks/s/i/%3A%2F'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.path, '/:/')
|
||||
|
||||
def test_arn_escape_decode_round_trip(self):
|
||||
hii = identifier.HeatIdentifier(':/', ':/', ':/', ':/')
|
||||
hio = identifier.HeatIdentifier.from_arn(hii.arn())
|
||||
self.assertEqual(hio.tenant, hii.tenant)
|
||||
self.assertEqual(hio.stack_name, hii.stack_name)
|
||||
self.assertEqual(hio.stack_id, hii.stack_id)
|
||||
self.assertEqual(hio.path, hii.path)
|
||||
|
||||
def test_arn_decode_escape_round_trip(self):
|
||||
arn = 'arn:openstack:heat::%3A%2F:stacks/%3A%2F/%3A%2F/%3A/'
|
||||
hi = identifier.HeatIdentifier.from_arn(arn)
|
||||
self.assertEqual(hi.arn(), arn)
|
||||
|
||||
def test_equal(self):
|
||||
hi1 = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
hi2 = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
self.assertTrue(hi1 == hi2)
|
||||
|
||||
def test_equal_dict(self):
|
||||
hi = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
self.assertTrue(hi == dict(hi))
|
||||
self.assertTrue(dict(hi) == hi)
|
||||
|
||||
def test_not_equal(self):
|
||||
hi1 = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
hi2 = identifier.HeatIdentifier('t', 's', 'i', 'q')
|
||||
self.assertFalse(hi1 == hi2)
|
||||
self.assertFalse(hi2 == hi1)
|
||||
|
||||
def test_not_equal_dict(self):
|
||||
hi1 = identifier.HeatIdentifier('t', 's', 'i', 'p')
|
||||
hi2 = identifier.HeatIdentifier('t', 's', 'i', 'q')
|
||||
self.assertFalse(hi1 == dict(hi2))
|
||||
self.assertFalse(dict(hi1) == hi2)
|
||||
self.assertFalse(hi1 == {'tenant': 't',
|
||||
'stack_name': 's',
|
||||
'stack_id': 'i'})
|
||||
self.assertFalse({'tenant': 't',
|
||||
'stack_name': 's',
|
||||
'stack_id': 'i'} == hi1)
|
||||
|
||||
|
||||
# allows testing of the test directly, shown below
|
||||
if __name__ == '__main__':
|
||||
sys.argv.append(__file__)
|
||||
nose.main()
|
||||
@ -356,6 +356,16 @@ class StackTest(unittest.TestCase):
|
||||
self.assertRaises(exception.NotFound, parser.Stack.load,
|
||||
None, -1)
|
||||
|
||||
def test_identifier(self):
|
||||
stack = parser.Stack(self.ctx, 'identifier_test',
|
||||
parser.Template({}))
|
||||
stack.store()
|
||||
identifier = stack.identifier()
|
||||
self.assertEqual(identifier.tenant, self.ctx.tenant)
|
||||
self.assertEqual(identifier.stack_name, 'identifier_test')
|
||||
self.assertTrue(identifier.stack_id)
|
||||
self.assertFalse(identifier.path)
|
||||
|
||||
def test_created_time(self):
|
||||
stack = parser.Stack(self.ctx, 'creation_time_test',
|
||||
parser.Template({}))
|
||||
|
||||
Loading…
Reference in New Issue
Block a user