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
90 lines
3.0 KiB
Python
90 lines
3.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import Python libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Libs
|
|
from salt.modules import status
|
|
from salt.exceptions import CommandExecutionError
|
|
|
|
# Import Salt Testing Libs
|
|
from salttesting import TestCase
|
|
from salttesting.helpers import ensure_in_syspath
|
|
from salttesting.mock import (
|
|
MagicMock,
|
|
patch,
|
|
)
|
|
|
|
ensure_in_syspath('../../')
|
|
|
|
# Globals
|
|
status.__salt__ = {}
|
|
|
|
|
|
class StatusTestCase(TestCase):
|
|
'''
|
|
test modules.status functions
|
|
'''
|
|
|
|
def test_uptime(self):
|
|
'''
|
|
Test modules.status.uptime function, new version
|
|
:return:
|
|
'''
|
|
class ProcUptime(object):
|
|
def __init__(self, *args, **kwargs):
|
|
self.data = "773865.18 1003405.46"
|
|
|
|
def read(self):
|
|
return self.data
|
|
|
|
with patch.dict(status.__salt__, {'cmd.run': MagicMock(return_value="1\n2\n3")}):
|
|
with patch('os.path.exists', MagicMock(return_value=True)):
|
|
with patch('time.time', MagicMock(return_value=1458821523.72)):
|
|
status.open = ProcUptime
|
|
u_time = status.uptime()
|
|
self.assertEqual(u_time['users'], 3)
|
|
self.assertEqual(u_time['seconds'], 773865)
|
|
self.assertEqual(u_time['days'], 8)
|
|
self.assertEqual(u_time['time'], '22:57')
|
|
|
|
def test_uptime_failure(self):
|
|
'''
|
|
Test modules.status.uptime function should raise an exception if /proc/uptime does not exists.
|
|
:return:
|
|
'''
|
|
with patch('os.path.exists', MagicMock(return_value=False)):
|
|
with self.assertRaises(CommandExecutionError):
|
|
status.uptime()
|
|
|
|
def test_deprecated_uptime(self):
|
|
'''
|
|
test modules.status.uptime function, deprecated version
|
|
'''
|
|
mock_uptime = 'very often'
|
|
mock_run = MagicMock(return_value=mock_uptime)
|
|
with patch.dict(status.__salt__, {'cmd.run': mock_run}):
|
|
self.assertEqual(status._uptime(), mock_uptime)
|
|
|
|
mock_uptime = 'very idle'
|
|
mock_run = MagicMock(return_value=mock_uptime)
|
|
with patch.dict(status.__salt__, {'cmd.run': mock_run}):
|
|
with patch('os.path.exists', MagicMock(return_value=True)):
|
|
self.assertEqual(status._uptime(human_readable=False), mock_uptime.split()[0])
|
|
|
|
mock_uptime = ''
|
|
mock_return = 'unexpected format in /proc/uptime'
|
|
mock_run = MagicMock(return_value=mock_uptime)
|
|
with patch.dict(status.__salt__, {'cmd.run': mock_run}):
|
|
with patch('os.path.exists', MagicMock(return_value=True)):
|
|
self.assertEqual(status._uptime(human_readable=False), mock_return)
|
|
|
|
mock_return = 'cannot find /proc/uptime'
|
|
with patch('os.path.exists', MagicMock(return_value=False)):
|
|
self.assertEqual(status._uptime(human_readable=False), mock_return)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
from integration import run_tests
|
|
run_tests(StatusTestCase, needs_daemon=False)
|