async def test_set_configuration(self):
"""Test that purge's set_configuration returns configuration item with key 'PURGE_READ' """
@asyncio.coroutine
def mock_cm_return():
return ""
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
with patch.object(FledgeProcess, '__init__'):
with patch.object(mockAuditLogger, "__init__", return_value=None):
p = Purge()
p._storage = MagicMock(spec=StorageClientAsync)
mock_cm = ConfigurationManager(p._storage)
with patch.object(
mock_cm, 'create_category',
return_value=mock_cm_return()) as mock_create_cat:
with patch.object(mock_cm,
'create_child_category',
return_value=mock_cm_return()
) as mock_create_child_cat:
with patch.object(
mock_cm,
'get_category_all_items',
return_value=mock_cm_return()) as mock_get_cat:
await p.set_configuration()
mock_get_cat.assert_called_once_with('PURGE_READ')
mock_create_child_cat.assert_called_once_with(
'Utilities', ['PURGE_READ'])
args, kwargs = mock_create_cat.call_args
assert 4 == len(args)
assert 5 == len(args[1].keys())
assert 'PURGE_READ' == args[0]
assert 'Purge the readings, log, statistics history table' == args[
2]
assert args[3] is True
async def test_purge_error_storage_response(self, conf, expected_return):
"""Test that purge_data logs error when storage purge returns an error response"""
@asyncio.coroutine
def mock_audit_info():
return ""
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
with patch.object(FledgeProcess, '__init__'):
with patch.object(mockAuditLogger, "__init__", return_value=None):
p = Purge()
p._logger = logger
p._logger.info = MagicMock()
p._logger.error = MagicMock()
p._storage_async = MagicMock(spec=StorageClientAsync)
p._readings_storage_async = MagicMock(
spec=ReadingsStorageClientAsync)
audit = p._audit
with patch.object(
p._storage_async,
"query_tbl_with_payload",
return_value=q_result('streams')) as patch_storage:
with patch.object(p._readings_storage_async,
'purge',
side_effect=self.store_purge):
with patch.object(audit,
'information',
return_value=mock_audit_info()):
assert expected_return == await p.purge_data(conf)
assert patch_storage.called
assert 1 == patch_storage.call_count
async def test_run_exception(self, event_loop):
"""Test that run calls all units of purge process and checks the exception handling"""
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
@asyncio.coroutine
def mock_config():
return "Some config"
@asyncio.coroutine
def mock_purge():
raise Exception()
with patch.object(FledgeProcess, '__init__'):
with patch.object(mockAuditLogger, "__init__", return_value=None):
p = Purge()
p._logger.exception = MagicMock()
with patch.object(p,
'set_configuration',
return_value=mock_config()):
with patch.object(p,
'purge_data',
return_value=mock_purge()):
with patch.object(p, 'write_statistics'):
await p.run()
# Test the negative case when function purge_data raise some exception
p._logger.exception.assert_called_once_with("")
async def test_run(self):
"""Test that run calls all units of purge process"""
@asyncio.coroutine
def mock_config():
return "Some config"
@asyncio.coroutine
def mock_purge():
return 1, 2
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
with patch.object(FledgeProcess, '__init__'):
with patch.object(mockAuditLogger, "__init__", return_value=None):
p = Purge()
p._logger.exception = MagicMock()
with patch.object(
p, 'set_configuration',
return_value=mock_config()) as mock_set_config:
with patch.object(
p, 'purge_data',
return_value=mock_purge()) as mock_purge_data:
with patch.object(
p, 'write_statistics') as mock_write_stats:
await p.run()
# Test the positive case when no error in try block
mock_write_stats.assert_called_once_with(1, 2)
mock_purge_data.assert_called_once_with("Some config")
mock_set_config.assert_called_once_with()
async def _purge_instance():
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
with patch.object(FledgeProcess, "__init__"):
with patch.object(logger, "setup"):
with patch.object(mockAuditLogger, "__init__", return_value=None):
p = Purge()
return p
async def test_purge_data(self, conf, expected_return, expected_calls):
"""Test that purge_data calls Storage's purge with defined configuration"""
@asyncio.coroutine
def mock_audit_info():
return ""
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
with patch.object(FledgeProcess, '__init__'):
with patch.object(mockAuditLogger, "__init__", return_value=None):
p = Purge()
p._logger = logger
p._logger.info = MagicMock()
p._logger.error = MagicMock()
p._storage_async = MagicMock(spec=StorageClientAsync)
p._readings_storage_async = MagicMock(
spec=ReadingsStorageClientAsync)
audit = p._audit
with patch.object(
p._storage_async,
"query_tbl_with_payload",
return_value=q_result('streams')) as patch_storage:
with patch.object(p._readings_storage_async,
'purge',
side_effect=self.store_purge
) as mock_storage_purge:
with patch.object(
audit,
'information',
return_value=mock_audit_info()) as audit_info:
# Test the positive case when all if conditions in purge_data pass
assert expected_return == await p.purge_data(conf)
assert audit_info.called
args, kwargs = mock_storage_purge.call_args
assert kwargs == expected_calls
assert patch_storage.called
assert 1 == patch_storage.call_count
args, kwargs = patch_storage.call_args
assert (
'streams',
'{"aggregate": {"operation": "min", "column": "last_object"}}'
) == args
def test_init(self):
"""Test that creating an instance of Purge calls init of FledgeProcess and creates loggers"""
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
with patch.object(FledgeProcess, "__init__") as mock_process:
with patch.object(logger, "setup") as log:
with patch.object(mockAuditLogger,
"__init__",
return_value=None):
p = Purge()
assert isinstance(p, Purge)
assert isinstance(p._audit, AuditLogger)
log.assert_called_once_with("Data Purge")
mock_process.assert_called_once_with()
async def test_purge_data_invalid_conf(self, conf, expected_error_key):
"""Test that purge_data raises exception when called with invalid configuration"""
@asyncio.coroutine
def mock_audit_info():
return ""
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
with patch.object(FledgeProcess, '__init__'):
with patch.object(mockAuditLogger, "__init__", return_value=None):
p = Purge()
p._logger = logger
p._logger.info = MagicMock()
p._logger.error = MagicMock()
p._storage_async = MagicMock(spec=StorageClientAsync)
p._readings_storage_async = MagicMock(
spec=ReadingsStorageClientAsync)
audit = p._audit
with patch.object(
p._storage_async,
"query_tbl_with_payload",
return_value=q_result('streams')) as patch_storage:
with patch.object(p._readings_storage_async,
'purge',
side_effect=self.store_purge):
with patch.object(audit,
'information',
return_value=mock_audit_info()):
# Test the code block when purge failed because of invalid configuration
await p.purge_data(conf)
p._logger.error.assert_called_with(
'Configuration item {} bla should be integer!'.
format(expected_error_key))
assert patch_storage.called
assert 1 == patch_storage.call_count
async def test_write_statistics(self):
"""Test that write_statistics calls update statistics with defined keys and value increments"""
@asyncio.coroutine
def mock_s_update():
return ""
mockStorageClientAsync = MagicMock(spec=StorageClientAsync)
mockAuditLogger = AuditLogger(mockStorageClientAsync)
with patch.object(FledgeProcess, '__init__'):
with patch.object(Statistics,
'_load_keys',
return_value=mock_s_update()):
with patch.object(
Statistics, 'update',
return_value=mock_s_update()) as mock_stats_update:
with patch.object(mockAuditLogger,
"__init__",
return_value=None):
p = Purge()
p._storage_async = mockStorageClientAsync
await p.write_statistics(1, 2)
mock_stats_update.assert_has_calls(
[call('PURGED', 1),
call('UNSNPURGED', 2)])
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# FLEDGE_BEGIN
# See: http://fledge.readthedocs.io/
# FLEDGE_END
"""Purge process starter"""
import asyncio
from fledge.tasks.purge.purge import Purge
from fledge.common import logger
__author__ = "Terris Linenbach, Vaibhav Singhal"
__copyright__ = "Copyright (c) 2017 OSIsoft, LLC"
__license__ = "Apache 2.0"
__version__ = "${VERSION}"
if __name__ == '__main__':
_logger = logger.setup("Purge")
loop = asyncio.get_event_loop()
purge_process = Purge()
loop.run_until_complete(purge_process.run())
