Arnike/watcher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added goal+strategy ObjectField for AuditTemplate

Browse Source 
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: I97418163f68aea2f1cda80be94e4035f0b3700ae
Partially-Implements: blueprint watcher-versioned-objects
This commit is contained in:
Vincent Françoise
2016-10-03 12:01:51 +02:00
parent f54aca70cc
commit 54cf10b41c
9 changed files with 234 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
watcher/tests/api/v1/test_audit_templates.py
View File

@@ -305,6 +305,7 @@ class TestPatch(FunctionalTestWithSetup):
def setUp(self):
super(TestPatch, self).setUp()
obj_utils.create_test_goal(self.context)
self.audit_template = obj_utils.create_test_audit_template(
self.context, strategy_id=None)
@@ -598,6 +599,7 @@ class TestDelete(api_base.FunctionalTest):
def setUp(self):
super(TestDelete, self).setUp()
obj_utils.create_test_goal(self.context)
self.audit_template = obj_utils.create_test_audit_template(
self.context)
@@ -656,7 +658,7 @@ class TestDelete(api_base.FunctionalTest):
self.assertTrue(response.json['error_message'])
class TestAuaditTemplatePolicyEnforcement(api_base.FunctionalTest):
class TestAuditTemplatePolicyEnforcement(api_base.FunctionalTest):
def _common_policy_check(self, rule, func, *arg, **kwarg):
self.policy.set_rules({
@@ -676,6 +678,7 @@ class TestAuaditTemplatePolicyEnforcement(api_base.FunctionalTest):
expect_errors=True)
def test_policy_disallow_get_one(self):
obj_utils.create_test_goal(self.context)
audit_template = obj_utils.create_test_audit_template(self.context)
self._common_policy_check(
"audit_template:get", self.get_json,
@@ -689,6 +692,7 @@ class TestAuaditTemplatePolicyEnforcement(api_base.FunctionalTest):
expect_errors=True)
def test_policy_disallow_update(self):
obj_utils.create_test_goal(self.context)
audit_template = obj_utils.create_test_audit_template(self.context)
self._common_policy_check(
"audit_template:update", self.patch_json,
@@ -713,6 +717,7 @@ class TestAuaditTemplatePolicyEnforcement(api_base.FunctionalTest):
audit_template_dict, expect_errors=True)
def test_policy_disallow_delete(self):
obj_utils.create_test_goal(self.context)
audit_template = obj_utils.create_test_audit_template(self.context)
self._common_policy_check(
"audit_template:delete", self.delete,

10
watcher/tests/api/v1/test_audits.py
View File

@@ -78,9 +78,9 @@ class TestListAudit(api_base.FunctionalTest):
def setUp(self):
super(TestListAudit, self).setUp()
obj_utils.create_test_audit_template(self.context)
obj_utils.create_test_goal(self.context)
obj_utils.create_test_strategy(self.context)
obj_utils.create_test_audit_template(self.context)
def test_empty(self):
response = self.get_json('/audits')
@@ -249,6 +249,8 @@ class TestPatch(api_base.FunctionalTest):
def setUp(self):
super(TestPatch, self).setUp()
obj_utils.create_test_goal(self.context)
obj_utils.create_test_strategy(self.context)
obj_utils.create_test_audit_template(self.context)
self.audit = obj_utils.create_test_audit(self.context, )
p = mock.patch.object(db_api.BaseConnection, 'update_audit')
@@ -345,9 +347,9 @@ class TestPost(api_base.FunctionalTest):
def setUp(self):
super(TestPost, self).setUp()
obj_utils.create_test_audit_template(self.context)
obj_utils.create_test_goal(self.context)
obj_utils.create_test_strategy(self.context)
obj_utils.create_test_audit_template(self.context)
p = mock.patch.object(db_api.BaseConnection, 'create_audit')
self.mock_create_audit = p.start()
self.mock_create_audit.side_effect = (
@@ -640,6 +642,8 @@ class TestDelete(api_base.FunctionalTest):
def setUp(self):
super(TestDelete, self).setUp()
obj_utils.create_test_goal(self.context)
obj_utils.create_test_strategy(self.context)
obj_utils.create_test_audit_template(self.context)
self.audit = obj_utils.create_test_audit(self.context)
p = mock.patch.object(db_api.BaseConnection, 'update_audit')
@@ -677,7 +681,7 @@ class TestDelete(api_base.FunctionalTest):
self.assertTrue(response.json['error_message'])
class TestAuaditPolicyEnforcement(api_base.FunctionalTest):
class TestAuditPolicyEnforcement(api_base.FunctionalTest):
def _common_policy_check(self, rule, func, *arg, **kwarg):
self.policy.set_rules({

10
watcher/tests/db/test_audit_template.py
View File

@@ -225,6 +225,11 @@ class TestDbAuditTemplateFilters(base.DbTestCase):
class DbAuditTemplateTestCase(base.DbTestCase):
def _create_test_goal(self, **kwargs):
goal = utils.get_test_goal(**kwargs)
self.dbapi.create_goal(goal)
return goal
def _create_test_audit_template(self, **kwargs):
audit_template = utils.get_test_audit_template(**kwargs)
self.dbapi.create_audit_template(audit_template)
@@ -268,18 +273,19 @@ class DbAuditTemplateTestCase(base.DbTestCase):
strategy.as_dict(), eager_audit_template.strategy.as_dict())
def test_get_audit_template_list_with_filters(self):
goal = self._create_test_goal(name='DUMMY')
audit_template1 = self._create_test_audit_template(
id=1,
uuid=w_utils.generate_uuid(),
name='My Audit Template 1',
description='Description of my audit template 1',
goal='DUMMY')
goal_id=goal['id'])
audit_template2 = self._create_test_audit_template(
id=2,
uuid=w_utils.generate_uuid(),
name='My Audit Template 2',
description='Description of my audit template 2',
goal='DUMMY')
goal_id=goal['id'])
res = self.dbapi.get_audit_template_list(
self.context, filters={'name': 'My Audit Template 1'})

4
watcher/tests/db/test_purge.py
View File

@@ -265,7 +265,7 @@ class TestPurgeCommand(base.DbTestCase):
with freezegun.freeze_time(self.fake_today):
# orphan audit template
audit_template4 = obj_utils.create_test_audit_template(
self.context, goal_id=404, # Does not exist
self.context, goal_id=self.goal2.id, # Does not exist
name=self.generate_unique_name(prefix="Audit Template 4 "),
strategy_id=None, id=self._generate_id(),
uuid=utils.generate_uuid())
@@ -362,7 +362,7 @@ class TestPurgeCommand(base.DbTestCase):
with freezegun.freeze_time(self.fake_today):
# orphan audit template
audit_template4 = obj_utils.create_test_audit_template(
self.context, goal_id=404, # Does not exist
self.context, goal_id=self.goal2.id, # Does not exist
name=self.generate_unique_name(prefix="Audit Template 4 "),
strategy_id=None, id=self._generate_id(),
uuid=utils.generate_uuid())

11
watcher/tests/db/utils.py
View File

@@ -21,7 +21,7 @@ from watcher import objects
def get_test_audit_template(**kwargs):
return {
audit_template_data = {
'id': kwargs.get('id', 1),
'uuid': kwargs.get('uuid', 'e74c40e0-d825-11e2-a28f-0800200c9a66'),
'goal_id': kwargs.get('goal_id', 1),
@@ -34,6 +34,15 @@ def get_test_audit_template(**kwargs):
'deleted_at': kwargs.get('deleted_at'),
}
# ObjectField doesn't allow None nor dict, so if we want to simulate a
# non-eager object loading, the field should not be referenced at all.
if kwargs.get('goal'):
audit_template_data['goal'] = kwargs.get('goal')
if kwargs.get('strategy'):
audit_template_data['strategy'] = kwargs.get('strategy')
return audit_template_data
def create_test_audit_template(**kwargs):
"""Create test audit template entry in DB and return AuditTemplate DB object.

1
watcher/tests/decision_engine/messaging/test_audit_endpoint.py
View File

@@ -27,6 +27,7 @@ from watcher.tests.objects import utils as obj_utils
class TestAuditEndpoint(base.DbTestCase):
def setUp(self):
super(TestAuditEndpoint, self).setUp()
self.goal = obj_utils.create_test_goal(self.context)
self.audit_template = obj_utils.create_test_audit_template(
self.context)
self.audit = obj_utils.create_test_audit(

258
watcher/tests/objects/test_audit_template.py
View File

@@ -17,6 +17,7 @@ import mock
from watcher.common import exception
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
@@ -24,135 +25,172 @@ from watcher.tests.db import utils
class TestAuditTemplateObject(base.DbTestCase):
goal_id = 1
goal_data = utils.get_test_goal(
id=goal_id, uuid=w_utils.generate_uuid(), name="DUMMY")
scenarios = [
('non_eager', dict(
eager=False,
fake_audit_template=utils.get_test_audit_template(
goal_id=goal_id))),
('eager_with_non_eager_load', dict(
eager=True,
fake_audit_template=utils.get_test_audit_template(
goal_id=goal_id))),
('eager_with_eager_load', dict(
eager=True,
fake_audit_template=utils.get_test_audit_template(
goal_id=goal_id, goal=goal_data))),
]
def setUp(self):
super(TestAuditTemplateObject, self).setUp()
self.fake_audit_template = utils.get_test_audit_template()
self.fake_goal1 = utils.create_test_goal(
id=1, uuid=w_utils.generate_uuid(), name="DUMMY")
self.fake_goal2 = utils.create_test_goal(
id=2, uuid=w_utils.generate_uuid(), name="BALANCE_LOAD")
self.fake_goal = utils.create_test_goal(**self.goal_data)
def test_get_by_id(self):
def eager_load_audit_template_assert(self, audit_template, goal):
if self.eager:
self.assertIsNotNone(audit_template.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_template.goal.as_dict().items()
if k in fields_to_check}
self.assertEqual(db_data, object_data)
@mock.patch.object(db_api.Connection, 'get_audit_template_by_id')
def test_get_by_id(self, mock_get_audit_template):
mock_get_audit_template.return_value = self.fake_audit_template
audit_template_id = self.fake_audit_template['id']
with mock.patch.object(self.dbapi, 'get_audit_template_by_id',
autospec=True) as mock_get_audit_template:
mock_get_audit_template.return_value = self.fake_audit_template
audit_template = objects.AuditTemplate.get(self.context,
audit_template_id)
mock_get_audit_template.assert_called_once_with(
self.context, audit_template_id)
self.assertEqual(self.context, audit_template._context)
audit_template = objects.AuditTemplate.get(
self.context, audit_template_id, eager=self.eager)
mock_get_audit_template.assert_called_once_with(
self.context, audit_template_id, eager=self.eager)
self.assertEqual(self.context, audit_template._context)
self.eager_load_audit_template_assert(audit_template, self.fake_goal)
def test_get_by_uuid(self):
@mock.patch.object(db_api.Connection, 'get_audit_template_by_uuid')
def test_get_by_uuid(self, mock_get_audit_template):
mock_get_audit_template.return_value = self.fake_audit_template
uuid = self.fake_audit_template['uuid']
with mock.patch.object(self.dbapi, 'get_audit_template_by_uuid',
autospec=True) as mock_get_audit_template:
mock_get_audit_template.return_value = self.fake_audit_template
audit_template = objects.AuditTemplate.get(self.context, uuid)
mock_get_audit_template.assert_called_once_with(self.context, uuid)
self.assertEqual(self.context, audit_template._context)
audit_template = objects.AuditTemplate.get(
self.context, uuid, eager=self.eager)
mock_get_audit_template.assert_called_once_with(
self.context, uuid, eager=self.eager)
self.assertEqual(self.context, audit_template._context)
self.eager_load_audit_template_assert(audit_template, self.fake_goal)
def test_get_by_name(self):
@mock.patch.object(db_api.Connection, 'get_audit_template_by_name')
def test_get_by_name(self, mock_get_audit_template):
mock_get_audit_template.return_value = self.fake_audit_template
name = self.fake_audit_template['name']
with mock.patch.object(self.dbapi, 'get_audit_template_by_name',
autospec=True) as mock_get_audit_template:
mock_get_audit_template.return_value = self.fake_audit_template
audit_template = objects.AuditTemplate.get_by_name(
self.context,
name)
mock_get_audit_template.assert_called_once_with(self.context, name)
self.assertEqual(self.context, audit_template._context)
audit_template = objects.AuditTemplate.get_by_name(
self.context, name, eager=self.eager)
mock_get_audit_template.assert_called_once_with(
self.context, name, eager=self.eager)
self.assertEqual(self.context, audit_template._context)
self.eager_load_audit_template_assert(audit_template, self.fake_goal)
def test_get_bad_id_and_uuid(self):
self.assertRaises(exception.InvalidIdentity,
objects.AuditTemplate.get,
self.context, 'not-a-uuid')
self.context, 'not-a-uuid', eager=self.eager)
def test_list(self):
with mock.patch.object(self.dbapi, 'get_audit_template_list',
autospec=True) as mock_get_list:
mock_get_list.return_value = [self.fake_audit_template]
audit_templates = objects.AuditTemplate.list(self.context)
self.assertEqual(1, mock_get_list.call_count)
self.assertEqual(1, len(audit_templates))
self.assertIsInstance(audit_templates[0], objects.AuditTemplate)
self.assertEqual(self.context, audit_templates[0]._context)
@mock.patch.object(db_api.Connection, 'get_audit_template_list')
def test_list(self, mock_get_list):
mock_get_list.return_value = [self.fake_audit_template]
audit_templates = objects.AuditTemplate.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(audit_templates))
self.assertIsInstance(audit_templates[0], objects.AuditTemplate)
self.assertEqual(self.context, audit_templates[0]._context)
for audit_template in audit_templates:
self.eager_load_audit_template_assert(
audit_template, self.fake_goal)
def test_create(self):
with mock.patch.object(self.dbapi, 'create_audit_template',
autospec=True) as mock_create_audit_template:
mock_create_audit_template.return_value = self.fake_audit_template
audit_template = objects.AuditTemplate(self.context,
**self.fake_audit_template)
audit_template.create()
mock_create_audit_template.assert_called_once_with(
self.fake_audit_template)
self.assertEqual(self.context, audit_template._context)
def test_destroy(self):
@mock.patch.object(db_api.Connection, 'update_audit_template')
@mock.patch.object(db_api.Connection, 'get_audit_template_by_uuid')
def test_save(self, mock_get_audit_template, mock_update_audit_template):
mock_get_audit_template.return_value = self.fake_audit_template
uuid = self.fake_audit_template['uuid']
with mock.patch.object(self.dbapi, 'get_audit_template_by_uuid',
autospec=True) as mock_get_audit_template:
mock_get_audit_template.return_value = self.fake_audit_template
with mock.patch.object(self.dbapi, 'destroy_audit_template',
autospec=True) \
as mock_destroy_audit_template:
audit_template = objects.AuditTemplate.get_by_uuid(
self.context, uuid)
audit_template.destroy()
mock_get_audit_template.assert_called_once_with(
self.context, uuid)
mock_destroy_audit_template.assert_called_once_with(uuid)
self.assertEqual(self.context, audit_template._context)
audit_template = objects.AuditTemplate.get_by_uuid(
self.context, uuid, eager=self.eager)
audit_template.goal_id = self.fake_goal.id
audit_template.save()
def test_save(self):
mock_get_audit_template.assert_called_once_with(
self.context, uuid, eager=self.eager)
mock_update_audit_template.assert_called_once_with(
uuid, {'goal_id': self.fake_goal.id})
self.assertEqual(self.context, audit_template._context)
self.eager_load_audit_template_assert(audit_template, self.fake_goal)
@mock.patch.object(db_api.Connection, 'get_audit_template_by_uuid')
def test_refresh(self, mock_get_audit_template):
returns = [dict(self.fake_audit_template, name="first name"),
dict(self.fake_audit_template, name="second name")]
mock_get_audit_template.side_effect = returns
uuid = self.fake_audit_template['uuid']
with mock.patch.object(self.dbapi, 'get_audit_template_by_uuid',
autospec=True) as mock_get_audit_template:
mock_get_audit_template.return_value = self.fake_audit_template
with mock.patch.object(self.dbapi, 'update_audit_template',
autospec=True) \
as mock_update_audit_template:
audit_template = objects.AuditTemplate.get_by_uuid(
self.context, uuid)
audit_template.goal_id = self.fake_goal1.id
audit_template.save()
expected = [mock.call(self.context, uuid, eager=self.eager),
mock.call(self.context, uuid, eager=self.eager)]
audit_template = objects.AuditTemplate.get(
self.context, uuid, eager=self.eager)
self.assertEqual("first name", audit_template.name)
audit_template.refresh(eager=self.eager)
self.assertEqual("second name", audit_template.name)
self.assertEqual(expected, mock_get_audit_template.call_args_list)
self.assertEqual(self.context, audit_template._context)
self.eager_load_audit_template_assert(audit_template, self.fake_goal)
mock_get_audit_template.assert_called_once_with(
self.context, uuid)
mock_update_audit_template.assert_called_once_with(
uuid, {'goal_id': self.fake_goal1.id})
self.assertEqual(self.context, audit_template._context)
def test_refresh(self):
class TestCreateDeleteAuditTemplateObject(base.DbTestCase):
def setUp(self):
super(TestCreateDeleteAuditTemplateObject, self).setUp()
self.fake_audit_template = utils.get_test_audit_template()
@mock.patch.object(db_api.Connection, 'create_audit_template')
def test_create(self, mock_create_audit_template):
goal = utils.create_test_goal()
self.fake_audit_template['goal_id'] = goal.id
mock_create_audit_template.return_value = self.fake_audit_template
audit_template = objects.AuditTemplate(
self.context, **self.fake_audit_template)
audit_template.create()
mock_create_audit_template.assert_called_once_with(
self.fake_audit_template)
self.assertEqual(self.context, audit_template._context)
@mock.patch.object(db_api.Connection, 'soft_delete_audit_template')
@mock.patch.object(db_api.Connection, 'get_audit_template_by_uuid')
def test_soft_delete(self, mock_get_audit_template,
mock_soft_delete_audit_template):
mock_get_audit_template.return_value = self.fake_audit_template
uuid = self.fake_audit_template['uuid']
returns = [dict(self.fake_audit_template,
goal_id=self.fake_goal1.id),
dict(self.fake_audit_template, goal_id=self.fake_goal2.id)]
expected = [mock.call(self.context, uuid),
mock.call(self.context, uuid)]
with mock.patch.object(self.dbapi, 'get_audit_template_by_uuid',
side_effect=returns,
autospec=True) as mock_get_audit_template:
audit_template = objects.AuditTemplate.get(self.context, uuid)
self.assertEqual(1, audit_template.goal_id)
audit_template.refresh()
self.assertEqual(2, audit_template.goal_id)
self.assertEqual(expected, mock_get_audit_template.call_args_list)
self.assertEqual(self.context, audit_template._context)
audit_template = objects.AuditTemplate.get_by_uuid(self.context, uuid)
audit_template.soft_delete()
mock_get_audit_template.assert_called_once_with(
self.context, uuid, eager=False)
mock_soft_delete_audit_template.assert_called_once_with(uuid)
self.assertEqual(self.context, audit_template._context)
def test_soft_delete(self):
@mock.patch.object(db_api.Connection, 'destroy_audit_template')
@mock.patch.object(db_api.Connection, 'get_audit_template_by_uuid')
def test_destroy(self, mock_get_audit_template,
mock_destroy_audit_template):
mock_get_audit_template.return_value = self.fake_audit_template
uuid = self.fake_audit_template['uuid']
with mock.patch.object(self.dbapi, 'get_audit_template_by_uuid',
autospec=True) as mock_get_audit_template:
mock_get_audit_template.return_value = self.fake_audit_template
with mock.patch.object(self.dbapi, 'soft_delete_audit_template',
autospec=True) \
as mock_soft_delete_audit_template:
audit_template = objects.AuditTemplate.get_by_uuid(
self.context, uuid)
audit_template.soft_delete()
mock_get_audit_template.assert_called_once_with(
self.context, uuid)
mock_soft_delete_audit_template.assert_called_once_with(uuid)
self.assertEqual(self.context, audit_template._context)
audit_template = objects.AuditTemplate.get_by_uuid(self.context, uuid)
audit_template.destroy()
mock_get_audit_template.assert_called_once_with(
self.context, uuid, eager=False)
mock_destroy_audit_template.assert_called_once_with(uuid)
self.assertEqual(self.context, audit_template._context)

2
watcher/tests/objects/test_objects.py
View File

@@ -411,7 +411,7 @@ class TestObject(_LocalTest, _TestObject):
expected_object_fingerprints = {
'Goal': '1.0-93881622db05e7b67a65ca885b4a022e',
'Strategy': '1.1-73f164491bdd4c034f48083a51bdeb7b',
'AuditTemplate': '1.0-7432ee4d3ce0c7cbb9d11a4565ee8eb6',
'AuditTemplate': '1.1-b291973ffc5efa2c61b24fe34fdccc0b',
'Audit': '1.0-ebfc5360d019baf583a10a8a27071c97',
'ActionPlan': '1.0-cc76fd7f0e8479aeff817dd266341de4',
'Action': '1.0-a78f69c0da98e13e601f9646f6b2f883',