Merge pull request #850 from seleniumbase/refactor-methods-and-other-updates

mdmintz · web-flow · commit ab94569d3ed7 · 2021-03-29T00:05:31.000-04:00
Refactor methods and other updates
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -6,10 +6,11 @@ Markdown==3.3.4
 Jinja2==2.11.3
 readme-renderer==29.0
 pymdown-extensions==8.1.1
+importlib-metadata==3.9.0;python_version>="3.6"
 lunr==0.5.8
 mkdocs==1.1.2
-mkdocs-material==6.2.3
+mkdocs-material==7.0.7
 mkdocs-exclude-search==0.4.0
-mkdocs-simple-hooks==0.1.2
+mkdocs-simple-hooks==0.1.3
 mkdocs-material-extensions==1.0.1
 mkdocs-minify-plugin==0.4.0
diff --git a/examples/boilerplates/samples/test_page_objects.py b/examples/boilerplates/samples/test_page_objects.py
@@ -24,8 +24,7 @@ def click_seleniumbase_io_link(self, sb):
         sb.wait_for_ready_state_complete()
         current_url = sb.get_current_url()
         if "seleniumbase.io" not in current_url:
-            # GitHub probably opened a new window
-            sb.switch_to_window(1)
+            sb.switch_to_window(1)  # GitHub probably opened a new window
 
 
 class SeleniumBaseIOPage():
diff --git a/examples/edge_test.py b/examples/edge_test.py
@@ -12,6 +12,9 @@ def test_edge(self):
             print("\n  This test is only for Microsoft Edge (Chromium)!")
             print('  (Run this test using "--edge" or "--browser=edge")')
             self.skip('Use "--edge" or "--browser=edge"')
+        if self.headless:
+            print("\n  This test is NOT designed for Headless Mode!")
+            self.skip('Do NOT use "--headless" with this test!')
         self.open("edge://settings/help")
         self.highlight('div[role="main"]')
         self.highlight('img[srcset*="logo"]')
diff --git a/examples/test_hack_search.py b/examples/test_hack_search.py
@@ -18,6 +18,8 @@ def test_hack_search(self):
         self.click('[value="Bing Search"]')
         self.highlight("h1.b_logo")
         self.highlight_click('a[href*="github.com/seleniumbase/SeleniumBase"]')
+        if self.browser == "firefox":
+            self.switch_to_window(1)  # Firefox opens a new window
         self.assert_element('[href="/seleniumbase/SeleniumBase"]')
         self.assert_true("seleniumbase/SeleniumBase" in self.get_current_url())
         self.click('a[title="examples"]')
diff --git a/help_docs/chinese.md b/help_docs/chinese.md
@@ -464,7 +464,7 @@ pytest test_fail.py
 pytest test_suite.py --html=report.html
 ```
 
-<img src="https://cdn2.hubspot.net/hubfs/100006/images/pytest_report_3c.png" alt="Example Pytest Report" title="Example Pytest Report" width="520" />
+<img src="https://seleniumbase.io/cdn/img/html_report.png" alt="Example Pytest Report" title="Example Pytest Report" width="520" />
 
 还可以使用``--junit-xml=report``。获取一个xml报告。Jenkins可以使用这个文件为您的测试显示更好的报告。
 
@@ -480,7 +480,7 @@ pytest test_suite.py --junit-xml=report.xml
 nosetests test_suite.py --report
 ```
 
-<img src="https://cdn2.hubspot.net/hubfs/100006/images/Test_Report_2.png" alt="Example Nosetest Report" title="Example Nosetest Report" width="320" />
+<img src="https://seleniumbase.io/cdn/img/nose_report.png" alt="Example Nosetest Report" title="Example Nosetest Report" width="320" />
 
 (注意:您可以添加``--show-report ``来在测试套件完成后立即显示Nosetest报告。只在本地运行测试时使用``--show-report ``，因为它会暂停测试运行.)
 
diff --git a/integrations/katalon/ReadMe.md b/integrations/katalon/ReadMe.md
@@ -4,7 +4,7 @@
 
 #### Step 1: Make a recording with the Katalon Recorder
 
-![](https://cdn2.hubspot.net/hubfs/100006/images/katalon_recorder_2.png "Katalon Recorder example")
+![](https://seleniumbase.io/cdn/img/katalon_recorder_2.png "Katalon Recorder example")
 
 #### Step 2: Export your recording as a Python 2 Webdriver script
 
diff --git a/integrations/selenium_ide/ReadMe.md b/integrations/selenium_ide/ReadMe.md
@@ -4,7 +4,7 @@ Katalon Recorder (Selenium IDE) is a tool that allows you to record and playback
 
 ### Step 1: Make a recording with the Katalon Recorder
 
-![](https://cdn2.hubspot.net/hubfs/100006/images/katalon_recorder_2.png "Katalon Recorder example")
+![](https://seleniumbase.io/cdn/img/katalon_recorder_2.png "Katalon Recorder example")
 
 ### Step 2: Export your recording as a Python 2 Webdriver script
 
diff --git a/requirements.txt b/requirements.txt
@@ -63,7 +63,7 @@ prompt-toolkit==3.0.18;python_version>="3.6"
 ipython==5.10.0;python_version<"3.5"
 ipython==6.5.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.21.0;python_version>="3.7"
+ipython==7.22.0;python_version>="3.7"
 colorama==0.4.4
 pathlib2==2.3.5;python_version<"3.5"
 importlib-metadata==2.0.0;python_version<"3.6"
@@ -78,7 +78,7 @@ 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"
 Pillow==8.1.2;python_version>="3.6"
-rich==9.13.0;python_version>="3.6" and python_version<"4.0"
+rich==10.0.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"
diff --git a/seleniumbase/__version__.py b/seleniumbase/__version__.py
@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.59.3"
+__version__ = "1.59.4"
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -3471,8 +3471,7 @@ def set_value(self, selector, text, by=By.CSS_SELECTOR, timeout=None):
                 self.wait_for_ready_state_complete()
         self.__demo_mode_pause_if_active()
 
-    def js_update_text(self, selector, text, by=By.CSS_SELECTOR,
-                       timeout=None):
+    def js_update_text(self, selector, text, by=By.CSS_SELECTOR, timeout=None):
         """ JavaScript + send_keys are used to update a text field.
             Performs self.set_value() and triggers event listeners.
             If text ends in "\n", set_value() presses RETURN after.
@@ -3486,18 +3485,16 @@ def js_update_text(self, selector, text, by=By.CSS_SELECTOR,
         selector, by = self.__recalculate_selector(selector, by)
         if type(text) is int or type(text) is float:
             text = str(text)
-        self.set_value(
-            selector, text, by=by, timeout=timeout)
+        self.set_value(selector, text, by=by, timeout=timeout)
         if not text.endswith('\n'):
             try:
                 element = page_actions.wait_for_element_present(
                     self.driver, selector, by, timeout=0.2)
-                element.send_keys(" \b")
+                element.send_keys(" " + Keys.BACK_SPACE)
             except Exception:
                 pass
 
-    def js_type(self, selector, text, by=By.CSS_SELECTOR,
-                timeout=None):
+    def js_type(self, selector, text, by=By.CSS_SELECTOR, timeout=None):
         """ Same as self.js_update_text()
             JavaScript + send_keys are used to update a text field.
             Performs self.set_value() and triggers event listeners.
@@ -3510,17 +3507,7 @@ def js_type(self, selector, text, by=By.CSS_SELECTOR,
         if self.timeout_multiplier and timeout == settings.LARGE_TIMEOUT:
             timeout = self.__get_new_timeout(timeout)
         selector, by = self.__recalculate_selector(selector, by)
-        if type(text) is int or type(text) is float:
-            text = str(text)
-        self.set_value(
-            selector, text, by=by, timeout=timeout)
-        if not text.endswith('\n'):
-            try:
-                element = page_actions.wait_for_element_present(
-                    self.driver, selector, by, timeout=0.2)
-                element.send_keys(" \b")
-            except Exception:
-                pass
+        self.js_update_text(selector, text, by=by, timeout=timeout)
 
     def set_text(self, selector, text, by=By.CSS_SELECTOR, timeout=None):
         """ Same as self.js_update_text()
@@ -3534,17 +3521,7 @@ def set_text(self, selector, text, by=By.CSS_SELECTOR, timeout=None):
         if self.timeout_multiplier and timeout == settings.LARGE_TIMEOUT:
             timeout = self.__get_new_timeout(timeout)
         selector, by = self.__recalculate_selector(selector, by)
-        if type(text) is int or type(text) is float:
-            text = str(text)
-        self.set_value(
-            selector, text, by=by, timeout=timeout)
-        if not text.endswith('\n'):
-            try:
-                element = page_actions.wait_for_element_present(
-                    self.driver, selector, by, timeout=0.2)
-                element.send_keys(" \b")
-            except Exception:
-                pass
+        self.js_update_text(selector, text, by=by, timeout=timeout)
 
     def jquery_update_text(self, selector, text, by=By.CSS_SELECTOR,
                            timeout=None):
diff --git a/seleniumbase/fixtures/js_utils.py b/seleniumbase/fixtures/js_utils.py
@@ -5,6 +5,7 @@
 import re
 import requests
 import time
+from selenium.common.exceptions import NoSuchElementException
 from selenium.common.exceptions import WebDriverException
 from seleniumbase import config as sb_config
 from seleniumbase.common import decorators
@@ -13,12 +14,16 @@
 from seleniumbase.fixtures import shared_utils
 
 
-def wait_for_ready_state_complete(driver, timeout=settings.EXTREME_TIMEOUT):
+def wait_for_ready_state_complete(driver, timeout=settings.LARGE_TIMEOUT):
     """
     The DOM (Document Object Model) has a property called "readyState".
     When the value of this becomes "complete", page resources are considered
-    fully loaded (although AJAX and other loads might still be happening).
+      fully loaded (although AJAX and other loads might still be happening).
     This method will wait until document.readyState == "complete".
+    This may be redundant, as methods already wait for page elements to load.
+    If the timeout is exceeded, the test will still continue
+      because readyState == "interactive" may be good enough.
+    (Previously, tests would fail immediately if exceeding the timeout.)
     """
     start_ms = time.time() * 1000.0
     stop_ms = start_ms + (timeout * 1000.0)
@@ -38,8 +43,7 @@ def wait_for_ready_state_complete(driver, timeout=settings.EXTREME_TIMEOUT):
             if now_ms >= stop_ms:
                 break
             time.sleep(0.1)
-    raise Exception(
-        "Page elements never fully loaded after %s seconds!" % timeout)
+    return False  # readyState stayed "interactive" (Not "complete")
 
 
 def execute_async_script(driver, script, timeout=settings.EXTREME_TIMEOUT):
@@ -214,8 +218,7 @@ def wait_for_css_query_selector(
             if now_ms >= stop_ms:
                 break
             time.sleep(0.1)
-
-    raise Exception(
+    raise NoSuchElementException(
         "Element {%s} was not present after %s seconds!" % (
             selector, timeout))
 
diff --git a/seleniumbase/fixtures/page_actions.py b/seleniumbase/fixtures/page_actions.py
@@ -23,15 +23,15 @@
 import os
 import sys
 import time
+from selenium.common.exceptions import ElementNotVisibleException
+from selenium.common.exceptions import NoAlertPresentException
+from selenium.common.exceptions import NoSuchElementException
+from selenium.common.exceptions import NoSuchFrameException
+from selenium.common.exceptions import NoSuchWindowException
 from selenium.common.exceptions import StaleElementReferenceException
 from selenium.common import exceptions as selenium_exceptions
 from selenium.webdriver.common.by import By
 from selenium.webdriver.common.action_chains import ActionChains
-from selenium.webdriver.remote.errorhandler import ElementNotVisibleException
-from selenium.webdriver.remote.errorhandler import NoSuchElementException
-from selenium.webdriver.remote.errorhandler import NoAlertPresentException
-from selenium.webdriver.remote.errorhandler import NoSuchFrameException
-from selenium.webdriver.remote.errorhandler import NoSuchWindowException
 from seleniumbase.config import settings
 from seleniumbase.fixtures import shared_utils as s_utils
 ENI_Exception = selenium_exceptions.ElementNotInteractableException
diff --git a/seleniumbase/fixtures/shared_utils.py b/seleniumbase/fixtures/shared_utils.py
@@ -2,11 +2,11 @@
 This module contains shared utility methods.
 """
 import time
-from selenium.webdriver.remote.errorhandler import ElementNotVisibleException
-from selenium.webdriver.remote.errorhandler import NoSuchElementException
-from selenium.webdriver.remote.errorhandler import NoAlertPresentException
-from selenium.webdriver.remote.errorhandler import NoSuchFrameException
-from selenium.webdriver.remote.errorhandler import NoSuchWindowException
+from selenium.common.exceptions import ElementNotVisibleException
+from selenium.common.exceptions import NoAlertPresentException
+from selenium.common.exceptions import NoSuchElementException
+from selenium.common.exceptions import NoSuchFrameException
+from selenium.common.exceptions import NoSuchWindowException
 from seleniumbase.common.exceptions import NoSuchFileException
 from seleniumbase.common.exceptions import TimeLimitExceededException
 from seleniumbase import config as sb_config
diff --git a/seleniumbase/masterqa/ReadMe.md b/seleniumbase/masterqa/ReadMe.md
@@ -1,8 +1,8 @@
-![](https://cdn2.hubspot.net/hubfs/100006/images/masterqa_logo-11.png "MasterQA")
+![](https://seleniumbase.io/cdn/img/masterqa_logo.png "MasterQA")
 
-### MasterQA combines automation with manual verification steps.
+<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> MasterQA combines automation with manual verification steps.</h3>
 
-![](https://cdn2.hubspot.net/hubfs/100006/images/masterqa6.gif "MasterQA")
+![](https://seleniumbase.io/cdn/gif/masterqa6.gif "MasterQA")
 
 Here's example code from [basic_masterqa_test_0.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/basic_masterqa_test_0.py):
 
@@ -19,16 +19,16 @@ After each automation checkpoint, a pop-up window will ask the user questions fo
 
 When the test run completes, as seen from [this longer example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test_1.py), you'll reach the results page that appears after answering all the verification questions. (Failed verifications generate links to screenshots and log files.)
 
-![](https://cdn2.hubspot.net/hubfs/100006/images/hybrid_screen.png "MasterQA")
+![](https://seleniumbase.io/cdn/img/mqa_hybrid.png "MasterQA")
 
 You may have noticed the ``Incomplete Test Runs`` row on the results page. If the value for that is not zero, it means that one of the automated steps failed. This could happen if you tell your script to perform an action on an element that doesn't exist. Now that we're mixing automation with manual QA, it's good to tell apart the failures from each. The results_table CSV file contains a spreadsheet with the details of each failure (if any) for both manual and automated steps.
 
 #### How to run the example tests from scratch:
+
 ```bash
 git clone https://github.com/seleniumbase/SeleniumBase.git
 cd SeleniumBase
-pip install -r requirements.txt --upgrade
-python setup.py develop
+pip install .
 cd examples/master_qa
 pytest basic_masterqa_test_0.py
 pytest masterqa_test_1.py
@@ -48,6 +48,6 @@ self.verify()
 self.verify("Can you find the moon?")
 ```
 
----
+--------
 
 MasterQA is powered by [SeleniumBase](https://seleniumbase.com), the most advanced open-source automation framework on the [Planet](https://en.wikipedia.org/wiki/Earth).
diff --git a/seleniumbase/masterqa/master_qa.py b/seleniumbase/masterqa/master_qa.py
@@ -2,8 +2,8 @@
 import shutil
 import sys
 import time
+from selenium.common.exceptions import NoAlertPresentException
 from selenium.common.exceptions import WebDriverException
-from selenium.webdriver.remote.errorhandler import NoAlertPresentException
 from seleniumbase import BaseCase
 from seleniumbase.core.style_sheet import style
 from seleniumbase.config import settings
diff --git a/seleniumbase/utilities/selenium_ide/ReadMe.md b/seleniumbase/utilities/selenium_ide/ReadMe.md
@@ -4,7 +4,7 @@ Katalon Recorder (Selenium IDE) is a tool that allows you to record and playback
 
 ### Step 1: Make a recording with the Katalon Recorder
 
-![](https://cdn2.hubspot.net/hubfs/100006/images/katalon_recorder_2.png "Katalon Recorder example")
+![](https://seleniumbase.io/cdn/img/katalon_recorder_2.png "Katalon Recorder example")
 
 ### Step 2: Export your recording as a Python 2 Webdriver script
 
diff --git a/setup.py b/setup.py
@@ -168,7 +168,7 @@
         'ipython==5.10.0;python_version<"3.5"',
         'ipython==6.5.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.21.0;python_version>="3.7"',
+        'ipython==7.22.0;python_version>="3.7"',
         'colorama==0.4.4',
         'pathlib2==2.3.5;python_version<"3.5"',  # Sync with "virtualenv"
         'importlib-metadata==2.0.0;python_version<"3.6"',  # Sync "virtualenv"
@@ -183,7 +183,7 @@
         'Pillow==6.2.2;python_version<"3.5"',
         'Pillow==7.2.0;python_version>="3.5" and python_version<"3.6"',
         'Pillow==8.1.2;python_version>="3.6"',
-        'rich==9.13.0;python_version>="3.6" and python_version<"4.0"',
+        'rich==10.0.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"',

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