Merge "Add OS::Trove::Cluster resource"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
e1aa606741
242
heat/engine/resources/openstack/trove/trove_cluster.py
Normal file
242
heat/engine/resources/openstack/trove/trove_cluster.py
Normal file
@ -0,0 +1,242 @@
|
||||
#
|
||||
# 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 oslo_log import log as logging
|
||||
|
||||
from heat.common.i18n import _
|
||||
from heat.common.i18n import _LI
|
||||
from heat.common.i18n import _LW
|
||||
from heat.engine import attributes
|
||||
from heat.engine import constraints
|
||||
from heat.engine import properties
|
||||
from heat.engine import resource
|
||||
from heat.engine import support
|
||||
|
||||
LOG = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class TroveCluster(resource.Resource):
|
||||
|
||||
support_status = support.SupportStatus(version='2015.1')
|
||||
|
||||
TROVE_STATUS = (
|
||||
ERROR, FAILED, ACTIVE,
|
||||
) = (
|
||||
'ERROR', 'FAILED', 'ACTIVE',
|
||||
)
|
||||
|
||||
TROVE_STATUS_REASON = {
|
||||
FAILED: _('The database instance was created, but heat failed to set '
|
||||
'up the datastore. If a database instance is in the FAILED '
|
||||
'state, it should be deleted and a new one should be '
|
||||
'created.'),
|
||||
ERROR: _('The last operation for the database instance failed due to '
|
||||
'an error.'),
|
||||
}
|
||||
|
||||
BAD_STATUSES = (ERROR, FAILED)
|
||||
|
||||
PROPERTIES = (
|
||||
NAME, DATASTORE_TYPE, DATASTORE_VERSION, INSTANCES,
|
||||
) = (
|
||||
'name', 'datastore_type', 'datastore_version', 'instances',
|
||||
)
|
||||
|
||||
_INSTANCE_KEYS = (
|
||||
FLAVOR, VOLUME_SIZE,
|
||||
) = (
|
||||
'flavor', 'volume_size',
|
||||
)
|
||||
|
||||
ATTRIBUTES = (
|
||||
INSTANCES_ATTR, IP
|
||||
) = (
|
||||
'instances', 'ip'
|
||||
)
|
||||
|
||||
properties_schema = {
|
||||
NAME: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Name of the cluster to create.'),
|
||||
constraints=[
|
||||
constraints.Length(max=255),
|
||||
]
|
||||
),
|
||||
DATASTORE_TYPE: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_("Name of registered datastore type."),
|
||||
required=True,
|
||||
constraints=[
|
||||
constraints.Length(max=255)
|
||||
]
|
||||
),
|
||||
DATASTORE_VERSION: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_("Name of the registered datastore version. "
|
||||
"It must exist for provided datastore type. "
|
||||
"Defaults to using single active version. "
|
||||
"If several active versions exist for provided datastore type, "
|
||||
"explicit value for this parameter must be specified."),
|
||||
required=True,
|
||||
constraints=[constraints.Length(max=255)]
|
||||
),
|
||||
INSTANCES: properties.Schema(
|
||||
properties.Schema.LIST,
|
||||
_("List of database instances."),
|
||||
required=True,
|
||||
schema=properties.Schema(
|
||||
properties.Schema.MAP,
|
||||
schema={
|
||||
FLAVOR: properties.Schema(
|
||||
properties.Schema.STRING,
|
||||
_('Flavor of the instance.'),
|
||||
required=True,
|
||||
constraints=[
|
||||
constraints.CustomConstraint('trove.flavor')
|
||||
]
|
||||
),
|
||||
VOLUME_SIZE: properties.Schema(
|
||||
properties.Schema.INTEGER,
|
||||
_('Size of the instance disk volume in GB.'),
|
||||
required=True,
|
||||
constraints=[
|
||||
constraints.Range(1, 150),
|
||||
]
|
||||
)
|
||||
}
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
attributes_schema = {
|
||||
INSTANCES: attributes.Schema(
|
||||
_("A list of instances ids.")
|
||||
),
|
||||
IP: attributes.Schema(
|
||||
_("IP of the cluster.")
|
||||
)
|
||||
}
|
||||
|
||||
default_client_name = 'trove'
|
||||
|
||||
def _cluster_name(self):
|
||||
return self.properties[self.NAME] or self.physical_resource_name()
|
||||
|
||||
def handle_create(self):
|
||||
datastore_type = self.properties[self.DATASTORE_TYPE]
|
||||
datastore_version = self.properties[self.DATASTORE_VERSION]
|
||||
|
||||
# convert instances to format required by troveclient
|
||||
instances = []
|
||||
for instance in self.properties[self.INSTANCES]:
|
||||
instances.append({
|
||||
'flavorRef': self.client_plugin().get_flavor_id(
|
||||
instance[self.FLAVOR]),
|
||||
'volume': {'size': instance[self.VOLUME_SIZE]}
|
||||
})
|
||||
|
||||
args = {
|
||||
'name': self._cluster_name(),
|
||||
'datastore': datastore_type,
|
||||
'datastore_version': datastore_version,
|
||||
'instances': instances
|
||||
}
|
||||
cluster = self.client().clusters.create(**args)
|
||||
self.resource_id_set(cluster.id)
|
||||
return cluster
|
||||
|
||||
def _refresh_cluster(self, cluster):
|
||||
try:
|
||||
cluster = self.client().clusters.get(cluster.id)
|
||||
return cluster
|
||||
except Exception as exc:
|
||||
if self.client_plugin().is_over_limit(exc):
|
||||
LOG.warn(_LW("Stack %(name)s (%(id)s) received an "
|
||||
"OverLimit response during clusters.get():"
|
||||
" %(exception)s"),
|
||||
{'name': self.stack.name,
|
||||
'id': self.stack.id,
|
||||
'exception': exc})
|
||||
return cluster
|
||||
else:
|
||||
raise
|
||||
|
||||
def check_create_complete(self, cluster):
|
||||
cluster = self._refresh_cluster(cluster)
|
||||
|
||||
for instance in cluster.instances:
|
||||
if instance['status'] in self.BAD_STATUSES:
|
||||
raise resource.ResourceInError(
|
||||
resource_status=instance['status'],
|
||||
status_reason=self.TROVE_STATUS_REASON.get(
|
||||
instance['status'], _("Unknown")))
|
||||
|
||||
if instance['status'] != self.ACTIVE:
|
||||
return False
|
||||
|
||||
LOG.info(_LI("Cluster '%s' has been created"), cluster.name)
|
||||
return True
|
||||
|
||||
def handle_delete(self):
|
||||
if not self.resource_id:
|
||||
return
|
||||
|
||||
try:
|
||||
cluster = self.client().clusters.get(self.resource_id)
|
||||
except Exception as ex:
|
||||
self.client_plugin().ignore_not_found(ex)
|
||||
else:
|
||||
cluster.delete()
|
||||
return cluster
|
||||
|
||||
def check_delete_complete(self, cluster):
|
||||
if not cluster:
|
||||
return True
|
||||
|
||||
try:
|
||||
# For some time trove cluster may continue to live
|
||||
self._refresh_cluster(cluster)
|
||||
except Exception as ex:
|
||||
self.client_plugin().ignore_not_found(ex)
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
def validate(self):
|
||||
res = super(TroveCluster, self).validate()
|
||||
if res:
|
||||
return res
|
||||
|
||||
datastore_type = self.properties[self.DATASTORE_TYPE]
|
||||
datastore_version = self.properties[self.DATASTORE_VERSION]
|
||||
|
||||
self.client_plugin().validate_datastore(
|
||||
datastore_type, datastore_version,
|
||||
self.DATASTORE_TYPE, self.DATASTORE_VERSION)
|
||||
|
||||
def _resolve_attribute(self, name):
|
||||
if name == self.INSTANCES_ATTR:
|
||||
instances = []
|
||||
cluster = self.client().clusters.get(self.resource_id)
|
||||
for instance in cluster.instances:
|
||||
instances.append(instance['id'])
|
||||
return instances
|
||||
elif name == self.IP:
|
||||
cluster = self.client().clusters.get(self.resource_id)
|
||||
return cluster.ip
|
||||
|
||||
|
||||
def resource_mapping():
|
||||
return {
|
||||
'OS::Trove::Cluster': TroveCluster
|
||||
}
|
||||
167
heat/tests/test_trove_cluster.py
Normal file
167
heat/tests/test_trove_cluster.py
Normal file
@ -0,0 +1,167 @@
|
||||
#
|
||||
# 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 six
|
||||
from troveclient.openstack.common.apiclient import exceptions as troveexc
|
||||
|
||||
from heat.common import exception
|
||||
from heat.common import template_format
|
||||
from heat.engine.clients.os import trove
|
||||
from heat.engine.resources.openstack.trove import trove_cluster
|
||||
from heat.engine import scheduler
|
||||
from heat.tests import common
|
||||
from heat.tests import utils
|
||||
|
||||
|
||||
stack_template = '''
|
||||
heat_template_version: 2013-05-23
|
||||
|
||||
resources:
|
||||
|
||||
cluster:
|
||||
type: OS::Trove::Cluster
|
||||
properties:
|
||||
datastore_type: mongodb
|
||||
datastore_version: 2.6.1
|
||||
instances:
|
||||
- flavor: m1.heat
|
||||
volume_size: 1
|
||||
- flavor: m1.heat
|
||||
volume_size: 1
|
||||
- flavor: m1.heat
|
||||
volume_size: 1
|
||||
'''
|
||||
|
||||
|
||||
class FakeTroveCluster(object):
|
||||
def __init__(self, status='ACTIVE'):
|
||||
self.name = 'cluster'
|
||||
self.id = '1189aa64-a471-4aa3-876a-9eb7d84089da'
|
||||
self.ip = '10.0.0.1'
|
||||
self.instances = [
|
||||
{'id': '416b0b16-ba55-4302-bbd3-ff566032e1c1', 'status': status},
|
||||
{'id': '965ef811-7c1d-47fc-89f2-a89dfdd23ef2', 'status': status},
|
||||
{'id': '3642f41c-e8ad-4164-a089-3891bf7f2d2b', 'status': status}]
|
||||
|
||||
def delete(self):
|
||||
pass
|
||||
|
||||
|
||||
class FakeFlavor(object):
|
||||
def __init__(self, id, name):
|
||||
self.id = id
|
||||
self.name = name
|
||||
|
||||
|
||||
class FakeVersion(object):
|
||||
def __init__(self, name="2.6.1"):
|
||||
self.name = name
|
||||
|
||||
|
||||
class TroveClusterTest(common.HeatTestCase):
|
||||
|
||||
def setUp(self):
|
||||
super(TroveClusterTest, self).setUp()
|
||||
utils.setup_dummy_db()
|
||||
self.ctx = utils.dummy_context()
|
||||
|
||||
t = template_format.parse(stack_template)
|
||||
self.stack = utils.parse_stack(t)
|
||||
resource_defns = self.stack.t.resource_definitions(self.stack)
|
||||
self.rsrc_defn = resource_defns['cluster']
|
||||
|
||||
self.patcher_client = mock.patch.object(trove_cluster.TroveCluster,
|
||||
'client')
|
||||
mock_client = self.patcher_client.start()
|
||||
self.client = mock_client.return_value
|
||||
client = mock.Mock()
|
||||
client.flavors.list.return_value = [FakeFlavor(1, 'm1.heat')]
|
||||
client.datastore_versions.list.return_value = [FakeVersion()]
|
||||
self.patchobject(trove.TroveClientPlugin, 'client',
|
||||
return_value=client)
|
||||
|
||||
def tearDown(self):
|
||||
super(TroveClusterTest, self).tearDown()
|
||||
self.patcher_client.stop()
|
||||
|
||||
def _create_resource(self, name, snippet, stack):
|
||||
tc = trove_cluster.TroveCluster(name, snippet, stack)
|
||||
self.client.clusters.create.return_value = FakeTroveCluster()
|
||||
self.client.clusters.get.return_value = FakeTroveCluster()
|
||||
scheduler.TaskRunner(tc.create)()
|
||||
return tc
|
||||
|
||||
def test_create(self):
|
||||
tc = self._create_resource('cluster', self.rsrc_defn, self.stack)
|
||||
expected_state = (tc.CREATE, tc.COMPLETE)
|
||||
self.assertEqual(expected_state, tc.state)
|
||||
args = self.client.clusters.create.call_args[1]
|
||||
self.assertEqual([{'flavorRef': 1, 'volume': {'size': 1}},
|
||||
{'flavorRef': 1, 'volume': {'size': 1}},
|
||||
{'flavorRef': 1, 'volume': {'size': 1}}],
|
||||
args['instances'])
|
||||
self.assertEqual('mongodb', args['datastore'])
|
||||
self.assertEqual('2.6.1', args['datastore_version'])
|
||||
self.assertEqual('1189aa64-a471-4aa3-876a-9eb7d84089da',
|
||||
tc.resource_id)
|
||||
|
||||
def test_resource_mapping(self):
|
||||
mapping = trove_cluster.resource_mapping()
|
||||
self.assertEqual(1, len(mapping))
|
||||
self.assertEqual(trove_cluster.TroveCluster,
|
||||
mapping['OS::Trove::Cluster'])
|
||||
|
||||
def test_attributes(self):
|
||||
tc = self._create_resource('cluster', self.rsrc_defn, self.stack)
|
||||
self.assertEqual('10.0.0.1', tc.FnGetAtt('ip'))
|
||||
self.assertEqual(['416b0b16-ba55-4302-bbd3-ff566032e1c1',
|
||||
'965ef811-7c1d-47fc-89f2-a89dfdd23ef2',
|
||||
'3642f41c-e8ad-4164-a089-3891bf7f2d2b'],
|
||||
tc.FnGetAtt('instances'))
|
||||
|
||||
def test_delete(self):
|
||||
tc = self._create_resource('cluster', self.rsrc_defn, self.stack)
|
||||
self.patchobject(tc, 'handle_delete', return_value=None)
|
||||
scheduler.TaskRunner(tc.delete)()
|
||||
self.assertEqual((tc.DELETE, tc.COMPLETE), tc.state)
|
||||
|
||||
def test_delete_not_found(self):
|
||||
tc = self._create_resource('cluster', self.rsrc_defn, self.stack)
|
||||
self.client.clusters.get.side_effect = troveexc.NotFound()
|
||||
scheduler.TaskRunner(tc.delete)()
|
||||
self.assertEqual((tc.DELETE, tc.COMPLETE), tc.state)
|
||||
self.client.clusters.get.assert_called_with(tc.resource_id)
|
||||
self.assertEqual(2, self.client.clusters.get.call_count)
|
||||
|
||||
def test_validate_ok(self):
|
||||
tc = trove_cluster.TroveCluster('cluster', self.rsrc_defn, self.stack)
|
||||
self.assertIsNone(tc.validate())
|
||||
|
||||
def test_validate_invalid_dsversion(self):
|
||||
self.rsrc_defn['Properties']['datastore_version'] = '2.6.2'
|
||||
tc = trove_cluster.TroveCluster('cluster', self.rsrc_defn, self.stack)
|
||||
ex = self.assertRaises(exception.StackValidationFailed, tc.validate)
|
||||
error_msg = ('Datastore version 2.6.2 for datastore type mongodb is '
|
||||
'not valid. Allowed versions are 2.6.1.')
|
||||
self.assertEqual(error_msg, six.text_type(ex))
|
||||
|
||||
def test_validate_invalid_flavor(self):
|
||||
self.rsrc_defn['Properties']['instances'][0]['flavor'] = 'm1.small'
|
||||
tc = trove_cluster.TroveCluster('cluster', self.rsrc_defn, self.stack)
|
||||
ex = self.assertRaises(exception.StackValidationFailed, tc.validate)
|
||||
error_msg = ("Property error : cluster: instances Property error : "
|
||||
"instances: 0 Property error : 0: flavor "
|
||||
"Error validating value 'm1.small': "
|
||||
"The Flavor ID (m1.small) could not be found.")
|
||||
self.assertEqual(error_msg, six.text_type(ex))
|
||||
Loading…
Reference in New Issue
Block a user