openstack
/
nova
Code Issues Proposed changes

resource-provider versioned objects 

Add ResourceProvider, Inventory and InventoryList objects with
minimal methods for persistence. It is likely the interfaces will
need to be expanded as these things are actually used.

An inventory can be created or updated or a list of inventories can
be retrieved by resource provider uuid.

A resource provider can be created and retrieved by uuid.

Inventory shares some code with a forthcoming Allocation object that
used to be in this patch will now come later. That sharing is via a
_HasAResoureProvider superclass.

Tests are mixed between unit and functional. The functional tests
explore the arc of an expected task.

Co-Authored-By: Dan Smith <dansmith@redhat.com>
Partially-Implements: blueprint resource-providers
Change-Id: I578eebf04c3b5d881aa7be7b72691515f2cf6758
This commit is contained in:
Chris Dent 2016-02-07 23:35:41 +00:00
parent 0a0d9627c1
commit b65a4e09b5
5 changed files with 583 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
nova/objects/__init__.py
View File

@ -59,6 +59,7 @@ def register_all():
__import__('nova.objects.pci_device')
__import__('nova.objects.pci_device_pool')
__import__('nova.objects.request_spec')
__import__('nova.objects.resource_provider')
__import__('nova.objects.tag')
__import__('nova.objects.quotas')
__import__('nova.objects.security_group')

197
nova/objects/resource_provider.py Normal file
View File

@ -0,0 +1,197 @@
# 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 sqlalchemy.orm import joinedload
from nova.db.sqlalchemy import api as db_api
from nova.db.sqlalchemy import models
from nova import exception
from nova import objects
from nova.objects import base
from nova.objects import fields
@base.NovaObjectRegistry.register
class ResourceProvider(base.NovaObject):
# Version 1.0: Initial version
VERSION = '1.0'
fields = {
'id': fields.IntegerField(read_only=True),
'uuid': fields.UUIDField(nullable=False),
}
@base.remotable
def create(self):
if 'id' in self:
raise exception.ObjectActionError(action='create',
reason='already created')
if 'uuid' not in self:
raise exception.ObjectActionError(action='create',
reason='uuid is required')
updates = self.obj_get_changes()
db_rp = self._create_in_db(self._context, updates)
self._from_db_object(self._context, self, db_rp)
@base.remotable_classmethod
def get_by_uuid(cls, context, uuid):
db_resource_provider = cls._get_by_uuid_from_db(context, uuid)
return cls._from_db_object(context, cls(), db_resource_provider)
@staticmethod
@db_api.main_context_manager.writer
def _create_in_db(context, updates):
db_rp = models.ResourceProvider()
db_rp.update(updates)
context.session.add(db_rp)
return db_rp
@staticmethod
def _from_db_object(context, resource_provider, db_resource_provider):
for field in resource_provider.fields:
setattr(resource_provider, field, db_resource_provider[field])
resource_provider._context = context
resource_provider.obj_reset_changes()
return resource_provider
@staticmethod
@db_api.main_context_manager.reader
def _get_by_uuid_from_db(context, uuid):
result = context.session.query(models.ResourceProvider).filter_by(
uuid=uuid).first()
if not result:
raise exception.NotFound()
return result
class _HasAResourceProvider(base.NovaObject):
"""Code shared between Inventory and Allocation
Both contain a ResourceProvider.
"""
@staticmethod
def _make_db(updates):
try:
resource_provider = updates.pop('resource_provider')
updates['resource_provider_id'] = resource_provider.id
except (KeyError, NotImplementedError):
raise exception.ObjectActionError(
action='create',
reason='resource_provider required')
try:
resource_class = updates.pop('resource_class')
except KeyError:
raise exception.ObjectActionError(
action='create',
reason='resource_class required')
updates['resource_class_id'] = fields.ResourceClass.index(
resource_class)
return updates
@staticmethod
def _from_db_object(context, target, source):
for field in target.fields:
if field not in ('resource_provider', 'resource_class'):
setattr(target, field, source[field])
if 'resource_class' not in target:
target.resource_class = (
target.fields['resource_class'].from_index(
source['resource_class_id']))
if ('resource_provider' not in target and
'resource_provider' in source):
target.resource_provider = ResourceProvider()
ResourceProvider._from_db_object(
context,
target.resource_provider,
source['resource_provider'])
target._context = context
target.obj_reset_changes()
return target
@base.NovaObjectRegistry.register
class Inventory(_HasAResourceProvider):
# Version 1.0: Initial version
VERSION = '1.0'
fields = {
'id': fields.IntegerField(read_only=True),
'resource_provider': fields.ObjectField('ResourceProvider'),
'resource_class': fields.ResourceClassField(read_only=True),
'total': fields.IntegerField(),
'reserved': fields.IntegerField(),
'min_unit': fields.IntegerField(),
'max_unit': fields.IntegerField(),
'step_size': fields.IntegerField(),
'allocation_ratio': fields.FloatField(),
}
@base.remotable
def create(self):
if 'id' in self:
raise exception.ObjectActionError(action='create',
reason='already created')
updates = self._make_db(self.obj_get_changes())
db_inventory = self._create_in_db(self._context, updates)
self._from_db_object(self._context, self, db_inventory)
@base.remotable
def save(self):
if 'id' not in self:
raise exception.ObjectActionError(action='save',
reason='not created')
updates = self.obj_get_changes()
updates.pop('id', None)
self._update_in_db(self._context, self.id, updates)
@staticmethod
@db_api.main_context_manager.writer
def _create_in_db(context, updates):
db_inventory = models.Inventory()
db_inventory.update(updates)
context.session.add(db_inventory)
return db_inventory
@staticmethod
@db_api.main_context_manager.writer
def _update_in_db(context, id_, updates):
result = context.session.query(
models.Inventory).filter_by(id=id_).update(updates)
if not result:
raise exception.NotFound()
@base.NovaObjectRegistry.register
class InventoryList(base.ObjectListBase, base.NovaObject):
# Version 1.0: Initial Version
VERSION = '1.0'
fields = {
'objects': fields.ListOfObjectsField('Inventory'),
}
@staticmethod
@db_api.main_context_manager.reader
def _get_all_by_resource_provider(context, rp_uuid):
return context.session.query(models.Inventory).\
options(joinedload('resource_provider')).\
filter(models.ResourceProvider.uuid == rp_uuid).all()
@base.remotable_classmethod
def get_all_by_resource_provider_uuid(cls, context, rp_uuid):
db_inventory_list = cls._get_all_by_resource_provider(context,
rp_uuid)
return base.obj_make_list(context, cls(context), objects.Inventory,
db_inventory_list)

112
nova/tests/functional/db/test_resource_provider.py Normal file
View File

@ -0,0 +1,112 @@
# 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 nova import context
from nova import exception
from nova import objects
from nova.objects import fields
from nova import test
from nova.tests import fixtures
from nova.tests import uuidsentinel
DISK_INVENTORY = dict(
total=200,
reserved=10,
min_unit=2,
max_unit=5,
step_size=1,
allocation_ratio=1.0
)
class ResourceProviderTestCase(test.NoDBTestCase):
"""Test resource-provider objects' lifecycles."""
def setUp(self):
super(ResourceProviderTestCase, self).setUp()
self.useFixture(fixtures.Database())
self.context = context.RequestContext('fake-user', 'fake-project')
def test_create_resource_provider_requires_uuid(self):
resource_provider = objects.ResourceProvider(
context = self.context)
self.assertRaises(exception.ObjectActionError,
resource_provider.create)
def test_create_resource_provider(self):
created_resource_provider = objects.ResourceProvider(
context=self.context,
uuid=uuidsentinel.fake_resource_provider
)
created_resource_provider.create()
self.assertIsInstance(created_resource_provider.id, int)
retrieved_resource_provider = objects.ResourceProvider.get_by_uuid(
self.context,
uuidsentinel.fake_resource_provider
)
self.assertEqual(retrieved_resource_provider.id,
created_resource_provider.id)
def test_create_inventory_with_uncreated_provider(self):
resource_provider = objects.ResourceProvider(
context=self.context,
uuid=uuidsentinel.inventory_resource_provider
)
resource_class = fields.ResourceClass.DISK_GB
disk_inventory = objects.Inventory(
context=self.context,
resource_provider=resource_provider,
resource_class=resource_class,
**DISK_INVENTORY
)
self.assertRaises(exception.ObjectActionError,
disk_inventory.create)
def test_create_and_update_inventory(self):
resource_provider = objects.ResourceProvider(
context=self.context,
uuid=uuidsentinel.inventory_resource_provider
)
resource_provider.create()
resource_class = fields.ResourceClass.DISK_GB
disk_inventory = objects.Inventory(
context=self.context,
resource_provider=resource_provider,
resource_class=resource_class,
**DISK_INVENTORY
)
disk_inventory.create()
self.assertEqual(resource_class, disk_inventory.resource_class)
self.assertEqual(resource_provider,
disk_inventory.resource_provider)
self.assertEqual(DISK_INVENTORY['allocation_ratio'],
disk_inventory.allocation_ratio)
self.assertEqual(DISK_INVENTORY['total'],
disk_inventory.total)
disk_inventory.total = 32
disk_inventory.save()
inventories = objects.InventoryList.get_all_by_resource_provider_uuid(
self.context, resource_provider.uuid)
self.assertEqual(1, len(inventories))
self.assertEqual(32, inventories[0].total)
inventories[0].total = 33
inventories[0].save()
reloaded_inventories = (
objects.InventoryList.get_all_by_resource_provider_uuid(
self.context, resource_provider.uuid))
self.assertEqual(33, reloaded_inventories[0].total)

3
nova/tests/unit/objects/test_objects.py
View File

@ -1143,6 +1143,8 @@ object_data = {
'InstanceNUMATopology': '1.2-d944a7d6c21e1c773ffdf09c6d025954',
'InstancePCIRequest': '1.1-b1d75ebc716cb12906d9d513890092bf',
'InstancePCIRequests': '1.1-65e38083177726d806684cb1cc0136d2',
'Inventory': '1.0-f4160797d47a533a58700e9ddcc9c5e2',
'InventoryList': '1.0-de53f0fd078c27cc1d43400f4e8bcef8',
'LibvirtLiveMigrateBDMInfo': '1.0-252aabb723ca79d5469fa56f64b57811',
'LibvirtLiveMigrateData': '1.1-4ecf40aae7fee7bb37fc3b2123e760de',
'KeyPair': '1.3-bfaa2a8b148cdf11e0c72435d9dd097a',
@ -1168,6 +1170,7 @@ object_data = {
'Quotas': '1.2-1fe4cd50593aaf5d36a6dc5ab3f98fb3',
'QuotasNoOp': '1.2-e041ddeb7dc8188ca71706f78aad41c1',
'RequestSpec': '1.5-576a249869c161e17b7cd6d55f9d85f3',
'ResourceProvider': '1.0-57a9a344b0faed9cf6d6811835b6deb6',
'S3ImageMapping': '1.0-7dd7366a890d82660ed121de9092276e',
'SchedulerLimits': '1.0-249c4bd8e62a9b327b7026b7f19cc641',
'SchedulerRetries': '1.1-3c9c8b16143ebbb6ad7030e999d14cc0',

270
nova/tests/unit/objects/test_resource_provider.py Normal file
View File

@ -0,0 +1,270 @@
# 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
from nova import exception
from nova import objects
from nova.tests.unit.objects import test_objects
from nova.tests import uuidsentinel as uuids
_RESOURCE_CLASS_NAME = 'DISK_GB'
_RESOURCE_CLASS_ID = 2
_RESOURCE_PROVIDER_ID = 1
_RESOURCE_PROVIDER_UUID = uuids.resource_provider
_RESOURCE_PROVIDER_DB = {
'id': _RESOURCE_PROVIDER_ID,
'uuid': _RESOURCE_PROVIDER_UUID,
}
_INVENTORY_ID = 2
_INVENTORY_DB = {
'id': _INVENTORY_ID,
'resource_provider_id': _RESOURCE_PROVIDER_ID,
'resource_class_id': _RESOURCE_CLASS_ID,
'total': 16,
'reserved': 2,
'min_unit': 1,
'max_unit': 8,
'step_size': 1,
'allocation_ratio': 1.0,
}
class _TestResourceProviderNoDB(object):
@mock.patch('nova.objects.ResourceProvider._get_by_uuid_from_db',
return_value=_RESOURCE_PROVIDER_DB)
def test_object_get_by_uuid(self, mock_db_get):
resource_provider_object = objects.ResourceProvider.get_by_uuid(
mock.sentinel.ctx, _RESOURCE_PROVIDER_UUID)
self.assertEqual(_RESOURCE_PROVIDER_ID, resource_provider_object.id)
self.assertEqual(_RESOURCE_PROVIDER_UUID,
resource_provider_object.uuid)
@mock.patch('nova.objects.ResourceProvider._create_in_db',
return_value=_RESOURCE_PROVIDER_DB)
def test_create(self, mock_db_create):
obj = objects.ResourceProvider(context=self.context,
uuid=_RESOURCE_PROVIDER_UUID)
obj.create()
self.assertEqual(_RESOURCE_PROVIDER_UUID, obj.uuid)
self.assertIsInstance(obj.id, int)
mock_db_create.assert_called_once_with(
self.context, {'uuid': _RESOURCE_PROVIDER_UUID})
def test_create_id_fail(self):
obj = objects.ResourceProvider(context=self.context,
uuid=_RESOURCE_PROVIDER_UUID,
id=_RESOURCE_PROVIDER_ID)
self.assertRaises(exception.ObjectActionError,
obj.create)
def test_create_no_uuid_fail(self):
obj = objects.ResourceProvider(context=self.context)
self.assertRaises(exception.ObjectActionError,
obj.create)
class TestResourceProviderNoDB(test_objects._LocalTest,
_TestResourceProviderNoDB):
USES_DB = False
class TestRemoteResourceProviderNoDB(test_objects._RemoteTest,
_TestResourceProviderNoDB):
USES_DB = False
class TestResourceProvider(test_objects._LocalTest):
def test_create_in_db(self):
updates = {'uuid': _RESOURCE_PROVIDER_UUID}
db_rp = objects.ResourceProvider._create_in_db(
self.context, updates)
self.assertIsInstance(db_rp.id, int)
self.assertEqual(_RESOURCE_PROVIDER_UUID, db_rp.uuid)
def test_get_by_uuid_from_db(self):
rp = objects.ResourceProvider(context=self.context,
uuid=_RESOURCE_PROVIDER_UUID)
rp.create()
retrieved_rp = objects.ResourceProvider._get_by_uuid_from_db(
self.context, _RESOURCE_PROVIDER_UUID)
self.assertEqual(rp.uuid, retrieved_rp.uuid)
self.assertRaises(exception.NotFound,
objects.ResourceProvider._get_by_uuid_from_db,
self.context,
uuids.missing)
class _TestInventoryNoDB(object):
@mock.patch('nova.objects.Inventory._create_in_db',
return_value=_INVENTORY_DB)
def test_create(self, mock_db_create):
rp = objects.ResourceProvider(id=_RESOURCE_PROVIDER_ID,
uuid=_RESOURCE_PROVIDER_UUID)
obj = objects.Inventory(context=self.context,
resource_provider=rp,
resource_class=_RESOURCE_CLASS_NAME,
total=16,
reserved=2,
min_unit=1,
max_unit=8,
step_size=1,
allocation_ratio=1.0)
obj.create()
self.assertEqual(_INVENTORY_ID, obj.id)
expected = dict(_INVENTORY_DB)
expected.pop('id')
mock_db_create.assert_called_once_with(self.context, expected)
@mock.patch('nova.objects.Inventory._update_in_db',
return_value=_INVENTORY_DB)
def test_save(self, mock_db_save):
obj = objects.Inventory(context=self.context,
id=_INVENTORY_ID,
reserved=4)
obj.save()
mock_db_save.assert_called_once_with(self.context,
_INVENTORY_ID,
{'reserved': 4})
@mock.patch('nova.objects.InventoryList._get_all_by_resource_provider')
def test_get_all_by_resource_provider(self, mock_get):
expected = [dict(_INVENTORY_DB,
resource_provider=dict(_RESOURCE_PROVIDER_DB)),
dict(_INVENTORY_DB,
id=_INVENTORY_DB['id'] + 1,
resource_provider=dict(_RESOURCE_PROVIDER_DB))]
mock_get.return_value = expected
objs = objects.InventoryList.get_all_by_resource_provider_uuid(
self.context, _RESOURCE_PROVIDER_DB['uuid'])
self.assertEqual(2, len(objs))
self.assertEqual(_INVENTORY_DB['id'], objs[0].id)
self.assertEqual(_INVENTORY_DB['id'] + 1, objs[1].id)
class TestInventoryNoDB(test_objects._LocalTest,
_TestInventoryNoDB):
USES_DB = False
class TestRemoteInventoryNoDB(test_objects._RemoteTest,
_TestInventoryNoDB):
USES_DB = False
class TestInventory(test_objects._LocalTest):
def _make_inventory(self):
db_rp = objects.ResourceProvider(
context=self.context, uuid=uuids.inventory_resource_provider)
db_rp.create()
updates = dict(_INVENTORY_DB,
resource_provider_id=db_rp.id)
updates.pop('id')
db_inventory = objects.Inventory._create_in_db(
self.context, updates)
return db_rp, db_inventory
def test_create_in_db(self):
updates = dict(_INVENTORY_DB)
updates.pop('id')
db_inventory = objects.Inventory._create_in_db(
self.context, updates)
self.assertEqual(_INVENTORY_DB['total'], db_inventory.total)
def test_update_in_db(self):
db_rp, db_inventory = self._make_inventory()
objects.Inventory._update_in_db(self.context,
db_inventory.id,
{'total': 32})
inventories = objects.InventoryList.\
get_all_by_resource_provider_uuid(self.context, db_rp.uuid)
self.assertEqual(32, inventories[0].total)
def test_update_in_db_fails_bad_id(self):
db_rp, db_inventory = self._make_inventory()
self.assertRaises(exception.NotFound,
objects.Inventory._update_in_db,
self.context, 99, {'total': 32})
def test_get_all_by_resource_provider_uuid(self):
db_rp, db_inventory = self._make_inventory()
retrieved_inventories = (
objects.InventoryList._get_all_by_resource_provider(
self.context, db_rp.uuid)
)
self.assertEqual(1, len(retrieved_inventories))
self.assertEqual(db_inventory.id, retrieved_inventories[0].id)
self.assertEqual(db_inventory.total, retrieved_inventories[0].total)
retrieved_inventories = (
objects.InventoryList._get_all_by_resource_provider(
self.context, uuids.bad_rp_uuid)
)
self.assertEqual(0, len(retrieved_inventories))
def test_create_requires_resource_provider(self):
inventory_dict = dict(_INVENTORY_DB)
inventory_dict.pop('id')
inventory_dict.pop('resource_provider_id')
inventory_dict.pop('resource_class_id')
inventory_dict['resource_class'] = _RESOURCE_CLASS_NAME
inventory = objects.Inventory(context=self.context,
**inventory_dict)
error = self.assertRaises(exception.ObjectActionError,
inventory.create)
self.assertIn('resource_provider required', str(error))
def test_create_requires_created_resource_provider(self):
rp = objects.ResourceProvider(
context=self.context, uuid=uuids.inventory_resource_provider)
inventory_dict = dict(_INVENTORY_DB)
inventory_dict.pop('id')
inventory_dict.pop('resource_provider_id')
inventory_dict.pop('resource_class_id')
inventory_dict['resource_provider'] = rp
inventory = objects.Inventory(context=self.context,
**inventory_dict)
error = self.assertRaises(exception.ObjectActionError,
inventory.create)
self.assertIn('resource_provider required', str(error))
def test_create_requires_resource_class(self):
rp = objects.ResourceProvider(
context=self.context, uuid=uuids.inventory_resource_provider)
rp.create()
inventory_dict = dict(_INVENTORY_DB)
inventory_dict.pop('id')
inventory_dict.pop('resource_provider_id')
inventory_dict.pop('resource_class_id')
inventory_dict['resource_provider'] = rp
inventory = objects.Inventory(context=self.context,
**inventory_dict)
error = self.assertRaises(exception.ObjectActionError,
inventory.create)
self.assertIn('resource_class required', str(error))
def test_create_id_fails(self):
inventory = objects.Inventory(self.context, **_INVENTORY_DB)
self.assertRaises(exception.ObjectActionError, inventory.create)
def test_save_without_id_fails(self):
inventory_dict = dict(_INVENTORY_DB)
inventory_dict.pop('id')
inventory = objects.Inventory(self.context, **inventory_dict)
self.assertRaises(exception.ObjectActionError, inventory.save)