From 539862c03b1a8c0b6a4d7c0e5efb19ba3d6504a5 Mon Sep 17 00:00:00 2001 From: susaant Date: Fri, 24 Oct 2014 19:31:27 -0700 Subject: [PATCH] Implementation of GBP ServiceChain resources This patch implements: ServiceChain Node ServiceChain Spec Implements: blueprint group-based-policy-automation Change-Id: I4ac1e924a492949b54e76f8f99e0dc951a0e82ef --- .../engine/resources/neutron/servicechain.py | 166 +++++++++++ gbpautomation/heat/tests/test_servicechain.py | 278 ++++++++++++++++++ 2 files changed, 444 insertions(+) create mode 100644 gbpautomation/heat/engine/resources/neutron/servicechain.py create mode 100644 gbpautomation/heat/tests/test_servicechain.py diff --git a/gbpautomation/heat/engine/resources/neutron/servicechain.py b/gbpautomation/heat/engine/resources/neutron/servicechain.py new file mode 100644 index 0000000..c402088 --- /dev/null +++ b/gbpautomation/heat/engine/resources/neutron/servicechain.py @@ -0,0 +1,166 @@ +# 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. + +from gbpautomation.heat.engine.resources.neutron import gbpresource +from neutronclient.common.exceptions import NeutronClientException + +from heat.engine import properties + + +class ServiceChainNode(gbpresource.GBPResource): + + PROPERTIES = ( + TENANT_ID, NAME, DESCRIPTION, SERVICE_TYPE, CONFIG + ) = ( + 'tenant_id', 'name', 'description', 'service_type', 'config' + ) + + properties_schema = { + TENANT_ID: properties.Schema( + properties.Schema.STRING, + _('Tenant id of the service chain node.') + ), + NAME: properties.Schema( + properties.Schema.STRING, + _('Name of the service chain node.'), + update_allowed=True + ), + DESCRIPTION: properties.Schema( + properties.Schema.STRING, + _('Description of the service chain node.'), + update_allowed=True + ), + SERVICE_TYPE: properties.Schema( + properties.Schema.STRING, + _('Type of service in the service chain node.'), + required=True, + update_allowed=True + ), + CONFIG: properties.Schema( + properties.Schema.STRING, + _('Configuration of the service chain node.'), + required=True, + update_allowed=False + ) + } + + def _show_resource(self): + client = self.grouppolicy() + sc_node_id = self.resource_id + return client.show_servicechain_node(sc_node_id)['servicechain_node'] + + def handle_create(self): + client = self.grouppolicy() + + props = {} + for key in self.properties: + if self.properties.get(key) is not None: + props[key] = self.properties.get(key) + + sc_node = client.create_servicechain_node( + {'servicechain_node': props})['servicechain_node'] + + self.resource_id_set(sc_node['id']) + + def handle_delete(self): + + client = self.grouppolicy() + sc_node_id = self.resource_id + + try: + client.delete_servicechain_node(sc_node_id) + except NeutronClientException as ex: + self.client_plugin().ignore_not_found(ex) + else: + return self._delete_task() + + def handle_update(self, json_snippet, tmpl_diff, prop_diff): + if prop_diff: + self.grouppolicy().update_servicechain_node( + self.resource_id, {'servicechain_node': prop_diff}) + + +class ServiceChainSpec(gbpresource.GBPResource): + + PROPERTIES = ( + TENANT_ID, NAME, DESCRIPTION, NODES + ) = ( + 'tenant_id', 'name', 'description', 'nodes' + ) + + properties_schema = { + TENANT_ID: properties.Schema( + properties.Schema.STRING, + _('Tenant id of the service chain spec.') + ), + NAME: properties.Schema( + properties.Schema.STRING, + _('Name of the service chain spec.'), + update_allowed=True + ), + DESCRIPTION: properties.Schema( + properties.Schema.STRING, + _('Description of the service chain spec.'), + update_allowed=True + ), + NODES: properties.Schema( + properties.Schema.LIST, + _('Nodes in the service chain spec.'), + required=True, + update_allowed=True + ) + } + + def _show_resource(self): + client = self.grouppolicy() + sc_spec_id = self.resource_id + return client.show_servicechain_spec(sc_spec_id)['servicechain_spec'] + + def handle_create(self): + client = self.grouppolicy() + + props = {} + for key in self.properties: + if self.properties.get(key) is not None: + props[key] = self.properties.get(key) + + sc_spec = client.create_servicechain_spec( + {'servicechain_spec': props})['servicechain_spec'] + + self.resource_id_set(sc_spec['id']) + + def handle_delete(self): + + client = self.grouppolicy() + sc_spec_id = self.resource_id + + try: + client.delete_servicechain_spec(sc_spec_id) + except NeutronClientException as ex: + self.client_plugin().ignore_not_found(ex) + else: + return self._delete_task() + + def handle_update(self, json_snippet, tmpl_diff, prop_diff): + if prop_diff: + self.grouppolicy().update_servicechain_spec( + self.resource_id, {'servicechain_spec': prop_diff}) + + +def resource_mapping(): + return { + 'OS::Neutron::ServiceChainNode': ServiceChainNode, + 'OS::Neutron::ServiceChainSpec': ServiceChainSpec, + } diff --git a/gbpautomation/heat/tests/test_servicechain.py b/gbpautomation/heat/tests/test_servicechain.py new file mode 100644 index 0000000..ece8cf2 --- /dev/null +++ b/gbpautomation/heat/tests/test_servicechain.py @@ -0,0 +1,278 @@ +# 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 copy + +from gbpautomation.heat.engine.resources.neutron import servicechain +from gbpclient.v2_0 import client as gbpclient +from heat.common import exception +from heat.common import template_format +from heat.tests.common import HeatTestCase + +from heat.engine import scheduler +from heat.tests import utils + + +servicechain_node_template = ''' +{ + "AWSTemplateFormatVersion" : "2010-09-09", + "Description" : "Template to test neutron service chain node", + "Parameters" : {}, + "Resources" : { + "servicechain_node": { + "Type": "OS::Neutron::ServiceChainNode", + "Properties": { + "name": "test-sc-node", + "description": "test service chain node resource", + "service_type": "TAP", + "config": "{'name': 'sc_node_config'}" + } + } + } +} +''' + +servicechain_spec_template = ''' +{ + "AWSTemplateFormatVersion" : "2010-09-09", + "Description" : "Template to test neutron service chain spec", + "Parameters" : {}, + "Resources" : { + "servicechain_spec": { + "Type": "OS::Neutron::ServiceChainSpec", + "Properties": { + "name": "test-sc-spec", + "description": "test service chain spec resource", + "nodes": ["1234", "7890"] + } + } + } +} +''' + + +class ServiceChainNodeTest(HeatTestCase): + + def setUp(self): + super(ServiceChainNodeTest, self).setUp() + self.m.StubOutWithMock(gbpclient.Client, 'create_servicechain_node') + self.m.StubOutWithMock(gbpclient.Client, 'delete_servicechain_node') + self.m.StubOutWithMock(gbpclient.Client, 'show_servicechain_node') + self.m.StubOutWithMock(gbpclient.Client, 'update_servicechain_node') + self.stub_keystoneclient() + + def create_servicechain_node(self): + gbpclient.Client.create_servicechain_node({ + 'servicechain_node': { + "name": "test-sc-node", + "description": "test service chain node resource", + "service_type": "TAP", + "config": "{'name': 'sc_node_config'}" + } + }).AndReturn({'servicechain_node': {'id': '5678'}}) + + snippet = template_format.parse(servicechain_node_template) + stack = utils.parse_stack(snippet) + resource_defns = stack.t.resource_definitions(stack) + return servicechain.ServiceChainNode( + 'servicechain_node', resource_defns['servicechain_node'], stack) + + def test_create(self): + rsrc = self.create_servicechain_node() + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + self.assertEqual((rsrc.CREATE, rsrc.COMPLETE), rsrc.state) + self.m.VerifyAll() + + def test_create_failed(self): + gbpclient.Client.create_servicechain_node({ + 'servicechain_node': { + "name": "test-sc-node", + "description": "test service chain node resource", + "service_type": "TAP", + "config": "{'name': 'sc_node_config'}" + } + }).AndRaise(servicechain.NeutronClientException()) + self.m.ReplayAll() + + snippet = template_format.parse(servicechain_node_template) + stack = utils.parse_stack(snippet) + resource_defns = stack.t.resource_definitions(stack) + rsrc = servicechain.ServiceChainNode( + 'servicechain_node', resource_defns['servicechain_node'], stack) + + error = self.assertRaises(exception.ResourceFailure, + scheduler.TaskRunner(rsrc.create)) + self.assertEqual( + 'NeutronClientException: An unknown exception occurred.', + str(error)) + self.assertEqual((rsrc.CREATE, rsrc.FAILED), rsrc.state) + self.m.VerifyAll() + + def test_delete(self): + gbpclient.Client.delete_servicechain_node('5678') + gbpclient.Client.show_servicechain_node('5678').AndRaise( + servicechain.NeutronClientException(status_code=404)) + + rsrc = self.create_servicechain_node() + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + scheduler.TaskRunner(rsrc.delete)() + self.assertEqual((rsrc.DELETE, rsrc.COMPLETE), rsrc.state) + self.m.VerifyAll() + + def test_delete_already_gone(self): + gbpclient.Client.delete_servicechain_node('5678').AndRaise( + servicechain.NeutronClientException(status_code=404)) + + rsrc = self.create_servicechain_node() + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + scheduler.TaskRunner(rsrc.delete)() + self.assertEqual((rsrc.DELETE, rsrc.COMPLETE), rsrc.state) + self.m.VerifyAll() + + def test_delete_failed(self): + gbpclient.Client.delete_servicechain_node('5678').AndRaise( + servicechain.NeutronClientException(status_code=400)) + + rsrc = self.create_servicechain_node() + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + error = self.assertRaises(exception.ResourceFailure, + scheduler.TaskRunner(rsrc.delete)) + self.assertEqual( + 'NeutronClientException: An unknown exception occurred.', + str(error)) + self.assertEqual((rsrc.DELETE, rsrc.FAILED), rsrc.state) + self.m.VerifyAll() + + def test_update(self): + rsrc = self.create_servicechain_node() + gbpclient.Client.update_servicechain_node( + '5678', {'servicechain_node': {'name': 'node_update'}}) + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + + update_template = copy.deepcopy(rsrc.t) + update_template['Properties']['name'] = 'node_update' + scheduler.TaskRunner(rsrc.update, update_template)() + + self.m.VerifyAll() + + +class ServiceChainSpecTest(HeatTestCase): + + def setUp(self): + super(ServiceChainSpecTest, self).setUp() + self.m.StubOutWithMock(gbpclient.Client, 'create_servicechain_spec') + self.m.StubOutWithMock(gbpclient.Client, 'delete_servicechain_spec') + self.m.StubOutWithMock(gbpclient.Client, 'show_servicechain_spec') + self.m.StubOutWithMock(gbpclient.Client, 'update_servicechain_spec') + self.stub_keystoneclient() + + def create_servicechain_spec(self): + gbpclient.Client.create_servicechain_spec({ + "servicechain_spec": { + "name": "test-sc-spec", + "description": "test service chain spec resource", + "nodes": ["1234", "7890"] + } + }).AndReturn({'servicechain_spec': {'id': '5678'}}) + + snippet = template_format.parse(servicechain_spec_template) + stack = utils.parse_stack(snippet) + resource_defns = stack.t.resource_definitions(stack) + return servicechain.ServiceChainSpec( + 'servicechain_spec', resource_defns['servicechain_spec'], stack) + + def test_create(self): + rsrc = self.create_servicechain_spec() + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + self.assertEqual((rsrc.CREATE, rsrc.COMPLETE), rsrc.state) + self.m.VerifyAll() + + def test_create_failed(self): + gbpclient.Client.create_servicechain_spec({ + 'servicechain_spec': { + "name": "test-sc-spec", + "description": "test service chain spec resource", + "nodes": ["1234", "7890"] + } + }).AndRaise(servicechain.NeutronClientException()) + self.m.ReplayAll() + + snippet = template_format.parse(servicechain_spec_template) + stack = utils.parse_stack(snippet) + resource_defns = stack.t.resource_definitions(stack) + rsrc = servicechain.ServiceChainSpec( + 'servicechain_spec', resource_defns['servicechain_spec'], stack) + + error = self.assertRaises(exception.ResourceFailure, + scheduler.TaskRunner(rsrc.create)) + self.assertEqual( + 'NeutronClientException: An unknown exception occurred.', + str(error)) + self.assertEqual((rsrc.CREATE, rsrc.FAILED), rsrc.state) + self.m.VerifyAll() + + def test_delete(self): + gbpclient.Client.delete_servicechain_spec('5678') + gbpclient.Client.show_servicechain_spec('5678').AndRaise( + servicechain.NeutronClientException(status_code=404)) + + rsrc = self.create_servicechain_spec() + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + scheduler.TaskRunner(rsrc.delete)() + self.assertEqual((rsrc.DELETE, rsrc.COMPLETE), rsrc.state) + self.m.VerifyAll() + + def test_delete_already_gone(self): + gbpclient.Client.delete_servicechain_spec('5678').AndRaise( + servicechain.NeutronClientException(status_code=404)) + + rsrc = self.create_servicechain_spec() + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + scheduler.TaskRunner(rsrc.delete)() + self.assertEqual((rsrc.DELETE, rsrc.COMPLETE), rsrc.state) + self.m.VerifyAll() + + def test_delete_failed(self): + gbpclient.Client.delete_servicechain_spec('5678').AndRaise( + servicechain.NeutronClientException(status_code=400)) + + rsrc = self.create_servicechain_spec() + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + error = self.assertRaises(exception.ResourceFailure, + scheduler.TaskRunner(rsrc.delete)) + self.assertEqual( + 'NeutronClientException: An unknown exception occurred.', + str(error)) + self.assertEqual((rsrc.DELETE, rsrc.FAILED), rsrc.state) + self.m.VerifyAll() + + def test_update(self): + rsrc = self.create_servicechain_spec() + gbpclient.Client.update_servicechain_spec( + '5678', {'servicechain_spec': {'name': 'spec_update'}}) + self.m.ReplayAll() + scheduler.TaskRunner(rsrc.create)() + + update_template = copy.deepcopy(rsrc.t) + update_template['Properties']['name'] = 'spec_update' + scheduler.TaskRunner(rsrc.update, update_template)() + + self.m.VerifyAll()