escape non-unicode symbols in messages and stacktraces (fixes #186 via #256)

Author: ehborisov

allure-pytest/src/listener.py

@@ -1,5 +1,6 @@
 import pytest
 import allure_commons
+from allure_commons.utils import escape_non_unicode_symbols
 from allure_commons.utils import now
 from allure_commons.utils import md5
 from allure_commons.utils import uuid4
@@ -158,7 +159,9 @@ def pytest_runtest_makereport(self, item, call):
         status_details = None
 
         if call.excinfo:
-            status_details = StatusDetails(message=call.excinfo.exconly(), trace=report.longreprtext)
+            status_details = StatusDetails(
+                message=escape_non_unicode_symbols(call.excinfo.exconly()),
+                trace=escape_non_unicode_symbols(report.longreprtext))
             if (status != Status.SKIPPED
                 and not (call.excinfo.errisinstance(AssertionError)
                          or call.excinfo.errisinstance(pytest.fail.Exception))):

allure-pytest/src/utils.py

@@ -4,7 +4,7 @@
 import six
 import pytest
 from allure_commons.utils import represent
-from allure_commons.utils import format_exception, format_traceback
+from allure_commons.utils import format_exception, format_traceback, escape_non_unicode_symbols
 from allure_commons.model2 import Status
 from allure_commons.model2 import StatusDetails
 
@@ -130,8 +130,8 @@ def get_status(exception):
 
 
 def get_status_details(exception_type, exception, exception_traceback):
-    message = format_exception(exception_type, exception)
-    trace = format_traceback(exception_traceback)
+    message = escape_non_unicode_symbols(format_exception(exception_type, exception))
+    trace = escape_non_unicode_symbols(format_traceback(exception_traceback))
     return StatusDetails(message=message, trace=trace) if message or trace else None
 
 

allure-pytest/test/status/base_step_status_test.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import pytest
 
 
@@ -43,3 +44,25 @@ def test_pytest_fail_in_step():
     """
     with pytest.allure.step('Step'):
         pytest.fail()
+
+
+def test_pytest_bytes_data_in_assert():
+    """
+    >>> allure_report = getfixture('allure_report')
+    >>> assert_that(allure_report,
+    ...             has_test_case('test_pytest_bytes_data_in_assert',
+    ...                           with_status('failed'),
+    ...                           has_status_details(with_message_contains("AssertionError: assert '0\\\\x82' == 1"),
+    ...                                              with_trace_contains("def test_pytest_bytes_data_in_assert():")
+    ...                           ),
+    ...                           has_step('Step',
+    ...                                    with_status('failed'),
+    ...                                    has_status_details(with_message_contains("AssertionError: assert '0\\\\x82' == 1"),
+    ...                                                       with_trace_contains("test_pytest_bytes_data_in_assert")
+    ...                                    )
+    ...                            )
+    ...             )
+    ... )
+    """
+    with pytest.allure.step('Step'):
+        assert '0\x82' == 1

allure-python-commons/src/utils.py

@@ -48,6 +48,19 @@ def host_tag():
     return socket.gethostname()
 
 
+def escape_non_unicode_symbols(item):
+    if not (six.PY2 and isinstance(item, str)):
+        return item
+
+    def escape_symbol(s):
+        try:
+            s.decode(encoding='UTF-8')
+            return s
+        except UnicodeDecodeError:
+            return repr(s)[1:-1]
+    return ''.join(map(escape_symbol, item))
+
+
 def represent(item):
     """
     >>> represent(None)