Colored test output

[anonymous]

Unit test failures are nicer to read when the diff is syntax highlighted.

Very primitive hack:

trac/test.py

@@ -291 +291 @@
         self.fixture = fixture
 
 
+try:
+    import pygments
+    import pygments.lexers
+    import pygments.formatters
+    import colorama
+    colorama.init()
+    hascolorhighlighting = True
+    formatter = pygments.formatters.TerminalFormatter(style='trac')
+    lexer = pygments.lexers.DiffLexer()
+except ImportError:
+    pass
+
+
+class ColoredTextTestResult(unittest.TextTestResult):
+    def __init__(self, *args, **kwargs):
+        unittest.TextTestResult.__init__(self, *args, **kwargs)
+
+    def printErrorList(self, flavour, errors):
+        for test, err in errors:
+            self.stream.writeln(self.separator1)
+            self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
+            self.stream.writeln(self.separator2)
+            if hascolorhighlighting:
+                print("%s" % pygments.highlight(err, lexer, formatter))
+            else:
+                self.stream.writeln("%s" % err)
+
+
+class ColoredTextTestRunner(unittest.TextTestRunner):
+    def __init__(self, *args, **kwargs):
+        unittest.TextTestRunner.__init__(self, resultclass=ColoredTextTestResult, *args, **kwargs)
+
+
 # -- Database utilities
 
 def get_dburi():

trac/tests/wikisyntax.py

@@ -19 +19 @@
 from trac.mimeview.api import RenderingContext
 from trac.resource import Resource
 from trac.search.web_ui import SearchModule
-from trac.test import MockPerm, mkdtemp
+from trac.test import MockPerm, mkdtemp, ColoredTextTestRunner
 from trac.web.href import Href
 from trac.wiki.tests import formatter
 
@@ -201 +201 @@
     return suite
 
 if __name__ == '__main__':
-    unittest.main(defaultTest='test_suite')
+    unittest.main(defaultTest='test_suite', testRunner=ColoredTextTestRunner)

All other unittest.main also have to be updated.

A new dependency colorama is optionally required for this.

Using print instead of using stream is probably bad.

Always using DiffLexer instead of custom lexer depending on error is probably bad.

Always using TerminalFormatter instead of limited color formatter is probably bad.

Maybe this is too much effort to really do nicely. But maybe you like colors.