Optimize logging

Author: mdmintz

seleniumbase/core/log_helper.py

@@ -5,24 +5,29 @@
 import sys
 import time
 from seleniumbase.config import settings
+from seleniumbase.fixtures import constants
 
 
 def log_screenshot(test_logpath, driver, screenshot=None, get=False):
     screenshot_name = settings.SCREENSHOT_NAME
     screenshot_path = "%s/%s" % (test_logpath, screenshot_name)
+    screenshot_warning = constants.Warnings.SCREENSHOT_UNDEFINED
     try:
         if not screenshot:
             element = driver.find_element_by_tag_name('body')
             screenshot = element.screenshot_as_base64
-        with open(screenshot_path, "wb") as file:
-            file.write(screenshot)
+        if screenshot != screenshot_warning:
+            with open(screenshot_path, "wb") as file:
+                file.write(screenshot)
+        else:
+            print("WARNING: %s" % screenshot_warning)
         if get:
             return screenshot
     except Exception:
         try:
             driver.get_screenshot_as_file(screenshot_path)
         except Exception:
-            print("WARNING: Unable to get screenshot for failure logs!")
+            print("WARNING: %s" % screenshot_warning)
 
 
 def get_master_time():
@@ -72,13 +77,15 @@ def log_test_failure_data(test, test_logpath, driver, browser, url=None):
     test_id = get_test_id(test)
     data_to_save = []
     data_to_save.append("%s" % test_id)
-    data_to_save.append("----------------------------------------------------")
+    data_to_save.append(
+        "--------------------------------------------------------------------")
     data_to_save.append("Last Page: %s" % last_page)
     data_to_save.append("  Browser: %s" % browser)
     data_to_save.append("Timestamp: %s" % timestamp)
     data_to_save.append("     Date: %s" % the_date)
     data_to_save.append("     Time: %s" % the_time)
-    data_to_save.append("----------------------------------------------------")
+    data_to_save.append(
+        "--------------------------------------------------------------------")
     if sys.version_info[0] >= 3 and hasattr(test, '_outcome') and (
             hasattr(test._outcome, 'errors') and test._outcome.errors):
         try:
@@ -128,6 +135,10 @@ def log_page_source(test_logpath, driver, source=None):
         except Exception:
             # Since we can't get the page source from here, skip saving it
             return
+    if source == constants.Warnings.PAGE_SOURCE_UNDEFINED:
+        page_source = "<h3>Warning: " + source + (
+            "</h3>\n<h4>The browser window was either unreachable, "
+            "unresponsive, or closed prematurely!</h4>")
     html_file_path = "%s/%s" % (test_logpath, html_file_name)
     html_file = codecs.open(html_file_path, "w+", "utf-8")
     rendered_source = get_html_source_with_base_href(driver, page_source)

seleniumbase/fixtures/base_case.py

@@ -7495,13 +7495,15 @@ def __set_last_page_screenshot(self):
                             self.__last_page_screenshot = (
                                 self.driver.get_screenshot_as_base64())
                         except Exception:
-                            pass
+                            self.__last_page_screenshot = (
+                                constants.Warnings.SCREENSHOT_UNDEFINED)
                 if not self.__last_page_screenshot_png:
                     try:
                         self.__last_page_screenshot_png = (
                             self.driver.get_screenshot_as_png())
                     except Exception:
-                        pass
+                        self.__last_page_screenshot_png = (
+                                constants.Warnings.SCREENSHOT_UNDEFINED)
 
     def __set_last_page_url(self):
         if not self.__last_page_url:
@@ -7517,7 +7519,8 @@ def __set_last_page_source(self):
                     log_helper.get_html_source_with_base_href(
                         self.driver, self.driver.page_source))
             except Exception:
-                self.__last_page_source = None
+                self.__last_page_source = (
+                    constants.Warnings.PAGE_SOURCE_UNDEFINED)
 
     def __get_exception_info(self):
         exc_message = None
@@ -7585,8 +7588,10 @@ def __add_pytest_html_extra(self):
                         extra_image['mime_type'] = 'image/png'
                         extra_image['extension'] = 'png'
                         self.__added_pytest_html_extra = True
-                        self._html_report_extra.append(extra_url)
-                        self._html_report_extra.append(extra_image)
+                        if self.__last_page_screenshot != (
+                                constants.Warnings.SCREENSHOT_UNDEFINED):
+                            self._html_report_extra.append(extra_url)
+                            self._html_report_extra.append(extra_image)
             except Exception:
                 pass
 

seleniumbase/fixtures/constants.py

@@ -54,6 +54,11 @@ class Values:
     SSMD = 900  # Smooth Scroll Minimum Distance (for advanced slow scroll)
 
 
+class Warnings:
+    SCREENSHOT_UNDEFINED = "Unable to get screenshot!"
+    PAGE_SOURCE_UNDEFINED = "Unable to get page source!"
+
+
 class JQuery:
     VER = "3.5.1"
     MIN_JS = (