Merge pull request #1292 from seleniumbase/fix-recorder-bugs-and-improve-deferred-asserts

Fix Recorder bugs and improve deferred asserts

Author: mdmintz

examples/test_deferred_asserts.py

@@ -2,7 +2,6 @@
 This test demonstrates the use of deferred asserts.
 Deferred asserts won't raise exceptions from failures until either
 process_deferred_asserts() is called, or the test reaches the tearDown() step.
-Requires version 2.1.6 or newer for the deferred_assert_exact_text() method.
 """
 import pytest
 from seleniumbase import BaseCase

help_docs/method_summary.md

@@ -740,25 +740,29 @@ self.check_window(
 
 ############
 
-self.deferred_assert_element(selector, by=By.CSS_SELECTOR, timeout=None)
-# Duplicates: self.delayed_assert_element(selector, by=By.CSS_SELECTOR, timeout=None)
+self.deferred_assert_element(selector, by=By.CSS_SELECTOR, timeout=None, fs=False)
+# Duplicates:
+# self.delayed_assert_element(selector, by=By.CSS_SELECTOR, timeout=None, fs=False)
 
 self.deferred_assert_text(
-    text, selector="html", by=By.CSS_SELECTOR, timeout=None)
+    text, selector="html", by=By.CSS_SELECTOR, timeout=None, fs=False)
 # Duplicates:
-# self.delayed_assert_text(text, selector="html", by=By.CSS_SELECTOR, timeout=None)
+# self.delayed_assert_text(
+#     text, selector="html", by=By.CSS_SELECTOR, timeout=None, fs=False)
 
 self.deferred_assert_exact_text(
-    text, selector="html", by=By.CSS_SELECTOR, timeout=None)
+    text, selector="html", by=By.CSS_SELECTOR, timeout=None, fs=False)
 # Duplicates:
-# self.delayed_assert_exact_text(text, selector="html", by=By.CSS_SELECTOR, timeout=None)
+# self.delayed_assert_exact_text(
+#     text, selector="html", by=By.CSS_SELECTOR, timeout=None, fs=False)
 
 self.deferred_check_window(
-    name="default", level=0, baseline=False, check_domain=True, full_diff=False)
+    name="default", level=0, baseline=False,
+    check_domain=True, full_diff=False, fs=False)
 # Duplicates:
-# self.deferred_check_window(
-#     name=name, level=level, baseline=baseline, check_domain=check_domain, full_diff=full_diff)
-
+# self.delayed_check_window(
+#     name="default", level=0, baseline=False,
+#     check_domain=True, full_diff=False, fs=False)
 self.process_deferred_asserts(print_only=False)
 # Duplicates: self.process_delayed_asserts(print_only=False)
 

mkdocs_build/requirements.txt

@@ -15,6 +15,7 @@ pkginfo==1.8.2
 Jinja2==3.1.2
 click==8.1.3
 zipp==3.8.0
+ghp-import==2.1.0
 readme-renderer==35.0
 pymdown-extensions==9.4
 importlib-metadata==4.11.3
@@ -24,7 +25,7 @@ lunr==0.6.2
 nltk==3.7
 watchdog==2.1.7
 mkdocs==1.3.0
-mkdocs-material==8.2.12
+mkdocs-material==8.2.13
 mkdocs-exclude-search==0.6.4
 mkdocs-simple-hooks==0.1.5
 mkdocs-material-extensions==1.0.3

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "2.5.3"
+__version__ = "2.5.4"

seleniumbase/extensions/recorder.zip

@@ -3201,7 +3201,7 @@ def save_screenshot(
     def save_screenshot_to_logs(
         self, name=None, selector=None, by=By.CSS_SELECTOR
     ):
-        """Saves a screenshot of the current page to the "latest_logs" folder.
+        """Saves a screenshot of the current page to the "latest_logs/" folder.
         Naming is automatic:
             If NO NAME provided: "_1_screenshot.png", "_2_screenshot.png", etc.
             If NAME IS provided, it becomes: "_1_name.png", "_2_name.png", etc.
@@ -10585,24 +10585,31 @@ def __get_exception_message(self):
             exc_message = sys.exc_info()
         return exc_message
 
-    def __add_deferred_assert_failure(self):
+    def __add_deferred_assert_failure(self, fs=False):
         """Add a deferred_assert failure to a list for future processing."""
         self.__check_scope()
         current_url = self.driver.current_url
         message = self.__get_exception_message()
+        count = self.__deferred_assert_count
         self.__deferred_assert_failures.append(
-            "CHECK #%s: (%s) %s\n"
-            % (self.__deferred_assert_count, current_url, message)
+            "DEFERRED ASSERT #%s: (%s) %s\n" % (count, current_url, message)
         )
+        if fs:
+            self.save_screenshot_to_logs(name="deferred_#%s" % count)
 
     ############
 
     def deferred_assert_element(
-        self, selector, by=By.CSS_SELECTOR, timeout=None
+        self, selector, by=By.CSS_SELECTOR, timeout=None, fs=False
     ):
         """A non-terminating assertion for an element on a page.
         Failures will be saved until the process_deferred_asserts()
-        method is called from inside a test, likely at the end of it."""
+        method is called from inside a test, likely at the end of it.
+        If "fs" is set to True, a failure screenshot is saved to the
+        "latest_logs/" folder for that assertion failure. Otherwise,
+        only the last page screenshot is taken for all failures when
+        calling the process_deferred_asserts() method.
+        """
         self.__check_scope()
         if not timeout:
             timeout = settings.MINI_TIMEOUT
@@ -10621,15 +10628,20 @@ def deferred_assert_element(
             self.wait_for_element_visible(selector, by=by, timeout=timeout)
             return True
         except Exception:
-            self.__add_deferred_assert_failure()
+            self.__add_deferred_assert_failure(fs=fs)
             return False
 
     def deferred_assert_text(
-        self, text, selector="html", by=By.CSS_SELECTOR, timeout=None
+        self, text, selector="html", by=By.CSS_SELECTOR, timeout=None, fs=False
     ):
         """A non-terminating assertion for text from an element on a page.
         Failures will be saved until the process_deferred_asserts()
-        method is called from inside a test, likely at the end of it."""
+        method is called from inside a test, likely at the end of it.
+        If "fs" is set to True, a failure screenshot is saved to the
+        "latest_logs/" folder for that assertion failure. Otherwise,
+        only the last page screenshot is taken for all failures when
+        calling the process_deferred_asserts() method.
+        """
         self.__check_scope()
         if not timeout:
             timeout = settings.MINI_TIMEOUT
@@ -10648,15 +10660,20 @@ def deferred_assert_text(
             self.wait_for_text_visible(text, selector, by=by, timeout=timeout)
             return True
         except Exception:
-            self.__add_deferred_assert_failure()
+            self.__add_deferred_assert_failure(fs=fs)
             return False
 
     def deferred_assert_exact_text(
-        self, text, selector="html", by=By.CSS_SELECTOR, timeout=None
+        self, text, selector="html", by=By.CSS_SELECTOR, timeout=None, fs=False
     ):
         """A non-terminating assertion for exact text from an element.
         Failures will be saved until the process_deferred_asserts()
-        method is called from inside a test, likely at the end of it."""
+        method is called from inside a test, likely at the end of it.
+        If "fs" is set to True, a failure screenshot is saved to the
+        "latest_logs/" folder for that assertion failure. Otherwise,
+        only the last page screenshot is taken for all failures when
+        calling the process_deferred_asserts() method.
+        """
         self.__check_scope()
         if not timeout:
             timeout = settings.MINI_TIMEOUT
@@ -10677,7 +10694,7 @@ def deferred_assert_exact_text(
             )
             return True
         except Exception:
-            self.__add_deferred_assert_failure()
+            self.__add_deferred_assert_failure(fs=fs)
             return False
 
     def deferred_check_window(
@@ -10687,10 +10704,16 @@ def deferred_check_window(
         baseline=False,
         check_domain=True,
         full_diff=False,
+        fs=False,
     ):
         """A non-terminating assertion for the check_window() method.
         Failures will be saved until the process_deferred_asserts()
-        method is called from inside a test, likely at the end of it."""
+        method is called from inside a test, likely at the end of it.
+        If "fs" is set to True, a failure screenshot is saved to the
+        "latest_logs/" folder for that assertion failure. Otherwise,
+        only the last page screenshot is taken for all failures when
+        calling the process_deferred_asserts() method.
+        """
         self.__check_scope()
         self.__deferred_assert_count += 1
         try:
@@ -10703,7 +10726,7 @@ def deferred_check_window(
             )
             return True
         except Exception:
-            self.__add_deferred_assert_failure()
+            self.__add_deferred_assert_failure(fs=fs)
             return False
 
     def process_deferred_asserts(self, print_only=False):
@@ -10735,27 +10758,27 @@ def process_deferred_asserts(self, print_only=False):
     # Alternate naming scheme for the "deferred_assert" methods.
 
     def delayed_assert_element(
-        self, selector, by=By.CSS_SELECTOR, timeout=None
+        self, selector, by=By.CSS_SELECTOR, timeout=None, fs=False
     ):
         """Same as self.deferred_assert_element()"""
         return self.deferred_assert_element(
-            selector=selector, by=by, timeout=timeout
+            selector=selector, by=by, timeout=timeout, fs=fs
         )
 
     def delayed_assert_text(
-        self, text, selector="html", by=By.CSS_SELECTOR, timeout=None
+        self, text, selector="html", by=By.CSS_SELECTOR, timeout=None, fs=False
     ):
         """Same as self.deferred_assert_text()"""
         return self.deferred_assert_text(
-            text=text, selector=selector, by=by, timeout=timeout
+            text=text, selector=selector, by=by, timeout=timeout, fs=fs
         )
 
     def delayed_assert_exact_text(
-        self, text, selector="html", by=By.CSS_SELECTOR, timeout=None
+        self, text, selector="html", by=By.CSS_SELECTOR, timeout=None, fs=False
     ):
         """Same as self.deferred_assert_exact_text()"""
         return self.deferred_assert_exact_text(
-            text=text, selector=selector, by=by, timeout=timeout
+            text=text, selector=selector, by=by, timeout=timeout, fs=fs
         )
 
     def delayed_check_window(
@@ -10765,6 +10788,7 @@ def delayed_check_window(
         baseline=False,
         check_domain=True,
         full_diff=False,
+        fs=False,
     ):
         """Same as self.deferred_check_window()"""
         return self.deferred_check_window(
@@ -10773,6 +10797,7 @@ def delayed_check_window(
             baseline=baseline,
             check_domain=check_domain,
             full_diff=full_diff,
+            fs=fs,
         )
 
     def process_delayed_asserts(self, print_only=False):

seleniumbase/fixtures/base_case.py

@@ -361,7 +361,7 @@
     document.title = sessionStorage.getItem('recorder_title');
 });
 document.body.addEventListener('click', function (event) {
-    // Do Nothing.
+    // Do Nothing
 });
 document.body.addEventListener('submit', function (event) {
     reset_if_recorder_undefined();
@@ -513,9 +513,8 @@
     if (rec_mode === '2' || rec_mode === '3')
     {
         el = turnIntoParentAsNeeded(el);
-        texts = [el.innerText, el.textContent];
-        text = texts[0];
-        t_con = texts[1];
+        text = el.innerText;
+        t_con = el.textContent;
         origin = window.location.origin;
         sel_has_contains = selector.includes(':contains(');
         if (!text) { text = ''; }
@@ -530,6 +529,8 @@
         else if (rec_mode === '3') {
             action = 'as_et';
             text = text.trim();
+            if (el.tagName.toLowerCase() == "input")
+                text = el.value.trim();
             var match = /\r|\n/.exec(text);
             if (match) {
                 lines = text.split(/\r\n|\r|\n/g);
@@ -550,7 +551,7 @@
     if (ra_len > 0 && document.recorded_actions[ra_len-1][0] === 'mo_dn')
         document.recorded_actions.pop();
     if (tag_name === 'select') {
-        // Do Nothing. ('change' action.)
+        // Do Nothing ('change' action)
     }
     else
         document.recorded_actions.push(['mo_dn', selector, '', d_now]);
@@ -662,7 +663,7 @@
     else if (ra_len > 0 &&
         document.recorded_actions[ra_len-1][0] === 'mo_dn')
     {
-        // Maybe accidental drag & drop.
+        // Accidental drag & drop.
         document.recorded_actions.pop();
     }
     json_rec_act = JSON.stringify(document.recorded_actions);
@@ -733,7 +734,7 @@
         red_border = 'thick solid #EE3344';
         document.querySelector('body').style.border = red_border;
     }
-    // After controls for switching modes.
+    // After switching modes
     if (sessionStorage.getItem('pause_recorder') === 'yes') return;
     const d_now = Date.now();
     const el = event.target;
@@ -775,7 +776,7 @@
         {
             skip_input = true;
         }
-        if (!skip_input) {
+        if (!skip_input && !el.hasAttribute('readonly')) {
             document.recorded_actions.push(
                 ['input', selector, el.value, d_now]);
         }