Merge pull request #1015 from seleniumbase/recorder-mode-assertions

Recorder Mode assertions and more

Author: mdmintz

docs/requirements.txt

@@ -19,7 +19,7 @@ bleach==4.1.0
 lunr==0.6.0;python_version>="3.6"
 nltk==3.6.5;python_version>="3.6"
 watchdog==2.1.6;python_version>="3.6"
-mkdocs==1.2.2;python_version>="3.6"
+mkdocs==1.2.3;python_version>="3.6"
 mkdocs-material==7.3.3;python_version>="3.6"
 mkdocs-exclude-search==0.5.2;python_version>="3.6"
 mkdocs-simple-hooks==0.1.3

examples/translations/french_test_1.py

@@ -11,7 +11,7 @@ def test_exemple_1(self):
         self.cliquer("#searchform button")
         self.vérifier_texte("Crème brûlée", "#firstHeading")
         self.vérifier_élément('img[alt*="Crème brûlée"]')
-        self.taper("#searchform input", "Jardin des Tuileries")
+        self.js_taper("#searchform input", "Jardin des Tuileries")
         self.cliquer("#searchform button")
         self.vérifier_texte("Jardin des Tuileries", "#firstHeading")
         self.vérifier_élément('img[alt*="Jardin des Tuileries"]')

help_docs/method_summary.md

@@ -247,6 +247,10 @@ self.sleep(seconds)
 
 self.install_addon(xpi_file)
 
+self.activate_demo_mode()
+
+self.deactivate_demo_mode()
+
 self.activate_design_mode()
 
 self.deactivate_design_mode()

help_docs/recorder_mode.md

@@ -84,6 +84,8 @@ class RecorderTest(BaseCase):
 
 <p>🔴 SeleniumBase <code>1.66.12</code> adds the ability to instantly create a new test recording by running <code>sbase mkrec FILE.py</code>. Once the browser spins up, you can open a new web page and start performing actions that will get recorded and saved to the file you specified.</p>
 
+<p>🔴 SeleniumBase <code>1.66.13</code> lets you add assertions for elements and text while making a recording. To add an element assertion, press <code>[^](SHIFT+6)</code>, (the border will become purple) then click on elements that you'd like to assert. To add a text assertion, press <code>[&](SHIFT+7)</code>, (the border will become orange) then click on text elements that you'd like to assert. To go back to the regular Record Mode, press any other key. While in the special assertion modes, certain actions such as clicking on links won't have any effect. This lets you make assertions on elements without certain actions getting in the way.</p>
+
 --------
 
 <div>To learn more about SeleniumBase, check out the Docs Site:</div>

requirements.txt

@@ -11,7 +11,7 @@ setuptools-scm>=6.3.2;python_version>="3.6"
 tomli>=1.2.1;python_version>="3.6"
 wheel>=0.37.0
 attrs>=21.2.0
-PyYAML>=5.4.1;python_version>="3.6"
+PyYAML>=6.0;python_version>="3.6"
 sortedcontainers==2.4.0
 certifi>=2021.10.8
 six==1.16.0
@@ -23,10 +23,10 @@ parso==0.8.2;python_version>="3.6"
 jedi==0.17.2;python_version<"3.6"
 jedi==0.18.0;python_version>="3.6"
 idna==2.10;python_version<"3.6"
-idna==3.2;python_version>="3.6"
+idna==3.3;python_version>="3.6"
 chardet==3.0.4;python_version<"3.5"
 chardet==4.0.0;python_version>="3.5"
-charset-normalizer==2.0.6;python_version>="3.5"
+charset-normalizer==2.0.7;python_version>="3.5"
 urllib3==1.26.7
 requests==2.26.0;python_version<"3.5"
 requests==2.25.1;python_version>="3.5" and python_version<"3.6"
@@ -96,7 +96,7 @@ pymysql==0.10.1;python_version<"3.6"
 pymysql==1.0.2;python_version>="3.6"
 pyotp==2.6.0
 boto==2.49.0
-cffi==1.14.6
+cffi==1.15.0
 toml==0.10.2
 Pillow==6.2.2;python_version<"3.5"
 Pillow==7.2.0;python_version>="3.5" and python_version<"3.6"
@@ -105,13 +105,14 @@ rich==10.12.0;python_version>="3.6" and python_version<"4.0"
 tornado==5.1.1;python_version<"3.5"
 tornado==6.1;python_version>="3.5"
 pdfminer.six==20191110;python_version<"3.5"
-pdfminer.six==20201018;python_version>="3.5"
+pdfminer.six==20201018;python_version>="3.5" and python_version<"3.6"
+pdfminer.six==20211012;python_version>="3.6"
 
 # --- Testing Requirements --- #
 # ("pip install -r requirements.txt" also installs this, but "pip install -e ." won't.)
 
 coverage==5.5;python_version<"3.6"
-coverage==6.0.1;python_version>="3.6"
+coverage==6.0.2;python_version>="3.6"
 pytest-cov==2.12.1;python_version<"3.6"
 pytest-cov==3.0.0;python_version>="3.6"
 flake8==3.7.9;python_version<"3.5"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.66.12"
+__version__ = "1.66.13"

seleniumbase/console_scripts/run.py

@@ -11,6 +11,7 @@
 sbase options
 sbase mkdir ui_tests
 sbase mkfile new_test.py
+sbase mkrec new_test.py
 sbase mkpres new_presentation.py
 sbase mkchart new_chart.py
 sbase convert webdriver_unittest_file.py
@@ -74,6 +75,7 @@ def show_basic_usage():
     sc += "      options         (List common pytest options)\n"
     sc += "      mkdir           [DIRECTORY] [OPTIONS]\n"
     sc += "      mkfile          [FILE.py] [OPTIONS]\n"
+    sc += "      mkrec           [FILE.py]\n"
     sc += "      mkpres          [FILE.py] [LANG]\n"
     sc += "      mkchart         [FILE.py] [LANG]\n"
     sc += "      print           [FILE] [OPTIONS]\n"

seleniumbase/extensions/recorder.zip

@@ -97,6 +97,7 @@ def __init__(self, *args, **kwargs):
         self.__last_page_source = None
         self.__skip_reason = None
         self.__dont_record_js_click = False
+        self.__new_window_on_rec_open = True
         self.__overrided_default_timeouts = False
         self.__added_pytest_html_extra = None
         self.__deferred_assert_count = 0
@@ -143,6 +144,11 @@ def open(self, url):
             # Convert URLs such as "://google.com" into "https://google.com"
             url = "https" + url
         if self.recorder_mode:
+            time_stamp = self.execute_script("return Date.now();")
+            origin = self.get_origin()
+            action = ["_url_", origin, url, time_stamp]
+            self.__extra_actions.append(action)
+        if self.recorder_mode and self.__new_window_on_rec_open:
             c_url = self.driver.current_url
             if ("http:") in c_url or ("https:") in c_url or ("file:") in c_url:
                 if self.get_domain_url(url) != self.get_domain_url(c_url):
@@ -3125,6 +3131,12 @@ def install_addon(self, xpi_file):
         xpi_path = os.path.abspath(xpi_file)
         self.driver.install_addon(xpi_path, temporary=True)
 
+    def activate_demo_mode(self):
+        self.demo_mode = True
+
+    def deactivate_demo_mode(self):
+        self.demo_mode = False
+
     def activate_design_mode(self):
         # Activate Chrome's Design Mode, which lets you edit a site directly.
         # See: https://twitter.com/sulco/status/1177559150563344384
@@ -3267,6 +3279,16 @@ def __process_recorded_actions(self):
                     url2 = url2[:-1]
                 if url1 == url2:
                     srt_actions[n-1][0] = "_skip"
+                elif url2.startswith(url1):
+                    srt_actions[n][0] = "f_url"
+        for n in range(len(srt_actions)):
+            if (
+                srt_actions[n][0] == "input"
+                and n > 0
+                and srt_actions[n-1][0] == "input"
+                and srt_actions[n-1][2] == ""
+            ):
+                srt_actions[n-1][0] = "_skip"
         for n in range(len(srt_actions)):
             if (
                 (srt_actions[n][0] == "begin" or srt_actions[n][0] == "_url_")
@@ -3336,8 +3358,10 @@ def __process_recorded_actions(self):
             ):
                 srt_actions[n-1][0] = "_skip"
         ext_actions = []
+        ext_actions.append("_url_")
         ext_actions.append("js_cl")
         ext_actions.append("js_ca")
+        ext_actions.append("js_ty")
         ext_actions.append("as_el")
         ext_actions.append("as_ep")
         ext_actions.append("asenv")
@@ -3365,8 +3389,21 @@ def __process_recorded_actions(self):
                     origin = srt_actions[n][2][1]
                 if origin.endswith("/"):
                     origin = origin[0:-1]
+                if srt_actions[n][0] == "js_ty":
+                    srt_actions[n][2] = srt_actions[n][1][1]
+                    srt_actions[n][1] = srt_actions[n][1][0]
+                if srt_actions[n][0] == "_url_" and origin not in origins:
+                    origins.append(origin)
                 if origin not in origins:
                     srt_actions[n][0] = "_skip"
+        for n in range(len(srt_actions)):
+            if (
+                srt_actions[n][0] == "input"
+                and n > 0
+                and srt_actions[n-1][0] == "js_ty"
+                and srt_actions[n][2] == srt_actions[n-1][2]
+            ):
+                srt_actions[n][0] = "_skip"
         for n in range(len(srt_actions)):
             cleaned_actions.append(srt_actions[n])
         for action in srt_actions:
@@ -3392,8 +3429,10 @@ def __process_recorded_actions(self):
                     sb_actions.append('self.%s("%s")' % (method, action[1]))
                 else:
                     sb_actions.append("self.%s('%s')" % (method, action[1]))
-            elif action[0] == "input":
+            elif action[0] == "input" or action[0] == "js_ty":
                 method = "type"
+                if action[0] == "js_ty":
+                    method = "js_type"
                 text = action[2].replace("\n", "\\n")
                 if '"' not in action[1] and '"' not in text:
                     sb_actions.append('self.%s("%s", "%s")' % (
@@ -5233,6 +5272,7 @@ def set_value(
             text = str(text)
         value = re.escape(text)
         value = self.__escape_quotes_if_needed(value)
+        pre_escape_css_selector = css_selector
         css_selector = re.escape(css_selector)  # Add "\\" to special chars
         css_selector = self.__escape_quotes_if_needed(css_selector)
         the_type = None
@@ -5247,6 +5287,12 @@ def set_value(
                 value,
             )
             self.execute_script(script)
+            if self.recorder_mode:
+                time_stamp = self.execute_script("return Date.now();")
+                origin = self.get_origin()
+                sel_tex = [pre_escape_css_selector, text]
+                action = ["js_ty", sel_tex, origin, time_stamp]
+                self.__extra_actions.append(action)
         else:
             script = """jQuery('%s')[0].value='%s';""" % (css_selector, value)
             self.safe_execute_script(script)
@@ -10336,6 +10382,11 @@ def setUp(self, masterqa_mode=False):
                     self._dash_initialized = True
                     self.__process_dashboard(False, init=True)
 
+        # Set the JS start time for Recorder Mode if reusing the session.
+        # Use this to skip saving recorded actions from previous tests.
+        if self.recorder_mode and self._reuse_session:
+            self.__js_start_time = int(time.time() * 1000.0)
+
         has_url = False
         if self._reuse_session:
             if not hasattr(sb_config, "shared_driver"):
@@ -10360,18 +10411,27 @@ def setUp(self, masterqa_mode=False):
                 except Exception:
                     pass
         if self._reuse_session and sb_config.shared_driver and has_url:
+            good_start_page = False
+            if self.recorder_ext:
+                self.__js_start_time = int(time.time() * 1000.0)
             if self.start_page and len(self.start_page) >= 4:
                 if page_utils.is_valid_url(self.start_page):
+                    good_start_page = True
+                    self.__new_window_on_rec_open = False
                     self.open(self.start_page)
+                    self.__new_window_on_rec_open = True
                 else:
                     new_start_page = "http://" + self.start_page
                     if page_utils.is_valid_url(new_start_page):
+                        good_start_page = True
                         self.open(new_start_page)
-            elif self._crumbs:
+            if self.recorder_ext or (self._crumbs and not good_start_page):
                 if self.get_current_url() != "data:,":
+                    self.__new_window_on_rec_open = False
                     self.open("data:,")
-            else:
-                pass
+                    self.__new_window_on_rec_open = True
+                    if self.recorder_ext:
+                        self.__js_start_time = int(time.time() * 1000.0)
         else:
             # Launch WebDriver for both Pytest and Nosetests
             self.driver = self.get_new_driver(
@@ -10431,11 +10491,6 @@ def setUp(self, masterqa_mode=False):
             # Call this once in case of multiple setUp() calls in the same test
             self.__start_time_ms = sb_config.start_time_ms
 
-        # Set the JS start time for Recorder Mode if reusing the session.
-        # Use this to skip saving recorded actions from previous tests.
-        if self.recorder_mode and self._reuse_session:
-            self.__js_start_time = self.execute_script("return Date.now();")
-
     def __set_last_page_screenshot(self):
         """self.__last_page_screenshot is only for pytest html report logs.
         self.__last_page_screenshot_png is for all screenshot log files."""

seleniumbase/fixtures/base_case.py

@@ -69,7 +69,7 @@ def __time_limit_exceeded(message):
 
 
 def check_if_time_limit_exceeded():
-    if sb_config.time_limit:
+    if sb_config.time_limit and not sb_config.recorder_mode:
         time_limit = sb_config.time_limit
         now_ms = int(time.time() * 1000)
         if now_ms > sb_config.start_time_ms + sb_config.time_limit_ms: