flake8 plus tests for cgitb.py

rouilj · rouilj · commit 7cb5d3278ada · 2022-09-14T22:35:23.000-04:00
flake8 fixes for cgitb.py.

Also set up tests for functions in unit.
Need tests before making some other changes in cgitb.py.
diff --git a/roundup/cgi/cgitb.py b/roundup/cgi/cgitb.py
@@ -7,13 +7,18 @@
 from __future__ import print_function
 __docformat__ = 'restructuredtext'
 
-import sys, os, keyword, linecache, tokenize, inspect
-import pydoc, traceback
+import inspect
+import keyword
+import linecache
+import os
+import pydoc
+import sys
+import tokenize
+import traceback
 
 from roundup.anypy.html import html_escape
-
-from roundup.cgi import TranslationService
 from roundup.anypy.strings import s2b
+from roundup.cgi import TranslationService
 
 
 def get_translator(i18n=None):
@@ -45,8 +50,8 @@ def niceDict(indent, dict):
     l = []
     for k in sorted(dict):
         v = dict[k]
-        l.append('<tr><td><strong>%s</strong></td><td>%s</td></tr>' % (k,
-            html_escape(repr(v))))
+        l.append('<tr><td><strong>%s</strong></td><td>%s</td></tr>' % (
+            k, html_escape(repr(v))))
     return '\n'.join(l)
 
 
@@ -72,9 +77,10 @@ def pt_html(context=5, i18n=None):
                     s.append(_('<li>"%(name)s" (%(info)s)</li>')
                              % {'name': name, 'info': esc(repr(info))})
                 s = '\n'.join(s)
-                l.append(_('<li>Looking for "%(name)s", '
-                           'current path:<ol>%(path)s</ol></li>'
-                          ) % {'name': ti.name, 'path': s})
+                l.append(_(
+                    '<li>Looking for "%(name)s", '
+                    'current path:<ol>%(path)s</ol></li>'
+                ) % {'name': ti.name, 'path': s})
             else:
                 l.append(_('<li>In %s</li>') % esc(str(ti)))
         if '__traceback_supplement__' in locals:
@@ -101,7 +107,7 @@ def pt_html(context=5, i18n=None):
     'line': context.position[0],
     'globals': niceDict('    ', context.global_vars),
     'locals': niceDict('    ', context.local_vars)
-})
+   })
 
     l.append('''
 </ol>
@@ -164,7 +170,7 @@ def tokeneater(type, token, start, end, line, names=names):
             if type == tokenize.NAME and token not in keyword.kwlist:
                 if token not in names:
                     names.append(token)
-            if type == tokenize.NEWLINE: raise IndexError
+            if type == tokenize.NEWLINE: raise IndexError       # noqa: E701
 
         def linereader(file=file, lnum=[lnum]):
             line = s2b(linecache.getline(file, lnum[0]))
diff --git a/test/test_misc.py b/test/test_misc.py
@@ -1,11 +1,16 @@
 # misc tests
 
+import re
+import sys
 import unittest
+
 import roundup.anypy.cmp_
-import sys
+
 from roundup.anypy.strings import StringIO  # define StringIO
+from roundup.cgi import cgitb
 from roundup.cgi.accept_language import parse
 
+
 class AcceptLanguageTest(unittest.TestCase):
     def testParse(self):
         self.assertEqual(parse("da, en-gb;q=0.8, en;q=0.7"),
@@ -63,3 +68,138 @@ def test_Version_Check(self):
         sys.version_info = real_ver
 
 
+class CgiTbCheck(unittest.TestCase):
+
+    def test_NiceDict(self):
+        d = cgitb.niceDict("    ", { "two": "three", "four": "five" })
+
+        expected = (
+            "<tr><td><strong>four</strong></td><td>'five'</td></tr>\n"
+            "<tr><td><strong>two</strong></td><td>'three'</td></tr>"
+            )
+
+        self.assertEqual(expected, d)
+
+    def test_breaker(self):
+        b = cgitb.breaker()
+
+        expected = ('<body bgcolor="white"><font color="white" size="-5">'
+                    ' > </font> </table></table></table></table></table>')
+
+        self.assertEqual(expected, b)
+
+    def test_pt_html(self):
+        """ templating error """
+        try:
+            f = 5
+            d = a + 4
+        except Exception:
+            p = cgitb.pt_html(context=2)
+
+        expected2 = """<h1>Templating Error</h1>
+<p><b>&lt;type 'exceptions.NameError'&gt;</b>: global name 'a' is not defined</p>
+<p class="help">Debugging information follows</p>
+<ol>
+
+</ol>
+<table style="font-size: 80%; color: gray">
+ <tr><th class="header" align="left">Full traceback:</th></tr>
+ <tr><td><pre>Traceback (most recent call last):
+  File "XX/test/test_misc.py", line XX, in test_pt_html
+    d = a + 4
+NameError: global name 'a' is not defined
+</pre></td></tr>
+</table>
+<p>&nbsp;</p>"""
+
+        expected3 = """<h1>Templating Error</h1>
+<p><b>&lt;class 'NameError'&gt;</b>: name 'a' is not defined</p>
+<p class="help">Debugging information follows</p>
+<ol>
+
+</ol>
+<table style="font-size: 80%; color: gray">
+ <tr><th class="header" align="left">Full traceback:</th></tr>
+ <tr><td><pre>Traceback (most recent call last):
+  File "XX/test/test_misc.py", line XX, in test_pt_html
+    d = a + 4
+NameError: name 'a' is not defined
+</pre></td></tr>
+</table>
+<p>&nbsp;</p>"""
+
+        # allow file directory prefix and line number to change
+        p = re.sub(r'(File ")/.*/(test/test_misc.py",)', r'\1XX/\2', p)
+        p = re.sub(r'(", line )\d*,', r'\1XX,', p)
+
+        print(p)
+
+        if sys.version_info > (3, 0, 0):
+            self.assertEqual(expected3, p)
+        else:
+            self.assertEqual(expected2, p)
+
+    def test_html(self):
+        """ templating error """
+        # enabiling this will cause the test to fail as the variable
+        # is included in the live outpu but not in expected.
+        # self.maxDiff = None
+
+        try:
+            f = 5
+            d = a + 4
+        except Exception:
+            h = cgitb.html(context=2)
+
+            expected2 = """
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
+<tr bgcolor="#777777">
+<td valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial">&nbsp;<br><font size=+1><strong>NameError</strong>: global name 'a' is not defined</font></font></td
+><td align=right valign=bottom
+><font color="#ffffff" face="helvetica, arial">Python 2.7.17<br>/usr/bin/python2</font></td></tr></table>
+    <p>A problem occurred while running a Python script. Here is the sequence of function calls leading up to the error, with the most recent (innermost) call first. The exception attributes are:<br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__class__&nbsp;= &lt;type 'exceptions.NameError'&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__delattr__&nbsp;= &lt;method-wrapper '__delattr__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__dict__&nbsp;= {} <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__doc__&nbsp;= 'Name not found globally.' <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__format__&nbsp;= &lt;built-in method __format__ of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__getattribute__&nbsp;= &lt;method-wrapper '__getattribute__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__getitem__&nbsp;= &lt;method-wrapper '__getitem__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__getslice__&nbsp;= &lt;method-wrapper '__getslice__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__hash__&nbsp;= &lt;method-wrapper '__hash__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__init__&nbsp;= &lt;method-wrapper '__init__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__new__&nbsp;= &lt;built-in method __new__ of type object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__reduce__&nbsp;= &lt;built-in method __reduce__ of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__reduce_ex__&nbsp;= &lt;built-in method __reduce_ex__ of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__repr__&nbsp;= &lt;method-wrapper '__repr__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__setattr__&nbsp;= &lt;method-wrapper '__setattr__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__setstate__&nbsp;= &lt;built-in method __setstate__ of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__sizeof__&nbsp;= &lt;built-in method __sizeof__ of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__str__&nbsp;= &lt;method-wrapper '__str__' of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__subclasshook__&nbsp;= &lt;built-in method __subclasshook__ of type object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__unicode__&nbsp;= &lt;built-in method __unicode__ of exceptions.NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>args&nbsp;= ("global name 'a' is not defined",) <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>message&nbsp;= "global name 'a' is not defined"<p>
+<table width="100%" bgcolor="#dddddd" cellspacing=0 cellpadding=2 border=0>
+<tr><td><a href="file:XX/test/test_misc.py">XX/test/test_misc.py</a> in <strong>test_html</strong>(self=&lt;test.test_misc.CgiTbCheck testMethod=test_html&gt;)</td></tr></table>
+<tt><small><font color="#909090">&nbsp;&nbsp;XX</font></small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f&nbsp;=&nbsp;5<br>
+</tt>
+
+
+<table width="100%" bgcolor="white" cellspacing=0 cellpadding=0 border=0>
+<tr><td><tt><small><font color="#909090">&nbsp;&nbsp;XX</font></small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;d&nbsp;=&nbsp;a&nbsp;+&nbsp;4<br>
+</tt></td></tr></table>
+<tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt><small><font color="#909090"><strong>d</strong>&nbsp;= <em>undefined</em>, <em>global</em> <strong>a</strong>&nbsp;= <em>undefined</em></font></small><br><p>&nbsp;</p>"""
+
+            expected3 = """
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
+<tr bgcolor="#777777">
+<td valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial">&nbsp;<br><font size=+1><strong>NameError</strong>: name 'a' is not defined</font></font></td
+><td align=right valign=bottom
+><font color="#ffffff" face="helvetica, arial">Python 3.6.9<br>/usr/bin/python3</font></td></tr></table>
+    <p>A problem occurred while running a Python script. Here is the sequence of function calls leading up to the error, with the most recent (innermost) call first. The exception attributes are:<br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__cause__&nbsp;= None <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__class__&nbsp;= &lt;class 'NameError'&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__context__&nbsp;= None <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__delattr__&nbsp;= &lt;method-wrapper '__delattr__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__dict__&nbsp;= {} <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__dir__&nbsp;= &lt;built-in method __dir__ of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__doc__&nbsp;= 'Name not found globally.' <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__eq__&nbsp;= &lt;method-wrapper '__eq__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__format__&nbsp;= &lt;built-in method __format__ of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__ge__&nbsp;= &lt;method-wrapper '__ge__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__getattribute__&nbsp;= &lt;method-wrapper '__getattribute__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__gt__&nbsp;= &lt;method-wrapper '__gt__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__hash__&nbsp;= &lt;method-wrapper '__hash__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__init__&nbsp;= &lt;method-wrapper '__init__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__init_subclass__&nbsp;= &lt;built-in method __init_subclass__ of type object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__le__&nbsp;= &lt;method-wrapper '__le__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__lt__&nbsp;= &lt;method-wrapper '__lt__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__ne__&nbsp;= &lt;method-wrapper '__ne__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__new__&nbsp;= &lt;built-in method __new__ of type object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__reduce__&nbsp;= &lt;built-in method __reduce__ of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__reduce_ex__&nbsp;= &lt;built-in method __reduce_ex__ of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__repr__&nbsp;= &lt;method-wrapper '__repr__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__setattr__&nbsp;= &lt;method-wrapper '__setattr__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__setstate__&nbsp;= &lt;built-in method __setstate__ of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__sizeof__&nbsp;= &lt;built-in method __sizeof__ of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__str__&nbsp;= &lt;method-wrapper '__str__' of NameError object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__subclasshook__&nbsp;= &lt;built-in method __subclasshook__ of type object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__suppress_context__&nbsp;= False <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>__traceback__&nbsp;= &lt;traceback object&gt; <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>args&nbsp;= ("name 'a' is not defined",) <br><tt><small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</small>&nbsp;</tt>with_traceback&nbsp;= &lt;built-in method with_traceback of NameError object&gt;<p>
+<table width="100%" bgcolor="#dddddd" cellspacing=0 cellpadding=2 border=0>
+<tr><td><a href="file:XX/test/test_misc.py">XX/test/test_misc.py</a> in <strong>test_html</strong>(self=&lt;test.test_misc.CgiTbCheck testMethod=test_html&gt;)</td></tr></table>
+<tt><small><font color="#909090">&nbsp;&nbsp;XX</font></small>&nbsp;<br>
+</tt>
+
+
+<table width="100%" bgcolor="white" cellspacing=0 cellpadding=0 border=0>
+<tr><td><tt><small><font color="#909090">&nbsp;&nbsp;XX</font></small>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;try:<br>
+</tt></td></tr></table>
+<p>&nbsp;</p>"""
+
+        # strip file path prefix from href and text
+        # /home/user/develop/roundup/test/test_misc.py in test_html
+        h = re.sub(r'(file:)/.*/(test/test_misc.py")', r'\1XX/\2', h)
+        h = re.sub(r'(/test_misc.py">)/.*/(test/test_misc.py</a>)',
+                   r'\1XX/\2', h)
+        # replace code line numbers with XX
+        h = re.sub(r'(&nbsp;)\d*(</font>)', r'\1XX\2', h)
+
+        print(h)
+
+        if sys.version_info > (3, 0, 0):
+            self.assertEqual(expected3, h)
+        else:
+            self.assertEqual(expected2, h)
