oslo.log/oslo_log/tests/unit/test_helpers.py
Kiseok Kim 14a496ff91 Fix bug in log_method_call decorator
log_method_call decorator miss first argument of staticmethod and function.
the cause of bug is wrong start position of argument array for staticmethod.
This patch adds a bug fix and test code.

Change-Id: Id83378ba5954a855f18a4fdcfd22d2c7887991b2
Closes-Bug: #1672283
2017-05-25 14:43:02 +00:00

78 lines
2.7 KiB
Python

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import mock
from oslo_log import helpers
from oslotest import base as test_base
class LogHelpersTestCase(test_base.BaseTestCase):
def test_log_decorator(self):
'''Test that LOG.debug is called with proper arguments.'''
class test_class(object):
@helpers.log_method_call
def test_method(self, arg1, arg2, arg3, *args, **kwargs):
pass
@classmethod
@helpers.log_method_call
def test_classmethod(cls, arg1, arg2, arg3, *args, **kwargs):
pass
args = tuple(range(6))
kwargs = {'kwarg1': 6, 'kwarg2': 7}
obj = test_class()
for method_name in ('test_method', 'test_classmethod'):
data = {'caller': helpers._get_full_class_name(test_class),
'method_name': method_name,
'args': args,
'kwargs': kwargs}
method = getattr(obj, method_name)
with mock.patch('logging.Logger.debug') as debug:
method(*args, **kwargs)
debug.assert_called_with(mock.ANY, data)
def test_log_decorator_for_static(self):
'''Test that LOG.debug is called with proper arguments.'''
@helpers.log_method_call
def _static_method():
pass
class test_class(object):
@staticmethod
@helpers.log_method_call
def test_staticmethod(arg1, arg2, arg3, *args, **kwargs):
pass
data = {'caller': 'static',
'method_name': '_static_method',
'args': (),
'kwargs': {}}
with mock.patch('logging.Logger.debug') as debug:
_static_method()
debug.assert_called_with(mock.ANY, data)
args = tuple(range(6))
kwargs = {'kwarg1': 6, 'kwarg2': 7}
data = {'caller': 'static',
'method_name': 'test_staticmethod',
'args': args,
'kwargs': kwargs}
with mock.patch('logging.Logger.debug') as debug:
test_class.test_staticmethod(*args, **kwargs)
debug.assert_called_with(mock.ANY, data)