Refactor error logging

Author: mdmintz

seleniumbase/core/log_helper.py

@@ -25,11 +25,14 @@ def log_screenshot(test_logpath, driver, screenshot=None, get=False):
             print("WARNING: Unable to get screenshot for failure logs!")
 
 
-def log_test_failure_data(test, test_logpath, driver, browser):
+def log_test_failure_data(test, test_logpath, driver, browser, url=None):
     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)
+    if url:
+        last_page = url
+    else:
+        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)
@@ -56,13 +59,16 @@ def log_test_failure_data(test, test_logpath, driver, browser):
     log_file.close()
 
 
-def log_page_source(test_logpath, driver):
+def log_page_source(test_logpath, driver, source=None):
     html_file_name = settings.PAGE_SOURCE_NAME
-    try:
-        page_source = driver.page_source
-    except Exception:
-        # Since we can't get the page source from here, skip saving it
-        return
+    if source:
+        page_source = source
+    else:
+        try:
+            page_source = driver.page_source
+        except Exception:
+            # Since we can't get the page source from here, skip saving it
+            return
     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

@@ -80,6 +80,8 @@ def __init__(self, *args, **kwargs):
         self.__last_page_load_url = "data:,"
         self.__last_page_screenshot = None
         self.__last_page_screenshot_png = None
+        self.__last_page_url = None
+        self.__last_page_source = None
         self.__added_pytest_html_extra = None
         self.__delayed_assert_count = 0
         self.__delayed_assert_failures = []
@@ -4548,6 +4550,22 @@ def __set_last_page_screenshot(self):
                     except Exception:
                         pass
 
+    def __set_last_page_url(self):
+        if not self.__last_page_url:
+            try:
+                self.__last_page_url = log_helper.get_last_page(self.driver)
+            except Exception:
+                self.__last_page_url = None
+
+    def __set_last_page_source(self):
+        if not self.__last_page_source:
+            try:
+                self.__last_page_source = (
+                    log_helper.get_html_source_with_base_href(
+                        self.driver, self.driver.page_source))
+            except Exception:
+                self.__last_page_source = None
+
     def __insert_test_result(self, state, err):
         data_payload = TestcaseDataPayload()
         data_payload.runtime = int(time.time() * 1000) - self.case_start_time
@@ -4574,6 +4592,8 @@ def __add_pytest_html_extra(self):
                 if self.with_selenium:
                     if not self.__last_page_screenshot:
                         self.__set_last_page_screenshot()
+                        self.__set_last_page_url()
+                        self.__set_last_page_source()
                     if self.report_on:
                         extra_url = {}
                         extra_url['name'] = 'URL'
@@ -4655,6 +4675,8 @@ def save_teardown_screenshot(self):
             test_logpath = self.log_path + "/" + test_id
             self.__create_log_path_as_needed(test_logpath)
             self.__set_last_page_screenshot()
+            self.__set_last_page_url()
+            self.__set_last_page_source()
             if self.is_pytest:
                 self.__add_pytest_html_extra()
 
@@ -4715,6 +4737,8 @@ def tearDown(self):
                     self.__create_log_path_as_needed(test_logpath)
                     if not self.__last_page_screenshot_png:
                         self.__set_last_page_screenshot()
+                        self.__set_last_page_url()
+                        self.__set_last_page_source()
                     log_helper.log_screenshot(
                         test_logpath,
                         self.driver,
@@ -4729,27 +4753,35 @@ def tearDown(self):
                         # Log everything if nothing specified (if testing_base)
                         if not self.__last_page_screenshot_png:
                             self.__set_last_page_screenshot()
+                            self.__set_last_page_url()
+                            self.__set_last_page_source()
                         log_helper.log_screenshot(
                             test_logpath,
                             self.driver,
                             self.__last_page_screenshot_png)
                         log_helper.log_test_failure_data(
-                            self, test_logpath, self.driver, self.browser)
-                        log_helper.log_page_source(test_logpath, self.driver)
+                            self, test_logpath, self.driver, self.browser,
+                            self.__last_page_url)
+                        log_helper.log_page_source(
+                            test_logpath, self.driver, self.__last_page_source)
                     else:
                         if self.with_screen_shots:
                             if not self.__last_page_screenshot_png:
                                 self.__set_last_page_screenshot()
+                                self.__set_last_page_url()
+                                self.__set_last_page_source()
                             log_helper.log_screenshot(
                                 test_logpath,
                                 self.driver,
                                 self.__last_page_screenshot_png)
                         if self.with_basic_test_info:
                             log_helper.log_test_failure_data(
-                                self, test_logpath, self.driver, self.browser)
+                                self, test_logpath, self.driver, self.browser,
+                                self.__last_page_url)
                         if self.with_page_source:
                             log_helper.log_page_source(
-                                test_logpath, self.driver)
+                                test_logpath, self.driver,
+                                self.__last_page_source)
                 # (Pytest) Finally close all open browser windows
                 self.__quit_all_drivers()
             if self.headless:
@@ -4801,21 +4833,27 @@ def tearDown(self):
                 test_logpath = self.log_path + "/" + test_id
                 self.__create_log_path_as_needed(test_logpath)
                 log_helper.log_test_failure_data(
-                    self, test_logpath, self.driver, self.browser)
+                    self, test_logpath, self.driver, self.browser,
+                    self.__last_page_url)
                 if len(self._drivers_list) > 0:
                     if not self.__last_page_screenshot_png:
                         self.__set_last_page_screenshot()
+                        self.__set_last_page_url()
+                        self.__set_last_page_source()
                     log_helper.log_screenshot(
                         test_logpath,
                         self.driver,
                         self.__last_page_screenshot_png)
-                    log_helper.log_page_source(test_logpath, self.driver)
+                    log_helper.log_page_source(
+                        test_logpath, self.driver, self.__last_page_source)
             elif self.save_screenshot_after_test:
                 test_id = self.__get_test_id()
                 test_logpath = self.log_path + "/" + test_id
                 self.__create_log_path_as_needed(test_logpath)
                 if not self.__last_page_screenshot_png:
                     self.__set_last_page_screenshot()
+                    self.__set_last_page_url()
+                    self.__set_last_page_source()
                 log_helper.log_screenshot(
                     test_logpath,
                     self.driver,