Improve test reports

Author: mdmintz

seleniumbase/core/encoded_images.py

@@ -1,3 +1,8 @@
+""" Instructions for generating encoded images:
+    > import base64
+    > with open("YOUR_FILE.png", "rb") as image_file:
+    >     encoded_string = base64.b64encode(image_file.read())
+"""
 DASH_PIE_PNG_1 = (
     "data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAEcAAABHCAYAAABVsFofAAAAAXN"
     "SR0IArs4c6QAABqxJREFUeAHtnOtPFFcUwO/sLo9GUKIkUtNWDK+a2qZGm2LShDFSoeWhqUat"
@@ -126,6 +131,14 @@
     "CtZrdwUAJRk/AoTJspXWuCo61KDQjw2oCBgOwE+egH3kfj7umAhCOmwEi050g4nslK+I4W/5C"
     "zyeuQ5f3kZ4tNlIZF18vP/AXYR+dvV3FCCAAAAAElFTkSuQmCC"
 )
+REPORT_FAVICON = (
+    "data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXN"
+    "SR0IArs4c6QAAAM9JREFUKBVjnNS8goEUwESKYpBaFiD+z/hTJz2EoM4rM9cw/mcHaYCA2Nl3"
+    "YUwEvTBFkZGREchnBEIwAGv4z/6f4T8DWAIk+P8/RA6ZBCkAA4QNi1IUkVVgYf9nBwpCNTiLc"
+    "GNRgSp0FcxF2CC3RhVVAcOjkNtAEYg4hA3kIjRAPYWmCeRdFIDQ8BBsHookmIMmDtXw5s0bTK"
+    "VoIhCrQBogLHaPUGQVP7avgnA5PMOAjJ87VkO4ZCUNiFa4GRAu3K9o4lA/LJ+xF6KOIEmykwB"
+    "QHy74EMZM3QAAAABJRU5ErkJggg=="
+)
 SIDE_BY_SIDE_PNG = (
     "data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXN"
     "SR0IArs4c6QAAAIVJREFUKBVjvPLvPwMpgIkUxSC1LBANOo0oGq/Ug7hYBUm2gWQNjBBPa/1l"

seleniumbase/core/log_helper.py

@@ -103,6 +103,7 @@ def log_test_failure_data(test, test_logpath, driver, browser, url=None):
     browser_version = None
     driver_version = None
     driver_name = None
+    duration = None
     try:
         browser_version = get_browser_version(driver)
     except Exception:
@@ -113,10 +114,21 @@ def log_test_failure_data(test, test_logpath, driver, browser, url=None):
         )
     except Exception:
         pass
+    try:
+        duration = "%.2f" % (time.time() - (sb_config.start_time_ms / 1000.0))
+        d_len = len(str(duration))
+        s_len = 12 - d_len
+        if s_len < 2:
+            s_len = 2
+        duration = "%s%s(seconds)" % (duration, s_len * " ")
+    except Exception:
+        duration = "(Unknown Duration)"
     if browser_version:
         headless = ""
         if test.headless and browser in ["chrome", "edge", "firefox"]:
             headless = " / headless"
+        if test.headless2 and browser in ["chrome", "edge"]:
+            headless = " / headless2"
         browser_displayed = "%s (%s%s)" % (browser, browser_version, headless)
         if driver_name and driver_version:
             driver_displayed = "%s (%s)" % (driver_name, driver_version)
@@ -143,6 +155,7 @@ def log_test_failure_data(test, test_logpath, driver, browser, url=None):
     data_to_save.append("  Browser: %s" % browser_displayed)
     data_to_save.append("   Driver: %s" % driver_displayed)
     data_to_save.append("Timestamp: %s" % timestamp)
+    data_to_save.append(" Duration: %s" % duration)
     data_to_save.append("     Date: %s" % the_date)
     data_to_save.append("     Time: %s" % the_time)
     data_to_save.append(
@@ -165,6 +178,17 @@ def log_test_failure_data(test, test_logpath, driver, browser, url=None):
             traceback_message = "(Unknown Traceback)"
         data_to_save.append("Traceback: " + traceback_message)
         data_to_save.append("Exception: " + str(exc_message))
+        if hasattr(test, "is_nosetest") and test.is_nosetest:
+            # Also save the data for the report
+            sb_config._report_test_id = test_id
+            sb_config._report_browser = browser_displayed
+            sb_config._report_driver = driver_displayed
+            sb_config._report_timestamp = timestamp
+            sb_config._report_duration = duration
+            sb_config._report_date = the_date
+            sb_config._report_time = the_time
+            sb_config._report_traceback = traceback_message
+            sb_config._report_exception = str(exc_message)
     else:
         the_traceback = None
         if hasattr(test, "is_behave") and test.is_behave:

seleniumbase/core/report_helper.py

@@ -1,10 +1,11 @@
+import codecs
 import os
 import shutil
 import sys
 import time
+from seleniumbase import config as sb_config
 from seleniumbase.config import settings
 from seleniumbase.core.style_sheet import style
-from seleniumbase.fixtures import page_actions
 
 LATEST_REPORT_DIR = settings.LATEST_REPORT_DIR
 ARCHIVE_DIR = settings.REPORT_ARCHIVE_DIR
@@ -31,16 +32,52 @@ def process_successes(test, test_count, duration):
     )
 
 
-def process_failures(test, test_count, browser_type, duration):
+def save_test_failure_data(name, folder=None):
+    """
+    Saves failure data to the current directory, or to a subfolder if provided.
+    If {name} does not end in ".txt", it will get added to it.
+    If the folder provided doesn't exist, it will get created.
+    """
+    if not name.endswith(".txt"):
+        name = name + ".txt"
+    if folder:
+        abs_path = os.path.abspath(".")
+        file_path = os.path.join(abs_path, folder)
+        if not os.path.exists(file_path):
+            os.makedirs(file_path)
+        failure_data_file_path = os.path.join(file_path, name)
+    else:
+        failure_data_file_path = name
+    failure_data_file = codecs.open(failure_data_file_path, "w+", "utf-8")
+    data_to_save = []
+    data_to_save.append(sb_config._report_test_id)
+    data_to_save.append(
+        "--------------------------------------------------------------------"
+    )
+    data_to_save.append("Last Page: %s" % sb_config._fail_page)
+    data_to_save.append("  Browser: %s" % sb_config._report_browser)
+    data_to_save.append("   Driver: %s" % sb_config._report_driver)
+    data_to_save.append("Timestamp: %s" % sb_config._report_timestamp)
+    data_to_save.append(" Duration: %s" % sb_config._report_duration)
+    data_to_save.append("     Date: %s" % sb_config._report_date)
+    data_to_save.append("     Time: %s" % sb_config._report_time)
+    data_to_save.append(
+        "--------------------------------------------------------------------"
+    )
+    data_to_save.append("Traceback: %s" % sb_config._report_traceback)
+    data_to_save.append("Exception: %s" % sb_config._report_exception)
+    failure_data_file.writelines("\r\n".join(data_to_save))
+    failure_data_file.close()
+
+
+def process_failures(test, test_count, duration):
     bad_page_image = "failure_%s.png" % test_count
     bad_page_data = "failure_%s.txt" % test_count
     screenshot_path = os.path.join(LATEST_REPORT_DIR, bad_page_image)
     if hasattr(test, "_last_page_screenshot"):
         with open(screenshot_path, "wb") as file:
             file.write(test._last_page_screenshot)
-    page_actions.save_test_failure_data(
-        test.driver, bad_page_data, browser_type, folder=LATEST_REPORT_DIR
-    )
+    save_test_failure_data(bad_page_data, folder=LATEST_REPORT_DIR)
     exc_message = None
     if (
         sys.version_info[0] >= 3

seleniumbase/core/style_sheet.py

@@ -1,7 +1,9 @@
+from seleniumbase.fixtures import constants
+
 title = """<meta id="OGTitle" property="og:title" content="SeleniumBase">
     <title>Test Report</title>
     <link rel="SHORTCUT ICON"
-    href="https://seleniumbase.io/img/favicon.ico" /> """
+    href="%s" /> """ % constants.Report.FAVICON
 
 style = (
     title

seleniumbase/fixtures/constants.py

@@ -90,6 +90,10 @@ class PipInstall:
     LOCKFILE = Files.DOWNLOADS_FOLDER + "/pipinstall.lock"
 
 
+class Report:
+    FAVICON = encoded_images.REPORT_FAVICON
+
+
 class SideBySide:
     HTML_FILE = "side_by_side.html"
     SIDE_BY_SIDE_PNG = encoded_images.SIDE_BY_SIDE_PNG

seleniumbase/fixtures/page_actions.py

@@ -22,7 +22,6 @@
 
 import codecs
 import os
-import sys
 import time
 from selenium.common.exceptions import ElementNotInteractableException
 from selenium.common.exceptions import ElementNotVisibleException
@@ -1127,53 +1126,6 @@ def save_page_source(driver, name, folder=None):
     html_file.close()
 
 
-def _get_last_page(driver):
-    try:
-        last_page = driver.current_url
-    except Exception:
-        last_page = "[WARNING! Browser Not Open!]"
-    if len(last_page) < 5:
-        last_page = "[WARNING! Browser Not Open!]"
-    return last_page
-
-
-def save_test_failure_data(driver, name, browser_type=None, folder=None):
-    """
-    Saves failure data to the current directory, or to a subfolder if provided.
-    If {name} does not end in ".txt", it will get added to it.
-    If {browser_type} is provided, the logs will include that.
-    If the folder provided doesn't exist, it will get created.
-    """
-    import traceback
-
-    if not name.endswith(".txt"):
-        name = name + ".txt"
-    if folder:
-        abs_path = os.path.abspath(".")
-        file_path = os.path.join(abs_path, folder)
-        if not os.path.exists(file_path):
-            os.makedirs(file_path)
-        failure_data_file_path = os.path.join(file_path, name)
-    else:
-        failure_data_file_path = name
-    failure_data_file = codecs.open(failure_data_file_path, "w+", "utf-8")
-    last_page = _get_last_page(driver)
-    data_to_save = []
-    data_to_save.append("Last_Page: %s" % last_page)
-    if browser_type:
-        data_to_save.append("Browser: %s " % browser_type)
-    data_to_save.append(
-        "Traceback: "
-        + "".join(
-            traceback.format_exception(
-                sys.exc_info()[0], sys.exc_info()[1], sys.exc_info()[2]
-            )
-        )
-    )
-    failure_data_file.writelines("\r\n".join(data_to_save))
-    failure_data_file.close()
-
-
 def wait_for_and_accept_alert(driver, timeout=settings.LARGE_TIMEOUT):
     """
     Wait for and accept an alert. Returns the text from the alert.

seleniumbase/plugins/base_plugin.py

@@ -299,10 +299,9 @@ def add_fails_or_errors(self, test):
                 self.import_error = True
                 return
             self.failures.append(test.id())
-            br = self.options.browser
             self.page_results_list.append(
                 report_helper.process_failures(
-                    test, self.test_count, br, self.duration
+                    test, self.test_count, self.duration
                 )
             )