Merge pull request #1626 from seleniumbase/improved-debugging

mdmintz · web-flow · commit 700b4d9ac150 · 2022-12-02T02:11:16.000-05:00
Improved debugging, and more
diff --git a/README.md b/README.md
@@ -162,7 +162,7 @@ def test_mfa_login(sb):
 from seleniumbase import SB
 
 with SB() as sb:  # By default, browser="chrome" if not set.
-    sb.open("https://seleniumbase.github.io/realworld/login")
+    sb.open("https://seleniumbase.io/realworld/login")
     sb.type("#username", "demo_user")
     sb.type("#password", "secret_pass")
     sb.enter_mfa_code("#totpcode", "GAXG2MTEOR3DMMDG")  # 6-digit
@@ -547,10 +547,8 @@ pytest my_first_test.py --pdb
 --disable-ws  # (Disable Web Security on Chromium-based browsers.)
 --enable-ws  # (Enable Web Security on Chromium-based browsers.)
 --enable-sync  # (Enable "Chrome Sync" on websites.)
---use-auto-ext  # (Use Chrome's automation extension.)
 --uc | --undetected  # (Use undetected-chromedriver to evade bot-detection.)
---uc-sub | --uc-subprocess  # (Use undetected-chromedriver as a subprocess.)
---remote-debug  # (Enable Chrome's Remote Debugger on http://localhost:9222)
+--remote-debug  # (Sync to Chrome Remote Debugger chrome://inspect/#devices)
 --final-debug  # (Enter Debug Mode after each test ends. Don't use with CI!)
 --dashboard  # (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
 --dash-title=STRING  # (Set the title shown for the generated dashboard.)
diff --git a/examples/raw_sb.py b/examples/raw_sb.py
@@ -2,7 +2,7 @@
 from seleniumbase import SB
 
 with SB() as sb:  # By default, browser="chrome" if not set.
-    sb.open("https://seleniumbase.github.io/realworld/login")
+    sb.open("https://seleniumbase.io/realworld/login")
     sb.type("#username", "demo_user")
     sb.type("#password", "secret_pass")
     sb.enter_mfa_code("#totpcode", "GAXG2MTEOR3DMMDG")  # 6-digit
diff --git a/examples/test_mfa_login.py b/examples/test_mfa_login.py
@@ -10,7 +10,7 @@ def test_mfa_login(self):
         self.assert_text("Welcome!", "h1")
         self.highlight("img#image1")  # A fancier assert_element() call
         self.click('a:contains("This Page")')  # Use :contains() on any tag
-        self.save_screenshot_to_logs()  # In "./latest_logs/" folder.
+        self.save_screenshot_to_logs()  # ("./latest_logs" folder for test)
         self.click_link("Sign out")  # Link must be "a" tag. Not "button".
         self.assert_element('a:contains("Sign in")')
         self.assert_exact_text("You have been signed out!", "#top_message")
diff --git a/help_docs/customizing_test_runs.md b/help_docs/customizing_test_runs.md
@@ -163,10 +163,8 @@ pytest my_first_test.py --settings-file=custom_settings.py
 --disable-ws  # (Disable Web Security on Chromium-based browsers.)
 --enable-ws  # (Enable Web Security on Chromium-based browsers.)
 --enable-sync  # (Enable "Chrome Sync" on websites.)
---use-auto-ext  # (Use Chrome's automation extension.)
 --uc | --undetected  # (Use undetected-chromedriver to evade bot-detection.)
---uc-sub | --uc-subprocess  # (Use undetected-chromedriver as a subprocess.)
---remote-debug  # (Enable Chrome's Remote Debugger on http://localhost:9222)
+--remote-debug  # (Sync to Chrome Remote Debugger chrome://inspect/#devices)
 --final-debug  # (Enter Debug Mode after each test ends. Don't use with CI!)
 --dashboard  # (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
 --dash-title=STRING  # (Set the title shown for the generated dashboard.)
diff --git a/help_docs/how_it_works.md b/help_docs/how_it_works.md
@@ -34,7 +34,7 @@ class TestMFALogin(BaseCase):
         self.assert_text("Welcome!", "h1")
         self.highlight("img#image1")  # A fancier assert_element() call
         self.click('a:contains("This Page")')  # Use :contains() on any tag
-        self.save_screenshot_to_logs()  # In "./latest_logs/" folder.
+        self.save_screenshot_to_logs()  # ("./latest_logs" folder for test)
         self.click_link("Sign out")  # Link must be "a" tag. Not "button".
         self.assert_element('a:contains("Sign in")')
         self.assert_exact_text("You have been signed out!", "#top_message")
diff --git a/help_docs/recorder_mode.md b/help_docs/recorder_mode.md
@@ -28,13 +28,12 @@ pytest new_test.py --rec -q -s --url=wikipedia.org
 
 >>>>>>>>>>>>>>>>>> PDB set_trace >>>>>>>>>>>>>>>>>
 
--> import pdb; pdb.set_trace()
 > PATH_TO_YOUR_CURRENT_DIRECTORY/new_test.py(9)
-....
+   .
    5         def test_recording(self):
-   6             if self.recorder_ext and not self.xvfb:
-   7                 # When you are done recording actions,
-   8                 # type "c" and press [ENTER] to continue
+   6             if self.recorder_ext:
+   7                 # When done recording actions,
+   8                 # type "c", and press [Enter].
    9  ->             import pdb; pdb.set_trace()
  return None
 (Pdb+) c
diff --git a/requirements.txt b/requirements.txt
@@ -30,7 +30,7 @@ idna==2.10;python_version<"3.6"
 idna==3.4;python_version>="3.6"
 chardet==3.0.4;python_version<"3.6"
 chardet==4.0.0;python_version>="3.6" and python_version<"3.7"
-chardet==5.0.0;python_version>="3.7"
+chardet==5.1.0;python_version>="3.7"
 charset-normalizer==2.0.12;python_version>="3.6" and python_version<"3.7"
 charset-normalizer==2.1.1;python_version>="3.7"
 urllib3==1.26.12;python_version<"3.7"
@@ -49,7 +49,7 @@ websockets==10.4;python_version>="3.7"
 pyopenssl==22.1.0;python_version>="3.7"
 wsproto==1.2.0;python_version>="3.7"
 selenium==3.141.0;python_version<"3.7"
-selenium==4.6.1;python_version>="3.7"
+selenium==4.7.0;python_version>="3.7"
 msedge-selenium-tools==3.141.3;python_version<"3.7"
 more-itertools==5.0.0;python_version<"3.6"
 more-itertools==8.14.0;python_version>="3.6" and python_version<"3.7"
@@ -99,7 +99,7 @@ pyreadline==2.1;platform_system=="Windows" and python_version<"3.6"
 pyreadline3==3.4.1;platform_system=="Windows" and python_version>="3.6"
 pyrepl==0.9.0
 tabcompleter==1.0.0
-pdbp==1.1.0
+pdbp==1.2.2
 colorama==0.4.6;python_version<"3.6"
 colorama==0.4.5;python_version>="3.6" and python_version<"3.7"
 colorama==0.4.6;python_version>="3.7"
diff --git a/seleniumbase/__version__.py b/seleniumbase/__version__.py
@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.9.3"
+__version__ = "4.9.4"
diff --git a/seleniumbase/behave/behave_sb.py b/seleniumbase/behave/behave_sb.py
@@ -71,10 +71,8 @@
 -D disable-ws  (Disable Web Security on Chromium-based browsers.)
 -D enable-ws  (Enable Web Security on Chromium-based browsers.)
 -D enable-sync  (Enable "Chrome Sync".)
--D use-auto-ext  (Use Chrome's automation extension.)
 -D uc | -D undetected  (Use undetected-chromedriver to evade bot-detection)
--D uc-sub | -D uc-subprocess  (Use undetected-chromedriver as a subprocess)
--D remote-debug  (Enable Chrome's Remote Debugger on http://localhost:9222)
+-D remote-debug  (Sync to Chrome Remote Debugger chrome://inspect/#devices)
 -D dashboard  (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
 -D dash-title=STRING  (Set the title shown for the generated dashboard.)
 -D enable-3d-apis  (Enables WebGL and 3D APIs.)
@@ -662,8 +660,8 @@ def get_configured_sb(context):
         if low_key in ["external-pdf", "external_pdf"]:
             sb.external_pdf = True
             continue
-        # Handle: -D remote-debug / remote_debug
-        if low_key in ["remote-debug", "remote_debug"]:
+        # Handle: -D remote-debug / remote_debug / remote-debugger
+        if low_key in ["remote-debug", "remote_debug", "remote-debugger"]:
             sb.remote_debug = True
             continue
         # Handle: -D settings=FILE / settings-file=FILE / settings_file=FILE
diff --git a/seleniumbase/console_scripts/ReadMe.md b/seleniumbase/console_scripts/ReadMe.md
@@ -120,6 +120,7 @@ that are available when using SeleniumBase.
 --crumbs  (Clear all cookies between tests reusing a session.)
 --maximize  (Start tests with the web browser window maximized.)
 --dashboard  (Enable SeleniumBase\'s Dashboard at dashboard.html)
+--uc  (Enable undetected-chromedriver to evade bot-detection.)
 --incognito  (Enable Chromium\'s Incognito mode.)
 --guest  (Enable Chromium\'s Guest mode.)
 -m=MARKER  (Run tests with the specified pytest marker.)
@@ -136,6 +137,7 @@ that are available when using SeleniumBase.
       |  return / r: Run until method returns. j: Jump to line. |
       | where / w: Show stack spot. u: Up stack. d: Down stack. |
       | longlist / ll: See code. dir(): List namespace objects. |
+--final-debug  (Enter Final Debug Mode after each test ends.)
 --recorder  (Record browser actions to generate test scripts.)
 --save-screenshot  (Save a screenshot at the end of each test.)
 --archive-logs  (Archive old log files instead of deleting them.)
@@ -149,6 +151,7 @@ that are available when using SeleniumBase.
 --env=ENV  (Set the test env. Access with "self.env" in tests.)
 --data=DATA  (Extra test data. Access with "self.data" in tests.)
 --disable-csp  (Disable the Content Security Policy of websites.)
+--remote-debug  (Sync to Ch-R-Debugger chrome://inspect/#devices)
 --server=SERVER  (The Selenium Grid server/IP used for tests.)
 --port=PORT  (The Selenium Grid port used by the test server.)
 --proxy=SERVER:PORT  (Connect to a proxy server:port for tests.)
@@ -179,6 +182,7 @@ that are available when using SeleniumBase.
 -D crumbs  (Clear all cookies between tests reusing a session.)
 -D maximize  (Start tests with the web browser window maximized.)
 -D dashboard  (Enable SeleniumBase\'s Dashboard at dashboard.html)
+-D uc  (Enable undetected-chromedriver to evade bot-detection.)
 -D incognito  (Enable Chromium\'s Incognito mode.)
 -D guest  (Enable Chromium\'s Guest mode.)
 --no-snippets / -q  (Quiet mode. Don\'t print snippets.)
@@ -203,6 +207,7 @@ that are available when using SeleniumBase.
 -D env=ENV  (Set the test env. Access with "self.env" in tests.)
 -D data=DATA  (Extra test data. Access with "self.data" in tests.)
 -D disable-csp  (Disable the Content Security Policy of websites.)
+-D remote-debug  (Sync to Ch-R-Debugger chrome://inspect/#devices)
 -D server=SERVER  (The Selenium Grid server/IP used for tests.)
 -D port=PORT  (The Selenium Grid port used by the test server.)
 -D proxy=SERVER:PORT  (Connect to a proxy server:port for tests.)
diff --git a/seleniumbase/console_scripts/run.py b/seleniumbase/console_scripts/run.py
@@ -11,6 +11,7 @@
 sbase options
 sbase commander
 sbase behave-gui
+sbase behave-options
 sbase caseplans
 sbase mkdir ui_tests
 sbase mkfile new_test.py
@@ -35,7 +36,6 @@
 sbase grid-hub start
 sbase grid-node start --hub=127.0.0.1
 """
-
 import colorama
 import sys
 import time
@@ -808,6 +808,7 @@ def show_options():
     op += '--env=ENV  (Set the test env. Access with "self.env" in tests.)\n'
     op += '--data=DATA  (Extra test data. Access with "self.data" in tests.)\n'
     op += "--disable-csp  (Disable the Content Security Policy of websites.)\n"
+    op += "--remote-debug  (Sync to Ch-R-Debugger chrome://inspect/#devices)\n"
     op += "--server=SERVER  (The Selenium Grid server/IP used for tests.)\n"
     op += "--port=PORT  (The Selenium Grid port used by the test server.)\n"
     op += "--proxy=SERVER:PORT  (Connect to a proxy server:port for tests.)\n"
@@ -851,6 +852,7 @@ def show_behave_options():
     op += "-D crumbs  (Clear all cookies between tests reusing a session.)\n"
     op += "-D maximize  (Start tests with the web browser window maximized.)\n"
     op += "-D dashboard  (Enable SeleniumBase's Dashboard at dashboard.html)\n"
+    op += "-D uc  (Enable undetected-chromedriver to evade bot-detection.)\n"
     op += "-D incognito  (Enable Chromium's Incognito mode.)\n"
     op += "-D guest  (Enable Chromium's Guest mode.)\n"
     op += "--no-snippets / -q  (Quiet mode. Don't print snippets.)\n"
@@ -875,6 +877,7 @@ def show_behave_options():
     op += '-D env=ENV  (Set the test env. Access using "self.env" in tests.)\n'
     op += '-D data=DATA  (Extra test data. Access using "self.data".)\n'
     op += "-D disable-csp  (Disable the Content Security Policy of sites.)\n"
+    op += "-D remote-debug  (Sync Ch-R-Debugger chrome://inspect/#devices)\n"
     op += "-D server=SERVER  (The Selenium Grid server/IP used for tests.)\n"
     op += "-D port=PORT  (The Selenium Grid port used by the test server.)\n"
     op += "-D proxy=SERVER:PORT  (Connect to a proxy server:port for tests.)\n"
diff --git a/seleniumbase/console_scripts/sb_behave_gui.py b/seleniumbase/console_scripts/sb_behave_gui.py
@@ -14,7 +14,6 @@
 Output:
       Launches SeleniumBase Behave Commander | GUI for Behave.
 """
-
 import colorama
 import subprocess
 import sys
diff --git a/seleniumbase/console_scripts/sb_caseplans.py b/seleniumbase/console_scripts/sb_caseplans.py
@@ -16,7 +16,6 @@
 Output:
       Launches the SeleniumBase Case Plans Generator.
 """
-
 import codecs
 import colorama
 import os
diff --git a/seleniumbase/console_scripts/sb_commander.py b/seleniumbase/console_scripts/sb_commander.py
@@ -18,7 +18,6 @@
 Output:
       Launches SeleniumBase Commander | GUI for pytest.
 """
-
 import colorama
 import subprocess
 import sys
diff --git a/seleniumbase/console_scripts/sb_install.py b/seleniumbase/console_scripts/sb_install.py
@@ -26,7 +26,6 @@
          (geckodriver is required for Firefox automation)
          (edgedriver is required for MS__Edge automation)
 """
-
 import colorama
 import os
 import platform
diff --git a/seleniumbase/console_scripts/sb_mkchart.py b/seleniumbase/console_scripts/sb_mkchart.py
@@ -23,7 +23,6 @@
     and use a "sky" theme with "slide" transition.
     The chart can be used as a basic boilerplate.
 """
-
 import codecs
 import colorama
 import os
diff --git a/seleniumbase/console_scripts/sb_mkdir.py b/seleniumbase/console_scripts/sb_mkdir.py
@@ -19,7 +19,6 @@
     and Python boilerplates for setting up customized
     test frameworks.
 """
-
 import codecs
 import colorama
 import os
diff --git a/seleniumbase/console_scripts/sb_mkfile.py b/seleniumbase/console_scripts/sb_mkfile.py
@@ -30,7 +30,6 @@
     basic boilerplate option, only the "open" method
     is included.
 """
-
 import codecs
 import colorama
 import os
diff --git a/seleniumbase/console_scripts/sb_mkpres.py b/seleniumbase/console_scripts/sb_mkpres.py
@@ -23,7 +23,6 @@
     and use "serif" theme with "slide" transition.
     The slides can be used as a basic boilerplate.
 """
-
 import codecs
 import colorama
 import os
diff --git a/seleniumbase/console_scripts/sb_mkrec.py b/seleniumbase/console_scripts/sb_mkrec.py
@@ -30,7 +30,6 @@
     Creates a new SeleniumBase test using the Recorder.
     If the filename already exists, an error is raised.
 """
-
 import codecs
 import colorama
 import shutil
@@ -169,11 +168,11 @@ def main():
     data.append("from seleniumbase import BaseCase")
     data.append("")
     data.append("")
-    data.append("class RecorderTests(BaseCase):")
+    data.append("class RecorderTest(BaseCase):")
     data.append("    def test_recording(self):")
-    data.append("        if self.recorder_ext and not self.xvfb:")
-    data.append("            # When you are done recording actions,")
-    data.append('            # type "c" and press [ENTER] to continue')
+    data.append("        if self.recorder_ext:")
+    data.append("            # When done recording actions,")
+    data.append('            # type "c", and press [Enter].')
     data.append("            import pdb; pdb.set_trace()")
     data.append("")
     file = codecs.open(file_path, "w+", "utf-8")
diff --git a/seleniumbase/console_scripts/sb_objectify.py b/seleniumbase/console_scripts/sb_objectify.py
@@ -8,7 +8,6 @@
         have been replaced with variable names defined in
         "page_objects.py", supporting the Page Object Pattern.
 """
-
 import codecs
 import os
 import re
diff --git a/seleniumbase/console_scripts/sb_print.py b/seleniumbase/console_scripts/sb_print.py
@@ -10,7 +10,6 @@
         Prints the code/text of any file
         with syntax-highlighting.
 """
-
 import colorama
 import os
 import sys
diff --git a/seleniumbase/console_scripts/sb_recorder.py b/seleniumbase/console_scripts/sb_recorder.py
@@ -13,7 +13,6 @@
 Output:
     Launches the SeleniumBase Recorder Desktop App.
 """
-
 import colorama
 import os
 import subprocess
diff --git a/seleniumbase/core/browser_launcher.py b/seleniumbase/core/browser_launcher.py
@@ -640,7 +640,7 @@ def _set_chrome_options(
         # Opera Chromium only!
         chrome_options.add_argument("--allow-elevated-browser")
     if remote_debug:
-        # To access the Remote Debugger, go to: http://localhost:9222
+        # To access the Debugger, go to: chrome://inspect/#devices
         # while a Chromium driver is running.
         # Info: https://chromedevtools.github.io/devtools-protocol/
         chrome_options.add_argument("--remote-debugging-port=9222")
@@ -2131,7 +2131,7 @@ def get_local_driver(
         if "linux" in PLATFORM or not is_using_uc(undetectable, browser_name):
             edge_options.add_argument("--no-sandbox")
         if remote_debug:
-            # To access the Remote Debugger, go to: http://localhost:9222
+            # To access the Debugger, go to: edge://inspect/#devices
             # while a Chromium driver is running.
             # Info: https://chromedevtools.github.io/devtools-protocol/
             edge_options.add_argument("--remote-debugging-port=9222")
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -111,6 +111,9 @@ def __initialize_variables(self):
         self.__extra_actions = []
         self.__js_start_time = 0
         self.__set_c_from_switch = False
+        self.__frame_switch_layer = 0  # Used by Recorder-Mode
+        self.__frame_switch_multi = False  # Used by Recorder-Mode
+        self.__last_saved_url = None  # Used by Recorder-Mode
         self.__called_setup = False
         self.__called_teardown = False
         self.__start_time_ms = None
@@ -3002,9 +3005,21 @@ def frame_switch(self, frame, timeout=None):
                 # Perform actions here that should be done within the iframe.
             # The iframe is automatically exited after the "with" block ends.
         """
+        if self.recorder_mode:
+            self.__frame_switch_layer += 1
+            if self.__frame_switch_layer >= 2:
+                self.__frame_switch_multi = True
         self.switch_to_frame(frame, timeout=timeout)
         yield
         self.switch_to_parent_frame()
+        if self.recorder_mode:
+            self.__frame_switch_layer -= 1
+            if self.__frame_switch_layer < 0:
+                self.__frame_switch_layer = 0
+                self.__frame_switch_multi = False
+            if self.__frame_switch_layer == 0 and self.__frame_switch_multi:
+                self.refresh()
+                self.__frame_switch_multi = False
 
     def set_content_to_frame(self, frame, timeout=None):
         """Replaces the page html with an iframe's html from that page.
@@ -12337,11 +12352,22 @@ def __ad_block_as_needed(self):
                 self.__last_page_load_url = current_url
 
     def __disable_beforeunload_as_needed(self):
+        """Disables beforeunload as needed. Also resets frame_switch state."""
         if (
             hasattr(self, "_disable_beforeunload")
             and self._disable_beforeunload
         ):
             self.disable_beforeunload()
+        if self.recorder_mode:
+            try:
+                current_url = self.get_current_url
+            except Exception:
+                current_url = None
+                self.__last_saved_url = None
+            if current_url != self.__last_saved_url:
+                self.__frame_switch_layer = 0
+                self.__frame_switch_multi = False
+                self.__last_saved_url = current_url
 
     ############
 
diff --git a/seleniumbase/plugins/pytest_plugin.py b/seleniumbase/plugins/pytest_plugin.py
diff --git a/seleniumbase/plugins/selenium_plugin.py b/seleniumbase/plugins/selenium_plugin.py
diff --git a/setup.py b/setup.py

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