diff --git a/heat/engine/resources/openstack/octavia/pool.py b/heat/engine/resources/openstack/octavia/pool.py new file mode 100644 index 0000000000..c459e68152 --- /dev/null +++ b/heat/engine/resources/openstack/octavia/pool.py @@ -0,0 +1,222 @@ +# +# 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. + +from heat.common import exception +from heat.common.i18n import _ +from heat.engine import attributes +from heat.engine import constraints +from heat.engine import properties +from heat.engine.resources.openstack.octavia import octavia_base +from heat.engine import translation + + +class Pool(octavia_base.OctaviaBase): + """A resource for managing Octavia Pools. + + This resources manages octavia LBaaS v2 Pools, which represent a group + of nodes. Pools define the subnet where nodes reside, balancing algorithm, + and the nodes themselves. + """ + + PROPERTIES = ( + ADMIN_STATE_UP, DESCRIPTION, SESSION_PERSISTENCE, NAME, + LB_ALGORITHM, LISTENER, LOADBALANCER, PROTOCOL, + SESSION_PERSISTENCE_TYPE, SESSION_PERSISTENCE_COOKIE_NAME, + ) = ( + 'admin_state_up', 'description', 'session_persistence', 'name', + 'lb_algorithm', 'listener', 'loadbalancer', 'protocol', + 'type', 'cookie_name' + ) + + SESSION_PERSISTENCE_TYPES = ( + SOURCE_IP, HTTP_COOKIE, APP_COOKIE + ) = ( + 'SOURCE_IP', 'HTTP_COOKIE', 'APP_COOKIE' + ) + + SUPPORTED_PROTOCOLS = (TCP, HTTP, HTTPS, TERMINATED_HTTPS, PROXY) = ( + 'TCP', 'HTTP', 'HTTPS', 'TERMINATED_HTTPS', 'PROXY') + + ATTRIBUTES = ( + HEALTHMONITOR_ID_ATTR, LISTENERS_ATTR, MEMBERS_ATTR + ) = ( + 'healthmonitor_id', 'listeners', 'members' + ) + + properties_schema = { + ADMIN_STATE_UP: properties.Schema( + properties.Schema.BOOLEAN, + _('The administrative state of this pool.'), + default=True, + update_allowed=True + ), + DESCRIPTION: properties.Schema( + properties.Schema.STRING, + _('Description of this pool.'), + update_allowed=True, + default='' + ), + SESSION_PERSISTENCE: properties.Schema( + properties.Schema.MAP, + _('Configuration of session persistence.'), + schema={ + SESSION_PERSISTENCE_TYPE: properties.Schema( + properties.Schema.STRING, + _('Method of implementation of session ' + 'persistence feature.'), + required=True, + constraints=[constraints.AllowedValues( + SESSION_PERSISTENCE_TYPES + )] + ), + SESSION_PERSISTENCE_COOKIE_NAME: properties.Schema( + properties.Schema.STRING, + _('Name of the cookie, ' + 'required if type is APP_COOKIE.') + ) + }, + ), + NAME: properties.Schema( + properties.Schema.STRING, + _('Name of this pool.'), + update_allowed=True + ), + LB_ALGORITHM: properties.Schema( + properties.Schema.STRING, + _('The algorithm used to distribute load between the members of ' + 'the pool.'), + required=True, + constraints=[ + constraints.AllowedValues(['ROUND_ROBIN', + 'LEAST_CONNECTIONS', 'SOURCE_IP']), + ], + update_allowed=True, + ), + LISTENER: properties.Schema( + properties.Schema.STRING, + _('Listener name or ID to be associated with this pool.'), + constraints=[ + constraints.CustomConstraint('octavia.listener') + ] + ), + LOADBALANCER: properties.Schema( + properties.Schema.STRING, + _('Loadbalancer name or ID to be associated with this pool. ' + 'Requires shared_pools service extension.'), + constraints=[ + constraints.CustomConstraint('octavia.loadbalancer') + ], + ), + PROTOCOL: properties.Schema( + properties.Schema.STRING, + _('Protocol of the pool.'), + required=True, + constraints=[ + constraints.AllowedValues(SUPPORTED_PROTOCOLS), + ] + ), + } + + attributes_schema = { + HEALTHMONITOR_ID_ATTR: attributes.Schema( + _('ID of the health monitor associated with this pool.'), + type=attributes.Schema.STRING + ), + LISTENERS_ATTR: attributes.Schema( + _('Listener associated with this pool.'), + type=attributes.Schema.STRING + ), + MEMBERS_ATTR: attributes.Schema( + _('Members associated with this pool.'), + cache_mode=attributes.Schema.CACHE_NONE, + type=attributes.Schema.LIST + ), + } + + def translation_rules(self, props): + return [ + translation.TranslationRule( + props, + translation.TranslationRule.RESOLVE, + [self.LISTENER], + client_plugin=self.client_plugin(), + finder='get_listener', + ), + translation.TranslationRule( + props, + translation.TranslationRule.RESOLVE, + [self.LOADBALANCER], + client_plugin=self.client_plugin(), + finder='get_loadbalancer', + ), + ] + + def _prepare_args(self, properties): + props = dict((k, v) for k, v in properties.items() if v is not None) + if self.NAME not in props: + props[self.NAME] = self.physical_resource_name() + if self.LISTENER in props: + props['listener_id'] = props.pop(self.LISTENER) + if self.LOADBALANCER in props: + props['loadbalancer_id'] = props.pop(self.LOADBALANCER) + session_p = props.get(self.SESSION_PERSISTENCE) + if session_p is not None: + session_props = dict( + (k, v) for k, v in session_p.items() if v is not None) + props[self.SESSION_PERSISTENCE] = session_props + return props + + def validate(self): + super(Pool, self).validate() + if (self.properties[self.LISTENER] is None and + self.properties[self.LOADBALANCER] is None): + raise exception.PropertyUnspecifiedError(self.LISTENER, + self.LOADBALANCER) + + if self.properties[self.SESSION_PERSISTENCE] is not None: + session_p = self.properties[self.SESSION_PERSISTENCE] + persistence_type = session_p[self.SESSION_PERSISTENCE_TYPE] + if persistence_type == self.APP_COOKIE: + if not session_p.get(self.SESSION_PERSISTENCE_COOKIE_NAME): + msg = (_('Property %(cookie)s is required when %(sp)s ' + 'type is set to %(app)s.') % + {'cookie': self.SESSION_PERSISTENCE_COOKIE_NAME, + 'sp': self.SESSION_PERSISTENCE, + 'app': self.APP_COOKIE}) + raise exception.StackValidationFailed(message=msg) + elif persistence_type == self.SOURCE_IP: + if session_p.get(self.SESSION_PERSISTENCE_COOKIE_NAME): + msg = (_('Property %(cookie)s must NOT be specified when ' + '%(sp)s type is set to %(ip)s.') % + {'cookie': self.SESSION_PERSISTENCE_COOKIE_NAME, + 'sp': self.SESSION_PERSISTENCE, + 'ip': self.SOURCE_IP}) + raise exception.StackValidationFailed(message=msg) + + def _resource_create(self, properties): + return self.client().pool_create(json={'pool': properties})['pool'] + + def _resource_update(self, prop_diff): + self.client().pool_set(self.resource_id, json={'pool': prop_diff}) + + def _resource_delete(self): + self.client().pool_delete(self.resource_id) + + def _show_resource(self): + return self.client().pool_show(self.resource_id) + + +def resource_mapping(): + return { + 'OS::Octavia::Pool': Pool, + } diff --git a/heat/tests/openstack/octavia/inline_templates.py b/heat/tests/openstack/octavia/inline_templates.py index 1990b2f480..60c068282d 100644 --- a/heat/tests/openstack/octavia/inline_templates.py +++ b/heat/tests/openstack/octavia/inline_templates.py @@ -11,6 +11,24 @@ # License for the specific language governing permissions and limitations # under the License. +POOL_TEMPLATE = ''' +heat_template_version: 2016-04-08 +description: Create a pool +resources: + pool: + type: OS::Octavia::Pool + properties: + name: my_pool + description: my pool + session_persistence: + type: HTTP_COOKIE + lb_algorithm: ROUND_ROBIN + loadbalancer: my_lb + listener: 123 + protocol: HTTP + admin_state_up: True +''' + MEMBER_TEMPLATE = ''' heat_template_version: 2016-04-08 description: Create a pool member diff --git a/heat/tests/openstack/octavia/test_pool.py b/heat/tests/openstack/octavia/test_pool.py new file mode 100644 index 0000000000..f4e74930f2 --- /dev/null +++ b/heat/tests/openstack/octavia/test_pool.py @@ -0,0 +1,200 @@ +# +# 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 mock +import yaml + +from osc_lib import exceptions + +from heat.common import exception +from heat.common.i18n import _ +from heat.common import template_format +from heat.engine.resources.openstack.octavia import pool +from heat.tests import common +from heat.tests.openstack.octavia import inline_templates +from heat.tests import utils + + +class PoolTest(common.HeatTestCase): + + def test_resource_mapping(self): + mapping = pool.resource_mapping() + self.assertEqual(pool.Pool, + mapping['OS::Octavia::Pool']) + + def _create_stack(self, tmpl=inline_templates.POOL_TEMPLATE): + self.t = template_format.parse(tmpl) + self.stack = utils.parse_stack(self.t) + self.pool = self.stack['pool'] + + self.octavia_client = mock.MagicMock() + self.pool.client = mock.MagicMock(return_value=self.octavia_client) + + self.pool.client_plugin().client = mock.MagicMock( + return_value=self.octavia_client) + + def test_validate_no_cookie_name(self): + tmpl = yaml.safe_load(inline_templates.POOL_TEMPLATE) + sp = tmpl['resources']['pool']['properties']['session_persistence'] + sp['type'] = 'APP_COOKIE' + self._create_stack(tmpl=yaml.safe_dump(tmpl)) + + msg = _('Property cookie_name is required when ' + 'session_persistence type is set to APP_COOKIE.') + self.assertRaisesRegex(exception.StackValidationFailed, + msg, self.pool.validate) + + def test_validate_source_ip_cookie_name(self): + tmpl = yaml.safe_load(inline_templates.POOL_TEMPLATE) + sp = tmpl['resources']['pool']['properties']['session_persistence'] + sp['type'] = 'SOURCE_IP' + sp['cookie_name'] = 'cookie' + self._create_stack(tmpl=yaml.safe_dump(tmpl)) + + msg = _('Property cookie_name must NOT be specified when ' + 'session_persistence type is set to SOURCE_IP.') + self.assertRaisesRegex(exception.StackValidationFailed, + msg, self.pool.validate) + + def test_create(self): + self._create_stack() + self.octavia_client.pool_show.side_effect = [ + {'provisioning_status': 'PENDING_CREATE'}, + {'provisioning_status': 'PENDING_CREATE'}, + {'provisioning_status': 'ACTIVE'}, + ] + self.octavia_client.pool_create.side_effect = [ + exceptions.Conflict(409), {'pool': {'id': '1234'}} + ] + expected = { + 'pool': { + 'name': 'my_pool', + 'description': 'my pool', + 'session_persistence': { + 'type': 'HTTP_COOKIE' + }, + 'lb_algorithm': 'ROUND_ROBIN', + 'listener_id': '123', + 'loadbalancer_id': 'my_lb', + 'protocol': 'HTTP', + 'admin_state_up': True + } + } + + props = self.pool.handle_create() + + self.assertFalse(self.pool.check_create_complete(props)) + self.octavia_client.pool_create.assert_called_with(json=expected) + self.assertFalse(self.pool.check_create_complete(props)) + self.octavia_client.pool_create.assert_called_with(json=expected) + self.assertFalse(self.pool.check_create_complete(props)) + self.assertTrue(self.pool.check_create_complete(props)) + + def test_create_missing_properties(self): + for prop in ('lb_algorithm', 'listener', 'protocol'): + tmpl = yaml.safe_load(inline_templates.POOL_TEMPLATE) + del tmpl['resources']['pool']['properties']['loadbalancer'] + del tmpl['resources']['pool']['properties'][prop] + self._create_stack(tmpl=yaml.safe_dump(tmpl)) + if prop == 'listener': + self.assertRaises(exception.PropertyUnspecifiedError, + self.pool.validate) + else: + self.assertRaises(exception.StackValidationFailed, + self.pool.validate) + + def test_show_resource(self): + self._create_stack() + self.pool.resource_id_set('1234') + self.octavia_client.pool_show.return_value = {'id': '1234'} + + self.assertEqual(self.pool._show_resource(), {'id': '1234'}) + + self.octavia_client.pool_show.assert_called_with('1234') + + def test_update(self): + self._create_stack() + self.pool.resource_id_set('1234') + self.octavia_client.pool_show.side_effect = [ + {'provisioning_status': 'PENDING_UPDATE'}, + {'provisioning_status': 'PENDING_UPDATE'}, + {'provisioning_status': 'ACTIVE'}, + ] + self.octavia_client.pool_set.side_effect = [ + exceptions.Conflict(409), None] + prop_diff = { + 'admin_state_up': False, + 'name': 'your_pool', + 'lb_algorithm': 'SOURCE_IP' + } + + prop_diff = self.pool.handle_update(None, None, prop_diff) + + self.assertFalse(self.pool.check_update_complete(prop_diff)) + self.assertFalse(self.pool._update_called) + self.octavia_client.pool_set.assert_called_with( + '1234', json={'pool': prop_diff}) + self.assertFalse(self.pool.check_update_complete(prop_diff)) + self.assertTrue(self.pool._update_called) + self.octavia_client.pool_set.assert_called_with( + '1234', json={'pool': prop_diff}) + self.assertFalse(self.pool.check_update_complete(prop_diff)) + self.assertTrue(self.pool.check_update_complete(prop_diff)) + + def test_delete(self): + self._create_stack() + self.pool.resource_id_set('1234') + self.octavia_client.pool_show.side_effect = [ + {'provisioning_status': 'PENDING_DELETE'}, + {'provisioning_status': 'PENDING_DELETE'}, + {'provisioning_status': 'DELETED'}, + ] + self.octavia_client.pool_delete.side_effect = [ + exceptions.Conflict(409), + None] + + self.pool.handle_delete() + + self.assertFalse(self.pool.check_delete_complete(None)) + self.assertFalse(self.pool._delete_called) + self.assertFalse(self.pool.check_delete_complete(None)) + self.assertTrue(self.pool._delete_called) + self.octavia_client.pool_delete.assert_called_with('1234') + self.assertTrue(self.pool.check_delete_complete(None)) + + def test_delete_not_found(self): + self._create_stack() + self.pool.resource_id_set('1234') + self.octavia_client.pool_show.side_effect = [ + {'provisioning_status': 'PENDING_DELETE'}, + ] + self.octavia_client.pool_delete.side_effect = [ + exceptions.Conflict(409), + exceptions.NotFound(404)] + + self.pool.handle_delete() + + self.assertFalse(self.pool.check_delete_complete(None)) + self.assertFalse(self.pool._delete_called) + self.octavia_client.pool_delete.assert_called_with('1234') + self.assertTrue(self.pool.check_delete_complete(None)) + + def test_delete_failed(self): + self._create_stack() + self.pool.resource_id_set('1234') + self.octavia_client.pool_delete.side_effect = ( + exceptions.Unauthorized(401)) + + self.pool.handle_delete() + self.assertRaises(exceptions.Unauthorized, + self.pool.check_delete_complete, None)