Added goal & strategy ObjectField for Audit

In this changeset, I added the "goal" and the "strategy "ObjectField
which can either be loaded by setting the new "eager" parameter as True
or not loaded (as before) by setting it to False.
The advantage of introducing this eager parameter is that this way,
we can reduce to a minimum the overhead of DB queries whenever the
related goal is not actually needed.

Change-Id: I5a1b25e395e3d904dae954952f8e0862c3556210
Partially-Implements: blueprint watcher-versioned-objects
This commit is contained in:
Vincent Françoise
2016-10-03 16:02:49 +02:00
parent 54cf10b41c
commit f9df54c555
7 changed files with 206 additions and 100 deletions

View File

@@ -14,8 +14,10 @@
# under the License.
import mock
from watcher.common import exception
# from watcher.common import utils as w_utils
from watcher.common import utils as w_utils
from watcher.db.sqlalchemy import api as db_api
from watcher import objects
from watcher.tests.db import base
from watcher.tests.db import utils
@@ -23,94 +25,154 @@ from watcher.tests.db import utils
class TestAuditObject(base.DbTestCase):
goal_id = 2
goal_data = utils.get_test_goal(
id=goal_id, uuid=w_utils.generate_uuid(), name="DUMMY")
scenarios = [
('non_eager', dict(
eager=False,
fake_audit=utils.get_test_audit(
goal_id=goal_id))),
('eager_with_non_eager_load', dict(
eager=True,
fake_audit=utils.get_test_audit(
goal_id=goal_id))),
('eager_with_eager_load', dict(
eager=True,
fake_audit=utils.get_test_audit(goal_id=goal_id, goal=goal_data))),
]
def setUp(self):
super(TestAuditObject, self).setUp()
self.fake_audit = utils.get_test_audit()
self.fake_goal = utils.create_test_goal(**self.goal_data)
def test_get_by_id(self):
def eager_load_audit_assert(self, audit, goal):
if self.eager:
self.assertIsNotNone(audit.goal)
fields_to_check = set(
super(objects.Goal, objects.Goal).fields
).symmetric_difference(objects.Goal.fields)
db_data = {
k: v for k, v in goal.as_dict().items()
if k in fields_to_check}
object_data = {
k: v for k, v in audit.goal.as_dict().items()
if k in fields_to_check}
self.assertEqual(db_data, object_data)
@mock.patch.object(db_api.Connection, 'get_audit_by_id')
def test_get_by_id(self, mock_get_audit):
mock_get_audit.return_value = self.fake_audit
audit_id = self.fake_audit['id']
with mock.patch.object(self.dbapi, 'get_audit_by_id',
autospec=True) as mock_get_audit:
mock_get_audit.return_value = self.fake_audit
audit = objects.Audit.get(self.context, audit_id)
mock_get_audit.assert_called_once_with(self.context,
audit_id)
self.assertEqual(self.context, audit._context)
audit = objects.Audit.get(self.context, audit_id, eager=self.eager)
mock_get_audit.assert_called_once_with(
self.context, audit_id, eager=self.eager)
self.assertEqual(self.context, audit._context)
self.eager_load_audit_assert(audit, self.fake_goal)
def test_get_by_uuid(self):
@mock.patch.object(db_api.Connection, 'get_audit_by_uuid')
def test_get_by_uuid(self, mock_get_audit):
mock_get_audit.return_value = self.fake_audit
uuid = self.fake_audit['uuid']
with mock.patch.object(self.dbapi, 'get_audit_by_uuid',
autospec=True) as mock_get_audit:
mock_get_audit.return_value = self.fake_audit
audit = objects.Audit.get(self.context, uuid)
mock_get_audit.assert_called_once_with(self.context, uuid)
self.assertEqual(self.context, audit._context)
audit = objects.Audit.get(self.context, uuid, eager=self.eager)
mock_get_audit.assert_called_once_with(
self.context, uuid, eager=self.eager)
self.assertEqual(self.context, audit._context)
self.eager_load_audit_assert(audit, self.fake_goal)
def test_get_bad_id_and_uuid(self):
self.assertRaises(exception.InvalidIdentity,
objects.Audit.get, self.context, 'not-a-uuid')
objects.Audit.get, self.context,
'not-a-uuid', eager=self.eager)
def test_list(self):
with mock.patch.object(self.dbapi, 'get_audit_list',
autospec=True) as mock_get_list:
mock_get_list.return_value = [self.fake_audit]
audits = objects.Audit.list(self.context)
self.assertEqual(1, mock_get_list.call_count, 1)
self.assertEqual(1, len(audits))
self.assertIsInstance(audits[0], objects.Audit)
self.assertEqual(self.context, audits[0]._context)
@mock.patch.object(db_api.Connection, 'get_audit_list')
def test_list(self, mock_get_list):
mock_get_list.return_value = [self.fake_audit]
audits = objects.Audit.list(self.context, eager=self.eager)
mock_get_list.assert_called_once_with(
self.context, eager=self.eager, filters=None, limit=None,
marker=None, sort_dir=None, sort_key=None)
self.assertEqual(1, len(audits))
self.assertIsInstance(audits[0], objects.Audit)
self.assertEqual(self.context, audits[0]._context)
for audit in audits:
self.eager_load_audit_assert(audit, self.fake_goal)
def test_create(self):
with mock.patch.object(self.dbapi, 'create_audit',
autospec=True) as mock_create_audit:
mock_create_audit.return_value = self.fake_audit
audit = objects.Audit(self.context, **self.fake_audit)
audit.create()
mock_create_audit.assert_called_once_with(self.fake_audit)
self.assertEqual(self.context, audit._context)
def test_destroy(self):
@mock.patch.object(db_api.Connection, 'update_audit')
@mock.patch.object(db_api.Connection, 'get_audit_by_uuid')
def test_save(self, mock_get_audit, mock_update_audit):
mock_get_audit.return_value = self.fake_audit
uuid = self.fake_audit['uuid']
with mock.patch.object(self.dbapi, 'get_audit_by_uuid',
autospec=True) as mock_get_audit:
mock_get_audit.return_value = self.fake_audit
with mock.patch.object(self.dbapi, 'destroy_audit',
autospec=True) as mock_destroy_audit:
audit = objects.Audit.get_by_uuid(self.context, uuid)
audit.destroy()
mock_get_audit.assert_called_once_with(self.context, uuid)
mock_destroy_audit.assert_called_once_with(uuid)
self.assertEqual(self.context, audit._context)
audit = objects.Audit.get_by_uuid(self.context, uuid, eager=self.eager)
audit.state = 'SUCCEEDED'
audit.save()
def test_save(self):
uuid = self.fake_audit['uuid']
with mock.patch.object(self.dbapi, 'get_audit_by_uuid',
autospec=True) as mock_get_audit:
mock_get_audit.return_value = self.fake_audit
with mock.patch.object(self.dbapi, 'update_audit',
autospec=True) as mock_update_audit:
audit = objects.Audit.get_by_uuid(self.context, uuid)
audit.state = 'SUCCEEDED'
audit.save()
mock_get_audit.assert_called_once_with(
self.context, uuid, eager=self.eager)
mock_update_audit.assert_called_once_with(
uuid, {'state': 'SUCCEEDED'})
self.assertEqual(self.context, audit._context)
self.eager_load_audit_assert(audit, self.fake_goal)
mock_get_audit.assert_called_once_with(self.context, uuid)
mock_update_audit.assert_called_once_with(
uuid, {'state': 'SUCCEEDED'})
self.assertEqual(self.context, audit._context)
def test_refresh(self):
uuid = self.fake_audit['uuid']
@mock.patch.object(db_api.Connection, 'get_audit_by_uuid')
def test_refresh(self, mock_get_audit):
returns = [dict(self.fake_audit, state="first state"),
dict(self.fake_audit, state="second state")]
expected = [mock.call(self.context, uuid),
mock.call(self.context, uuid)]
with mock.patch.object(self.dbapi, 'get_audit_by_uuid',
side_effect=returns,
autospec=True) as mock_get_audit:
audit = objects.Audit.get(self.context, uuid)
self.assertEqual("first state", audit.state)
audit.refresh()
self.assertEqual("second state", audit.state)
self.assertEqual(expected, mock_get_audit.call_args_list)
self.assertEqual(self.context, audit._context)
mock_get_audit.side_effect = returns
uuid = self.fake_audit['uuid']
expected = [
mock.call(self.context, uuid, eager=self.eager),
mock.call(self.context, uuid, eager=self.eager)]
audit = objects.Audit.get(self.context, uuid, eager=self.eager)
self.assertEqual("first state", audit.state)
audit.refresh(eager=self.eager)
self.assertEqual("second state", audit.state)
self.assertEqual(expected, mock_get_audit.call_args_list)
self.assertEqual(self.context, audit._context)
self.eager_load_audit_assert(audit, self.fake_goal)
class TestCreateDeleteAuditObject(base.DbTestCase):
def setUp(self):
super(TestCreateDeleteAuditObject, self).setUp()
self.goal_id = 1
self.fake_audit = utils.get_test_audit(goal_id=self.goal_id)
@mock.patch.object(db_api.Connection, 'create_audit')
def test_create(self, mock_create_audit):
utils.create_test_goal(id=self.goal_id)
mock_create_audit.return_value = self.fake_audit
audit = objects.Audit(self.context, **self.fake_audit)
audit.create()
mock_create_audit.assert_called_once_with(self.fake_audit)
self.assertEqual(self.context, audit._context)
@mock.patch.object(db_api.Connection, 'update_audit')
@mock.patch.object(db_api.Connection, 'soft_delete_audit')
@mock.patch.object(db_api.Connection, 'get_audit_by_uuid')
def test_soft_delete(self, mock_get_audit,
mock_soft_delete_audit, mock_update_audit):
mock_get_audit.return_value = self.fake_audit
uuid = self.fake_audit['uuid']
audit = objects.Audit.get_by_uuid(self.context, uuid)
audit.soft_delete()
mock_get_audit.assert_called_once_with(self.context, uuid, eager=False)
mock_soft_delete_audit.assert_called_once_with(uuid)
mock_update_audit.assert_called_once_with(uuid, {'state': 'DELETED'})
self.assertEqual(self.context, audit._context)
@mock.patch.object(db_api.Connection, 'destroy_audit')
@mock.patch.object(db_api.Connection, 'get_audit_by_uuid')
def test_destroy(self, mock_get_audit,
mock_destroy_audit):
mock_get_audit.return_value = self.fake_audit
uuid = self.fake_audit['uuid']
audit = objects.Audit.get_by_uuid(self.context, uuid)
audit.destroy()
mock_get_audit.assert_called_once_with(
self.context, uuid, eager=False)
mock_destroy_audit.assert_called_once_with(uuid)
self.assertEqual(self.context, audit._context)