Add tests for last_error formatter and lexer

tests/shell/test_error_handling.py

@@ -7,8 +7,11 @@
 
 import pytest
 import gevent
-from bliss.shell.cli import repl
 from datetime import date as datetime
+from pygments import lex
+from pygments.token import Token
+from bliss.shell.cli import repl
+from bliss.shell.cli.formatted_traceback import BlissTracebackLexer
 
 
 @pytest.fixture
@@ -21,8 +24,8 @@ def error_report():
 
 
 def test_error_report(beacon, error_report):
-    errors = error_report._last_error.errors
-    assert len(errors) == 0
+    err_hist = error_report.history
+    assert len(err_hist) == 0
     MYERROR = "MYERROR"
 
     def raise_exception():
@@ -31,11 +34,11 @@ def test_error_report(beacon, error_report):
     def raise_hub_exception(nerrors=1):
         w = gevent.get_hub().loop.async_()
         w.start(raise_exception)
-        n = len(errors) + nerrors
+        n = len(err_hist) + nerrors
         try:
             w.send()
             with gevent.Timeout(10):
-                while len(errors) != n:
+                while len(err_hist) != n:
                     gevent.sleep(0.1)
         finally:
             w.stop()
@@ -44,19 +47,17 @@ def test_error_report(beacon, error_report):
     # Exception in greenlet
     MYERROR = "MYERROR1"
     gevent.spawn(raise_exception).join()
-    assert len(errors) == 1
-    assert f"RuntimeError: {MYERROR}" in errors[-1]
+    assert len(err_hist) == 1
+    assert f"RuntimeError: {MYERROR}" in err_hist[-1].format()
 
     # Exception in gevent loop callback
     MYERROR = "MYERROR2"
     raise_hub_exception()
-    assert len(errors) == 2
-    assert f"RuntimeError: {MYERROR}" in errors[-1]
+    assert len(err_hist) == 2
+    assert f"RuntimeError: {MYERROR}" in err_hist[-1].format()
 
 
 def test_error_report_chained(error_report):
-    errors = error_report._last_error.errors
-
     def func1():
         raise RuntimeError("LEVEL 0")
 
@@ -68,7 +69,206 @@ def test_error_report_chained(error_report):
 
     gevent.spawn(func2).join()
 
-    assert len(errors) == 1
-    assert "\nRuntimeError: LEVEL 0" in errors[0]
-    assert "\nRuntimeError: LEVEL 1" in errors[0]
-    assert datetime.today().strftime("%d/%m/%Y") in errors[0]
+    assert len(error_report.history) == 1
+    last_error = error_report.history[-1].format()
+    assert "\nRuntimeError: LEVEL 0" in last_error
+    assert "\nRuntimeError: LEVEL 1" in last_error
+    assert datetime.today().strftime("%d/%m/%Y") in last_error
+
+
+def test_error_report_format(error_report):
+    def func1():
+        # variable longer than max_local_len
+        longvar = "bar" * 100  # noqa: F841
+        raise RuntimeError("LEVEL 0")
+
+    def func2():
+        # number of variables exceeding max_nb_locals
+        a = 0  # noqa: F841
+        b = 0  # noqa: F841
+        c = 0  # noqa: F841
+        d = 0  # noqa: F841
+        try:
+            func1()
+        except Exception as e:
+            # will cause "The above exception was the direct cause..." message
+            raise RuntimeError("LEVEL 1") from e
+
+    def func3():
+        foo = 42  # noqa: F841
+        try:
+            func2()
+        except Exception:
+            # will cause "During handling of the above..." message
+            raise RuntimeError("LEVEL 2")
+
+    gevent.spawn(func3).join()
+
+    assert len(error_report.history) == 1
+    formatted_error = error_report.history[-1].format(max_nb_locals=3, max_local_len=50)
+    lines = formatted_error.splitlines()
+
+    assert lines[0].startswith(datetime.today().strftime("%d/%m/%Y"))
+    assert lines[1] == "Traceback (most recent call last):"
+    assert (
+        "During handling of the above exception, another exception occurred:" in lines
+    )
+    assert (
+        "The above exception was the direct cause of the following exception:" in lines
+    )
+    assert "    @foo: 42" in lines
+    assert "    @longvar: ... (truncated)" in lines
+    assert "    ... (truncated)" in lines
+    assert "RuntimeError: LEVEL 0" in lines
+    assert "RuntimeError: LEVEL 1" in lines
+    assert "RuntimeError: LEVEL 2" in lines
+
+
+# =================== TRACEBACK LEXER TESTS ===================
+# Following tests are only written for non-regression purpose,
+# as there is no specific requirements on coloration.
+
+
+def test_error_report_lexer(error_report):
+    tb = """\
+01/01/1970 01:02:03
+Traceback (most recent call last):
+  File "filename", line 1546, in func
+    line of code
+    @foo: 'bar'
+RuntimeError: something happened
+"""
+    tokens = list(lex(tb, lexer=BlissTracebackLexer()))
+    expected_tokens = [
+        (Token.Name.Property, "01/01/1970 01:02:03\n"),
+        (Token.Text, "Traceback (most recent call last):\n"),
+        (Token.Text, "  File "),
+        (Token.Name.Builtin, '"filename"'),
+        (Token.Text, ", line "),
+        (Token.Literal.Number, "1546"),
+        (Token.Text, ", in "),
+        (Token.Name, "func"),
+        (Token.Text, "\n"),
+        (Token.Text, "    "),
+        (Token.Other, "line of code"),
+        (Token.Text, "\n"),
+        (Token.Text, "    "),
+        (Token.Name.Variable, "@foo"),
+        (Token.Punctuation, ":"),
+        (Token.Literal.String.Other, " 'bar'"),
+        (Token.Text, "\n"),
+        (Token.Generic.Error, "RuntimeError"),
+        (Token.Text, ": "),
+        (Token.Name.Exception, "something happened"),
+        (Token.Text, "\n"),
+    ]
+    assert tokens == expected_tokens
+
+
+def test_error_report_lexer_locals_truncated(error_report):
+    tb = """\
+01/01/1970 01:02:03
+Traceback (most recent call last):
+  File "filename", line 1546, in func
+    line of code
+    @foo: ... (truncated)
+    ... (truncated)
+RuntimeError: something happened
+"""
+    tokens = list(lex(tb, lexer=BlissTracebackLexer()))
+    expected_tokens = [
+        (Token.Name.Property, "01/01/1970 01:02:03\n"),
+        (Token.Text, "Traceback (most recent call last):\n"),
+        (Token.Text, "  File "),
+        (Token.Name.Builtin, '"filename"'),
+        (Token.Text, ", line "),
+        (Token.Literal.Number, "1546"),
+        (Token.Text, ", in "),
+        (Token.Name, "func"),
+        (Token.Text, "\n"),
+        (Token.Text, "    "),
+        (Token.Other, "line of code"),
+        (Token.Text, "\n"),
+        (Token.Text, "    "),
+        (Token.Name.Variable, "@foo"),
+        (Token.Punctuation, ": "),
+        (Token.Comment.Preproc, "... (truncated)\n"),
+        (Token.Comment.Preproc, "    ... (truncated)\n"),
+        (Token.Generic.Error, "RuntimeError"),
+        (Token.Text, ": "),
+        (Token.Name.Exception, "something happened"),
+        (Token.Text, "\n"),
+    ]
+    assert tokens == expected_tokens
+
+
+def test_error_report_lexer_chained(error_report):
+    tb = """\
+01/01/1970 01:02:03
+Traceback (most recent call last):
+  File "filename", line 1546, in func
+RuntimeError: something happened
+
+During handling of the above exception, another exception occurred:
+
+Traceback (most recent call last):
+  File "filename", line 1546, in func
+RuntimeError: something happened
+
+The above exception was the direct cause of the following exception:
+
+Traceback (most recent call last):
+  File "filename", line 1546, in func
+RuntimeError: something happened
+"""
+    tokens = list(lex(tb, lexer=BlissTracebackLexer()))
+    expected_tokens = [
+        (Token.Name.Property, "01/01/1970 01:02:03\n"),
+        (Token.Text, "Traceback (most recent call last):\n"),
+        (Token.Text, "  File "),
+        (Token.Name.Builtin, '"filename"'),
+        (Token.Text, ", line "),
+        (Token.Literal.Number, "1546"),
+        (Token.Text, ", in "),
+        (Token.Name, "func"),
+        (Token.Text, "\n"),
+        (Token.Generic.Error, "RuntimeError"),
+        (Token.Text, ": "),
+        (Token.Name.Exception, "something happened"),
+        (Token.Text, "\n"),
+        (Token.Text, "\n"),
+        (
+            Token.Heading,
+            "During handling of the above exception, another exception occurred:\n\n",
+        ),
+        (Token.Text, "Traceback (most recent call last):\n"),
+        (Token.Text, "  File "),
+        (Token.Name.Builtin, '"filename"'),
+        (Token.Text, ", line "),
+        (Token.Literal.Number, "1546"),
+        (Token.Text, ", in "),
+        (Token.Name, "func"),
+        (Token.Text, "\n"),
+        (Token.Generic.Error, "RuntimeError"),
+        (Token.Text, ": "),
+        (Token.Name.Exception, "something happened"),
+        (Token.Text, "\n"),
+        (Token.Text, "\n"),
+        (
+            Token.Heading,
+            "The above exception was the direct cause of the following exception:\n\n",
+        ),
+        (Token.Text, "Traceback (most recent call last):\n"),
+        (Token.Text, "  File "),
+        (Token.Name.Builtin, '"filename"'),
+        (Token.Text, ", line "),
+        (Token.Literal.Number, "1546"),
+        (Token.Text, ", in "),
+        (Token.Name, "func"),
+        (Token.Text, "\n"),
+        (Token.Generic.Error, "RuntimeError"),
+        (Token.Text, ": "),
+        (Token.Name.Exception, "something happened"),
+        (Token.Text, "\n"),
+    ]
+    assert tokens == expected_tokens