openstack
/
python-keystoneclient
Code Issues Proposed changes

Fix response body being omitted in debug mode incorrectly 

In debug mode, when a response's header Content-Type is set
to "application/json" with a parameter, i.e.,
"application/json; charset=UTF-8".  This patch set ignores
the additional parameter and only match the mimetype.

Change-Id: Ie8fcb1061e0e49b039436947524cfdc704c83846
Closes-Bug: #1656981
(cherry picked from commit dcb719d0e5)
This commit is contained in:
Tin Lam 2017-01-16 23:14:42 -06:00 committed by Steve Martinelli
parent b69f3a1f0a
commit 7c40ff8466
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
keystoneclient/session.py
View File

@ -232,8 +232,14 @@ class Session(object):
# anyways may result on reading a long stream of bytes and getting an
# unexpected MemoryError. See bug 1616105 for further details.
content_type = response.headers.get('content-type', None)
if content_type in _LOG_CONTENT_TYPES:
text = _remove_service_catalog(response.text)
# NOTE(lamt): Per [1], the Content-Type header can be of the form
# Content-Type := type "/" subtype *[";" parameter]
# [1] https://www.w3.org/Protocols/rfc1341/4_Content-Type.html
for log_type in _LOG_CONTENT_TYPES:
if content_type is not None and content_type.startswith(log_type):
text = _remove_service_catalog(response.text)
break
else:
text = ('Omitted, Content-Type is set to %s. Only '
'%s responses have their bodies logged.')

10
keystoneclient/tests/unit/test_session.py
View File

@ -228,6 +228,16 @@ class SessionTests(utils.TestCase):
self.assertIn(body, self.logger.output)
self.assertNotIn(OMITTED_BODY % 'application/json', self.logger.output)
# Content-Type is set to application/json; charset=UTF-8
body = jsonutils.dumps({'token': {'id': '...'}})
self.stub_url(
'POST', text=body,
headers={'Content-Type': 'application/json; charset=UTF-8'})
session.post(self.TEST_URL)
self.assertIn(body, self.logger.output)
self.assertNotIn(OMITTED_BODY % 'application/json; charset=UTF-8',
self.logger.output)
def test_unicode_data_in_debug_output(self):
"""Verify that ascii-encodable data is logged without modification."""
session = client_session.Session(verify=False)