openstack
/
oslo.log
Code Issues Proposed changes

rewrite tests to not rely on implementation details of logging module 

The tests for ensuring the results of the adapter are passed to the
logger correctly rely more on the implementation details of the
logging library than on the adapter supposedly being tested. As the
underlying implementation changes in various ways, this causes the
tests to fail (most recently when we try to run the tests under python
3.6. Rather than adding yet another case to the conditional for this
specific version of python, rewrite the tests so they do not rely on
the underlying implementation details.

Change-Id: Id4d416852553b8d11ad27e25edcf9cceab3eb1b6
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

fix

Change-Id: I1f5140b0a9499c94e13fa3cd0f7151dc6c952621
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2018-08-12 15:59:11 -04:00
parent 184ea300d0
commit dbab9ab8c2
1 changed files with 42 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
oslo_log/tests/unit/test_log.py
View File

@ -1702,6 +1702,20 @@ class LogConfigTestCase(BaseTestCase):
disable_existing_loggers=False)
class SavingAdapter(log.KeywordArgumentAdapter):
def __init__(self, *args, **kwds):
super(log.KeywordArgumentAdapter, self).__init__(*args, **kwds)
self.results = []
def process(self, msg, kwargs):
# Run the real adapter and save the inputs and outputs
# before returning them so the test can examine both.
results = super(SavingAdapter, self).process(msg, kwargs)
self.results.append((msg, kwargs, results))
return results
class KeywordArgumentAdapterTestCase(BaseTestCase):
def setUp(self):
@ -1754,52 +1768,44 @@ class KeywordArgumentAdapterTestCase(BaseTestCase):
kwargs)
def test_pass_args_to_log(self):
a = log.KeywordArgumentAdapter(self.mock_log, {})
a = SavingAdapter(self.mock_log, {})
message = 'message'
exc_message = 'exception'
key = 'name'
val = 'value'
a.log(logging.DEBUG, message, name=val, exc_info=exc_message)
if six.PY3:
self.mock_log._log.assert_called_once_with(
logging.DEBUG,
message,
(),
extra={key: val, 'extra_keys': [key]},
exc_info=exc_message
)
else:
self.mock_log.log.assert_called_once_with(
logging.DEBUG,
message,
extra={key: val, 'extra_keys': [key]},
exc_info=exc_message
)
expected = {
'exc_info': exc_message,
'extra': {'name': val, 'extra_keys': ['name']},
}
actual = a.results[0]
self.assertEqual(message, actual[0])
self.assertEqual(expected, actual[1])
results = actual[2]
self.assertEqual(message, results[0])
self.assertEqual(expected, results[1])
def test_pass_args_via_debug(self):
a = log.KeywordArgumentAdapter(self.mock_log, {})
a = SavingAdapter(self.mock_log, {})
message = 'message'
exc_message = 'exception'
key = 'name'
val = 'value'
a.debug(message, name=val, exc_info=exc_message)
# The adapter implementation for debug() is different for
# python 3, so we expect a different method to be called
# internally.
if six.PY3:
self.mock_log._log.assert_called_once_with(
logging.DEBUG,
message,
(),
extra={key: val, 'extra_keys': [key]},
exc_info=exc_message
)
else:
self.mock_log.debug.assert_called_once_with(
message,
extra={key: val, 'extra_keys': [key]},
exc_info=exc_message
)
expected = {
'exc_info': exc_message,
'extra': {'name': val, 'extra_keys': ['name']},
}
actual = a.results[0]
self.assertEqual(message, actual[0])
self.assertEqual(expected, actual[1])
results = actual[2]
self.assertEqual(message, results[0])
self.assertEqual(expected, results[1])
class UnicodeConversionTestCase(BaseTestCase):