Merge pull request #61 from mbengit/sanitizelogmessages

Sanitize log message text

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+omit=qpylib/__init__.py
+
+[report]
+fail_under=100

qpylib/log_qpylib.py

@@ -68,7 +68,7 @@ def log(message, level):
     log_function = LOG_LEVEL_TO_FUNCTION.get(level.upper())
     if not log_function:
         raise ValueError("Unknown level: '{0}'".format(level))
-    log_function(message)
+    log_function(_sanitize(message))
 
 def set_log_level(level='INFO'):
     if not QLOGGER:
@@ -81,6 +81,10 @@ def _default_log_level():
 def _log_file_location():
     return app_qpylib.get_log_path('app.log')
 
+def _sanitize(message):
+    # Use repr to suppress \t, \n, \r, and strip the surrounding quotes added by repr.
+    return repr(message)[1:-1]
+
 def _generate_handlers(syslog_enabled):
     handlers = []
 

qpylib/qpylib.py

@@ -28,6 +28,8 @@ def create_log(syslog_enabled=True):
 
 def log(message, level='INFO'):
     ''' Logs a message at the given level, which defaults to INFO.
+        Within the message string, any control characters such as tab
+        and newline will be suppressed.
         Level values: DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL.
         EXCEPTION is ERROR plus extra exception details.
         Raises RuntimeError if logging was not previously initialised

test/test_logging.py

@@ -293,6 +293,15 @@ def test_log_with_bad_level_raises_error(info_threshold, tmpdir):
         with pytest.raises(ValueError, match="Unknown level: 'BAD'"):
             qpylib.log('hello', 'BAD')
 
+def test_message_with_control_chars(info_threshold, tmpdir):
+    log_path = os.path.join(tmpdir.strpath, 'app.log')
+    with patch('qpylib.log_qpylib._log_file_location') as mock_log_location:
+        mock_log_location.return_value = log_path
+        qpylib.create_log()
+        qpylib.log('This \r should all \n be on %0a one \t line')
+    verify_log_file_content(log_path, [
+        {'level': 'INFO', 'text': 'This \\r should all \\n be on %0a one \\t line'}])
+
 def test_all_log_levels_with_manifest_info_threshold(info_threshold, tmpdir):
     log_path = os.path.join(tmpdir.strpath, 'app.log')
     with patch('qpylib.log_qpylib._log_file_location') as mock_log_location: