Merge pull request #118 from seleniumbase/fix-python3-logging-issue

Fix Python 3 Logging Issue

Author: mdmintz

examples/gui_test_runner.py

@@ -3,7 +3,12 @@
 Run by Typing: "python gui_test_runner.py"
 '''
 
-from Tkinter import Tk, Frame, Button, Label
+try:
+    # Python 2
+    from Tkinter import Tk, Frame, Button, Label
+except:
+    # Python 3
+    from tkinter import Tk, Frame, Button, Label
 import os
 
 

seleniumbase/core/log_helper.py

@@ -10,18 +10,32 @@ def log_screenshot(test_logpath, driver):
     driver.get_screenshot_as_file(screenshot_path)
 
 
-def log_test_failure_data(test_logpath, driver, browser):
+def log_test_failure_data(test, test_logpath, driver, browser):
     basic_info_name = settings.BASIC_INFO_NAME
     basic_file_path = "%s/%s" % (test_logpath, basic_info_name)
     log_file = codecs.open(basic_file_path, "w+", "utf-8")
     last_page = get_last_page(driver)
     data_to_save = []
     data_to_save.append("Last_Page: %s" % last_page)
     data_to_save.append("Browser: %s " % browser)
-    data_to_save.append("Traceback: " + ''.join(
-        traceback.format_exception(sys.exc_info()[0],
-                                   sys.exc_info()[1],
-                                   sys.exc_info()[2])))
+    if sys.version.startswith('3') and hasattr(test, '_outcome'):
+        if test._outcome.errors:
+            try:
+                exc_message = test._outcome.errors[0][1][1].msg
+                traceback_address = test._outcome.errors[0][1][2]
+                traceback_list = traceback.format_list(
+                    traceback.extract_tb(traceback_address)[1:])
+                traceback_message = ''.join(traceback_list).strip()
+            except:
+                exc_message = "(Unknown Exception)"
+                traceback_message = "(Unknown Traceback)"
+            data_to_save.append("Traceback: " + traceback_message)
+            data_to_save.append("Exception: " + exc_message)
+    else:
+        data_to_save.append("Traceback: " + ''.join(
+            traceback.format_exception(sys.exc_info()[0],
+                                       sys.exc_info()[1],
+                                       sys.exc_info()[2])))
     log_file.writelines("\r\n".join(data_to_save))
     log_file.close()
 

seleniumbase/fixtures/base_case.py

@@ -1126,13 +1126,23 @@ def _get_exception_message(self):
         """ This method extracts the message from an exception if there
             was an exception that occurred during the test, assuming
             that the exception was in a try/except block and not thrown. """
-        exception_info = sys.exc_info()[1]
-        if hasattr(exception_info, 'msg'):
-            exc_message = exception_info.msg
-        elif hasattr(exception_info, 'message'):
-            exc_message = exception_info.message
+        if sys.version.startswith('3') and hasattr(self, '_outcome'):
+            exception_info = self._outcome.errors
+            if exception_info:
+                try:
+                    exc_message = exception_info[0][1][1]
+                except:
+                    exc_message = "(Unknown Exception)"
+            else:
+                exc_message = "(Unknown Exception)"
         else:
-            exc_message = '(Unknown Exception)'
+            exception_info = sys.exc_info()[1]
+            if hasattr(exception_info, 'msg'):
+                exc_message = exception_info.msg
+            elif hasattr(exception_info, 'message'):
+                exc_message = exception_info.message
+            else:
+                exc_message = '(Unknown Exception)'
         return exc_message
 
     def _package_check(self):
@@ -1405,12 +1415,18 @@ def tearDown(self):
         You'll need to add the following line to the subclass's tearDown():
         super(SubClassOfBaseCase, self).tearDown()
         """
+        has_exception = False
+        if sys.version.startswith('3') and hasattr(self, '_outcome'):
+            if self._outcome.errors:
+                has_exception = True
+        else:
+            has_exception = sys.exc_info()[1] is not None
         if self.page_check_failures:
             print(
                 "\nWhen using self.check_assert_***() methods in your tests, "
                 "remember to call self.process_checks() afterwards. "
                 "Now calling in tearDown()...\nFailures Detected:")
-            if not sys.exc_info()[1]:
+            if not has_exception:
                 self.process_checks()
             else:
                 self.process_checks(print_only=True)
@@ -1428,10 +1444,9 @@ def tearDown(self):
                                     self._testMethodName)
             if self.with_selenium:
                 # Save a screenshot if logging is on when an exception occurs
-                is_exception = sys.exc_info()[1] is not None
-                if is_exception:
+                if has_exception:
                     self._add_pytest_html_extra()
-                if self.with_testing_base and is_exception:
+                if self.with_testing_base and has_exception:
                     test_logpath = self.log_path + "/" + test_id
                     if not os.path.exists(test_logpath):
                         os.makedirs(test_logpath)
@@ -1441,15 +1456,15 @@ def tearDown(self):
                         # Log everything if nothing specified (if testing_base)
                         log_helper.log_screenshot(test_logpath, self.driver)
                         log_helper.log_test_failure_data(
-                            test_logpath, self.driver, self.browser)
+                            self, test_logpath, self.driver, self.browser)
                         log_helper.log_page_source(test_logpath, self.driver)
                     else:
                         if self.with_screen_shots:
                             log_helper.log_screenshot(
                                 test_logpath, self.driver)
                         if self.with_basic_test_info:
                             log_helper.log_test_failure_data(
-                                test_logpath, self.driver, self.browser)
+                                self, test_logpath, self.driver, self.browser)
                         if self.with_page_source:
                             log_helper.log_page_source(
                                 test_logpath, self.driver)
@@ -1466,14 +1481,14 @@ def tearDown(self):
                     self.display.stop()
                     self.display = None
             if self.with_db_reporting:
-                if sys.exc_info()[1] is not None:
+                if has_exception:
                     self.__insert_test_result(constants.State.ERROR, True)
                 else:
                     self.__insert_test_result(constants.State.PASS, False)
                 runtime = int(time.time() * 1000) - self.execution_start_time
                 self.testcase_manager.update_execution_data(
                     self.execution_guid, runtime)
-            if self.with_s3_logging and (sys.exc_info()[1] is not None):
+            if self.with_s3_logging and has_exception:
                 """ After each testcase, upload logs to the S3 bucket. """
                 s3_bucket = S3LoggingBucket()
                 guid = str(uuid.uuid4().hex)

seleniumbase/plugins/base_plugin.py

@@ -123,7 +123,7 @@ def __log_all_options_if_none_specified(self, test):
             test_logpath = self.options.log_path + "/" + test.id()
             log_helper.log_screenshot(test_logpath, test.driver)
             log_helper.log_test_failure_data(
-                test_logpath, test.driver, test.browser)
+                test, test_logpath, test.driver, test.browser)
             log_helper.log_page_source(test_logpath, test.driver)
 
     def addSuccess(self, test, capt):

server_setup.py

@@ -8,7 +8,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.4.3',
+    version='1.4.4',
     description='Test Automation Framework - http://seleniumbase.com',
     long_description='Automation Framework for Simple & Reliable Web Testing',
     platforms='Mac * Windows * Linux * Docker',

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.4.3',
+    version='1.4.4',
     description='Test Automation Framework - http://seleniumbase.com',
     long_description='Automation Framework for Simple & Reliable Web Testing',
     platforms='Mac * Windows * Linux * Docker',