Merge pull request #1956 from seleniumbase/detection-handling-and-more

Detection-handling and more

Author: mdmintz

README.md

@@ -167,7 +167,7 @@ With raw Selenium, that requires more code:<br />
 <summary> ▶️ Learn about different ways of writing tests (<b>click to expand</b>)</summary>
 <div>
 
-<p align="left">📘📝 An example test with the <b>BaseCase</b> class. Runs with <b><a href="https://docs.pytest.org/en/latest/how-to/usage.html">pytest</a></b> or <b>pynose</b>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">Learn more</a>)</p>
+<p align="left">📘📝 An example test with the <b>BaseCase</b> class. Runs with <b><a href="https://docs.pytest.org/en/latest/how-to/usage.html">pytest</a></b> or <b><a href="https://github.com/mdmintz/pynose">pynose</a></b>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">Learn more</a>)</p>
 
 ```python
 from seleniumbase import BaseCase
@@ -460,14 +460,14 @@ self.assert_no_js_errors()  # Verify there are no JS errors.
 <p>✅ SeleniumBase uses simple syntax for commands. Example:</p>
 
 ```python
-self.type("input", "dogs\n")
+self.type("input", "dogs\n")  # (The "\n" presses ENTER)
 ```
 
 Most SeleniumBase scripts can be run with <code>pytest</code>, <code>pynose</code>, or pure <code>python</code>. Not all test runners can run all test formats. For example, tests that use the ``sb`` pytest fixture can only be run with ``pytest``. (See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">Syntax Formats</a>) There's also a <a href="https://behave.readthedocs.io/en/stable/gherkin.html#features" target="_blank">Gherkin</a> test format that runs with <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd/ReadMe.md">behave</a>.
 
 ```bash
 pytest coffee_cart_tests.py --rs
-pytest test_sb_fixture.py
+pytest test_sb_fixture.py --demo
 pytest test_suite.py --rs --html=report.html --dashboard
 
 pynose basic_test.py --mobile
@@ -506,12 +506,14 @@ pynose [FILE_NAME.py]:[CLASS_NAME].[METHOD_NAME]
 
 ✅ SeleniumBase supports all major browsers and operating systems:
 <p><b>Browsers:</b> Chrome, Edge, Firefox, and Safari.</p>
-<p><b>Systems: </b>Linux/Ubuntu, macOS, and Windows.</p>
+<p><b>Systems:</b> Linux/Ubuntu, macOS, and Windows.</p>
 
 ✅ SeleniumBase works on all popular CI/CD platforms:
 <p><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md"><img alt="GitHub Actions integration" src="https://img.shields.io/badge/GitHub_Actions-12B2C2.svg?logo=GitHubActions&logoColor=CFFFC2" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/jenkins/ReadMe.md"><img alt="Jenkins integration" src="https://img.shields.io/badge/Jenkins-32B242.svg?logo=jenkins&logoColor=white" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/azure_pipelines/ReadMe.md"><img alt="Azure integration" src="https://img.shields.io/badge/Azure-2288EE.svg?logo=AzurePipelines&logoColor=white" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/google_cloud/ReadMe.md"><img alt="Google Cloud integration" src="https://img.shields.io/badge/Google_Cloud-11CAE8.svg?logo=GoogleCloud&logoColor=EE0066" /></a> <a href="#utilizing_advanced_features"><img alt="AWS integration" src="https://img.shields.io/badge/AWS-4488DD.svg?logo=AmazonAWS&logoColor=FFFF44" /></a> <a href="https://en.wikipedia.org/wiki/Personal_computer" target="_blank"><img alt="Your Computer" src="https://img.shields.io/badge/💻_Your_Computer-44E6E6.svg" /></a></p>
 
-<p>✅ SeleniumBase includes an automated/manual hybrid solution called <b><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">MasterQA</a></b> to speed up manual testing with automation while the manual tester handles validation.</p>
+<p>✅ SeleniumBase includes an automated/manual hybrid solution called <b><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">MasterQA</a></b> to speed up manual testing with automation while manual testers handle validation.</p>
+
+<p>✅ SeleniumBase supports <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/offline_examples">running tests while offline</a> (<i>assuming webdrivers have previously been downloaded when online</i>).</p>
 
 <p>✅ For a full list of SeleniumBase features, <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">Click Here</a>.</p>
 
@@ -681,9 +683,9 @@ pytest test_coffee_cart.py --trace
 ```bash
 cd examples/
 
-pytest test_suite.py --browser=chrome
+pytest test_suite.py --chrome
 
-pytest test_suite.py --browser=firefox
+pytest test_suite.py --firefox
 ```
 
 An easy way to override seleniumbase/config/settings.py is by using a custom settings file.
@@ -697,7 +699,7 @@ Inside your tests, you can use ``self.data`` to access that.
 <a id="directory_configuration"></a>
 <h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Directory Configuration:</h2>
 
-🔵 When running tests with **pytest**, you'll want a copy of **[pytest.ini](https://github.com/seleniumbase/SeleniumBase/blob/master/pytest.ini)** in your root folders. When running tests with **pynose**, you'll want a copy of **[setup.cfg](https://github.com/seleniumbase/SeleniumBase/blob/master/setup.cfg)** in your root folders. These files specify default configuration details for tests. Folders should also include a blank ``__init__.py`` file to allow your tests to import files from that folder.
+🔵 When running tests with **``pytest``**, you'll want a copy of **[pytest.ini](https://github.com/seleniumbase/SeleniumBase/blob/master/pytest.ini)** in your root folders. When running tests with **``pynose``**, you'll want a copy of **[setup.cfg](https://github.com/seleniumbase/SeleniumBase/blob/master/setup.cfg)** in your root folders. These files specify default configuration details for tests. Test folders should also include a blank **[__init__.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/offline_examples/__init__.py)** file to allow your test files to import other files from that folder.
 
 🔵 ``sbase mkdir DIR`` creates a folder with config files and sample tests:
 

examples/dialog_boxes/dialog_box_tour.py

@@ -1,4 +1,5 @@
 from seleniumbase import BaseCase
+BaseCase.main(__name__, __file__)
 
 
 class DialogBoxTests(BaseCase):

examples/test_geolocation.py

@@ -0,0 +1,40 @@
+from seleniumbase import BaseCase
+BaseCase.main(__name__, __file__)
+
+
+class TestGeolocation(BaseCase):
+    def tearDown(self):
+        self.save_teardown_screenshot()  # If test fails, or if "--screenshot"
+        if self.is_chromium() and not self._multithreaded:
+            # Reset Permissions and GeolocationOverride
+            self.execute_cdp_cmd("Browser.resetPermissions", {})
+            self.execute_cdp_cmd("Emulation.setGeolocationOverride", {})
+        super().tearDown()
+
+    def test_geolocation(self):
+        self.open("about:blank")
+        if self._multithreaded:
+            self.skip("Skipping test in multi-threaded mode.")
+        if not self.is_chromium():
+            print("\n* execute_cdp_cmd() is only for Chromium browsers")
+            self.skip("execute_cdp_cmd() is only for Chromium browsers")
+        self.execute_cdp_cmd(
+            "Browser.grantPermissions",
+            {
+                "origin": "https://www.openstreetmap.org/",
+                "permissions": ["geolocation"],
+            },
+        )
+        self.execute_cdp_cmd(
+            "Emulation.setGeolocationOverride",
+            {
+                "latitude": 48.87645,
+                "longitude": 2.26340,
+                "accuracy": 100,
+            },
+        )
+        self.open("https://www.openstreetmap.org/")
+        self.click("span.geolocate")
+        self.assert_url_contains("48.87645/2.26340")
+        if not (self.headless or self.headless2 or self.xvfb):
+            self.sleep(2.5)

examples/translations/japanese_test_1.py

@@ -17,7 +17,7 @@ def test_例1(self):
         self.要素を確認する('img[alt="握り寿司"]')
         self.JS入力("#searchInput", "レゴランド・ジャパン")
         self.クリックして("#searchform button")
-        self.要素を確認する('img[alt*="LEGOLAND JAPAN"]')
+        self.要素を確認する('img[src*="LEGOLAND_JAPAN"]')
         self.リンクテキストを確認する("名古屋城")
         self.リンクテキストをクリックします("テーマパーク")
         self.テキストを確認する("テーマパーク", "#firstHeading")

examples/uc_cdp_events.py

@@ -7,17 +7,36 @@
 
 
 class CDPTests(BaseCase):
-    def test_display_cdp_events(self):
-        if not (self.undetectable and self.uc_cdp_events and self.incognito):
-            self.get_new_driver(
-                undetectable=True, uc_cdp_events=True, incognito=True
-            )
+    def add_cdp_listener(self):
         # (To print everything, use "*". Otherwise select specific headers.)
         # self.driver.add_cdp_listener("*", lambda data: print(pformat(data)))
         self.driver.add_cdp_listener(
             "Network.requestWillBeSentExtraInfo",
             lambda data: print(pformat(data))
         )
-        self.open("https://nowsecure.nl/#relax")
-        self.assert_text("OH YEAH, you passed!", "h1", timeout=7.25)
+
+    def verify_success(self):
+        self.assert_text("OH YEAH, you passed!", "h1", timeout=6.25)
         self.sleep(2)
+
+    def fail_me(self):
+        self.fail('Selenium was detected! Try using: "pytest --uc"')
+
+    def test_display_cdp_events(self):
+        if not (self.undetectable and self.uc_cdp_events and self.incognito):
+            self.get_new_driver(
+                undetectable=True, uc_cdp_events=True, incognito=True
+            )
+        self.add_cdp_listener()
+        self.open("https://nowsecure.nl/#relax")
+        try:
+            self.verify_success()
+        except Exception:
+            self.clear_all_cookies()
+            self.get_new_driver(devtools=True)
+            self.add_cdp_listener()
+            self.open("https://nowsecure.nl/#relax")
+            try:
+                self.verify_success()
+            except Exception:
+                self.fail_me()

examples/verify_undetected.py

@@ -5,12 +5,12 @@
 
 if __name__ == "__main__":
     from pytest import main
-    main([__file__, "--uc", "--uc-cdp", "--incognito", "-s"])
+    main([__file__, "--uc", "-s"])
 
 
 class UndetectedTest(BaseCase):
     def verify_success(self):
-        self.assert_text("OH YEAH, you passed!", "h1", timeout=7.25)
+        self.assert_text("OH YEAH, you passed!", "h1", timeout=6.25)
         self.post_message("Selenium wasn't detected!", duration=2.8)
         self._print("\n Success! Website did not detect Selenium! ")
 
@@ -22,13 +22,9 @@ def test_browser_is_undetected(self):
         try:
             self.verify_success()
         except Exception:
-            if self.is_element_visible('input[value*="Verify"]'):
-                self.click('input[value*="Verify"]')
-            elif self.is_element_visible('iframe[title*="challenge"]'):
-                self.switch_to_frame('iframe[title*="challenge"]')
-                self.click("span.mark")
-            else:
-                self.fail_me()
+            self.clear_all_cookies()
+            self.get_new_driver(devtools=True)
+            self.open("https://nowsecure.nl/#relax")
             try:
                 self.verify_success()
             except Exception:

help_docs/syntax_formats.md

@@ -546,7 +546,7 @@ class 私のテストクラス(セレニウムテストケース):
         self.要素を確認する('img[alt="握り寿司"]')
         self.JS入力("#searchInput", "レゴランド・ジャパン")
         self.クリックして("#searchform button")
-        self.要素を確認する('img[alt*="LEGOLAND JAPAN"]')
+        self.要素を確認する('img[src*="LEGOLAND_JAPAN"]')
         self.リンクテキストを確認する("名古屋城")
         self.リンクテキストをクリックします("テーマパーク")
         self.テキストを確認する("テーマパーク", "#firstHeading")

mkdocs_build/requirements.txt

@@ -6,7 +6,7 @@ pkginfo>=1.9.6
 readme-renderer>=40.0
 pymdown-extensions>=10.0.1
 importlib-metadata>=6.8.0
-pipdeptree>=2.9.4
+pipdeptree>=2.9.5
 bleach>=6.0.0
 docutils>=0.20.1
 python-dateutil>=2.8.2

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.15.13"
+__version__ = "4.15.14"

seleniumbase/common/exceptions.py

@@ -1,5 +1,6 @@
 """ SeleniumBase Exceptions
     NoSuchFileException => Called when self.assert_downloaded_file(...) fails.
+    NoSuchOptionException => Called when select_option_by_*() lacks the option.
     NotConnectedException => Called when Internet is not reachable when needed.
     NotUsingChromeException => Used by Chrome-only methods if not using Chrome.
     NotUsingChromiumException => Used by Chromium-only methods if not Chromium.
@@ -15,6 +16,10 @@ class NoSuchFileException(Exception):
     pass
 
 
+class NoSuchOptionException(Exception):
+    pass
+
+
 class NotConnectedException(Exception):
     pass