Minor code style clean-up after servlet import fix

Author: Cito

.pylintrc

@@ -46,7 +46,7 @@ variable-naming-style = camelCase
 
 good-names =
  b, c, d, e, f, g, h, i, j, k, m, n, p, q, r, s, t, ,v, w, x, y,
- dt, fd, fp, fs, ip, tm, ts, wr,
+ dt, fd, fp, fs, ip, ok, tm, ts, wr,
  dir_, id_, input_, type_,
  allow_none, entry_point, has_key, start_response, ssl_ctx,
  memcache, redis,

webware/Testing/ServletImport.py

@@ -1,26 +1,33 @@
-
-from Page import Page
 import sys
 
-mod_name = __name__  # we expect Testing.ServletImport
+from SidebarPage import SidebarPage
+
+modName = __name__  # should be Testing.ServletImport
+
 
-class ServletImport(Page):
-    """Test of import details."""
+class ServletImport(SidebarPage):
+    """Test of servlet import details."""
 
-    def title(self):
-        return self.__doc__
+    def cornerTitle(self):
+        return 'Testing'
 
-    def writeBody(self):
-        self.writeln('<h2>Webware Servlet Import Test</h2>')
-        self.writeln(f'<h3>{self.title()}</h3>')
-        mod_name_from_class = ServletImport.__module__   # we expect Testing.ServletImport
-        mod_name_consistent = mod_name == mod_name_from_class  # we expect True
-        servlet_in_sys_modules = mod_name in sys.modules  # we expect True
-        servlet_file_watched = __file__ in self.transaction().application()._imp.fileList(update=False)  # we expect True
-        self.writeln(
-            f"<p>mod_name = <code>{mod_name}</code></p>"
-            f"<p>mod_name_from_class = <code>{mod_name_from_class}</code></p>"
-            f"<p>mod_name_consistent = <code>{mod_name_consistent}</code></p>"
-            f"<p>servlet_in_sys_modules = <code>{servlet_in_sys_modules}</code></p>"
-            f"<p>servlet_file_watched = <code>{servlet_file_watched}</code></p>"
+    def writeContent(self):
+        wr = self.writeln
+        wr('<h2>Webware Servlet Import Test</h2>')
+        wr(f'<h3>{self.__doc__}</h3>')
+        modNameFromClass = ServletImport.__module__
+        modNameConsistent = modName == modNameFromClass
+        servletInSysModules = modName in sys.modules
+        app = self.transaction().application()
+        files = app._imp.fileList(update=False)
+        servletFileWatched = __file__ in files
+        wr(
+            f"<p>modName = <code>{modName}</code></p>"
+            f"<p>modNameFromClass = <code>{modNameFromClass}</code></p>"
+            f"<p>modNameConsistent = <code>{modNameConsistent}</code></p>"
+            f"<p>servletInSysModules = <code>{servletInSysModules}</code></p>"
+            f"<p>servletFileWatched = <code>{servletFileWatched}</code></p>"
         )
+        ok = modNameConsistent and servletInSysModules and servletInSysModules
+        wr('<p style="color:{}"><b>Servlet import test {}.</b></p>'.format(
+            'green' if ok else 'red', 'passed' if ok else 'failed'))

webware/Testing/TestCases.data

@@ -61,5 +61,5 @@
 # If-Modified-Since
 /Testing/TestIMS --> TestIMS passed
 
-# ServletImport
-/Testing/ServletImport --> Servlet imported as part of package
+# Servlet import details
+/Testing/ServletImport --> Servlet import test passed

webware/Tests/TestEndToEnd/AppTest.py

@@ -17,12 +17,12 @@ class AppTest:
     settings = dict(
         PrintConfigAtStartUp=False
     )
-    bufferOutput = True   # set to False if you want to run pdb inside a test to debug it.
+    catchOutput = True  # set to False if you want to run pdb inside a test
 
     @classmethod
     def setUpClass(cls):
         stdout, stderr = sys.stdout, sys.stderr
-        if cls.bufferOutput:
+        if cls.catchOutput:
             sys.stdout = sys.stderr = StringIO()
         cls.currentDir = getcwd()
         import webware
@@ -37,7 +37,7 @@ def setUpClass(cls):
         else:
             error = None
         finally:
-            if cls.bufferOutput:
+            if cls.catchOutput:
                 output = sys.stdout.getvalue().rstrip()
                 sys.stdout, sys.stderr = stdout, stderr
             else:
@@ -46,46 +46,47 @@ def setUpClass(cls):
             raise RuntimeError(
                 'Error setting up application:\n' + error +
                 '\nOutput was:\n' + output)
-        if cls.bufferOutput:
-            if (not output.startswith('Webware for Python')
-                    or 'Running in development mode' not in output
-                    or 'Loading context' not in output):
-                raise AssertionError(
-                    'Application was not properly started.'
-                    ' Output was:\n' + output)
+        if cls.catchOutput and not (
+                output.startswith('Webware for Python')
+                and 'Running in development mode' in output
+                and 'Loading context' in output):
+            raise AssertionError(
+                'Application was not properly started.'
+                ' Output was:\n' + output)
 
     @classmethod
     def tearDownClass(cls):
         stdout, stderr = sys.stdout, sys.stderr
-        if cls.bufferOutput:
+        if cls.catchOutput:
             sys.stdout = sys.stderr = StringIO()
         cls.app.shutDown()
-        if cls.bufferOutput:
+        if cls.catchOutput:
             output = sys.stdout.getvalue().rstrip()
             sys.stdout, sys.stderr = stdout, stderr
         else:
             output = ''
         chdir(cls.currentDir)
-        if cls.bufferOutput and output != ('Application is shutting down...\n'
-                                           'Application has been successfully shutdown.'):
+        if cls.catchOutput and output != (
+                'Application is shutting down...\n'
+                'Application has been successfully shutdown.'):
             raise AssertionError(
                 'Application was not properly shut down. Output was:\n'
                 + output)
 
     def setUp(self):
         self.stdout, self.stderr = sys.stdout, sys.stderr
-        if self.bufferOutput:
+        if self.catchOutput:
             sys.stdout = sys.stderr = StringIO()
 
     def tearDown(self):
-        if self.bufferOutput:
+        if self.catchOutput:
             self.output = sys.stdout.getvalue().rstrip()
             sys.stdout, sys.stderr = self.stdout, self.stderr
         else:
             self.output = ''
 
     def run(self, result=None):
         result = super().run(result)  # pylint: disable=no-member
-        if not result.wasSuccessful() and self.bufferOutput and self.output:
+        if not result.wasSuccessful() and self.output:
             print("Application output was:")
             print(self.output)

webware/Tests/TestEndToEnd/TestAdmin.py

@@ -232,14 +232,13 @@ def testAppControl(self):
             'Reload the selected Python modules. Be careful!',
             '<input type="checkbox" name="reloads"'
             ' value="Admin.AdminPage"> Admin.AdminPage<br>')
-
-        # things change, so don't hardcode the index of this checkbox.
-        for i, checkbox in enumerate(r.html.find_all('input', attrs={'name': 'reloads'})):
+        for i, checkbox in enumerate(
+                r.html.find_all('input', attrs={'name': 'reloads'})):
             if checkbox.attrs['value'] == 'Admin.AdminPage':
+                r.form.get('reloads', index=i).checked = True
                 break
         else:
-            assert False, 'Did not find expected checkbox for Admin.AdminPage'
-        r.form.get('reloads', index=i).checked = True
+            self.fail('Did not find expected checkbox for Admin.AdminPage')
         r = r.form.submit('action', index=1)
         self.assertEqual(r.status, '200 OK')
         r.mustcontain(

webware/Tests/TestEndToEnd/TestTesting.py

@@ -259,15 +259,17 @@ def testCase17(self):
         self.assertEqual(len(r.body), size)
 
     def testCase18(self):
-        url = self.getTestCaseUrl(18, 'Servlet imported as part of package')
+        url = self.getTestCaseUrl(18, 'Servlet import test passed')
         r = self.testApp.get(url)
         self.assertEqual(r.status, '200 OK')
         r.mustcontain(
-            '<title>Test of import details.</title>',
-            '<p>mod_name = <code>Testing.ServletImport</code></p>',
-            '<p>mod_name_from_class = <code>Testing.ServletImport</code></p>',
-            f"<p>servlet_in_sys_modules = <code>True</code></p>",
-        )
+            '<title>ServletImport</title>',
+            '<h2>Webware Servlet Import Test</h2>',
+            '<h3>Test of servlet import details.</h3>',
+            '<p>modName = <code>Testing.ServletImport</code></p>',
+            '<p>modNameFromClass = <code>Testing.ServletImport</code></p>',
+            'passed', no='failed')
+
 
 class TestTestingWithExtraPathInfo(TestTesting):