mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 17:09:03 +00:00
0d9a06b8c6
* Add deprecation decorator scaffold * Capture type error and unhandled exceptions while function calls * Aware of the current and future version of deprecation * Implement initially is_deprecated decorator * Add an alias for the capitalization * Fix capitalization easier way * Remove an extra line * Add successor name to the deprecation decorator. * Granulate logging and error messages. * Implement function swapper * Raise later the caught exception * Clarify exception message * Save function original name * Remove an extra line * Hide an alternative hidden function name in the error message, preserving the error itself * Rename variable as private * Add a method to detect if a function is using its previous version * Message to the log and/or raise an exception accordingly to the status of used function * Log an error along with the exception * Add internal method documentation * Add documentation and usage process for decorator "is_deprecated" * Add documentation and process usage for the decorator "with_deprecated" * Hide private method name * Fix PEP8, re-word the error message * Deprecate basic uptime function * Add initial decorator unit test * Rename old/new functions, mock versions * Move frequent data to the test setup * Add logging on EOL exception * Rename and document high to low version test on is_deprecated * Implement a test on low to high version of is_deprecated decorator * Add a correction to the test description * Remove a dead code * Implement a test for high to low version on is_deprecated, using with_successor param * Correct typso adn mistaeks * Implement high to low version with successor param on is_deprecated * Setup a virtual name for the module * Implement test for with_deprecated should raise an exception if same deprecated function not found * Implement test for with_deprecated an old function is picked up if configured * Correct test description purpose * Implement test with_deprecated when no deprecation is requested * Add logging test to the configured deprecation request * Add logging testing when deprecated version wasn't requested * Implement test EOL for with_deprecated decorator * Correct test explanation * Rename the test * Implement with_deprecated no EOL, deprecated other function name * Implement with_deprecated, deprecated other function name, EOL reached * Add test description for the with_deprecated + with_name + EOL * Fix confusing test names * Add logging test to the is_deprecated decorator when function as not found. * Add more test point to each test, remove empty lines * Bugfix: at certain conditions a wrong alias name is reported to the log * Fix a typo in a comment * Add test for the logging * Disable a pylint: None will _never_ be raised * Fix test for the deprecated "status.uptime" version * Bugfix: Do not yank raised exceptions * Remove unnecessary decorator * Add test for the new uptime * Add test for the new uptime fails when /proc/uptime does not exists * Rename old test case * Skip test for the UTC time, unless freeze time is used. * Fix pylint * Fix documentation * Bugfix: proxy-pass the docstring of the decorated function * Lint fix
233 lines
8.9 KiB
Python
233 lines
8.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
'''
|
|
:codeauthor: :email:`Bo Maryniuk (bo@suse.de)`
|
|
unit.utils.decorators_test
|
|
'''
|
|
|
|
# Import Python libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Testing libs
|
|
from salttesting import TestCase
|
|
from salttesting.helpers import ensure_in_syspath
|
|
from salt.utils import decorators
|
|
from salt.version import SaltStackVersion
|
|
from salt.exceptions import CommandExecutionError
|
|
|
|
ensure_in_syspath('../../')
|
|
|
|
|
|
class DummyLogger(object):
|
|
'''
|
|
Dummy logger accepts everything and simply logs
|
|
'''
|
|
def __init__(self, messages):
|
|
self._messages = messages
|
|
|
|
def __getattr__(self, item):
|
|
return self._log
|
|
|
|
def _log(self, msg):
|
|
self._messages.append(msg)
|
|
|
|
|
|
class DecoratorsTest(TestCase):
|
|
'''
|
|
Testing decorators.
|
|
'''
|
|
def old_function(self):
|
|
return "old"
|
|
|
|
def new_function(self):
|
|
return "new"
|
|
|
|
def _mk_version(self, name):
|
|
'''
|
|
Make a version
|
|
|
|
:return:
|
|
'''
|
|
return name, SaltStackVersion.from_name(name)
|
|
|
|
def setUp(self):
|
|
'''
|
|
Setup a test
|
|
:return:
|
|
'''
|
|
self.globs = {
|
|
'__virtualname__': 'test',
|
|
'__opts__': {},
|
|
'old_function': self.old_function,
|
|
'new_function': self.new_function,
|
|
}
|
|
self.messages = list()
|
|
decorators.log = DummyLogger(self.messages)
|
|
|
|
def test_is_deprecated_version_eol(self):
|
|
'''
|
|
Use of is_deprecated will result to the exception,
|
|
if the expiration version is lower than the current version.
|
|
A successor function is not pointed out.
|
|
|
|
:return:
|
|
'''
|
|
depr = decorators.is_deprecated(self.globs, "Helium")
|
|
depr._curr_version = self._mk_version("Beryllium")[1]
|
|
with self.assertRaises(CommandExecutionError):
|
|
depr(self.old_function)()
|
|
self.assertEqual(self.messages,
|
|
['The lifetime of the function "old_function" expired.'])
|
|
|
|
def test_is_deprecated_with_successor_eol(self):
|
|
'''
|
|
Use of is_deprecated will result to the exception,
|
|
if the expiration version is lower than the current version.
|
|
A successor function is pointed out.
|
|
|
|
:return:
|
|
'''
|
|
depr = decorators.is_deprecated(self.globs, "Helium", with_successor="new_function")
|
|
depr._curr_version = self._mk_version("Beryllium")[1]
|
|
with self.assertRaises(CommandExecutionError):
|
|
depr(self.old_function)()
|
|
self.assertEqual(self.messages,
|
|
['The lifetime of the function "old_function" expired. '
|
|
'Please use its successor "new_function" instead.'])
|
|
|
|
def test_is_deprecated(self):
|
|
'''
|
|
Use of is_deprecated will result to the log message,
|
|
if the expiration version is higher than the current version.
|
|
A successor function is not pointed out.
|
|
|
|
:return:
|
|
'''
|
|
depr = decorators.is_deprecated(self.globs, "Beryllium")
|
|
depr._curr_version = self._mk_version("Helium")[1]
|
|
self.assertEqual(depr(self.old_function)(), self.old_function())
|
|
self.assertEqual(self.messages,
|
|
['The function "old_function" is deprecated '
|
|
'and will expire in version "Beryllium".'])
|
|
|
|
def test_is_deprecated_with_successor(self):
|
|
'''
|
|
Use of is_deprecated will result to the log message,
|
|
if the expiration version is higher than the current version.
|
|
A successor function is pointed out.
|
|
|
|
:return:
|
|
'''
|
|
depr = decorators.is_deprecated(self.globs, "Beryllium", with_successor="old_function")
|
|
depr._curr_version = self._mk_version("Helium")[1]
|
|
self.assertEqual(depr(self.old_function)(), self.old_function())
|
|
self.assertEqual(self.messages,
|
|
['The function "old_function" is deprecated '
|
|
'and will expire in version "Beryllium". '
|
|
'Use successor "old_function" instead.'])
|
|
|
|
def test_with_deprecated_notfound(self):
|
|
'''
|
|
Test with_deprecated should raise an exception, if a same name
|
|
function with the "_" prefix not implemented.
|
|
|
|
:return:
|
|
'''
|
|
self.globs['__opts__']['use_deprecated'] = ['test.new_function']
|
|
depr = decorators.with_deprecated(self.globs, "Beryllium")
|
|
depr._curr_version = self._mk_version("Helium")[1]
|
|
with self.assertRaises(CommandExecutionError):
|
|
depr(self.new_function)()
|
|
self.assertEqual(self.messages,
|
|
['The function is using its deprecated version and will expire in version "Beryllium". '
|
|
'Use its successor "new_function" instead.'])
|
|
|
|
def test_with_deprecated_found(self):
|
|
'''
|
|
Test with_deprecated should not raise an exception, if a same name
|
|
function with the "_" prefix is implemented, but should use
|
|
an old version instead, if "use_deprecated" is requested.
|
|
|
|
:return:
|
|
'''
|
|
self.globs['__opts__']['use_deprecated'] = ['test.new_function']
|
|
self.globs['_new_function'] = self.old_function
|
|
depr = decorators.with_deprecated(self.globs, "Beryllium")
|
|
depr._curr_version = self._mk_version("Helium")[1]
|
|
self.assertEqual(depr(self.new_function)(), self.old_function())
|
|
log_msg = ['The function is using its deprecated version and will expire in version "Beryllium". '
|
|
'Use its successor "new_function" instead.']
|
|
self.assertEqual(self.messages, log_msg)
|
|
|
|
def test_with_deprecated_found_eol(self):
|
|
'''
|
|
Test with_deprecated should raise an exception, if a same name
|
|
function with the "_" prefix is implemented, "use_deprecated" is requested
|
|
and EOL is reached.
|
|
|
|
:return:
|
|
'''
|
|
self.globs['__opts__']['use_deprecated'] = ['test.new_function']
|
|
self.globs['_new_function'] = self.old_function
|
|
depr = decorators.with_deprecated(self.globs, "Helium")
|
|
depr._curr_version = self._mk_version("Beryllium")[1]
|
|
with self.assertRaises(CommandExecutionError):
|
|
depr(self.new_function)()
|
|
self.assertEqual(self.messages,
|
|
['Although function "new_function" is called, an alias "new_function" '
|
|
'is configured as its deprecated version. The lifetime of the function '
|
|
'"new_function" expired. Please use its successor "new_function" instead.'])
|
|
|
|
def test_with_deprecated_no_conf(self):
|
|
'''
|
|
Test with_deprecated should not raise an exception, if a same name
|
|
function with the "_" prefix is implemented, but should use
|
|
a new version instead, if "use_deprecated" is not requested.
|
|
|
|
:return:
|
|
'''
|
|
self.globs['_new_function'] = self.old_function
|
|
depr = decorators.with_deprecated(self.globs, "Beryllium")
|
|
depr._curr_version = self._mk_version("Helium")[1]
|
|
self.assertEqual(depr(self.new_function)(), self.new_function())
|
|
self.assertFalse(self.messages)
|
|
|
|
def test_with_deprecated_with_name(self):
|
|
'''
|
|
Test with_deprecated should not raise an exception, if a different name
|
|
function is implemented and specified with the "with_name" parameter,
|
|
but should use an old version instead and log a warning log message.
|
|
|
|
:return:
|
|
'''
|
|
self.globs['__opts__']['use_deprecated'] = ['test.new_function']
|
|
depr = decorators.with_deprecated(self.globs, "Beryllium", with_name="old_function")
|
|
depr._curr_version = self._mk_version("Helium")[1]
|
|
self.assertEqual(depr(self.new_function)(), self.old_function())
|
|
self.assertEqual(self.messages,
|
|
['The function "old_function" is deprecated and will expire in version "Beryllium". '
|
|
'Use its successor "new_function" instead.'])
|
|
|
|
def test_with_deprecated_with_name_eol(self):
|
|
'''
|
|
Test with_deprecated should raise an exception, if a different name
|
|
function is implemented and specified with the "with_name" parameter
|
|
and EOL is reached.
|
|
|
|
:return:
|
|
'''
|
|
self.globs['__opts__']['use_deprecated'] = ['test.new_function']
|
|
depr = decorators.with_deprecated(self.globs, "Helium", with_name="old_function")
|
|
depr._curr_version = self._mk_version("Beryllium")[1]
|
|
with self.assertRaises(CommandExecutionError):
|
|
depr(self.new_function)()
|
|
self.assertEqual(self.messages,
|
|
['Although function "new_function" is called, '
|
|
'an alias "old_function" is configured as its deprecated version. '
|
|
'The lifetime of the function "old_function" expired. '
|
|
'Please use its successor "new_function" instead.'])
|
|
|
|
|
|
if __name__ == '__main__':
|
|
from integration import run_tests
|
|
run_tests(DecoratorsTest, needs_daemon=False)
|