openstack/python-swiftclient
Code Issues Proposed changes

Fix test for redacting sensitive data in client.http_log()

Browse Source 
The test should have included utf8 encoded unicode data to
test that encoded unicode data stored in headers was parsed
correctly.

Also fixes the docstring for swiftclient.safe_value()

Change-Id: Id0def0b3af7a364f1257cc22f67b71c0cc5d8479
This commit is contained in:
Joel Wright 2016-02-25 17:13:35 +00:00
parent ee905477ac
commit 46d8178280
2 changed files with 15 additions and 10 deletions
swiftclient
client.py
tests/unit
test_swiftclient.py

2
swiftclient/client.py

@ -103,7 +103,7 @@ def safe_value(name, value):
:param name: Header name :param name: Header name
:param value: Header value :param value: Header value
:return: Safe (header, value) pair :return: Safe header value
""" """
if name.lower() in LOGGER_SENSITIVE_HEADERS: if name.lower() in LOGGER_SENSITIVE_HEADERS:
prefix_length = logger_settings.get('reveal_sensitive_prefix', 16) prefix_length = logger_settings.get('reveal_sensitive_prefix', 16)

23
tests/unit/test_swiftclient.py

@ -2191,23 +2191,26 @@ class TestLogging(MockHttpTest):
def test_redact_token(self): def test_redact_token(self):
with mock.patch('swiftclient.client.logger.debug') as mock_log: with mock.patch('swiftclient.client.logger.debug') as mock_log:
token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b' token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'
token_encoded = token_value.encode('utf8')
unicode_token_value = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91' unicode_token_value = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91' u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
u'\u5929\u7a7a\u4e2d\u7684\u4e4c') u'\u5929\u7a7a\u4e2d\u7684\u4e4c')
unicode_token_encoded = unicode_token_value.encode('utf8')
set_cookie_value = 'X-Auth-Token=%s' % token_value set_cookie_value = 'X-Auth-Token=%s' % token_value
set_cookie_encoded = set_cookie_value.encode('utf8')
c.http_log( c.http_log(
['GET'], ['GET'],
{'headers': { {'headers': {
'X-Auth-Token': token_value, 'X-Auth-Token': token_encoded,
'X-Storage-Token': unicode_token_value 'X-Storage-Token': unicode_token_encoded
}}, }},
MockHttpResponse( MockHttpResponse(
status=200, status=200,
headers={ headers={
'X-Auth-Token': token_value, 'X-Auth-Token': token_encoded,
'X-Storage-Token': unicode_token_value, 'X-Storage-Token': unicode_token_encoded,
'Etag': b'mock_etag', 'Etag': b'mock_etag',
'Set-Cookie': set_cookie_value 'Set-Cookie': set_cookie_encoded
} }
), ),
'' ''
@ -2230,21 +2233,23 @@ class TestLogging(MockHttpTest):
def test_show_token(self): def test_show_token(self):
with mock.patch('swiftclient.client.logger.debug') as mock_log: with mock.patch('swiftclient.client.logger.debug') as mock_log:
token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b' token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'
token_encoded = token_value.encode('utf8')
unicode_token_value = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91' unicode_token_value = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91' u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
u'\u5929\u7a7a\u4e2d\u7684\u4e4c') u'\u5929\u7a7a\u4e2d\u7684\u4e4c')
c.logger_settings['redact_sensitive_headers'] = False c.logger_settings['redact_sensitive_headers'] = False
unicode_token_encoded = unicode_token_value.encode('utf8')
c.http_log( c.http_log(
['GET'], ['GET'],
{'headers': { {'headers': {
'X-Auth-Token': token_value, 'X-Auth-Token': token_encoded,
'X-Storage-Token': unicode_token_value 'X-Storage-Token': unicode_token_encoded
}}, }},
MockHttpResponse( MockHttpResponse(
status=200, status=200,
headers=[ headers=[
('X-Auth-Token', token_value), ('X-Auth-Token', token_encoded),
('X-Storage-Token', unicode_token_value), ('X-Storage-Token', unicode_token_encoded),
('Etag', b'mock_etag') ('Etag', b'mock_etag')
] ]
), ),