Merge pull request #950 from seleniumbase/reliability-and-other-improvements

Reliability and other improvements

Author: mdmintz

README.md

@@ -6,12 +6,12 @@
 <link rel="icon" href="https://seleniumbase.io/img/logo6.png" />
 
 <p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/">
-<img src="https://seleniumbase.io/cdn/img/long_logo.png" alt="SeleniumBase" title="SeleniumBase" width="690" /></a></p>
+<img src="https://seleniumbase.io/cdn/img/logo_and_pie.png" alt="SeleniumBase" title="SeleniumBase" width="690" /></a></p>
 <p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/releases">
 <img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=0090c0" alt="Latest Release on GitHub" /></a> <a href="https://pypi.org/project/seleniumbase/">
 <img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=00a0e0" alt="Latest Release on PyPI" /></a></p>
 <p align="center">
-<b>Python Web UI Testing Made Easy.</b>
+<b>Python Web-UI Testing Made Awesome.</b>
 </p>
 
 <!-- View on GitHub -->
@@ -20,27 +20,31 @@
 <img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/stargazers"><img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=19A57B" title="Stargazers" /></a> <a href="https://seleniumbase.io">
 <img src="https://img.shields.io/badge/docs-%20seleniumbase.io-22BBAA.svg" alt="SeleniumBase.io Docs" /></a></p>
 
-<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py"><img src="https://seleniumbase.io/cdn/gif/swag_labs_gif.gif" alt="SeleniumBase Demo Mode" title="SeleniumBase Demo Mode" /></a></p>
-
-<p align="center">
-<b>SeleniumBase is a complete framework for automated browser testing with pytest.</b>
+<p align="left">
+✅ SeleniumBase is a Python framework for web testing.<br / >
+✅ Tests can be run with <b>pytest</b> from the command-line.<br / >
+✅ Includes code to simplify & improve WebDriver APIs.<br / >
+✅ Supports Chrome, Edge, Firefox, IE, Opera, and Safari.<br />
+✅ Includes powerful <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">reporting and dashboard features</a>.
 </p>
 
+<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py"><img src="https://seleniumbase.io/cdn/gif/demo_page_1.gif" alt="SeleniumBase Demo Mode" title="SeleniumBase Demo Mode" width="450" /></a></p>
+
 <p align="center">
 <a href="#python_installation">🚀 Start</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🗂️ Features</a> |
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">📖 Examples</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">🖥️ CLI</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">📖 Examples</a>
-<br />
-<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🗄️ PkgManager</a>
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🗂️ Features</a>
 <br />
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📗 API</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📋 Reports</a> |
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📗 API</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">💻 Scripts</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md">📱 Mobile</a>
 <br />
+<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> |
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> |
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🗄️ PkgManager</a>
+<br />
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">🔡 SyntaxFormats</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 GridHub</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md">⏺️ Recorder</a>
@@ -55,9 +59,6 @@
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🛂 MasterQA</a>
 </p>
 
-✅ Chrome/Edge/Firefox/IE/Opera/Safari.<br />
-✅ Includes [reporting and dashboard tools](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
-
 --------
 
 <p align="left">Example: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py">my_first_test.py</a> (<code>--demo</code> mode)</p>
@@ -191,7 +192,7 @@ pytest test_demo_site.py
 
 > (Chrome is the default browser if not specified with ``--browser=BROWSER``. On Linux, ``--headless`` is the default behavior. You can also run in headless mode on any OS. If your Linux machine has a GUI and you want to see the web browser as tests run, add ``--headed`` or ``--gui``.)
 
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py"><img src="https://seleniumbase.io/cdn/gif/demo_page_1.gif" title="SeleniumBase Demo Page" /></a><br />
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py"><img src="https://seleniumbase.io/cdn/gif/demo_page_1.gif" title="SeleniumBase Demo Page" width="450" /></a><br />
 
 🔵 <b>Here are more examples that you can run:</b>
 

examples/example_logs/ReadMe.md

@@ -1,7 +1,7 @@
 <h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Logging, Dashboards, and Reports:</h3>
 
 [<img src="http://img.youtube.com/vi/XpuJCjJhJwQ/0.jpg" title="SeleniumBase Features" width="285">](https://www.youtube.com/watch?v=XpuJCjJhJwQ)
-<p>(<b><a href="https://www.youtube.com/watch?v=XpuJCjJhJwQ">SBase Dashboard Tutorial on YouTube</a></b>)</p>
+<p>(<b><a href="https://www.youtube.com/watch?v=XpuJCjJhJwQ">The Dashboard Tutorial on YouTube</a></b>)</p>
 
 🔵 During test failures, logs and screenshots from the most recent test run will get saved to the ``latest_logs/`` folder. If ``--archive-logs`` is specified (or if ARCHIVE_EXISTING_LOGS is set to True in [settings.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py)), test logs will also get archived to the ``archived_logs/`` folder. Otherwise, the log files will be cleaned out when the next test run begins (by default).
 

examples/test_chinese_pdf.py

@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-import sys
 from seleniumbase import BaseCase
 
 
@@ -13,10 +12,7 @@ def test_chinese_pdf(self):
 
         # Get and print PDF text
         pdf_text = self.get_pdf_text(pdf, page=2)
-        if sys.version_info[0] >= 3:
-            print("\n" + pdf_text, file=sys.stderr)  # noqa
-        else:
-            print("\n" + pdf_text)  # Use older print()
+        self._print("\n" + pdf_text)
 
         # Assert PDF contains the expected text on Page 2
         self.assert_pdf_text(pdf, "个测试类", page=2)

examples/test_get_pdf_text.py

@@ -1,4 +1,3 @@
-import sys
 from seleniumbase import BaseCase
 
 
@@ -9,7 +8,4 @@ def test_get_pdf_text(self):
             "Automate_the_Boring_Stuff_sample_ch17.pdf"
         )
         pdf_text = self.get_pdf_text(pdf, page=1)
-        if sys.version_info[0] >= 3:
-            print("\n" + pdf_text, file=sys.stderr)  # noqa
-        else:
-            print("\n" + pdf_text)  # Use older print()
+        self._print("\n" + pdf_text)

requirements.txt

@@ -1,5 +1,5 @@
 pip>=20.3.4;python_version<"3.6"
-pip>=21.1.3;python_version>="3.6"
+pip>=21.2.1;python_version>="3.6"
 packaging>=20.9;python_version<"3.6"
 packaging>=21.0;python_version>="3.6"
 typing-extensions>=3.10.0.0
@@ -82,7 +82,8 @@ ipython==7.16.1;python_version>="3.6" and python_version<"3.7"
 ipython==7.25.0;python_version>="3.7"
 matplotlib-inline==0.1.2;python_version>="3.7"
 colorama==0.4.4
-platformdirs==2.0.2
+platformdirs==2.0.2;python_version<"3.6"
+platformdirs==2.2.0;python_version>="3.6"
 pathlib2==2.3.5;python_version<"3.5"
 importlib-metadata==2.0.0;python_version<"3.6"
 virtualenv>=20.6.0

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.63.17"
+__version__ = "1.63.18"

seleniumbase/fixtures/base_case.py

@@ -1424,6 +1424,7 @@ def click_nth_visible_element(
         if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
             timeout = self.__get_new_timeout(timeout)
         selector, by = self.__recalculate_selector(selector, by)
+        self.wait_for_ready_state_complete()
         self.wait_for_element_present(selector, by=by, timeout=timeout)
         elements = self.find_visible_elements(selector, by=by)
         if len(elements) < number:
@@ -1435,14 +1436,23 @@ def click_nth_visible_element(
         if number < 0:
             number = 0
         element = elements[number]
-        self.wait_for_ready_state_complete()
         try:
             self.__scroll_to_element(element)
             element.click()
         except (StaleElementReferenceException, ENI_Exception):
-            self.wait_for_ready_state_complete()
             time.sleep(0.12)
-            self.__scroll_to_element(element)
+            self.wait_for_ready_state_complete()
+            self.wait_for_element_present(selector, by=by, timeout=timeout)
+            elements = self.find_visible_elements(selector, by=by)
+            if len(elements) < number:
+                raise Exception(
+                    "Not enough matching {%s} elements of type {%s} to "
+                    "click number %s!" % (selector, by, number)
+                )
+            number = number - 1
+            if number < 0:
+                number = 0
+            element = elements[number]
             element.click()
 
     def click_if_visible(self, selector, by=By.CSS_SELECTOR):
@@ -4083,6 +4093,8 @@ def set_value(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, xp_ok=False)
+        self.wait_for_ready_state_complete()
+        self.wait_for_element_present(selector, by=by, timeout=timeout)
         orginal_selector = selector
         css_selector = self.convert_to_css_selector(selector, by=by)
         self.__demo_mode_highlight_if_active(orginal_selector, by)
@@ -4853,8 +4865,16 @@ def block_ads(self):
         self.ad_block()
 
     def _print(self, msg):
-        """ Same as Python's print() """
-        print(msg)
+        """Same as Python's print(), but won't print during multithreaded runs
+        because overlapping print() commands may lead to unexpected output.
+        In most cases, the print() command won't print for multithreaded tests,
+        but there are some exceptions, and this will take care of those.
+        Here's an example of running tests multithreaded: "pytest -n=4".
+        To force a print during multithreaded tests, use: "sys.stderr.write()".
+        To print without the new-line character end, use: "sys.stdout.write()".
+        """
+        if not sb_config._multithreaded:
+            print(msg)
 
     def start_tour(self, name=None, interval=0):
         self.play_tour(name=name, interval=interval)

setup.py

@@ -114,7 +114,7 @@
     python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
     install_requires=[
         'pip>=20.3.4;python_version<"3.6"',
-        'pip>=21.1.3;python_version>="3.6"',
+        'pip>=21.2.1;python_version>="3.6"',
         'packaging>=20.9;python_version<"3.6"',
         'packaging>=21.0;python_version>="3.6"',
         "typing-extensions>=3.10.0.0",
@@ -197,7 +197,8 @@
         'ipython==7.25.0;python_version>="3.7"',
         'matplotlib-inline==0.1.2;python_version>="3.7"',
         "colorama==0.4.4",
-        "platformdirs==2.0.2",
+        'platformdirs==2.0.2;python_version<"3.6"',
+        'platformdirs==2.2.0;python_version>="3.6"',
         'pathlib2==2.3.5;python_version<"3.5"',  # Sync with "virtualenv"
         'importlib-metadata==2.0.0;python_version<"3.6"',  # Sync "virtualenv"
         "virtualenv>=20.6.0",  # Sync with importlib-metadata and pathlib2