Merge pull request #977 from seleniumbase/all-your-base

mdmintz · web-flow · commit 03b8fba6752d · 2021-09-01T01:53:42.000-04:00
The one with "All Your Base..."
diff --git a/README.md b/README.md
@@ -9,7 +9,8 @@
 <h4 align="center">A super framework for <a href="https://www.selenium.dev/documentation/">Selenium</a> & <a href="https://docs.pytest.org/en/latest/index.html">pytest</a>.</h4>
 <p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/releases">
 <img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=2277EE" 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>
+<img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=00a0e0" alt="Latest Release on PyPI" /></a> <a href="https://pepy.tech/project/seleniumbase">
+<img src="https://pepy.tech/badge/seleniumbase/month" alt="SeleniumBase downloads per month" /></a></p>
 
 <!-- View on GitHub -->
 <p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/actions">
@@ -360,8 +361,9 @@ The code above will leave your browser window open in case there's a failure. (i
 --firefox-pref=SET  # (Set a Firefox preference:value set, comma-separated.)
 --extension-zip=ZIP  # (Load a Chrome Extension .zip|.crx, comma-separated.)
 --extension-dir=DIR  # (Load a Chrome Extension directory, comma-separated.)
---headless  # (Run tests headlessly. Default mode on Linux OS.)
---headed  # (Run tests with a GUI on Linux OS.)
+--headless  # (Run tests in headless mode. The default arg on Linux OS.)
+--headed  # (Run tests in headed/GUI mode on Linux OS.)
+--xvfb  # (Run tests using the Xvfb virtual display server on Linux OS.)
 --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
 --interval=SECONDS  # (The autoplay interval for presentations & tour steps)
 --start-page=URL  # (The starting URL for the web browser when tests begin.)
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
-regex>=2021.8.21
+regex>=2021.8.27
 tqdm>=4.62.2
 livereload==2.6.3;python_version>="3.6"
 joblib==1.0.1;python_version>="3.6"
@@ -12,7 +12,8 @@ click==8.0.1;python_version>="3.6"
 zipp==3.5.0;python_version>="3.6"
 readme-renderer==29.0
 pymdown-extensions==8.2;python_version>="3.6"
-importlib-metadata==4.6.4;python_version>="3.6"
+importlib-metadata==4.8.1;python_version>="3.6"
+bleach==4.1.0
 lunr==0.6.0;python_version>="3.6"
 nltk==3.6.2;python_version>="3.6"
 watchdog==2.1.5;python_version>="3.6"
diff --git a/examples/github_test.py b/examples/github_test.py
@@ -14,9 +14,9 @@ def test_github(self):
             self.browser == "chrome" or self.browser == "edge"
         ):
             self.get_new_driver(
-                agent="""Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) """
+                agent="""Mozilla/5.0 """
                 """AppleWebKit/537.36 (KHTML, like Gecko) """
-                """Chrome/90.0.4430.85 Safari/537.36"""
+                """Chrome/92.0.4515.159 Safari/537.36"""
             )
         self.open("https://github.com/search?q=SeleniumBase")
         self.slow_click('a[href="/seleniumbase/SeleniumBase"]')
diff --git a/examples/hack_the_planet.py b/examples/hack_the_planet.py
diff --git a/examples/raw_parameter_script.py b/examples/raw_parameter_script.py
@@ -33,6 +33,7 @@
     sb.browser = "chrome"
     sb.headless = False
     sb.headed = False
+    sb.xvfb = False
     sb.start_page = None
     sb.locale_code = None
     sb.protocol = "http"
diff --git a/examples/tour_examples/bootstrap_google_tour.py b/examples/tour_examples/bootstrap_google_tour.py
@@ -50,7 +50,7 @@ def test_google_tour(self):
         )
         self.add_tour_step(
             "Use this button to switch to Satellite view.",
-            "#minimap div.widget-minimap",
+            "div.widget-minimap-shim",
             alignment="right",
         )
         self.add_tour_step(
diff --git a/examples/tour_examples/driverjs_maps_tour.py b/examples/tour_examples/driverjs_maps_tour.py
@@ -31,7 +31,7 @@ def test_create_tour(self):
         )
         self.add_tour_step(
             "Use this button to get a Satellite view.",
-            "#minimap div.widget-minimap",
+            "div.widget-minimap-shim",
             alignment="right",
         )
         self.add_tour_step(
diff --git a/examples/tour_examples/google_tour.py b/examples/tour_examples/google_tour.py
@@ -58,7 +58,7 @@ def test_google_tour(self):
         )
         self.add_tour_step(
             "Use this button to switch to Satellite view.",
-            "#minimap div.widget-minimap",
+            "div.widget-minimap-shim",
             alignment="right",
         )
         self.add_tour_step(
diff --git a/examples/tour_examples/hopscotch_google_tour.py b/examples/tour_examples/hopscotch_google_tour.py
@@ -50,7 +50,7 @@ def test_google_tour(self):
         )
         self.add_tour_step(
             "Use this button to switch to Satellite view.",
-            "#minimap div.widget-minimap",
+            "div.widget-minimap-shim",
             alignment="right",
         )
         self.add_tour_step(
diff --git a/examples/tour_examples/introjs_google_tour.py b/examples/tour_examples/introjs_google_tour.py
@@ -33,6 +33,7 @@ def test_google_tour(self):
         self.wait_for_element("#minimap", timeout=20)
         self.wait_for_element("#zoom", timeout=20)
 
+        self.set_introjs_colors("#f26721", "#db5409")
         self.create_introjs_tour()
         self.add_tour_step("Welcome to Google Maps!")
         self.add_tour_step(
@@ -50,7 +51,7 @@ def test_google_tour(self):
         )
         self.add_tour_step(
             "Use this button to switch to Satellite view.",
-            "#minimap div.widget-minimap",
+            "div.widget-minimap-shim",
             alignment="right",
         )
         self.add_tour_step(
diff --git a/examples/tour_examples/maps_introjs_tour.py b/examples/tour_examples/maps_introjs_tour.py
@@ -27,7 +27,7 @@ def test_google_maps_tour(self):
         )
         self.add_tour_step(
             "Use this button to switch to Satellite view.",
-            "#minimap div.widget-minimap",
+            "div.widget-minimap-shim",
             alignment="right",
         )
         self.add_tour_step(
@@ -50,5 +50,5 @@ def test_google_maps_tour(self):
             "Thanks for using SeleniumBase Tours!",
             title="🚃 End of Guided Tour 🚃",
         )
-        self.export_tour(filename="google_maps_introjs_tour.js")
+        self.export_tour(filename="maps_introjs_tour.js")
         self.play_tour()
diff --git a/examples/tour_examples/shepherd_google_tour.py b/examples/tour_examples/shepherd_google_tour.py
@@ -51,7 +51,7 @@ def test_google_tour(self):
         )
         self.add_tour_step(
             "Use this button to switch to Satellite view.",
-            "#minimap div.widget-minimap",
+            "div.widget-minimap-shim",
             alignment="right",
         )
         self.add_tour_step(
diff --git a/help_docs/customizing_test_runs.md b/help_docs/customizing_test_runs.md
@@ -122,8 +122,9 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
 --firefox-pref=SET  # (Set a Firefox preference:value set, comma-separated.)
 --extension-zip=ZIP  # (Load a Chrome Extension .zip|.crx, comma-separated.)
 --extension-dir=DIR  # (Load a Chrome Extension directory, comma-separated.)
---headless  # (Run tests headlessly. Default mode on Linux OS.)
---headed  # (Run tests with a GUI on Linux OS.)
+--headless  # (Run tests in headless mode. The default arg on Linux OS.)
+--headed  # (Run tests in headed/GUI mode on Linux OS.)
+--xvfb  # (Run tests using the Xvfb virtual display server on Linux OS.)
 --locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
 --interval=SECONDS  # (The autoplay interval for presentations & tour steps)
 --start-page=URL  # (The starting URL for the web browser when tests begin.)
diff --git a/help_docs/method_summary.md b/help_docs/method_summary.md
@@ -18,7 +18,7 @@ self.get(url)
 # If the url parameter is a URL: Perform self.open(url)
 # Otherwise: return self.get_element(URL_AS_A_SELECTOR)
 
-self.click(selector, by=By.CSS_SELECTOR, timeout=None, delay=0)
+self.click(selector, by=By.CSS_SELECTOR, timeout=None, delay=0, scroll=True)
 
 self.slow_click(selector, by=By.CSS_SELECTOR, timeout=None)
 
@@ -96,7 +96,8 @@ self.get_attribute(
     selector, attribute, by=By.CSS_SELECTOR,
     timeout=None, hard_fail=True)
 
-self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR, timeout=None)
+self.set_attribute(
+    selector, attribute, value, by=By.CSS_SELECTOR, timeout=None, scroll=False)
 
 self.set_attributes(selector, attribute, value, by=By.CSS_SELECTOR)
 # Duplicates: self.set_attribute_all(selector, attribute, value, by=By.CSS_SELECTOR)
@@ -272,7 +273,7 @@ self.scroll_to_bottom()
 
 self.click_xpath(xpath)
 
-self.js_click(selector, by=By.CSS_SELECTOR, all_matches=False)
+self.js_click(selector, by=By.CSS_SELECTOR, all_matches=False, scroll=True)
 
 self.js_click_all(selector, by=By.CSS_SELECTOR)
 
@@ -388,14 +389,18 @@ self.convert_xpath_to_css(xpath)
 
 self.convert_to_css_selector(selector, by)
 
-self.set_value(selector, text, by=By.CSS_SELECTOR, timeout=None)
+self.set_value(selector, text, by=By.CSS_SELECTOR, timeout=None, scroll=True)
 
 self.js_update_text(selector, text, by=By.CSS_SELECTOR, timeout=None)
 # Duplicates: self.js_type(selector, text, by=By.CSS_SELECTOR, timeout=None)
 #             self.set_text(selector, text, by=By.CSS_SELECTOR, timeout=None)
 
+self.set_text_content(selector, text, by=By.CSS_SELECTOR, timeout=None, scroll=False)
+
 self.jquery_update_text(selector, text, by=By.CSS_SELECTOR, timeout=None)
 
+self.get_value(selector, by=By.CSS_SELECTOR, timeout=None)
+
 self.set_time_limit(time_limit)
 
 self.set_default_timeout(timeout)
@@ -507,6 +512,8 @@ self.create_hopscotch_tour(name=None)
 
 self.create_introjs_tour(name=None)
 
+self.set_introjs_colors(theme_color=None, hover_color=None)
+
 self.add_tour_step(message, selector=None, name=None,
                    title=None, theme=None, alignment=None)
 
diff --git a/requirements.txt b/requirements.txt
@@ -2,7 +2,7 @@ pip>=20.3.4;python_version<"3.6"
 pip>=21.2.4;python_version>="3.6"
 packaging>=20.9;python_version<"3.6"
 packaging>=21.0;python_version>="3.6"
-typing-extensions>=3.10.0.0
+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"
 setuptools>=57.4.0;python_version>="3.6"
@@ -39,12 +39,13 @@ filelock==3.0.12
 fasteners==0.16;python_version<"3.5"
 fasteners==0.16.3;python_version>="3.5"
 execnet==1.9.0
-pluggy==0.13.1
+pluggy==0.13.1;python_version<"3.6"
+pluggy==1.0.0;python_version>="3.6"
 py==1.8.1;python_version<"3.5"
 py==1.10.0;python_version>="3.5"
 pytest==4.6.11;python_version<"3.5"
 pytest==6.1.2;python_version>="3.5" and python_version<"3.6"
-pytest==6.2.4;python_version>="3.6"
+pytest==6.2.5;python_version>="3.6"
 pytest-forked==1.3.0
 pytest-html==1.22.1;python_version<"3.6"
 pytest-html==2.0.1;python_version>="3.6"
@@ -71,7 +72,7 @@ pyopenssl==20.0.1;python_version>="3.5"
 pygments==2.5.2;python_version<"3.5"
 pygments==2.10.0;python_version>="3.5"
 traitlets==4.3.3;python_version<"3.7"
-traitlets==5.0.5;python_version>="3.7"
+traitlets==5.1.0;python_version>="3.7"
 prompt-toolkit==1.0.18;python_version<"3.5"
 prompt-toolkit==2.0.10;python_version>="3.5" and python_version<"3.6.2"
 prompt-toolkit==3.0.20;python_version>="3.6.2"
@@ -80,11 +81,11 @@ decorator==5.0.9;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.26.0;python_version>="3.7"
+ipython==7.27.0;python_version>="3.7"
 matplotlib-inline==0.1.2;python_version>="3.7"
 colorama==0.4.4
 platformdirs==2.0.2;python_version<"3.6"
-platformdirs==2.2.0;python_version>="3.6"
+platformdirs==2.3.0;python_version>="3.6"
 pathlib2==2.3.5;python_version<"3.5"
 importlib-metadata==2.0.0;python_version<"3.5"
 importlib-metadata==2.1.1;python_version>="3.5" and python_version<"3.6"
@@ -98,7 +99,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.3.1;python_version>="3.6"
-rich==10.7.0;python_version>="3.6" and python_version<"4.0"
+rich==10.9.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.64.1"
+__version__ = "1.65.0"
diff --git a/seleniumbase/core/browser_launcher.py b/seleniumbase/core/browser_launcher.py
@@ -519,7 +519,7 @@ def _set_firefox_options(
     options.set_preference(
         "browser.download.manager.showAlertOnComplete", False
     )
-    if headless and "linux" not in PLATFORM:
+    if headless:
         options.add_argument("--headless")
     if locale_code:
         options.set_preference("intl.accept_languages", locale_code)
diff --git a/seleniumbase/core/style_sheet.py b/seleniumbase/core/style_sheet.py
@@ -117,6 +117,9 @@
     #driver-popover-item, .popover-class {
         pointer-events: auto !important;
     }
+    button.driver-prev-btn.driver-disabled {
+        visibility: hidden;
+    }
     """
 
 messenger_style = """
@@ -146,6 +149,35 @@
     }
     """
 
+# IntroJS Style
+introjs_style = """
+    .introjs-button.introjs-nextbutton,
+    .introjs-button.introjs-donebutton {
+        color: #fff !important;
+        background-color: %s !important;
+        border: 1px solid %s !important;
+        text-shadow: none;
+        box-shadow: none;
+    }
+    .introjs-button.introjs-nextbutton:hover,
+    .introjs-button.introjs-donebutton:hover {
+        color: #fff !important;
+        background-color: %s !important;
+        border: 1px solid %s !important;
+    }
+    .introjs-button {
+        box-sizing: content-box;
+        text-decoration: none;
+    }
+    .introjs-button.introjs-skipbutton {
+        color: %s;
+    }
+    .introjs-tooltip, .introjs-floating {
+        box-sizing: content-box;
+        position: absolute;
+    }
+"""
+
 # Shepherd Backdrop Style
 sh_backdrop_style = """
     body.shepherd-active .shepherd-target.shepherd-enabled {
diff --git a/seleniumbase/core/tour_helper.py b/seleniumbase/core/tour_helper.py
@@ -6,6 +6,7 @@
 import re
 import time
 from selenium.webdriver.common.by import By
+from seleniumbase import config as sb_config
 from seleniumbase.config import settings
 from seleniumbase.core import style_sheet
 from seleniumbase.fixtures import constants
@@ -154,13 +155,24 @@ def activate_introjs(driver):
     intro_css = constants.IntroJS.MIN_CSS
     intro_js = constants.IntroJS.MIN_JS
 
+    theme_color = sb_config.introjs_theme_color
+    hover_color = sb_config.introjs_hover_color
+    backdrop_style = style_sheet.introjs_style % (
+        theme_color,
+        hover_color,
+        hover_color,
+        hover_color,
+        theme_color,
+    )
+
     verify_script = """// Verify IntroJS activated
                      var intro2 = introJs();
                      """
 
     activate_bootstrap(driver)
     js_utils.wait_for_ready_state_complete(driver)
     js_utils.wait_for_angularjs(driver)
+    js_utils.add_css_style(driver, backdrop_style)
     for x in range(4):
         js_utils.activate_jquery(driver)
         js_utils.add_css_link(driver, intro_css)
@@ -727,7 +739,9 @@ def play_introjs_tour(
         intro.setOption("overlayOpacity", .29);
         intro.setOption("scrollToElement", true);
         intro.setOption("keyboardNavigation", true);
-        intro.setOption("exitOnEsc", false);
+        intro.setOption("exitOnEsc", true);
+        intro.setOption("hidePrev", true);
+        intro.setOption("nextToDone", true);
         intro.setOption("exitOnOverlayClick", false);
         intro.setOption("showStepNumbers", false);
         intro.setOption("showProgress", false);
@@ -946,7 +960,19 @@ def export_tour(tour_steps, name=None, filename="my_tour.js", url=None):
     elif tour_type == "introjs":
         intro_css = constants.IntroJS.MIN_CSS
         intro_js = constants.IntroJS.MIN_JS
+        theme_color = sb_config.introjs_theme_color
+        hover_color = sb_config.introjs_hover_color
+        backdrop_style = style_sheet.introjs_style % (
+            theme_color,
+            hover_color,
+            hover_color,
+            hover_color,
+            theme_color,
+        )
+        backdrop_style = backdrop_style.replace("\n", "")
+        backdrop_style = js_utils.escape_quotes_if_needed(backdrop_style)
         instructions += 'injectCSS("%s");\n' % intro_css
+        instructions += 'injectStyle("%s");\n' % backdrop_style
         instructions += 'injectJS("%s");' % intro_js
 
     elif tour_type == "shepherd":
@@ -1028,7 +1054,9 @@ def export_tour(tour_steps, name=None, filename="my_tour.js", url=None):
             intro.setOption("overlayOpacity", .29);
             intro.setOption("scrollToElement", true);
             intro.setOption("keyboardNavigation", true);
-            intro.setOption("exitOnEsc", false);
+            intro.setOption("exitOnEsc", true);
+            intro.setOption("hidePrev", true);
+            intro.setOption("nextToDone", true);
             intro.setOption("exitOnOverlayClick", false);
             intro.setOption("showStepNumbers", false);
             intro.setOption("showProgress", false);
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
diff --git a/seleniumbase/fixtures/constants.py b/seleniumbase/fixtures/constants.py
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
`@@ -50,7 +50,7 @@ def test_google_tour(self):`
`50`	`50`	`)`
`51`	`51`	`self.add_tour_step(`
`52`	`52`	`"Use this button to switch to Satellite view.",`
`53`		`- "#minimap div.widget-minimap",`
	`53`	`+ "div.widget-minimap-shim",`
`54`	`54`	`alignment="right",`
`55`	`55`	`)`
`56`	`56`	`self.add_tour_step(`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ def test_create_tour(self):`
`31`	`31`	`)`
`32`	`32`	`self.add_tour_step(`
`33`	`33`	`"Use this button to get a Satellite view.",`
`34`		`- "#minimap div.widget-minimap",`
	`34`	`+ "div.widget-minimap-shim",`
`35`	`35`	`alignment="right",`
`36`	`36`	`)`
`37`	`37`	`self.add_tour_step(`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ def test_google_tour(self):`
`58`	`58`	`)`
`59`	`59`	`self.add_tour_step(`
`60`	`60`	`"Use this button to switch to Satellite view.",`
`61`		`- "#minimap div.widget-minimap",`
	`61`	`+ "div.widget-minimap-shim",`
`62`	`62`	`alignment="right",`
`63`	`63`	`)`
`64`	`64`	`self.add_tour_step(`