Merge pull request #189 from seleniumbase/fix-ie-browser-usage

Fix compatibility with IE Browser

Author: mdmintz

README.md

@@ -1,14 +1,12 @@
-[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo3g.png" title="SeleniumBase" height="50">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo3g4.png" title="SeleniumBase" height="45">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 
 [<img src="https://img.shields.io/pypi/v/seleniumbase.svg" alt="Version" />](https://pypi.python.org/pypi/seleniumbase) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="GitHub Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the Gitter Chat" />](https://gitter.im/seleniumbase/SeleniumBase)<br />
 
-A reliable solution for fast & simple browser automation and testing with [WebDriver](https://docs.microsoft.com/en-us/microsoft-edge/webdriver) & [Pytest](https://github.com/pytest-dev/pytest).
+SeleniumBase extends [WebDriver](https://docs.microsoft.com/en-us/microsoft-edge/webdriver) into a complete framework for end-to-end testing with [Pytest](https://github.com/pytest-dev/pytest).
 
-**Why SeleniumBase?** WebDriver automates browsers, but it's not a stand-alone test framework. SeleniumBase saves you time by providing you with a complete framework for end-to-end testing.
+## Quick Start
 
-**Why Python?** Python is the [fastest growing programming language according to Stack Overflow](https://stackoverflow.blog/2017/09/06/incredible-growth-python/). Python's structure makes it optimal for scripting and quickly building things.
-
-**Quick Start in a few steps:** (Requires [Python](https://www.python.org/downloads/), [Git](https://git-scm.com/), and an optional [Python virtual env](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).)
+(Requires [Python](https://www.python.org/downloads/), [Git](https://git-scm.com/), and an optional [Python virtual environment](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md).)
 
 ```
 python -m pip install --upgrade pip
@@ -56,16 +54,16 @@ For more detailed steps on getting started, see the [**Detailed Instructions**](
 
 ### Learn More:
 
-**No more repetitive WebDriver code:**<br />
+#### **No more repetitive WebDriver code:**<br />
 SeleniumBase automatically handles common WebDriver actions such as spinning up web browsers, waiting for page objects to load, saving screenshots during test failures, using a proxy server, and more. (<i>[Read about customizing test runs](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).</i>)
 
-**Simple Python syntax makes coding easy:**<br />
+#### **Simple Python syntax makes coding easy:**<br />
 
 <img src="https://cdn2.hubspot.net/hubfs/100006/images/my_first_test_image.png" title="SeleniumBase Python Code" height="280">
 
 (<i>By default, [CSS Selectors](https://www.w3schools.com/cssref/css_selectors.asp) are used for finding page elements.</i>)
 
-**Run tests with Pytest or Nose in any browser:**<br />
+#### **Run tests with Pytest or Nose in any browser:**<br />
 (<i>Using **Pytest** is strongly recommended</i>)
 
 ```
@@ -76,7 +74,7 @@ nosetests my_test_suite.py --browser=firefox
 
 Python methods that start with ``test_`` will automatically be run when using ``pytest`` or ``nosetests`` on a Python file, (<i>or on folders containing Python files</i>).
 
-**No more messy code:**<br />
+#### **No more messy code:**<br />
 This long line of standard WebDriver code,
 ```python
 self.driver.find_element_by_css_selector("textarea").send_keys("text")
@@ -87,26 +85,26 @@ self.update_text("textarea", "text")
 ```
 (<i>You can still use ``self.driver`` in your code.</i>)
 
-**No more flaky tests:**<br />
+#### **No more flaky tests:**<br />
 SeleniumBase methods automatically wait for page elements to finish loading before interacting with them (*up to a timeout limit*). This means you no longer need random ``time.sleep()`` statements in your code.
 
-**Assist manual QA with automation:**<br />
+#### **Assist manual QA with automation:**<br />
 SeleniumBase includes an automated/manual hybrid solution called **[MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/masterqa/ReadMe.md)**, which speeds up manual testing by having automation perform all the web browser actions while the manual tester only validates what is seen.
 
-**Integrate with your favorite tools:**<br />
+#### **Integrate with your favorite tools:**<br />
 SeleniumBase is compatible with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_grid), [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py), [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md), [NodeJS](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js), [Google Cloud](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/google_cloud/ReadMe.md), and [AWS](#amazon_section).
 
-**Comes with a business mindset:**<br />
-SeleniumBase makes it easy to automate tedious business tasks. (*To learn about businesses using SeleniumBase, [Click Here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/happy_customers.md).*)
+#### **Automate tedious business tasks:**<br />
+Beyond test automation, SeleniumBase is perfect for automating tedious business tasks that you would perform in a web browser.
 
-**Extensively tested and made with love:**<br />
-SeleniumBase was originally built for [testing HubSpot's platform](https://product.hubspot.com/blog/bid/88880/Automated-Integration-Testing-with-Selenium-at-HubSpot) and automating business processes. In 2014, SeleniumBase was open-sourced and spun off as its own independent entity to benefit users everywhere.
+#### **Lots of Happy Customers:**<br />
+(*To learn about businesses using SeleniumBase, [Click Here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/happy_customers.md).*)
 
-**Feature-Rich:**<br />
+#### **Feature-Rich:**<br />
 ([Read more about SeleniumBase features here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md))
 
 <a id="seleniumbase_installation"></a>
-<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo3g.png" title="SeleniumBase" height="48">
+<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo3g4.png" title="SeleniumBase" height="45">
 
 ## Detailed Instructions:
 
@@ -256,6 +254,8 @@ Now you can install webdrivers by doing this:
 seleniumbase install chromedriver
 seleniumbase install geckodriver
 seleniumbase install edgedriver
+seleniumbase install iedriver
+seleniumbase install operadriver
 ```
 
 Remember, you'll need chromedriver if you want to run automation on Chrome, geckodriver if you want to run automation on Firefox, edgedriver for Microsoft Edge, etc.
@@ -696,4 +696,4 @@ Congratulations on getting started with SeleniumBase!
 
 [https://github.com/mdmintz](https://github.com/mdmintz)<br />
 
-[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo3g.png" title="SeleniumBase" height="60">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> <img src="https://cdn2.hubspot.net/hubfs/100006/images/logo_base_4b.png" title="SeleniumBase" height="150">
+[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SB_Logo3g4.png" title="SeleniumBase" height="45">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) <br /> <img src="https://cdn2.hubspot.net/hubfs/100006/images/logo_base_4b.png" title="SeleniumBase" height="150">

help_docs/virtualenv_instructions.md

@@ -11,7 +11,7 @@ export WORKON_HOME=$HOME/.virtualenvs
 source /usr/local/bin/virtualenvwrapper.sh
 ```
 
-If you add ``source /usr/local/bin/virtualenvwrapper.sh`` to your local bash file (``~/.bash_profile`` on a Mac, or ``~/.bashrc`` on Linux), virtualenvwrapper commands will be available whenever you open a new command prompt. Use the ``source`` command on those files to activate any changes you make.
+If you add ``source /usr/local/bin/virtualenvwrapper.sh`` to your local bash file (``~/.bash_profile`` on a Mac, or ``~/.bashrc`` on Linux), virtualenvwrapper commands will be available whenever you open a new command prompt.
 
 ### WINDOWS:
 

seleniumbase/core/browser_launcher.py

@@ -13,16 +13,20 @@
 from seleniumbase import drivers  # webdriver storage folder for SeleniumBase
 DRIVER_DIR = os.path.dirname(os.path.realpath(drivers.__file__))
 PLATFORM = sys.platform
+IS_WINDOWS = False
 LOCAL_CHROMEDRIVER = None
 LOCAL_GECKODRIVER = None
 LOCAL_EDGEDRIVER = None
+LOCAL_IEDRIVER = None
 LOCAL_OPERADRIVER = None
 if "darwin" in PLATFORM or "linux" in PLATFORM:
     LOCAL_CHROMEDRIVER = DRIVER_DIR + '/chromedriver'
     LOCAL_GECKODRIVER = DRIVER_DIR + '/geckodriver'
     LOCAL_OPERADRIVER = DRIVER_DIR + '/operadriver'
 elif "win32" in PLATFORM or "win64" in PLATFORM or "x64" in PLATFORM:
+    IS_WINDOWS = True
     LOCAL_EDGEDRIVER = DRIVER_DIR + '/MicrosoftWebDriver.exe'
+    LOCAL_IEDRIVER = DRIVER_DIR + '/IEDriverServer.exe'
     LOCAL_CHROMEDRIVER = DRIVER_DIR + '/chromedriver.exe'
     LOCAL_GECKODRIVER = DRIVER_DIR + '/geckodriver.exe'
     LOCAL_OPERADRIVER = DRIVER_DIR + '/operadriver.exe'
@@ -279,8 +283,27 @@ def get_local_driver(browser_name, headless, proxy_string):
                 raise Exception(e)
             return webdriver.Firefox()
     elif browser_name == constants.Browser.INTERNET_EXPLORER:
-        return webdriver.Ie()
+        if not IS_WINDOWS:
+            raise Exception(
+                "IE Browser is for Windows-based operating systems only!")
+        ie_caps = DesiredCapabilities.INTERNETEXPLORER.copy()
+        ie_caps['ignoreProtectedModeSettings'] = True
+        ie_caps['IntroduceInstabilityByIgnoringProtectedModeSettings'] = True
+        ie_caps['nativeEvents'] = True
+        ie_caps['ignoreZoomSetting'] = True
+        ie_caps['requireWindowFocus'] = True
+        ie_caps['INTRODUCE_FLAKINESS_BY_IGNORING_SECURITY_DOMAINS'] = True
+        if LOCAL_IEDRIVER and os.path.exists(LOCAL_IEDRIVER):
+            make_driver_executable_if_not(LOCAL_IEDRIVER)
+            return webdriver.Ie(
+                capabilities=ie_caps,
+                executable_path=LOCAL_IEDRIVER)
+        else:
+            return webdriver.Ie(capabilities=ie_caps)
     elif browser_name == constants.Browser.EDGE:
+        if not IS_WINDOWS:
+            raise Exception(
+                "Edge Browser is for Windows-based operating systems only!")
         edge_capabilities = DesiredCapabilities.EDGE.copy()
         if LOCAL_EDGEDRIVER and os.path.exists(LOCAL_EDGEDRIVER):
             make_driver_executable_if_not(LOCAL_EDGEDRIVER)

seleniumbase/fixtures/base_case.py

@@ -48,6 +48,7 @@ def test_anything(self):
 from seleniumbase.fixtures import page_utils
 from seleniumbase.fixtures import xpath_to_css
 from selenium.common.exceptions import (StaleElementReferenceException,
+                                        MoveTargetOutOfBoundsException,
                                         WebDriverException)
 from selenium.common import exceptions as selenium_exceptions
 try:
@@ -115,24 +116,30 @@ def click(self, selector, by=By.CSS_SELECTOR,
             self.__scroll_to_element(element)
         pre_action_url = self.driver.current_url
         try:
-            element.click()
+            if self.browser == 'ie' and by == By.LINK_TEXT:
+                # An issue with clicking Link Text on IE means using jquery
+                self.__jquery_click(selector, by=by)
+            else:
+                # Normal click
+                element.click()
         except (StaleElementReferenceException, ENI_Exception):
             self.wait_for_ready_state_complete()
             time.sleep(0.05)
             element = page_actions.wait_for_element_visible(
                 self.driver, selector, by, timeout=timeout)
             element.click()
-        except WebDriverException:
+        except (WebDriverException, MoveTargetOutOfBoundsException):
             self.wait_for_ready_state_complete()
-            if not by == By.LINK_TEXT:
-                # Only use a JavaScript click if not clicking by Link Text
+            try:
                 self.__js_click(selector, by=by)
-            else:
-                # One more attempt to click on the element
-                element = page_actions.wait_for_element_visible(
-                    self.driver, selector, by, timeout=timeout)
-                element.click()
-
+            except Exception:
+                try:
+                    self.__jquery_click(selector, by=by)
+                except Exception:
+                    # One more attempt to click on the element
+                    element = page_actions.wait_for_element_visible(
+                        self.driver, selector, by, timeout=timeout)
+                    element.click()
         if settings.WAIT_FOR_RSC_ON_CLICKS:
             self.wait_for_ready_state_complete()
         if self.demo_mode:
@@ -2431,6 +2438,18 @@ def __js_click(self, selector, by=By.CSS_SELECTOR):
                   % css_selector)
         self.execute_script(script)
 
+    def __jquery_click(self, selector, by=By.CSS_SELECTOR):
+        """ Clicks an element using jQuery. Different from using pure JS. """
+        selector, by = self.__recalculate_selector(selector, by)
+        self.wait_for_element_present(
+            selector, by=by, timeout=settings.SMALL_TIMEOUT)
+        if self.is_element_visible(selector, by=by):
+            self.__demo_mode_highlight_if_active(selector, by)
+        selector = self.convert_to_css_selector(selector, by=by)
+        selector = self.__make_css_match_first_element_only(selector)
+        click_script = """jQuery('%s')[0].click()""" % selector
+        self.safe_execute_script(click_script)
+
     def __get_href_from_link_text(self, link_text, hard_fail=True):
         href = self.get_link_attribute(link_text, "href", hard_fail)
         if not href:
@@ -2587,6 +2606,7 @@ def __post_messenger_success_message(self, message, duration=None):
             else:
                 duration = self.message_duration
         try:
+            self.set_messenger_theme(theme="future", location="bottom_right")
             self.post_message(message, style="success", duration=duration)
             time.sleep(duration)
         except Exception:

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.14.0',
+    version='1.14.1',
     description='Web Automation & Testing Framework - http://seleniumbase.com',
     long_description='Web Automation and Testing Framework - seleniumbase.com',
     platforms='Mac * Windows * Linux * Docker',