f24f422373
There is a analysis [1] suggested to run queries against specific columns rather than full ORM entities to optimize the performance. Right now, it is impossible to execute such optimization because OVO doesn't support fetching specific column yet. This commit introduces a new method 'get_values' in the base neutron object class. Subclass of neutron object can leverage this method to fetch specific field of a OVO. It supports fetching non-synthetic fields only as syntheic fields are not directly backed by corresponding DB table columns. neutron-lib patch: https://review.openstack.org/#/c/619047/ [1] https://review.openstack.org/#/c/592361/ Needed-By: https://review.openstack.org/#/c/610184/ Change-Id: Ib90eae7738a5d2e4548fe9fed001d6cdaffddf3b Partial-Implements: blueprint adopt-oslo-versioned-objects-for-db
252 lines
9.8 KiB
Python
252 lines
9.8 KiB
Python
# 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
|
|
|
|
import mock
|
|
from neutron_lib import context
|
|
from neutron_lib import exceptions as n_exc
|
|
from neutron_lib.objects import utils as obj_utils
|
|
|
|
from neutron.db import _model_query as model_query
|
|
from neutron.objects import base
|
|
from neutron.objects.db import api
|
|
from neutron.objects import network
|
|
from neutron.tests import base as test_base
|
|
from neutron.tests.unit import testlib_api
|
|
|
|
|
|
class FakeModel(object):
|
|
def __init__(self, *args, **kwargs):
|
|
pass
|
|
|
|
|
|
class FakeObj(base.NeutronDbObject):
|
|
db_model = FakeModel
|
|
|
|
|
|
class GetObjectsTestCase(test_base.BaseTestCase):
|
|
|
|
def test_get_objects_pass_marker_obj_when_limit_and_marker_passed(self):
|
|
ctxt = context.get_admin_context()
|
|
marker = mock.sentinel.marker
|
|
limit = mock.sentinel.limit
|
|
pager = base.Pager(marker=marker, limit=limit)
|
|
|
|
with mock.patch.object(
|
|
model_query, 'get_collection') as get_collection:
|
|
with mock.patch.object(api, 'get_object') as get_object:
|
|
api.get_objects(FakeObj, ctxt, _pager=pager)
|
|
get_object.assert_called_with(FakeObj, ctxt, id=marker)
|
|
get_collection.assert_called_with(
|
|
ctxt, FakeObj.db_model, dict_func=None,
|
|
filters={},
|
|
limit=limit,
|
|
marker_obj=get_object.return_value)
|
|
|
|
|
|
class GetValuesTestCase(test_base.BaseTestCase):
|
|
|
|
def test_get_values(self):
|
|
ctxt = context.get_admin_context()
|
|
fake_field = 'fake_field'
|
|
|
|
with mock.patch.object(
|
|
model_query, 'get_values') as get_values:
|
|
api.get_values(FakeObj, ctxt, fake_field)
|
|
get_values.assert_called_with(
|
|
ctxt, FakeObj.db_model, fake_field, filters={})
|
|
|
|
|
|
class CreateObjectTestCase(test_base.BaseTestCase):
|
|
def test_populate_id(self, populate_id=True):
|
|
ctxt = context.get_admin_context()
|
|
values = {'x': 1, 'y': 2, 'z': 3}
|
|
with mock.patch.object(FakeObj, 'db_model') as db_model_mock:
|
|
with mock.patch.object(ctxt.__class__, 'session'):
|
|
api.create_object(FakeObj, ctxt, values,
|
|
populate_id=populate_id)
|
|
expected = copy.copy(values)
|
|
if populate_id:
|
|
expected['id'] = mock.ANY
|
|
db_model_mock.assert_called_with(**expected)
|
|
|
|
def test_populate_id_False(self):
|
|
self.test_populate_id(populate_id=False)
|
|
|
|
|
|
class CRUDScenarioTestCase(testlib_api.SqlTestCase):
|
|
|
|
CORE_PLUGIN = 'neutron.db.db_base_plugin_v2.NeutronDbPluginV2'
|
|
|
|
def setUp(self):
|
|
super(CRUDScenarioTestCase, self).setUp()
|
|
# TODO(ihrachys): revisit plugin setup once we decouple
|
|
# neutron.objects.db.api from core plugin instance
|
|
self.setup_coreplugin(self.CORE_PLUGIN)
|
|
# NOTE(ihrachys): nothing specific to networks in this test case, but
|
|
# we needed to pick some real object, so we picked the network. Any
|
|
# other object would work as well for our needs here.
|
|
self.obj_cls = network.Network
|
|
self.ctxt = context.get_admin_context()
|
|
|
|
def test_get_object_with_None_value_in_filters(self):
|
|
obj = api.create_object(self.obj_cls, self.ctxt, {'name': 'foo'})
|
|
new_obj = api.get_object(
|
|
self.obj_cls, self.ctxt, name='foo', status=None)
|
|
self.assertEqual(obj, new_obj)
|
|
|
|
def test_get_objects_with_None_value_in_filters(self):
|
|
obj = api.create_object(self.obj_cls, self.ctxt, {'name': 'foo'})
|
|
new_objs = api.get_objects(
|
|
self.obj_cls, self.ctxt, name='foo', status=None)
|
|
self.assertEqual(obj, new_objs[0])
|
|
|
|
def test_get_objects_with_string_matching_filters_contains(self):
|
|
obj1 = api.create_object(
|
|
self.obj_cls, self.ctxt, {'name': 'obj_con_1'})
|
|
obj2 = api.create_object(
|
|
self.obj_cls, self.ctxt, {'name': 'obj_con_2'})
|
|
obj3 = api.create_object(
|
|
self.obj_cls, self.ctxt, {'name': 'obj_3'})
|
|
|
|
objs = api.get_objects(
|
|
self.obj_cls, self.ctxt, name=obj_utils.StringContains('con'))
|
|
self.assertEqual(2, len(objs))
|
|
self.assertIn(obj1, objs)
|
|
self.assertIn(obj2, objs)
|
|
self.assertNotIn(obj3, objs)
|
|
|
|
def test_get_objects_with_string_matching_filters_starts(self):
|
|
obj1 = api.create_object(self.obj_cls, self.ctxt, {'name': 'pre_obj1'})
|
|
obj2 = api.create_object(self.obj_cls, self.ctxt, {'name': 'pre_obj2'})
|
|
obj3 = api.create_object(self.obj_cls, self.ctxt, {'name': 'obj_3'})
|
|
|
|
objs = api.get_objects(
|
|
self.obj_cls, self.ctxt, name=obj_utils.StringStarts('pre'))
|
|
self.assertEqual(2, len(objs))
|
|
self.assertIn(obj1, objs)
|
|
self.assertIn(obj2, objs)
|
|
self.assertNotIn(obj3, objs)
|
|
|
|
def test_get_objects_with_string_matching_filters_ends(self):
|
|
obj1 = api.create_object(self.obj_cls, self.ctxt, {'name': 'obj1_end'})
|
|
obj2 = api.create_object(self.obj_cls, self.ctxt, {'name': 'obj2_end'})
|
|
obj3 = api.create_object(self.obj_cls, self.ctxt, {'name': 'obj_3'})
|
|
|
|
objs = api.get_objects(
|
|
self.obj_cls, self.ctxt, name=obj_utils.StringEnds('end'))
|
|
self.assertEqual(2, len(objs))
|
|
self.assertIn(obj1, objs)
|
|
self.assertIn(obj2, objs)
|
|
self.assertNotIn(obj3, objs)
|
|
|
|
def test_get_values_with_None_value_in_filters(self):
|
|
api.create_object(self.obj_cls, self.ctxt, {'name': 'foo'})
|
|
values = api.get_values(
|
|
self.obj_cls, self.ctxt, 'name', name='foo', status=None)
|
|
self.assertEqual('foo', values[0])
|
|
|
|
def test_get_values_with_string_matching_filters_contains(self):
|
|
api.create_object(
|
|
self.obj_cls, self.ctxt, {'name': 'obj_con_1'})
|
|
api.create_object(
|
|
self.obj_cls, self.ctxt, {'name': 'obj_con_2'})
|
|
api.create_object(
|
|
self.obj_cls, self.ctxt, {'name': 'obj_3'})
|
|
|
|
values = api.get_values(
|
|
self.obj_cls, self.ctxt, 'name',
|
|
name=obj_utils.StringContains('con'))
|
|
self.assertEqual(2, len(values))
|
|
self.assertIn('obj_con_1', values)
|
|
self.assertIn('obj_con_2', values)
|
|
self.assertNotIn('obj_3', values)
|
|
|
|
def test_get_values_with_string_matching_filters_starts(self):
|
|
api.create_object(self.obj_cls, self.ctxt, {'name': 'pre_obj1'})
|
|
api.create_object(self.obj_cls, self.ctxt, {'name': 'pre_obj2'})
|
|
api.create_object(self.obj_cls, self.ctxt, {'name': 'obj_3'})
|
|
|
|
values = api.get_values(
|
|
self.obj_cls, self.ctxt, 'name',
|
|
name=obj_utils.StringStarts('pre'))
|
|
self.assertEqual(2, len(values))
|
|
self.assertIn('pre_obj1', values)
|
|
self.assertIn('pre_obj2', values)
|
|
self.assertNotIn('obj_3', values)
|
|
|
|
def test_get_values_with_string_matching_filters_ends(self):
|
|
api.create_object(self.obj_cls, self.ctxt, {'name': 'obj1_end'})
|
|
api.create_object(self.obj_cls, self.ctxt, {'name': 'obj2_end'})
|
|
api.create_object(self.obj_cls, self.ctxt, {'name': 'obj_3'})
|
|
|
|
values = api.get_values(
|
|
self.obj_cls, self.ctxt, 'name', name=obj_utils.StringEnds('end'))
|
|
self.assertEqual(2, len(values))
|
|
self.assertIn('obj1_end', values)
|
|
self.assertIn('obj2_end', values)
|
|
self.assertNotIn('obj_3', values)
|
|
|
|
def test_get_object_create_update_delete(self):
|
|
obj = api.create_object(self.obj_cls, self.ctxt, {'name': 'foo'})
|
|
|
|
new_obj = api.get_object(self.obj_cls, self.ctxt, id=obj.id)
|
|
self.assertEqual(obj, new_obj)
|
|
|
|
obj = new_obj
|
|
api.update_object(self.obj_cls, self.ctxt, {'name': 'bar'}, id=obj.id)
|
|
|
|
new_obj = api.get_object(self.obj_cls, self.ctxt, id=obj.id)
|
|
self.assertEqual(obj, new_obj)
|
|
|
|
obj = new_obj
|
|
api.delete_object(self.obj_cls, self.ctxt, id=obj.id)
|
|
|
|
new_obj = api.get_object(self.obj_cls, self.ctxt, id=obj.id)
|
|
self.assertIsNone(new_obj)
|
|
|
|
# delete_object raises an exception on missing object
|
|
self.assertRaises(
|
|
n_exc.ObjectNotFound,
|
|
api.delete_object, self.obj_cls, self.ctxt, id=obj.id)
|
|
|
|
# but delete_objects does not not
|
|
api.delete_objects(self.obj_cls, self.ctxt, id=obj.id)
|
|
|
|
def test_delete_objects_removes_all_matching_objects(self):
|
|
# create some objects with identical description
|
|
for i in range(10):
|
|
api.create_object(
|
|
self.obj_cls, self.ctxt,
|
|
{'name': 'foo%d' % i, 'description': 'bar'})
|
|
# create some more objects with a different description
|
|
descriptions = set()
|
|
for i in range(10, 20):
|
|
desc = 'bar%d' % i
|
|
descriptions.add(desc)
|
|
api.create_object(
|
|
self.obj_cls, self.ctxt,
|
|
{'name': 'foo%d' % i, 'description': desc})
|
|
# make sure that all objects are in the database
|
|
self.assertEqual(20, api.count(self.obj_cls, self.ctxt))
|
|
# now delete just those with the 'bar' description
|
|
api.delete_objects(self.obj_cls, self.ctxt, description='bar')
|
|
|
|
# check that half of objects are gone, and remaining have expected
|
|
# descriptions
|
|
objs = api.get_objects(self.obj_cls, self.ctxt)
|
|
self.assertEqual(10, len(objs))
|
|
self.assertEqual(
|
|
descriptions,
|
|
{obj.description for obj in objs})
|