From e19a8051b28efafccce97146ced9b8b0a82c6fae Mon Sep 17 00:00:00 2001 From: Vijendar Komalla Date: Mon, 10 Feb 2014 13:51:39 -0600 Subject: [PATCH] Delete rackspace database resource Rackspace database resource 'Rackspace::Cloud::DBInstance' is not required anymore and 'OS::Trove::Instance' should be used instead. Closes-Bug: #1261870 Change-Id: I875048995792aa9993febf1391039d3a82ec849d --- contrib/rackspace/resources/clouddatabase.py | 301 ------------------ contrib/rackspace/tests/test_clouddatabase.py | 199 ------------ 2 files changed, 500 deletions(-) delete mode 100644 contrib/rackspace/resources/clouddatabase.py delete mode 100644 contrib/rackspace/tests/test_clouddatabase.py diff --git a/contrib/rackspace/resources/clouddatabase.py b/contrib/rackspace/resources/clouddatabase.py deleted file mode 100644 index c9d7dcf67..000000000 --- a/contrib/rackspace/resources/clouddatabase.py +++ /dev/null @@ -1,301 +0,0 @@ -# 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. - -try: - from pyrax.exceptions import ClientException -except ImportError: - # define exception for testing without pyrax - class ClientException(Exception): - def __init__(self, code, message=None, details=None, request_id=None): - self.code = code - self.message = message or self.__class__.message - self.details = details - self.request_id = request_id - - def __str__(self): - formatted_string = "%s (HTTP %s)" % (self.message, self.code) - if self.request_id: - formatted_string += " (Request-ID: %s)" % self.request_id - - return formatted_string - - def resource_mapping(): - return {} -else: - - def resource_mapping(): - return {'Rackspace::Cloud::DBInstance': CloudDBInstance} - -from heat.common import exception -from heat.openstack.common import log as logging -from heat.engine import constraints -from heat.engine import properties -from heat.engine import resource - -logger = logging.getLogger(__name__) - - -class CloudDBInstance(resource.Resource): - ''' - Rackspace cloud database resource. - ''' - - PROPERTIES = ( - INSTANCE_NAME, FLAVOR_REF, VOLUME_SIZE, DATABASES, USERS, - ) = ( - 'InstanceName', 'FlavorRef', 'VolumeSize', 'Databases', 'Users', - ) - - _DATABASE_KEYS = ( - DATABASE_CHARACTER_SET, DATABASE_COLLATE, DATABASE_NAME, - ) = ( - 'Character_set', 'Collate', 'Name', - ) - - _USER_KEYS = ( - USER_NAME, USER_PASSWORD, USER_HOST, USER_DATABASES, - ) = ( - 'Name', 'Password', 'Host', 'Databases', - ) - - properties_schema = { - INSTANCE_NAME: properties.Schema( - properties.Schema.STRING, - required=True, - constraints=[ - constraints.Length(max=255), - ] - ), - FLAVOR_REF: properties.Schema( - properties.Schema.STRING, - required=True - ), - VOLUME_SIZE: properties.Schema( - properties.Schema.NUMBER, - required=True, - constraints=[ - constraints.Range(1, 150), - ] - ), - DATABASES: properties.Schema( - properties.Schema.LIST, - schema=properties.Schema( - properties.Schema.MAP, - schema={ - DATABASE_CHARACTER_SET: properties.Schema( - properties.Schema.STRING, - default='utf8' - ), - DATABASE_COLLATE: properties.Schema( - properties.Schema.STRING, - default='utf8_general_ci' - ), - DATABASE_NAME: properties.Schema( - properties.Schema.STRING, - required=True, - constraints=[ - constraints.Length(max=64), - constraints.AllowedPattern(r'[a-zA-Z0-9_]+' - r'[a-zA-Z0-9_@?#\s]*' - r'[a-zA-Z0-9_]+'), - ] - ), - }, - ) - ), - USERS: properties.Schema( - properties.Schema.LIST, - schema=properties.Schema( - properties.Schema.MAP, - schema={ - USER_NAME: properties.Schema( - properties.Schema.STRING, - required=True, - constraints=[ - constraints.Length(max=16), - constraints.AllowedPattern(r'[a-zA-Z0-9_]+' - r'[a-zA-Z0-9_@?#\s]*' - r'[a-zA-Z0-9_]+'), - ] - ), - USER_PASSWORD: properties.Schema( - properties.Schema.STRING, - required=True, - constraints=[ - constraints.AllowedPattern(r'[a-zA-Z0-9_]+' - r'[a-zA-Z0-9_@?#\s]*' - r'[a-zA-Z0-9_]+'), - ] - ), - USER_HOST: properties.Schema( - properties.Schema.STRING, - default='%' - ), - USER_DATABASES: properties.Schema( - properties.Schema.LIST, - required=True - ), - }, - ) - ), - } - - attributes_schema = { - "hostname": "Hostname of the instance", - "href": "Api endpoint reference of the instance" - } - - def __init__(self, name, json_snippet, stack): - super(CloudDBInstance, self).__init__(name, json_snippet, stack) - self.hostname = None - self.href = None - - def cloud_db(self): - return self.stack.clients.cloud_db() - - def handle_create(self): - ''' - Create Rackspace Cloud DB Instance. - ''' - logger.debug("Cloud DB instance handle_create called") - self.sqlinstancename = self.properties[self.INSTANCE_NAME] - self.flavor = self.properties[self.FLAVOR_REF] - self.volume = self.properties[self.VOLUME_SIZE] - self.databases = self.properties.get(self.DATABASES, None) - self.users = self.properties.get(self.USERS, None) - - # create db instance - logger.info("Creating Cloud DB instance %s" % self.sqlinstancename) - instance = self.cloud_db().create(self.sqlinstancename, - flavor=self.flavor, - volume=self.volume) - if instance is not None: - self.resource_id_set(instance.id) - - self.hostname = instance.hostname - self.href = instance.links[0]['href'] - return instance - - def check_create_complete(self, instance): - ''' - Check if cloud DB instance creation is complete. - ''' - instance.get() # get updated attributes - if instance.status == 'ERROR': - instance.delete() - raise exception.Error("Cloud DB instance creation failed.") - - if instance.status != 'ACTIVE': - return False - - logger.info("Cloud DB instance %s created (flavor:%s, volume:%s)" % - (self.sqlinstancename, self.flavor, self.volume)) - # create databases - for database in self.databases: - instance.create_database( - database[self.DATABASE_NAME], - character_set=database[self.DATABASE_CHARACTER_SET], - collate=database[self.DATABASE_COLLATE]) - logger.info("Database %s created on cloud DB instance %s" % - (database[self.DATABASE_NAME], self.sqlinstancename)) - - # add users - dbs = [] - for user in self.users: - if user[self.USER_DATABASES]: - dbs = user[self.USER_DATABASES] - instance.create_user(user[self.DATABASE_NAME], - user[self.USER_PASSWORD], - dbs) - logger.info("Cloud database user %s created successfully" % - (user[self.DATABASE_NAME])) - return True - - def handle_delete(self): - ''' - Delete a Rackspace Cloud DB Instance. - ''' - logger.debug("CloudDBInstance handle_delete called.") - if self.resource_id is None: - return - try: - self.cloud_db().delete(self.resource_id) - except ClientException as cexc: - if str(cexc.code) != "404": - raise cexc - - def validate(self): - ''' - Validate any of the provided params - ''' - res = super(CloudDBInstance, self).validate() - if res: - return res - - # check validity of user and databases - users = self.properties.get(self.USERS, None) - if not users: - return - - databases = self.properties.get(self.DATABASES, None) - if not databases: - return {'Error': - 'Databases property is required if Users property' - ' is provided'} - - for user in users: - if not user[self.USER_DATABASES]: - return {'Error': - 'Must provide access to at least one database for ' - 'user %s' % user[self.DATABASE_NAME]} - - db_names = set([db[self.DATABASE_NAME] for db in databases]) - missing_db = [db_name for db_name in user[self.USER_DATABASES] - if db_name not in db_names] - if missing_db: - return {'Error': - 'Database %s specified for user does not exist in ' - 'databases.' % missing_db} - return - - def _hostname(self): - if self.hostname is None and self.resource_id is not None: - dbinstance = self.cloud_db().get(self.resource_id) - self.hostname = dbinstance.hostname - - return self.hostname - - def _href(self): - if self.href is None and self.resource_id is not None: - dbinstance = self.cloud_db().get(self.resource_id) - self.href = self._gethref(dbinstance) - - return self.href - - def _gethref(self, dbinstance): - if dbinstance is None or dbinstance.links is None: - return None - - for link in dbinstance.links: - if link['rel'] == 'self': - return link['href'] - - def _resolve_attribute(self, name): - if name == 'hostname': - return self._hostname() - elif name == 'href': - return self._href() - else: - return None diff --git a/contrib/rackspace/tests/test_clouddatabase.py b/contrib/rackspace/tests/test_clouddatabase.py deleted file mode 100644 index 1e367367c..000000000 --- a/contrib/rackspace/tests/test_clouddatabase.py +++ /dev/null @@ -1,199 +0,0 @@ -# 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 uuid - -from heat.common import template_format -from heat.engine import parser -from heat.engine import environment -from heat.engine import resource -from heat.tests.common import HeatTestCase -from heat.tests import utils - -from ..resources import clouddatabase # noqa - -try: - from pyrax.exceptions import ClientException -except ImportError: - from ..resources.clouddatabase import ClientException # noqa - -wp_template = ''' -{ - "AWSTemplateFormatVersion" : "2010-09-09", - "Description" : "MYSQL instance running on Rackspace cloud", - "Parameters" : { - "FlavorRef": { - "Description" : "Flavor reference", - "Type": "String" - }, - "VolumeSize": { - "Description" : "The volume size", - "Type": "Number", - "MinValue" : "1", - "MaxValue" : "1024" - }, - "InstanceName": { - "Description" : "The database instance name", - "Type": "String" - } - }, - "Resources" : { - "MySqlCloudDB": { - "Type": "Rackspace::Cloud::DBInstance", - "Properties" : { - "InstanceName" : {"Ref": "InstanceName"}, - "FlavorRef" : {"Ref": "FlavorRef"}, - "VolumeSize" : {"Ref": VolumeSize}, - "Users" : [{"name":"testuser", "password":"testpass123"}] , - "Databases" : [{"name":"testdbonetwo"}] - } - } - } - -} -''' - - -class FakeDBInstance(object): - def __init__(self): - self.id = 12345 - self.hostname = "testhost" - self.links = \ - [{"href": "https://adga23dd432a.rackspacecloud.com/132345245"}] - self.resource_id = 12345 - - -class CloudDBInstanceTest(HeatTestCase): - def setUp(self): - super(CloudDBInstanceTest, self).setUp() - utils.setup_dummy_db() - # Test environment may not have pyrax client library installed and if - # pyrax is not installed resource class would not be registered. - # So register resource provider class explicitly for unit testing. - resource._register_class("Rackspace::Cloud::DBInstance", - clouddatabase.CloudDBInstance) - - def _setup_test_clouddbinstance(self, name, inject_property_error=False): - stack_name = '%s_stack' % name - t = template_format.parse(wp_template) - template = parser.Template(t) - stack = parser.Stack(utils.dummy_context(), - stack_name, - template, - environment.Environment({'InstanceName': 'Test', - 'FlavorRef': '1GB', - 'VolumeSize': '30'}), - stack_id=str(uuid.uuid4())) - - if inject_property_error: - # database name given in users list is not a valid database - t['Resources']['MySqlCloudDB']['Properties']['Databases'] = \ - [{"Name": "onedb"}] - t['Resources']['MySqlCloudDB']['Properties']['Users'] = \ - [{"Name": "testuser", - "Password": "pass", - "Databases": ["invaliddb"]}] - else: - t['Resources']['MySqlCloudDB']['Properties']['Databases'] = \ - [{"Name": "validdb"}] - t['Resources']['MySqlCloudDB']['Properties']['Users'] = \ - [{"Name": "testuser", - "Password": "pass", - "Databases": ["validdb"]}] - - instance = clouddatabase.CloudDBInstance( - '%s_name' % name, - t['Resources']['MySqlCloudDB'], - stack) - instance.resource_id = 1234 - self.m.StubOutWithMock(instance, 'cloud_db') - return instance - - def test_clouddbinstance(self): - instance = self._setup_test_clouddbinstance('dbinstance') - self.assertIsNone(instance.hostname) - self.assertIsNone(instance.href) - - def test_clouddbinstance_create(self): - instance = self._setup_test_clouddbinstance('dbinstance_create') - fake_client = self.m.CreateMockAnything() - instance.cloud_db().AndReturn(fake_client) - fakedbinstance = FakeDBInstance() - fake_client.create('Test', - flavor='1GB', - volume=30).AndReturn(fakedbinstance) - self.m.ReplayAll() - instance.handle_create() - expected_hostname = fakedbinstance.hostname - expected_href = fakedbinstance.links[0]['href'] - self.assertEqual(expected_hostname, - instance._resolve_attribute('hostname')) - self.assertEqual(expected_href, instance._resolve_attribute('href')) - self.m.VerifyAll() - - def test_clouddbinstance_delete_resource_notfound(self): - instance = self._setup_test_clouddbinstance('dbinstance_delete') - instance.resource_id = None - self.m.ReplayAll() - instance.handle_delete() - self.m.VerifyAll() - - def test_cloudbinstance_delete_exception(self): - instance = self._setup_test_clouddbinstance('dbinstance_delete') - fake_client = self.m.CreateMockAnything() - instance.cloud_db().AndReturn(fake_client) - client_exc = ClientException(404) - fake_client.delete(instance.resource_id).AndRaise(client_exc) - self.m.ReplayAll() - instance.handle_delete() - self.m.VerifyAll() - - def test_attribute_not_found(self): - instance = self._setup_test_clouddbinstance('dbinstance_create') - fake_client = self.m.CreateMockAnything() - instance.cloud_db().AndReturn(fake_client) - fakedbinstance = FakeDBInstance() - fake_client.create('Test', - flavor='1GB', - volume=30).AndReturn(fakedbinstance) - self.m.ReplayAll() - instance.handle_create() - self.assertIsNone(instance._resolve_attribute('invalid-attrib')) - self.m.VerifyAll() - - def test_clouddbinstance_delete(self): - instance = self._setup_test_clouddbinstance('dbinstance_delete') - fake_client = self.m.CreateMockAnything() - instance.cloud_db().AndReturn(fake_client) - fake_client.delete(1234).AndReturn(None) - self.m.ReplayAll() - instance.handle_delete() - self.m.VerifyAll() - - def test_clouddbinstance_param_validation_success(self): - instance = self._setup_test_clouddbinstance( - 'dbinstance_params', - inject_property_error=False) - self.m.ReplayAll() - ret = instance.validate() - self.assertIsNone(ret) - self.m.VerifyAll() - - def test_clouddbinstance_param_validation_fail(self): - instance = self._setup_test_clouddbinstance('dbinstance_params', - inject_property_error=True) - self.m.ReplayAll() - ret = instance.validate() - self.assertIn('Error', ret) - self.m.VerifyAll()