Merge pull request #340 from seleniumbase/add-command-line-features

mdmintz · web-flow · commit 7fcfa768d085 · 2019-07-14T01:16:04.000-04:00
Add command line features for Chrome control
diff --git a/examples/boilerplates/samples/google_test.py b/examples/boilerplates/samples/google_test.py
@@ -9,7 +9,7 @@
 class GoogleTests(BaseCase):
 
     def test_google_dot_com(self):
-        self.open('https://google.com')
+        self.open('https://google.com/ncr')
         self.update_text(HomePage.search_box, 'github')
         self.assert_element(HomePage.list_box)
         self.assert_element(HomePage.search_button)
diff --git a/examples/github_test.py b/examples/github_test.py
@@ -3,13 +3,20 @@
 
 class GitHubTests(BaseCase):
 
-    # Selenium can trigger GitHub's abuse detection mechanism:
-    # "You have triggered an abuse detection mechanism."
-    # "Please wait a few minutes before you try again."
-    # To avoid this, slow_click() is being used to
-    # slow down Selenium actions.
-
     def test_github(self):
+        # Selenium can trigger GitHub's anti-automation system:
+        # "You have triggered an abuse detection mechanism."
+        # "Please wait a few minutes before you try again."
+        # To avoid this automation blocker, two steps are being taken:
+        # 1. self.slow_click() is being used to slow down Selenium actions.
+        # 2. The browser's User Agent is modified to avoid Selenium-detection
+        #    when running in headless mode on Chrome.
+        if self.browser == "chrome" and self.headless:
+            self.driver.quit()
+            self.get_new_driver(
+                agent="""Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) """
+                      """AppleWebKit/537.36 (KHTML, like Gecko) """
+                      """Chrome/75.0.3770.100 Safari/537.36""")
         self.open("https://github.com/")
         self.update_text("input.header-search-input", "SeleniumBase\n")
         self.slow_click('a[href="/seleniumbase/SeleniumBase"]')
diff --git a/examples/parameterized_test.py b/examples/parameterized_test.py
@@ -10,6 +10,6 @@ class GoogleTestClass(BaseCase):
         ["seleniumbase", "https://github.com/seleniumbase/SeleniumBase"],
     ])
     def test_parameterized_google_search(self, search_term, expected_url):
-        self.open('https://google.com')
+        self.open('https://google.com/ncr')
         self.update_text('input[title="Search"]', search_term + '\n')
         self.assert_text(expected_url, '#search')
diff --git a/examples/raw_parameter_script.py b/examples/raw_parameter_script.py
@@ -33,10 +33,13 @@
     b.data = None
     b.environment = "test"
     b.user_agent = None
+    b.extension_zip = None
+    b.extension_dir = None
     b.database_env = "test"
     b.log_path = "latest_logs/"
     b.archive_logs = False
     b.disable_csp = False
+    b.enable_sync = False
     b.visual_baseline = False
     b.save_screenshot_after_test = False
     b.timeout_multiplier = None
@@ -49,6 +52,7 @@
     b.demo_mode = False
     b.demo_sleep = 1
     b.message_duration = 2
+    b.user_data_dir = None
     b.proxy_string = None
     b.ad_block_on = False
     b.highlights = None
diff --git a/examples/tour_examples/bootstrap_google_tour.py b/examples/tour_examples/bootstrap_google_tour.py
@@ -4,7 +4,7 @@
 class MyTourClass(BaseCase):
 
     def test_google_tour(self):
-        self.open('https://google.com')
+        self.open('https://google.com/ncr')
         self.wait_for_element('input[title="Search"]')
 
         self.create_bootstrap_tour()  # OR self.create_tour(theme="bootstrap")
diff --git a/examples/tour_examples/google_tour.py b/examples/tour_examples/google_tour.py
@@ -4,7 +4,7 @@
 class MyTourClass(BaseCase):
 
     def test_google_tour(self):
-        self.open('https://google.com')
+        self.open('https://google.com/ncr')
         self.wait_for_element('input[title="Search"]')
 
         # Create a website tour using the ShepherdJS library with "dark" theme
diff --git a/examples/tour_examples/hopscotch_google_tour.py b/examples/tour_examples/hopscotch_google_tour.py
@@ -4,7 +4,7 @@
 class MyTourClass(BaseCase):
 
     def test_google_tour(self):
-        self.open('https://google.com')
+        self.open('https://google.com/ncr')
         self.wait_for_element('input[title="Search"]')
 
         self.create_hopscotch_tour()  # OR self.create_tour(theme="hopscotch")
diff --git a/examples/tour_examples/introjs_google_tour.py b/examples/tour_examples/introjs_google_tour.py
@@ -4,7 +4,7 @@
 class MyTourClass(BaseCase):
 
     def test_google_tour(self):
-        self.open('https://google.com')
+        self.open('https://google.com/ncr')
         self.wait_for_element('input[title="Search"]')
 
         self.create_introjs_tour()  # OR self.create_tour(theme="introjs")
diff --git a/examples/tour_examples/shepherd_google_tour.py b/examples/tour_examples/shepherd_google_tour.py
@@ -4,7 +4,7 @@
 class MyTourClass(BaseCase):
 
     def test_google_tour(self):
-        self.open('https://google.com')
+        self.open('https://google.com/ncr')
         self.wait_for_element('input[title="Search"]')
 
         self.create_shepherd_tour(theme="dark")
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,6 @@
 pip>=19.1.1
 setuptools>=41.0.1
+wheel>=0.33.4
 six
 nose
 ipdb
@@ -26,6 +27,6 @@ pyopenssl>=19.0.0
 colorama>=0.4.1
 pyotp>=2.2.7
 boto>=2.49.0
-flake8>=3.7.7
+flake8>=3.7.8
 certifi>=2019.6.16
 PyVirtualDisplay==0.2.1
diff --git a/seleniumbase/console_scripts/sb_mkdir.py b/seleniumbase/console_scripts/sb_mkdir.py
@@ -217,7 +217,7 @@ def main():
         data.append("class GoogleTests(BaseCase):")
         data.append("")
         data.append("    def test_google_dot_com(self):")
-        data.append("        self.open('https://google.com')")
+        data.append("        self.open('https://google.com/ncr')")
         data.append(
             "        self.update_text(HomePage.search_box, 'github')")
         data.append("        self.assert_element(HomePage.list_box)")
diff --git a/seleniumbase/core/browser_launcher.py b/seleniumbase/core/browser_launcher.py
@@ -97,7 +97,8 @@ def _add_chrome_disable_csp_extension(chrome_options):
 
 def _set_chrome_options(
         downloads_path, headless, proxy_string, proxy_auth,
-        proxy_user, proxy_pass, user_agent, disable_csp):
+        proxy_user, proxy_pass, user_agent, disable_csp, enable_sync,
+        user_data_dir, extension_zip, extension_dir):
     chrome_options = webdriver.ChromeOptions()
     prefs = {
         "download.default_directory": downloads_path,
@@ -108,6 +109,19 @@ def _set_chrome_options(
         }
     }
     chrome_options.add_experimental_option("prefs", prefs)
+    if enable_sync:
+        chrome_options.add_experimental_option(
+            "excludeSwitches", ["disable-sync"])
+        chrome_options.add_argument("--enable-sync")
+    if user_data_dir:
+        abs_path = os.path.abspath(user_data_dir)
+        chrome_options.add_argument("user-data-dir=%s" % abs_path)
+    if extension_zip:
+        abs_path = os.path.abspath(extension_zip)
+        chrome_options.add_extension(abs_path)
+    if extension_dir:
+        abs_path = os.path.abspath(extension_dir)
+        chrome_options.add_argument("--load-extension=%s" % abs_path)
     chrome_options.add_argument("--test-type")
     chrome_options.add_argument("--log-level=3")
     chrome_options.add_argument("--no-first-run")
@@ -245,7 +259,9 @@ def validate_proxy_string(proxy_string):
 
 def get_driver(browser_name, headless=False, use_grid=False,
                servername='localhost', port=4444, proxy_string=None,
-               user_agent=None, cap_file=None, disable_csp=None):
+               user_agent=None, cap_file=None, disable_csp=None,
+               enable_sync=None, user_data_dir=None,
+               extension_zip=None, extension_dir=None):
     proxy_auth = False
     proxy_user = None
     proxy_pass = None
@@ -271,19 +287,27 @@ def get_driver(browser_name, headless=False, use_grid=False,
         proxy_string = validate_proxy_string(proxy_string)
         if proxy_string and proxy_user and proxy_pass:
             proxy_auth = True
+    if browser_name == "chrome" and user_data_dir and len(user_data_dir) < 3:
+        raise Exception(
+            "Name length of Chrome's User Data Directory must be >= 3.")
     if use_grid:
         return get_remote_driver(
-            browser_name, headless, servername, port, proxy_string, proxy_auth,
-            proxy_user, proxy_pass, user_agent, cap_file, disable_csp)
+            browser_name, headless, servername, port,
+            proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
+            cap_file, disable_csp, enable_sync, user_data_dir,
+            extension_zip, extension_dir)
     else:
         return get_local_driver(
-            browser_name, headless, proxy_string, proxy_auth,
-            proxy_user, proxy_pass, user_agent, disable_csp)
+            browser_name, headless,
+            proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
+            disable_csp, enable_sync, user_data_dir,
+            extension_zip, extension_dir)
 
 
 def get_remote_driver(
         browser_name, headless, servername, port, proxy_string, proxy_auth,
-        proxy_user, proxy_pass, user_agent, cap_file, disable_csp):
+        proxy_user, proxy_pass, user_agent, cap_file, disable_csp,
+        enable_sync, user_data_dir, extension_zip, extension_dir):
     downloads_path = download_helper.get_downloads_folder()
     download_helper.reset_downloads_folder()
     address = "http://%s:%s/wd/hub" % (servername, port)
@@ -293,7 +317,8 @@ def get_remote_driver(
     if browser_name == constants.Browser.GOOGLE_CHROME:
         chrome_options = _set_chrome_options(
             downloads_path, headless, proxy_string, proxy_auth,
-            proxy_user, proxy_pass, user_agent, disable_csp)
+            proxy_user, proxy_pass, user_agent, disable_csp, enable_sync,
+            user_data_dir, extension_zip, extension_dir)
         capabilities = chrome_options.to_capabilities()
         for key in desired_caps.keys():
             capabilities[key] = desired_caps[key]
@@ -400,8 +425,10 @@ def get_remote_driver(
 
 
 def get_local_driver(
-        browser_name, headless, proxy_string, proxy_auth,
-        proxy_user, proxy_pass, user_agent, disable_csp):
+        browser_name, headless,
+        proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
+        disable_csp, enable_sync, user_data_dir,
+        extension_zip, extension_dir):
     '''
     Spins up a new web browser and returns the driver.
     Can also be used to spin up additional browsers for the same test.
@@ -493,8 +520,10 @@ def get_local_driver(
     elif browser_name == constants.Browser.GOOGLE_CHROME:
         try:
             chrome_options = _set_chrome_options(
-                downloads_path, headless, proxy_string, proxy_auth,
-                proxy_user, proxy_pass, user_agent, disable_csp)
+                downloads_path, headless,
+                proxy_string, proxy_auth, proxy_user, proxy_pass, user_agent,
+                disable_csp, enable_sync, user_data_dir,
+                extension_zip, extension_dir)
             if LOCAL_CHROMEDRIVER and os.path.exists(LOCAL_CHROMEDRIVER):
                 make_driver_executable_if_not(LOCAL_CHROMEDRIVER)
                 return webdriver.Chrome(
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -1443,7 +1443,14 @@ def highlight(self, selector, by=By.CSS_SELECTOR,
         element = self.wait_for_element_visible(
             selector, by=by, timeout=settings.SMALL_TIMEOUT)
         if scroll:
-            self.__slow_scroll_to_element(element)
+            try:
+                self.__slow_scroll_to_element(element)
+            except (StaleElementReferenceException, ENI_Exception):
+                self.wait_for_ready_state_complete()
+                time.sleep(0.05)
+                element = self.wait_for_element_visible(
+                    selector, by=by, timeout=settings.SMALL_TIMEOUT)
+                self.__slow_scroll_to_element(element)
         try:
             selector = self.convert_to_css_selector(selector, by=by)
         except Exception:
@@ -1509,9 +1516,17 @@ def slow_scroll_to(self, selector, by=By.CSS_SELECTOR,
         ''' Slow motion scroll to destination '''
         if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
             timeout = self.__get_new_timeout(timeout)
+        selector, by = self.__recalculate_selector(selector, by)
         element = self.wait_for_element_visible(
             selector, by=by, timeout=timeout)
-        self.__slow_scroll_to_element(element)
+        try:
+            self.__slow_scroll_to_element(element)
+        except (StaleElementReferenceException, ENI_Exception):
+            self.wait_for_ready_state_complete()
+            time.sleep(0.05)
+            element = self.wait_for_element_visible(
+                selector, by=by, timeout=timeout)
+            self.__slow_scroll_to_element(element)
 
     def click_xpath(self, xpath):
         # Technically self.click() will automatically detect an xpath selector,
@@ -2707,7 +2722,9 @@ def save_screenshot(self, name, folder=None):
 
     def get_new_driver(self, browser=None, headless=None,
                        servername=None, port=None, proxy=None, agent=None,
-                       switch_to=True, cap_file=None, disable_csp=None):
+                       switch_to=True, cap_file=None, disable_csp=None,
+                       enable_sync=None, user_data_dir=None,
+                       extension_zip=None, extension_dir=None):
         """ This method spins up an extra browser for tests that require
             more than one. The first browser is already provided by tests
             that import base_case.BaseCase from seleniumbase. If parameters
@@ -2719,6 +2736,12 @@ def get_new_driver(self, browser=None, headless=None,
             port - if using a Selenium Grid, set the host port here
             proxy - if using a proxy server, specify the "host:port" combo here
             switch_to - the option to switch to the new driver (default = True)
+            cap_file - the file containing desired capabilities for the browser
+            disable_csp - an option to disable Chrome's Content Security Policy
+            enable_sync - the option to enable the "Chrome Sync" feature
+            user_data_dir - Chrome's User Data Directory to use (Chrome-only)
+            extension_zip - A Chrome Extension ZIP file to use (Chrome-only)
+            extension_dir - A Chrome Extension folder to use (Chrome-only)
         """
         if self.browser == "remote" and self.servername == "localhost":
             raise Exception('Cannot use "remote" browser driver on localhost!'
@@ -2762,6 +2785,14 @@ def get_new_driver(self, browser=None, headless=None,
             user_agent = self.user_agent
         if disable_csp is None:
             disable_csp = self.disable_csp
+        if enable_sync is None:
+            enable_sync = self.enable_sync
+        if user_data_dir is None:
+            user_data_dir = self.user_data_dir
+        if extension_zip is None:
+            extension_zip = self.extension_zip
+        if extension_dir is None:
+            extension_dir = self.extension_dir
         if self.demo_mode or self.masterqa_mode:
             disable_csp = True
         if cap_file is None:
@@ -2780,7 +2811,11 @@ def get_new_driver(self, browser=None, headless=None,
                                                  proxy_string=proxy_string,
                                                  user_agent=user_agent,
                                                  cap_file=cap_file,
-                                                 disable_csp=disable_csp)
+                                                 disable_csp=disable_csp,
+                                                 enable_sync=enable_sync,
+                                                 user_data_dir=user_data_dir,
+                                                 extension_zip=extension_zip,
+                                                 extension_dir=extension_dir)
         self._drivers_list.append(new_driver)
         if switch_to:
             self.driver = new_driver
@@ -3071,7 +3106,14 @@ def __highlight_with_assert_success(
         except Exception:
             # Don't highlight if can't convert to CSS_SELECTOR
             return
-        self.__slow_scroll_to_element(element)
+        try:
+            self.__slow_scroll_to_element(element)
+        except (StaleElementReferenceException, ENI_Exception):
+            self.wait_for_ready_state_complete()
+            time.sleep(0.05)
+            element = self.wait_for_element_visible(
+                selector, by=by, timeout=settings.SMALL_TIMEOUT)
+            self.__slow_scroll_to_element(element)
 
         o_bs = ''  # original_box_shadow
         style = element.get_attribute('style')
@@ -3191,6 +3233,10 @@ def setUp(self, masterqa_mode=False):
             self.ad_block_on = sb_config.ad_block_on
             self.verify_delay = sb_config.verify_delay
             self.disable_csp = sb_config.disable_csp
+            self.enable_sync = sb_config.enable_sync
+            self.user_data_dir = sb_config.user_data_dir
+            self.extension_zip = sb_config.extension_zip
+            self.extension_dir = sb_config.extension_dir
             self.save_screenshot_after_test = sb_config.save_screenshot
             self.visual_baseline = sb_config.visual_baseline
             self.timeout_multiplier = sb_config.timeout_multiplier
@@ -3264,7 +3310,11 @@ def setUp(self, masterqa_mode=False):
                                           agent=self.user_agent,
                                           switch_to=True,
                                           cap_file=self.cap_file,
-                                          disable_csp=self.disable_csp)
+                                          disable_csp=self.disable_csp,
+                                          enable_sync=self.enable_sync,
+                                          user_data_dir=self.user_data_dir,
+                                          extension_zip=self.extension_zip,
+                                          extension_dir=self.extension_dir)
         self._default_driver = self.driver
 
     def __set_last_page_screenshot(self):
diff --git a/seleniumbase/fixtures/constants.py b/seleniumbase/fixtures/constants.py
@@ -91,7 +91,7 @@ class IntroJS:
 
 
 class JqueryConfirm:
-    VER = "3.3.2"
+    VER = "3.3.4"
     MIN_CSS = ("//cdnjs.cloudflare.com/ajax/libs/"
                "jquery-confirm/%s/jquery-confirm.min.css" % VER)
     MIN_JS = ("//cdnjs.cloudflare.com/ajax/libs/"
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/seleniumbase/resources/jquery_confirm/jquery-confirm.min.css b/seleniumbase/resources/jquery_confirm/jquery-confirm.min.css
diff --git a/seleniumbase/resources/jquery_confirm/jquery-confirm.min.js b/seleniumbase/resources/jquery_confirm/jquery-confirm.min.js
diff --git a/seleniumbase/utilities/selenium_ide/objectify.py b/seleniumbase/utilities/selenium_ide/objectify.py
diff --git a/setup.py b/setup.py
