openstack
/
heat
Code Issues Proposed changes

Add 'enabled' property for keystone endpoint 

Allow user to determine whether the keystone endpoint
appears in catalog.

Change-Id: I2056555db2ae715ca8ff1d3d4c6846adef375a73
Closes-Bug: #1505165
This commit is contained in:
huangtianhua 2015-10-15 10:36:06 +08:00
parent c435ebf816
commit 72a4d244ad
2 changed files with 105 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
heat/engine/resources/openstack/keystone/endpoint.py
View File

@ -30,9 +30,9 @@ class KeystoneEndpoint(resource.Resource):
entity = 'endpoints' entity = 'endpoints'
PROPERTIES = ( PROPERTIES = (
NAME, REGION, SERVICE, INTERFACE, SERVICE_URL NAME, REGION, SERVICE, INTERFACE, SERVICE_URL, ENABLED,
) = ( ) = (
'name', 'region', 'service', 'interface', 'url' 'name', 'region', 'service', 'interface', 'url', 'enabled',
) )
properties_schema = { properties_schema = {
@ -67,6 +67,13 @@ class KeystoneEndpoint(resource.Resource):
_('URL of keystone service endpoint.'), _('URL of keystone service endpoint.'),
update_allowed=True, update_allowed=True,
required=True required=True
),
ENABLED: properties.Schema(
properties.Schema.BOOLEAN,
_('This endpoint is enabled or disabled.'),
default=True,
update_allowed=True,
support_status=support.SupportStatus(version='6.0.0')
) )
} }
@ -80,13 +87,15 @@ class KeystoneEndpoint(resource.Resource):
url = self.properties[self.SERVICE_URL] url = self.properties[self.SERVICE_URL]
name = (self.properties[self.NAME] or name = (self.properties[self.NAME] or
self.physical_resource_name()) self.physical_resource_name())
enabled = self.properties[self.ENABLED]
endpoint = self.client().endpoints.create( endpoint = self.client().endpoints.create(
region=region, region=region,
service=service, service=service,
interface=interface, interface=interface,
url=url, url=url,
name=name) name=name,
enabled=enabled)
self.resource_id_set(endpoint.id) self.resource_id_set(endpoint.id)
@ -97,6 +106,7 @@ class KeystoneEndpoint(resource.Resource):
interface = prop_diff.get(self.INTERFACE) interface = prop_diff.get(self.INTERFACE)
url = prop_diff.get(self.SERVICE_URL) url = prop_diff.get(self.SERVICE_URL)
name = prop_diff.get(self.NAME) or self.physical_resource_name() name = prop_diff.get(self.NAME) or self.physical_resource_name()
enabled = prop_diff.get(self.ENABLED)
self.client().endpoints.update( self.client().endpoints.update(
endpoint=self.resource_id, endpoint=self.resource_id,
@ -104,7 +114,8 @@ class KeystoneEndpoint(resource.Resource):
service=service, service=service,
interface=interface, interface=interface,
url=url, url=url,
name=name) name=name,
enabled=enabled)
def resource_mapping(): def resource_mapping():

139
heat/tests/openstack/keystone/test_endpoint.py
View File

@ -31,7 +31,8 @@ keystone_endpoint_template = {
'region': 'RegionOne', 'region': 'RegionOne',
'interface': 'public', 'interface': 'public',
'url': 'http://127.0.0.1:8004/v1/tenant-id', 'url': 'http://127.0.0.1:8004/v1/tenant-id',
'name': 'endpoint_foo' 'name': 'endpoint_foo',
'enabled': False
} }
} }
} }
@ -46,23 +47,12 @@ class KeystoneEndpointTest(common.HeatTestCase):
self.ctx = utils.dummy_context() self.ctx = utils.dummy_context()
self.stack = stack.Stack(
self.ctx, 'test_stack_keystone',
template.Template(keystone_endpoint_template)
)
self.test_endpoint = self.stack['test_endpoint']
# Mock client # Mock client
self.keystoneclient = mock.MagicMock() self.keystoneclient = mock.MagicMock()
self.test_endpoint.client = mock.MagicMock()
self.test_endpoint.client.return_value = self.keystoneclient
self.endpoints = self.keystoneclient.endpoints self.endpoints = self.keystoneclient.endpoints
# Mock client plugin # Mock client plugin
keystone_client_plugin = mock.MagicMock() self.keystone_client_plugin = mock.MagicMock()
self.test_endpoint.client_plugin = mock.MagicMock()
self.test_endpoint.client_plugin.return_value = keystone_client_plugin
def _get_mock_endpoint(self): def _get_mock_endpoint(self):
value = mock.MagicMock() value = mock.MagicMock()
@ -70,33 +60,48 @@ class KeystoneEndpointTest(common.HeatTestCase):
return value return value
def _setup_endpoint_resource(self, stack_name, use_default=False):
test_stack = stack.Stack(
self.ctx, stack_name,
template.Template(keystone_endpoint_template)
)
r_endpoint = test_stack['test_endpoint']
r_endpoint.client = mock.MagicMock()
r_endpoint.client.return_value = self.keystoneclient
r_endpoint.client_plugin = mock.MagicMock()
r_endpoint.client_plugin.return_value = self.keystone_client_plugin
if use_default:
del r_endpoint.t['Properties']['name']
del r_endpoint.t['Properties']['enabled']
return r_endpoint
def test_endpoint_handle_create(self): def test_endpoint_handle_create(self):
rsrc = self._setup_endpoint_resource('test_endpoint_create')
mock_endpoint = self._get_mock_endpoint() mock_endpoint = self._get_mock_endpoint()
self.endpoints.create.return_value = mock_endpoint self.endpoints.create.return_value = mock_endpoint
# validate the properties # validate the properties
self.assertEqual( self.assertEqual(
'heat', 'heat', rsrc.properties.get(endpoint.KeystoneEndpoint.SERVICE))
self.test_endpoint.properties.get(
endpoint.KeystoneEndpoint.SERVICE))
self.assertEqual( self.assertEqual(
'public', 'public',
self.test_endpoint.properties.get( rsrc.properties.get(endpoint.KeystoneEndpoint.INTERFACE))
endpoint.KeystoneEndpoint.INTERFACE))
self.assertEqual( self.assertEqual(
'RegionOne', 'RegionOne',
self.test_endpoint.properties.get( rsrc.properties.get(endpoint.KeystoneEndpoint.REGION))
endpoint.KeystoneEndpoint.REGION))
self.assertEqual( self.assertEqual(
'http://127.0.0.1:8004/v1/tenant-id', 'http://127.0.0.1:8004/v1/tenant-id',
self.test_endpoint.properties.get( rsrc.properties.get(endpoint.KeystoneEndpoint.SERVICE_URL))
endpoint.KeystoneEndpoint.SERVICE_URL))
self.assertEqual( self.assertEqual(
'endpoint_foo', 'endpoint_foo',
self.test_endpoint.properties.get( rsrc.properties.get(endpoint.KeystoneEndpoint.NAME))
endpoint.KeystoneEndpoint.NAME)) self.assertFalse(rsrc.properties.get(
endpoint.KeystoneEndpoint.ENABLED))
self.test_endpoint.handle_create() rsrc.handle_create()
# validate endpoint creation # validate endpoint creation
self.endpoints.create.assert_called_once_with( self.endpoints.create.assert_called_once_with(
@ -104,13 +109,42 @@ class KeystoneEndpointTest(common.HeatTestCase):
url='http://127.0.0.1:8004/v1/tenant-id', url='http://127.0.0.1:8004/v1/tenant-id',
interface='public', interface='public',
region='RegionOne', region='RegionOne',
name='endpoint_foo') name='endpoint_foo',
enabled=False)
# validate physical resource id # validate physical resource id
self.assertEqual(mock_endpoint.id, self.test_endpoint.resource_id) self.assertEqual(mock_endpoint.id, rsrc.resource_id)
def test_endpoint_handle_create_default(self):
rsrc = self._setup_endpoint_resource('test_create_with_defaults',
use_default=True)
mock_endpoint = self._get_mock_endpoint()
self.endpoints.create.return_value = mock_endpoint
rsrc.physical_resource_name = mock.MagicMock()
rsrc.physical_resource_name.return_value = 'stack_endpoint_foo'
# validate the properties
self.assertIsNone(
rsrc.properties.get(endpoint.KeystoneEndpoint.NAME))
self.assertTrue(rsrc.properties.get(
endpoint.KeystoneEndpoint.ENABLED))
rsrc.handle_create()
# validate endpoints creation with physical resource name
# and with enabled(default is True)
self.endpoints.create.assert_called_once_with(
service='heat',
url='http://127.0.0.1:8004/v1/tenant-id',
interface='public',
region='RegionOne',
name='stack_endpoint_foo',
enabled=True)
def test_endpoint_handle_update(self): def test_endpoint_handle_update(self):
self.test_endpoint.resource_id = '477e8273-60a7-4c41-b683-fdb0bc7cd151' rsrc = self._setup_endpoint_resource('test_endpoint_update')
rsrc.resource_id = '477e8273-60a7-4c41-b683-fdb0bc7cd151'
prop_diff = {endpoint.KeystoneEndpoint.REGION: 'RegionTwo', prop_diff = {endpoint.KeystoneEndpoint.REGION: 'RegionTwo',
endpoint.KeystoneEndpoint.INTERFACE: 'internal', endpoint.KeystoneEndpoint.INTERFACE: 'internal',
@ -118,48 +152,53 @@ class KeystoneEndpointTest(common.HeatTestCase):
endpoint.KeystoneEndpoint.SERVICE_URL: endpoint.KeystoneEndpoint.SERVICE_URL:
'http://127.0.0.1:8004/v2/tenant-id', 'http://127.0.0.1:8004/v2/tenant-id',
endpoint.KeystoneEndpoint.NAME: endpoint.KeystoneEndpoint.NAME:
'endpoint_foo_updated'} 'endpoint_foo_updated',
endpoint.KeystoneEndpoint.ENABLED: True}
self.test_endpoint.handle_update(json_snippet=None, rsrc.handle_update(json_snippet=None,
tmpl_diff=None, tmpl_diff=None,
prop_diff=prop_diff) prop_diff=prop_diff)
self.endpoints.update.assert_called_once_with( self.endpoints.update.assert_called_once_with(
endpoint=self.test_endpoint.resource_id, endpoint=rsrc.resource_id,
region=prop_diff[endpoint.KeystoneEndpoint.REGION], region=prop_diff[endpoint.KeystoneEndpoint.REGION],
interface=prop_diff[endpoint.KeystoneEndpoint.INTERFACE], interface=prop_diff[endpoint.KeystoneEndpoint.INTERFACE],
service=prop_diff[endpoint.KeystoneEndpoint.SERVICE], service=prop_diff[endpoint.KeystoneEndpoint.SERVICE],
url=prop_diff[endpoint.KeystoneEndpoint.SERVICE_URL], url=prop_diff[endpoint.KeystoneEndpoint.SERVICE_URL],
name=prop_diff[endpoint.KeystoneEndpoint.NAME] name=prop_diff[endpoint.KeystoneEndpoint.NAME],
enabled=prop_diff[endpoint.KeystoneEndpoint.ENABLED]
) )
def test_endpoint_handle_update_default(self): def test_endpoint_handle_update_default(self):
self.test_endpoint.resource_id = '477e8273-60a7-4c41-b683-fdb0bc7cd151' rsrc = self._setup_endpoint_resource('test_endpoint_update_default')
self.test_endpoint.physical_resource_name = mock.MagicMock() rsrc.resource_id = '477e8273-60a7-4c41-b683-fdb0bc7cd151'
self.test_endpoint.physical_resource_name.return_value = 'foo' rsrc.physical_resource_name = mock.MagicMock()
rsrc.physical_resource_name.return_value = 'stack_endpoint_foo'
# Name is reset to None, so default to physical resource name # Name is reset to None, so default to physical resource name
prop_diff = {endpoint.KeystoneEndpoint.NAME: None} prop_diff = {endpoint.KeystoneEndpoint.NAME: None}
self.test_endpoint.handle_update(json_snippet=None, rsrc.handle_update(json_snippet=None,
tmpl_diff=None, tmpl_diff=None,
prop_diff=prop_diff) prop_diff=prop_diff)
# validate default name to physical resource name # validate default name to physical resource name
self.endpoints.update.assert_called_once_with( self.endpoints.update.assert_called_once_with(
endpoint=self.test_endpoint.resource_id, endpoint=rsrc.resource_id,
region=None, region=None,
interface=None, interface=None,
service=None, service=None,
url=None, url=None,
name='foo' name='stack_endpoint_foo',
enabled=None
) )
def test_resource_mapping(self): def test_resource_mapping(self):
rsrc = self._setup_endpoint_resource('test_resource_mapping')
mapping = endpoint.resource_mapping() mapping = endpoint.resource_mapping()
self.assertEqual(1, len(mapping)) self.assertEqual(1, len(mapping))
self.assertEqual(endpoint.KeystoneEndpoint, mapping[RESOURCE_TYPE]) self.assertEqual(endpoint.KeystoneEndpoint, mapping[RESOURCE_TYPE])
self.assertIsInstance(self.test_endpoint, endpoint.KeystoneEndpoint) self.assertIsInstance(rsrc, endpoint.KeystoneEndpoint)
def test_properties_title(self): def test_properties_title(self):
property_title_map = { property_title_map = {
@ -167,7 +206,8 @@ class KeystoneEndpointTest(common.HeatTestCase):
endpoint.KeystoneEndpoint.REGION: 'region', endpoint.KeystoneEndpoint.REGION: 'region',
endpoint.KeystoneEndpoint.INTERFACE: 'interface', endpoint.KeystoneEndpoint.INTERFACE: 'interface',
endpoint.KeystoneEndpoint.SERVICE_URL: 'url', endpoint.KeystoneEndpoint.SERVICE_URL: 'url',
endpoint.KeystoneEndpoint.NAME: 'name' endpoint.KeystoneEndpoint.NAME: 'name',
endpoint.KeystoneEndpoint.ENABLED: 'enabled'
} }
for actual_title, expected_title in property_title_map.items(): for actual_title, expected_title in property_title_map.items():
@ -299,8 +339,9 @@ class KeystoneEndpointTest(common.HeatTestCase):
endpoint.KeystoneEndpoint.NAME) endpoint.KeystoneEndpoint.NAME)
def test_show_resource(self): def test_show_resource(self):
endpoint = mock.Mock() rsrc = self._setup_endpoint_resource('test_show_resource')
endpoint.to_dict.return_value = {'attr': 'val'} mock_endpoint = mock.Mock()
self.endpoints.get.return_value = endpoint mock_endpoint.to_dict.return_value = {'attr': 'val'}
res = self.test_endpoint._show_resource() self.endpoints.get.return_value = mock_endpoint
self.assertEqual({'attr': 'val'}, res) attrs = rsrc._show_resource()
self.assertEqual({'attr': 'val'}, attrs)