Merge pull request #1044 from seleniumbase/recorder-asserts-without-full-clicks

Several updates to various areas

Author: mdmintz

examples/hack_the_planet.py

@@ -179,30 +179,12 @@ def test_all_your_base_are_belong_to_us(self):
         self.highlight('button#live-engage-btn', loops=6, scroll=False)
 
         self.open("https://www.snapchat.com/")
-        self.set_text_content('a[href*="download"]', "ALL")
-        self.set_text_content('a[href*="spotlight"]', "YOUR")
-        self.set_text_content('a[href="https://story.snapchat.com"]', "BASE")
-        self.set_text_content('a[href*="map"]', "ARE")
-        self.set_text_content('a[href*="forbusiness"]', "BELONG")
-        self.set_text_content('a[href*="spectacles"]', "TO")
-        self.set_text_content('a[href="/create"]', "US")
-        self.set_text_content('a[href*="lensstudio"]', ".")
-        self.set_text_content('a[href*="kit"]', ".")
-        self.set_text_content('a[href*="snapcodes"]', ".")
         self.set_text_content("h1", ayb)
-        self.set_text_content("a.button-large span > span", abtu)
+        self.set_text_content("form .button-large span span", abtu)
         zoom_in = 'a.button-large span{zoom: 1.2;-moz-transform: scale(1.2);}'
         self.add_css_style(zoom_in)
-        self.highlight("header", loops=1)
-        self.highlight('a[href*="download"]', loops=1)
-        self.highlight('a[href*="spotlight"]', loops=1)
-        self.highlight('a[href="https://story.snapchat.com"]', loops=2)
-        self.highlight('a[href*="map"]', loops=1, scroll=False)
-        self.highlight('a[href*="forbusiness"]', loops=1)
-        self.highlight('a[href*="spectacles"]', loops=1)
-        self.highlight('a[href="/create"]', loops=2)
-        self.highlight("h1", loops=4, scroll=False)
-        self.highlight("a.button-large span > span", loops=5, scroll=False)
+        self.highlight("h1", loops=6, scroll=False)
+        self.highlight("form .button-large span span", loops=8, scroll=False)
 
         self.open("https://store.steampowered.com/")
         self.set_text_content('div.content a[href*="/about/"]', " ")

examples/test_mfa_login.py

@@ -0,0 +1,14 @@
+from seleniumbase import BaseCase
+
+
+class TestMFALogin(BaseCase):
+    def test_mfa_login(self):
+        self.open("https://seleniumbase.io/realworld/login")
+        self.type("#username", "demo_user")
+        self.type("#password", "secret_pass")
+        totp_code = self.get_totp_code("GAXG2MTEOR3DMMDG")
+        self.type("#totpcode", totp_code)
+        self.click("#log-in")
+        self.highlight("img#image1")
+        self.assert_text("Welcome!", "h1")
+        self.save_screenshot_to_logs()

help_docs/method_summary.md

@@ -202,12 +202,16 @@ self.set_content_to_frame(frame, timeout=None)
 self.set_content_to_default(nested=True)
 
 self.open_new_window(switch_to=True)
+# Duplicates: self.open_new_tab(switch_to=True)
 
 self.switch_to_window(window, timeout=None)
+# Duplicates: self.switch_to_tab(tab, timeout=None)
 
 self.switch_to_default_window()
+# Duplicates: self.switch_to_default_tab()
 
 self.switch_to_newest_window()
+# Duplicates: self.switch_to_newest_tab()
 
 self.get_new_driver(
     browser=None, headless=None, locale_code=None, protocol=None,
@@ -398,7 +402,9 @@ self.get_chromedriver_version()
 
 self.is_chromedriver_too_old()
 
-self.get_google_auth_password(totp_key=None)
+self.get_totp_code(totp_key=None)
+# Duplicates: self.get_google_auth_password(totp_key=None)
+#             self.get_google_auth_code(totp_key=None)
 
 self.convert_css_to_xpath(css)
 

help_docs/recorder_mode.md

@@ -6,7 +6,7 @@
 
 <img src="https://seleniumbase.io/cdn/img/sb_recorder_notification.png" title="SeleniumBase" width="380">
 
-(This tutorial assumes you are using SeleniumBase version ``2.0.10`` or newer.)
+(This tutorial assumes that you are using SeleniumBase version ``2.1.0`` or newer.)
 
 🔴 To make a new recording with Recorder Mode, you can use ``sbase mkrec`` or ``sbase codegen``):
 
@@ -40,7 +40,7 @@ ipdb> c
 
 🔴 While a recording is in progress, you can press the ``[ESC]`` key to pause the recording. To resume the recording, you can hit the ``[~`]`` key, which is located directly below the ``[ESC]`` key on most keyboards.
 
-🔴 From within Recorder Mode there are two additional modes: "Assert Element Mode" and "Assert Text Mode". To switch into "Assert Element Mode", press the <code>{^}-key (SHIFT+6)</code>: The border will become purple, and you'll be able to click on elements to assert from your test. To switch into "Assert Text Mode", press the <code>{&}-key (SHIFT+7)</code>: The border will become teal, and you'll be able to click on elements for asserting text from your test. While using either of the two special Assertion Modes, certain actions such as clicking on links won't have any effect. This lets you make assertions on elements without navigating away from the page, etc. To return back to the original Recorder Mode, press any key other than SHIFT or BACKSPACE (Eg: Press ``CONTROL``, etc.). You can also press ESC once to leave the Assertion Modes, but if you press it again, it'll stop the Recorder.
+🔴 From within Recorder Mode there are two additional modes: "Assert Element Mode" and "Assert Text Mode". To switch into "Assert Element Mode", press the <code>{^}-key (SHIFT+6)</code>: The border will become purple, and you'll be able to click on elements to assert from your test. To switch into "Assert Text Mode", press the <code>{&}-key (SHIFT+7)</code>: The border will become teal, and you'll be able to click on elements for asserting text from your test. While using either of the two special Assertion Modes, certain actions such as clicking on links won't have any effect. This lets you make assertions on elements without navigating away from the page, etc. To add an assertion for a button without triggering its default behavior via a "click" action, mouse-down on the button and then mouse-up somewhere else, which prevents a detected click while still recording the assert. To return back to the original Recorder Mode, press any key other than SHIFT or BACKSPACE (Eg: Press ``CONTROL``, etc.). You can also press ESC once to leave the Assertion Modes, but if you press it again, it'll stop the Recorder.
 
 🔴 For extra flexibility, you can break up the ``sbase mkrec`` command into three separate commands so that you can pick & choose how you use the Recorder:
 

mkdocs.yml

@@ -27,7 +27,7 @@ markdown_extensions:
 # Configuration
 theme:
   name: material
-  logo: img/green_logo2.png
+  logo: img/green_logo.png
   favicon: img/green_logo3.png
   language: en
   include_homepage_in_sidebar: true
@@ -49,7 +49,7 @@ theme:
     - navigation.instant
   palette:
     scheme: default
-    primary: blue
+    primary: teal
     accent: indigo
   font:
     text: Roboto
@@ -124,18 +124,19 @@ nav:
     - MySQL Instructions: help_docs/mysql_installation.md
   - Demo Pages:
     - Demo Page / Demo Site: https://seleniumbase.io/demo_page
+    - MFA Login Demo Page: https://seleniumbase.io/realworld/login
     - TinyMCE Demo Page: https://seleniumbase.io/tinymce/
-    - Drag & Drop Demo Page: https://seleniumbase.io/other/drag_and_drop
     - Virtual Device Farm: https://seleniumbase.io/devices/
+    - Drag & Drop Demo Page: https://seleniumbase.io/other/drag_and_drop
+    - HTML Playground Page: https://seleniumbase.io/w3schools/
+    - SeleniumBase in iframe: https://seleniumbase.io/w3schools/sbase
     - Error Demo Page: https://seleniumbase.io/error_page/
     - Page with broken links: https://seleniumbase.io/other/broken_page
     - W3Schools iframes: https://seleniumbase.io/w3schools/iframes
     - W3Schools doubleclick: https://seleniumbase.io/w3schools/double_click
     - W3Schools checkboxes: https://seleniumbase.io/w3schools/checkboxes
     - W3Schools drag & drop: https://seleniumbase.io/w3schools/drag_drop
     - W3Schools radio buttons: https://seleniumbase.io/w3schools/radio_buttons
-    - SeleniumBase in iframe: https://seleniumbase.io/w3schools/sbase
-    - HTML Playground Page: https://seleniumbase.io/w3schools/
   - Presentations:
     - Presenter Demo: https://seleniumbase.io/other/presenter.html
     - Core Presentation: https://seleniumbase.io/other/core_presentation.html

mkdocs_build/requirements.txt

@@ -6,7 +6,7 @@ livereload==2.6.3;python_version>="3.6"
 joblib==1.1.0;python_version>="3.6"
 Markdown==3.3.4;python_version>="3.6"
 MarkupSafe==2.0.1;python_version>="3.6"
-pyparsing==3.0.3;python_version>="3.6"
+pyparsing==2.4.7;python_version>="3.6"
 keyring==23.2.1;python_version>="3.6"
 pkginfo==1.7.1;python_version>="3.6"
 Jinja2==3.0.2;python_version>="3.6"
@@ -21,7 +21,7 @@ lunr==0.6.1;python_version>="3.6"
 nltk==3.6.5;python_version>="3.6"
 watchdog==2.1.6;python_version>="3.6"
 mkdocs==1.2.3;python_version>="3.6"
-mkdocs-material==7.3.5;python_version>="3.6"
+mkdocs-material==7.3.6;python_version>="3.6"
 mkdocs-exclude-search==0.5.2;python_version>="3.6"
 mkdocs-simple-hooks==0.1.3
 mkdocs-material-extensions==1.0.3;python_version>="3.6"

requirements.txt

@@ -1,7 +1,7 @@
 pip>=20.3.4;python_version<"3.6"
 pip>=21.3.1;python_version>="3.6"
 packaging>=20.9;python_version<"3.6"
-packaging>=21.0;python_version>="3.6"
+packaging>=21.2;python_version>="3.6"
 typing-extensions>=3.10.0.2
 setuptools>=44.1.1;python_version<"3.5"
 setuptools>=50.3.2;python_version>="3.5" and python_version<"3.6"
@@ -43,7 +43,7 @@ more-itertools==5.0.0;python_version<"3.5"
 more-itertools==8.10.0;python_version>="3.5"
 cssselect==1.1.0
 filelock==3.2.1;python_version<"3.6"
-filelock==3.3.1;python_version>="3.6"
+filelock==3.3.2;python_version>="3.6"
 fasteners==0.16;python_version<"3.5"
 fasteners==0.16.3;python_version>="3.5"
 execnet==1.9.0
@@ -89,7 +89,7 @@ decorator==5.1.0;python_version>="3.5"
 ipython==5.10.0;python_version<"3.5"
 ipython==7.9.0;python_version>="3.5" and python_version<"3.6"
 ipython==7.16.1;python_version>="3.6" and python_version<"3.7"
-ipython==7.28.0;python_version>="3.7"
+ipython==7.29.0;python_version>="3.7"
 matplotlib-inline==0.1.3;python_version>="3.7"
 colorama==0.4.4
 platformdirs==2.0.2;python_version<"3.6"
@@ -118,7 +118,7 @@ pdfminer.six==20211012;python_version>="3.6"
 # ("pip install -r requirements.txt" also installs this, but "pip install -e ." won't.)
 
 coverage==5.5;python_version<"3.6"
-coverage==6.0.2;python_version>="3.6"
+coverage==6.1;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/extensions/recorder.zip

@@ -2590,6 +2590,9 @@ def open_new_window(self, switch_to=True):
                 self.wait_for_ready_state_complete()
 
     def switch_to_window(self, window, timeout=None):
+        """ Switches control of the browser to the specified window.
+            The window can be an integer: 0 -> 1st tab, 1 -> 2nd tab, etc...
+                Or it can be a list item from self.driver.window_handles """
         self.__check_scope()
         if not timeout:
             timeout = settings.SMALL_TIMEOUT
@@ -2916,7 +2919,8 @@ def get_new_driver(
         return new_driver
 
     def switch_to_driver(self, driver):
-        """Sets self.driver to the specified driver.
+        """Switches control of the browser to the specified driver.
+        Also sets the self.driver variable to the specified driver.
         You may need this if using self.get_new_driver() in your code."""
         self.__check_scope()
         self.driver = driver
@@ -5191,12 +5195,12 @@ def is_chromedriver_too_old(self):
             return True  # chromedriver is too old! Please upgrade!
         return False
 
-    def get_google_auth_password(self, totp_key=None):
+    def get_totp_code(self, totp_key=None):
         """Returns a time-based one-time password based on the
-        Google Authenticator password algorithm. Works with Authy.
-        If "totp_key" is not specified, defaults to using the one
-        provided in seleniumbase/config/settings.py
-        Google Auth passwords expire and change at 30-second intervals.
+        Google Authenticator algorithm. Works with Authy and Okta.
+        If the "totp_key" is not specified, this method defaults
+        to using the one provided in [seleniumbase/config/settings.py].
+        Google Authenticator codes expire & change at 30-sec intervals.
         If the fetched password expires in the next 1.5 seconds, waits
         for a new one before returning it (may take up to 1.5 seconds).
         See https://pyotp.readthedocs.io/en/latest/ for details."""
@@ -6023,6 +6027,25 @@ def reload_page(self):
         """ Same as self.refresh_page() """
         self.refresh_page()
 
+    def open_new_tab(self, switch_to=True):
+        """ Same as self.open_new_window() """
+        self.open_new_window(switch_to=switch_to)
+
+    def switch_to_tab(self, tab, timeout=None):
+        """ Same as self.switch_to_window()
+            Switches control of the browser to the specified window.
+            The window can be an integer: 0 -> 1st tab, 1 -> 2nd tab, etc...
+                Or it can be a list item from self.driver.window_handles """
+        self.switch_to_window(window=tab, timeout=timeout)
+
+    def switch_to_default_tab(self):
+        """ Same as self.switch_to_default_window() """
+        self.switch_to_default_window()
+
+    def switch_to_newest_tab(self):
+        """ Same as self.switch_to_newest_window() """
+        self.switch_to_newest_window()
+
     def input(
         self, selector, text, by=By.CSS_SELECTOR, timeout=None, retry=False
     ):
@@ -6140,6 +6163,14 @@ def assert_element_not_present(
         self.wait_for_element_absent(selector, by=by, timeout=timeout)
         return True
 
+    def get_google_auth_password(self, totp_key=None):
+        """ Same as self.get_totp_code() """
+        return self.get_totp_code(totp_key=totp_key)
+
+    def get_google_auth_code(self, totp_key=None):
+        """ Same as self.get_totp_code() """
+        return self.get_totp_code(totp_key=totp_key)
+
     def assert_no_broken_links(self, multithreaded=True):
         """ Same as self.assert_no_404_errors() """
         self.assert_no_404_errors(multithreaded=multithreaded)
@@ -7276,17 +7307,15 @@ def extract_chart(self, chart_name=None):
     ############
 
     def create_tour(self, name=None, theme=None):
-        """Creates a tour for a website. By default, the Shepherd JavaScript
-        Library is used with the Shepherd "Light" / "Arrows" theme.
+        """Creates a guided tour for any website.
+        The default theme is the IntroJS Library.
         @Params
         name - If creating multiple tours at the same time,
                use this to select the tour you wish to add steps to.
-        theme - Sets the default theme for the tour.
-                Choose from "light"/"arrows", "dark", "default", "square",
-                and "square-dark". ("arrows" is used if None is selected.)
-                Alternatively, you may use a different JavaScript Library
-                as the theme. Those include "IntroJS", "DriverJS",
-                "Hopscotch", and "Bootstrap".
+        theme - Sets the default theme for the website tour. Available themes:
+                "Bootstrap", "DriverJS", "Hopscotch", "IntroJS", "Shepherd".
+                The "Shepherd" library also contains multiple variation themes:
+                "light"/"arrows", "dark", "default", "square", "square-dark".
         """
         if not name:
             name = "default"
@@ -7308,20 +7337,20 @@ def create_tour(self, name=None, theme=None):
                 self.create_shepherd_tour(name, theme="light")
             elif theme.lower() == "light":
                 self.create_shepherd_tour(name, theme="light")
-            elif theme.lower() == "dark":
-                self.create_shepherd_tour(name, theme="dark")
             elif theme.lower() == "arrows":
                 self.create_shepherd_tour(name, theme="light")
+            elif theme.lower() == "dark":
+                self.create_shepherd_tour(name, theme="dark")
             elif theme.lower() == "square":
                 self.create_shepherd_tour(name, theme="square")
             elif theme.lower() == "square-dark":
                 self.create_shepherd_tour(name, theme="square-dark")
             elif theme.lower() == "default":
                 self.create_shepherd_tour(name, theme="default")
             else:
-                self.create_shepherd_tour(name, theme)
+                self.create_introjs_tour(name)
         else:
-            self.create_shepherd_tour(name, theme="light")
+            self.create_introjs_tour(name)
 
     def create_shepherd_tour(self, name=None, theme=None):
         """Creates a Shepherd JS website tour.

seleniumbase/fixtures/base_case.py

@@ -10,7 +10,6 @@
 from seleniumbase import config as sb_config
 from seleniumbase.config import settings
 from seleniumbase.fixtures import constants
-from seleniumbase.fixtures import shared_utils
 
 
 def wait_for_ready_state_complete(driver, timeout=settings.LARGE_TIMEOUT):
@@ -24,10 +23,14 @@ def wait_for_ready_state_complete(driver, timeout=settings.LARGE_TIMEOUT):
       because readyState == "interactive" may be good enough.
     (Previously, tests would fail immediately if exceeding the timeout.)
     """
+    if sb_config.time_limit and not sb_config.recorder_mode:
+        from seleniumbase.fixtures import shared_utils
+
     start_ms = time.time() * 1000.0
     stop_ms = start_ms + (timeout * 1000.0)
     for x in range(int(timeout * 10)):
-        shared_utils.check_if_time_limit_exceeded()
+        if sb_config.time_limit and not sb_config.recorder_mode:
+            shared_utils.check_if_time_limit_exceeded()
         try:
             ready_state = driver.execute_script("return document.readyState")
         except WebDriverException: