Merge pull request #1537 from seleniumbase/improved-test-reports

mdmintz · web-flow · commit 5fab8903544e · 2022-10-01T20:37:24.000-04:00
Improve test reports
diff --git a/examples/test_apple_site.py b/examples/test_apple_site.py
@@ -4,18 +4,14 @@
 
 class AppleTests(BaseCase):
     def test_apple_developer_site_webdriver_instructions(self):
-        if not (self.headless or self.xvfb):
+        if not (self.headless or self.headless2 or self.xvfb):
             self.demo_mode = True
             self.demo_sleep = 0.5
             self.message_duration = 2.0
         if self.headless and (
             self.browser == "chrome" or self.browser == "edge"
         ):
-            self.get_new_driver(
-                agent="""Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) """
-                """AppleWebKit/537.36 (KHTML, like Gecko) """
-                """Chrome/102.0.5005.61 Safari/537.36"""
-            )
+            self.get_new_driver(browser=self.browser, headless2=True)
         self.open("https://developer.apple.com/search/")
         title = "Testing with WebDriver in Safari"
         self.type('[placeholder*="developer.apple.com"]', title + "\n")
diff --git a/examples/upgrade_chromedriver.py b/examples/upgrade_chromedriver.py
@@ -80,9 +80,7 @@ def test_print_versions(self):
 
     def test_upgrade_chromedriver(self, testdir):
         # Find out if the installed chromedriver version works with Chrome
-        subprocess.check_call(
-            "seleniumbase get chromedriver latest", shell=True
-        )
+        subprocess.check_call("seleniumbase get chromedriver", shell=True)
         testdir = self.basic_run(testdir)
         result = testdir.inline_run("--headless", "-s")  # Upgrades as needed
         try:
diff --git a/help_docs/webdriver_installation.md b/help_docs/webdriver_installation.md
@@ -10,7 +10,7 @@ sbase get geckodriver
 sbase get edgedriver
 ```
 
-* ``sbase get chromedriver`` automatically tries to detect the version you need. If it can't, it defaults to ``chromedriver 72.0.3626.69`` for compatibility reasons. To force getting the latest version, use:
+* To get the latest ``chromedriver`` when you don't have the latest Chrome, use:
 
 ```bash
 sbase get chromedriver latest
@@ -19,9 +19,9 @@ sbase get chromedriver latest
 * You can also get a specific version of chromedriver for a specific version of Chrome:
 
 ```bash
-sbase get chromedriver 102.0.5005.61
+sbase get chromedriver 105.0.5195.52
 
-sbase get chromedriver 102
+sbase get chromedriver 105
 ```
 
 * On Linux, you can run the following two commands (once you've installed SeleniumBase) to automatically upgrade your Chromedriver to match your version of Chrome: (``wget`` downloads the file, and ``pytest`` runs it.)
diff --git a/mkdocs_build/img/logo3.png b/mkdocs_build/img/logo3.png
diff --git a/mkdocs_build/requirements.txt b/mkdocs_build/requirements.txt
@@ -16,7 +16,7 @@ zipp==3.8.1
 ghp-import==2.1.0
 readme-renderer==37.2
 pymdown-extensions==9.6
-importlib-metadata==4.12.0
+importlib-metadata==4.13.0
 bleach==5.0.1
 jsmin==3.0.1
 lunr==0.6.2
@@ -29,7 +29,7 @@ cssselect2==0.7.0
 tinycss2==1.1.1
 defusedxml==0.7.1
 mkdocs==1.4.0
-mkdocs-material==8.5.4
+mkdocs-material==8.5.5
 mkdocs-exclude-search==0.6.4
 mkdocs-simple-hooks==0.1.5
 mkdocs-material-extensions==1.0.3
diff --git a/seleniumbase/__version__.py b/seleniumbase/__version__.py
@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.5.1"
+__version__ = "4.5.2"
diff --git a/seleniumbase/console_scripts/ReadMe.md b/seleniumbase/console_scripts/ReadMe.md
@@ -60,13 +60,13 @@ sbase install [DRIVER] [OPTIONS]
 sbase get chromedriver  # (Default: 72.0.3626.69 - Tries to detect first.)
 sbase get geckodriver
 sbase get edgedriver
-sbase get chromedriver 102
-sbase get chromedriver 102.0.5005.61
+sbase get chromedriver 105
+sbase get chromedriver 105.0.5195.52
 sbase get chromedriver latest
 sbase get chromedriver latest-1  # (Latest minus one)
 sbase get chromedriver -p
 sbase get chromedriver latest -p
-sbase get edgedriver 102.0.1245.44
+sbase get edgedriver 105.0.1343.53
 ```
 
 (Drivers:  ``chromedriver``, ``geckodriver``, ``edgedriver``,
diff --git a/seleniumbase/console_scripts/run.py b/seleniumbase/console_scripts/run.py
@@ -132,24 +132,25 @@ def show_install_usage():
     print("                           iedriver, operadriver)")
     print("  Options:")
     print("           VERSION         Specify the version to download.")
-    print("                            (Default chromedriver = 72.0.3626.69.")
-    print("                             Tries to detect the needed version.")
-    print('                             Use "latest" for the latest version.')
-    print("                             For chromedriver, you can also use")
-    print("                             the major version integer")
-    print('                             or "latest-1" for 1 less than that.)')
+    print("                           Default chromedriver = 72.0.3626.69.")
+    print("                           Tries to detect the needed version.")
+    print('                           Use "latest" for the latest version.')
+    print('                           Use "latest-1" for one less than that.')
+    print("                           For chromedriver or edgedriver,")
+    print("                           you can use the major version integer.")
+    print()
     print("           -p OR --path    Also copy the driver to /usr/local/bin")
     print("  Examples:")
     print("           sbase get chromedriver")
     print("           sbase get geckodriver")
     print("           sbase get edgedriver")
-    print("           sbase get chromedriver 102")
-    print("           sbase get chromedriver 102.0.5005.61")
+    print("           sbase get chromedriver 105")
+    print("           sbase get chromedriver 105.0.5195.52")
     print("           sbase get chromedriver latest")
     print("           sbase get chromedriver latest-1")
     print("           sbase get chromedriver -p")
     print("           sbase get chromedriver latest -p")
-    print("           sbase get edgedriver 102.0.1245.44")
+    print("           sbase get edgedriver 105.0.1343.53")
     print("  Output:")
     print("           Downloads the chosen webdriver to seleniumbase/drivers")
     print("           (chromedriver is required for Chrome automation)")
diff --git a/seleniumbase/console_scripts/sb_install.py b/seleniumbase/console_scripts/sb_install.py
@@ -15,13 +15,13 @@
          sbase get chromedriver
          sbase get geckodriver
          sbase get edgedriver
-         sbase get chromedriver 102.0.5005.61
-         sbase get chromedriver 102
+         sbase get chromedriver 105.0.5195.52
+         sbase get chromedriver 105
          sbase get chromedriver latest
          sbase get chromedriver latest-1  # (Latest minus one)
          sbase get chromedriver -p
          sbase get chromedriver latest -p
-         sbase get edgedriver 102.0.1245.44
+         sbase get edgedriver 105.0.1343.53
 Output:
          Downloads the chosen webdriver to seleniumbase/drivers
          (chromedriver is required for Chrome automation)
@@ -66,24 +66,24 @@ def invalid_run_command():
     exp += "                          iedriver, operadriver)\n"
     exp += "  Options:\n"
     exp += "           VERSION        Specify the version.\n"
-    exp += "                           (Default chromedriver = 72.0.3626.69.\n"
-    exp += "                            Tries to detect the needed version.\n"
-    exp += '                            Use "latest" for the latest version.\n'
-    exp += "                            For chromedriver, you can also use\n"
-    exp += "                            the major version integer\n"
-    exp += '                            or "latest-1" for 1 less than that.)\n'
+    exp += "                          Default chromedriver = 72.0.3626.69.\n"
+    exp += "                          Tries to detect the needed version.\n"
+    exp += '                          Use "latest" for the latest version.\n'
+    exp += '                          Use "latest-1" for one less than that.\n'
+    exp += "                          For chromedriver or edgedriver,\n"
+    exp += "                          you can use the major version integer.\n"
     exp += "           -p OR --path   Also copy the driver to /usr/local/bin\n"
     exp += "  Examples:\n"
     exp += "           sbase get chromedriver\n"
     exp += "           sbase get geckodriver\n"
     exp += "           sbase get edgedriver\n"
-    exp += "           sbase get chromedriver 102\n"
-    exp += "           sbase get chromedriver 102.0.5005.61\n"
+    exp += "           sbase get chromedriver 105\n"
+    exp += "           sbase get chromedriver 105.0.5195.52\n"
     exp += "           sbase get chromedriver latest\n"
     exp += "           sbase get chromedriver latest-1\n"
     exp += "           sbase get chromedriver -p\n"
     exp += "           sbase get chromedriver latest -p\n"
-    exp += "           sbase get edgedriver 102.0.1245.44\n"
+    exp += "           sbase get edgedriver 105.0.1343.53\n"
     exp += "  Output:\n"
     exp += "          Downloads the chosen webdriver to seleniumbase/drivers\n"
     exp += "          (chromedriver is required for Chrome automation)\n"
diff --git a/seleniumbase/core/encoded_images.py b/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"
diff --git a/seleniumbase/core/log_helper.py b/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:
diff --git a/seleniumbase/core/report_helper.py b/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
diff --git a/seleniumbase/core/style_sheet.py b/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
diff --git a/seleniumbase/fixtures/constants.py b/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
diff --git a/seleniumbase/fixtures/page_actions.py b/seleniumbase/fixtures/page_actions.py
diff --git a/seleniumbase/plugins/base_plugin.py b/seleniumbase/plugins/base_plugin.py

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# seleniumbase package`
`2`		`-__version__ = "4.5.1"`
	`2`	`+__version__ = "4.5.2"`