Merge pull request #410 from seleniumbase/safari-improvements

Improve Test Automation on Safari

Author: mdmintz

README.md

@@ -2,12 +2,14 @@
 
 [<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://dev.azure.com/seleniumbase/seleniumbase/_apis/build/status/seleniumbase.SeleniumBase?branchName=master" alt=" " />](https://dev.azure.com/seleniumbase/seleniumbase/_build/latest?definitionId=1&branchName=master) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt=" " />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt=" " />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt=" " />](https://github.com/seleniumbase/SeleniumBase/stargazers)
 
-A complete framework for web automation, end-to-end testing, and [user-onboarding](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). SeleniumBase uses [pytest](https://github.com/pytest-dev/pytest) for running Python scripts, while using [Selenium WebDriver](https://www.seleniumhq.org/) for controlling web browsers.
+All-in-one framework for web automation, end-to-end testing, and website tours. SeleniumBase uses pytest for running Python scripts, while using Selenium WebDriver for controlling web browsers.
 
-* No more flaky tests! (Smart-waiting keeps tests reliable.)
+* Contains reliable, smart-waiting code to prevent flaky tests.
+* Simplifies the process of creating UI tests for any website.
 * Includes [Plugins](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py) for logging [test results and screenshots](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
+* Multiplies the abilities of [pytest](https://pytest.org) and [Selenium WebDriver](https://www.seleniumhq.org/).
 * Uses versatile [Python methods](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) and [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
-* Has tools for [website tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md), [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), and [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md).
+* Includes tools for [assisted-QA](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md), [visual testing](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md), and [web tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md).
 * Integrates with [Selenium Grid](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md), [Katalon Recorder](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md), and [MySQL](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/testcase_manager.py).
 * Supports [Azure Pipelines](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/azure_pipelines/ReadMe.md), [GCP](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/google_cloud/ReadMe.md), [TravisCI](https://github.com/seleniumbase/SeleniumBase/blob/master/.travis.yml), [Docker](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/docker/ReadMe.md), and more.
 * To see the full list of SeleniumBase features, [click here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md).

help_docs/hidden_files_info.md

@@ -1,11 +1,11 @@
-### Info about hidden files on macOS
+## Info about hidden files on macOS
 
 Depending on your macOS settings, some files may be hidden from view in your Finder window, such as ``.gitignore``. To view all files, run the following command and then reopen the Finder window:
 ```bash
 defaults write com.apple.finder AppleShowAllFiles -bool true
 ```
 
 More info on that can be found here:
-https://www.defaults-write.com/show-hidden-files-in-os-x-finder/
-https://www.macworld.co.uk/how-to/mac-software/hidden-files-mac-3520878/
-https://setapp.com/how-to/show-hidden-files-on-mac
+* https://www.defaults-write.com/show-hidden-files-in-os-x-finder/
+* https://www.macworld.co.uk/how-to/mac-software/hidden-files-mac-3520878/
+* https://setapp.com/how-to/show-hidden-files-on-mac

help_docs/method_summary.md

@@ -24,6 +24,8 @@ self.click_chain(selectors_list, by=By.CSS_SELECTOR, timeout=None, spacing=0)
 
 self.type(selector, text, by=By.CSS_SELECTOR, timeout=None, retry=False)
 
+self.input(selector, text, by=By.CSS_SELECTOR, timeout=None, retry=False)
+
 self.update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=None, retry=False)
 
 self.add_text(selector, text, by=By.CSS_SELECTOR, timeout=None)

help_docs/using_safari_driver.md

@@ -1,18 +1,9 @@
-### Info about using Safari Driver for running automated tests on macOS
+## Using Safari's WebDriver for running browser tests on macOS
 
-(NOTE: SafariDriver requires Safari 10 running on OS X 10.11 El Capitan or greater)
+*(NOTE: Safari's WebDriver requires macOS 10.13 "High Sierra" or later.)*
 
-You can find info on Safari Driver if you scroll down to that section on the [SeleniumHQ downloads page](https://www.seleniumhq.org/download/).
+You can find the official Apple documentation regarding "Testing with WebDriver in Safari" on the following page: https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari
 
-That page will tell you to [download the required Safari Driver browser extension (SafariDriver.safariextz) here at this link](http://selenium-release.storage.googleapis.com/index.html?path=2.48/).
+Run ``safaridriver --enable`` once in a terminal to enable Safari's WebDriver. (If you’re upgrading from a previous macOS release, you may need to prefix the command with ``sudo``.)
 
-For that to work, you'll need to [download the Standalone Selenium Server from here](http://docs.seleniumhq.org/download/) and put that JAR file in ``/usr/local/bin/``. To make the next step easier, rename the downloaded JAR file to ``selenium-server-standalone.jar`` (if it's not already called that).
-
-Next, configure the Selenium Server JAR file into your PATH like this:
-
-```bash
-export SELENIUM_SERVER_JAR=/usr/local/bin/selenium-server-standalone.jar
-export PATH=$PATH:/usr/local/bin/selenium-server-standalone.jar
-```
-
-Now you're ready to run automated tests on Safari if you use ``--browser=safari`` on the command line when running your tests/scripts with SeleniumBase.
+Now you can use ``--browser=safari`` to run your **SeleniumBase** tests on Safari.

help_docs/verify_webdriver.md

@@ -1,23 +1,39 @@
-### Verify that web drivers were successfully installed
+## Verifying that web drivers are installed
 
-*You can do this by checking inside a Python command prompt. (NOTE: xkcd is a webcomic)*
+*You can do this by checking inside a Python command prompt.*
 
 #### Verifying ChromeDriver
 ```bash
 python
+```
+```python
 >>> from selenium import webdriver
->>> browser = webdriver.Chrome()
->>> browser.get("http://xkcd.com/1337/")
->>> browser.close()
+>>> driver = webdriver.Chrome()
+>>> driver.get("https://www.google.com/chrome")
+>>> driver.quit()
 >>> exit()
 ```
 
-#### Verifying FirefoxDriver (Geckodriver)
+#### Verifying Geckodriver (Firefox WebDriver)
 ```bash
 python
+```
+```python
+>>> from selenium import webdriver
+>>> driver = webdriver.Firefox()
+>>> driver.get("https://www.mozilla.org/firefox")
+>>> driver.quit()
+>>> exit()
+```
+
+#### Verifying WebDriver for Safari
+```bash
+python
+```
+```python
 >>> from selenium import webdriver
->>> browser = webdriver.Firefox()
->>> browser.get("http://xkcd.com/1337/")
->>> browser.close()
+>>> driver = webdriver.Safari()
+>>> driver.get("https://www.apple.com/safari")
+>>> driver.quit()
 >>> exit()
 ```

integrations/selenium_ide/ReadMe.md

@@ -1 +1,19 @@
-### The ReadMe for the Katalon / Selenium IDE conversion tool has been moved to: [seleniumbase/utilities/selenium_ide/ReadMe.md](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md) and all related code has been moved to [seleniumbase/utilities/selenium_ide](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide)
+## Converting Katalon recordings into SeleniumBase test scripts
+
+Katalon Recorder (Selenium IDE) is a tool that allows you to record and playback actions performed inside a web browser. It's available as a [downloadable Chrome extension](https://chrome.google.com/webstore/detail/katalon-recorder-selenium/ljdobmomdgdljniojadhoplhkpialdid) and a [downloadable Firefox extension](https://addons.mozilla.org/en-US/firefox/addon/katalon-automation-record/). The Katalon Recorder comes with an option to export recordings as various WebDriver test scripts, one of which is ``Python 2 (WebDriver + unittest)``. Unfortunately, these natively-exported scripts can be very messy and don't always run reliably. The purpose of this converter is to clean up and improve the scripts so that they can be used in production-level environments.
+
+#### Step 1: Make a recording with the Katalon Recorder
+
+![](https://cdn2.hubspot.net/hubfs/100006/images/katalon_recorder_2.png "Katalon Recorder example")
+
+#### Step 2: Export your recording as a Python 2 Webdriver script
+
+* ``{} Export`` => ``Python 2 (WebDriver + unittest)`` => ``Save As File``
+
+#### Step 3: Run ``seleniumbase convert`` on your exported Python file
+
+```
+seleniumbase convert [MY_TEST.py]
+```
+
+* You should see a [MY_TEST_SB.py] file appear in the folder. (``_SB`` is added to the file name so that the original file stays intact in case you still need it.) This new clean & reliable SeleniumBase test script is ready to be added into your test suite for running.

requirements.txt

@@ -33,7 +33,7 @@ colorama>=0.4.1
 pymysql>=0.9.3
 pyotp>=2.3.0
 boto>=2.49.0
-cffi>=1.13.1
+cffi>=1.13.2
 tqdm>=4.37.0
 flake8>=3.7.9
 certifi>=2019.9.11

seleniumbase/core/browser_launcher.py

@@ -545,6 +545,8 @@ def get_local_driver(
         else:
             return webdriver.Edge()
     elif browser_name == constants.Browser.SAFARI:
+        if "".join(sys.argv) == "-c":  # Skip if multithreaded
+            raise Exception("Can't run Safari tests in multi-threaded mode!")
         return webdriver.Safari()
     elif browser_name == constants.Browser.OPERA:
         if LOCAL_OPERADRIVER and os.path.exists(LOCAL_OPERADRIVER):

seleniumbase/fixtures/base_case.py

@@ -141,7 +141,13 @@ def click(self, selector, by=By.CSS_SELECTOR, timeout=None, delay=0):
             time.sleep(0.05)
             element = page_actions.wait_for_element_visible(
                 self.driver, selector, by, timeout=timeout)
-            element.click()
+            if self.browser == "safari":
+                if by == By.LINK_TEXT:
+                    self.__jquery_click(selector, by=by)
+                else:
+                    self.__js_click(selector, by=by)
+            else:
+                element.click()
         except (WebDriverException, MoveTargetOutOfBoundsException):
             self.wait_for_ready_state_complete()
             try:
@@ -242,12 +248,26 @@ def type(self, selector, text, by=By.CSS_SELECTOR,
             by = By.XPATH
         self.update_text(selector, text, by=by, timeout=timeout, retry=retry)
 
+    def input(self, selector, text, by=By.CSS_SELECTOR,
+              timeout=None, retry=False):
+        """ Same as update_text(). """
+        if not timeout:
+            timeout = settings.LARGE_TIMEOUT
+        if self.timeout_multiplier and timeout == settings.LARGE_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        if page_utils.is_xpath_selector(selector):
+            by = By.XPATH
+        self.update_text(selector, text, by=by, timeout=timeout, retry=retry)
+
     def update_text(self, selector, new_value, by=By.CSS_SELECTOR,
                     timeout=None, retry=False):
         """ This method updates an element's text field with new text.
-            Has two parts:
-            1. Clears the text field.
-            2. Types in new text into the text field.
+            Has multiple parts:
+            * Waits for the element to be visible.
+            * Waits for the element to be interactive.
+            * Clears the text field.
+            * Types in the new text.
+            * Hits Enter/Submit (if the text ends in "\n").
             @Params
             selector - the selector of the text field
             new_value - the new value to type into the text field
@@ -273,7 +293,10 @@ def update_text(self, selector, new_value, by=By.CSS_SELECTOR,
             time.sleep(0.06)
             element = self.wait_for_element_visible(
                 selector, by=by, timeout=timeout)
-            element.clear()
+            try:
+                element.clear()
+            except Exception:
+                pass  # Clearing the text field first isn't critical
         except Exception:
             pass  # Clearing the text field first isn't critical
         self.__demo_mode_pause_if_active(tiny=True)
@@ -411,11 +434,15 @@ def get_title(self):
     def go_back(self):
         self.__last_page_load_url = None
         self.driver.back()
+        if self.browser == "safari":
+            self.driver.refresh()
         self.wait_for_ready_state_complete()
 
     def go_forward(self):
         self.__last_page_load_url = None
         self.driver.forward()
+        if self.browser == "safari":
+            self.driver.refresh()
         self.wait_for_ready_state_complete()
 
     def is_element_present(self, selector, by=By.CSS_SELECTOR):
@@ -1373,15 +1400,26 @@ def get_new_driver(self, browser=None, headless=None,
                     # WebDrivers can get closed during tearDown().
                     pass
             else:
-                if self.browser == 'chrome' or self.browser == 'opera':
+                if self.browser == 'chrome':
+                    width = 1250
+                    height = 840
                     try:
                         if self.maximize_option:
                             self.driver.maximize_window()
                         else:
-                            self.driver.set_window_size(1250, 840)
+                            self.driver.set_window_size(width, height)
                         self.wait_for_ready_state_complete()
                     except Exception:
                         pass  # Keep existing browser resolution
+                elif self.browser == 'firefox':
+                    pass  # No changes
+                elif self.browser == 'safari':
+                    if self.maximize_option:
+                        try:
+                            self.driver.maximize_window()
+                            self.wait_for_ready_state_complete()
+                        except Exception:
+                            pass  # Keep existing browser resolution
                 elif self.browser == 'edge':
                     try:
                         self.driver.maximize_window()
@@ -3582,6 +3620,12 @@ def __recalculate_selector(self, selector, by):
             name = page_utils.get_name_from_selector(selector)
             selector = '[name="%s"]' % name
             by = By.CSS_SELECTOR
+        if by == By.LINK_TEXT or by == By.PARTIAL_LINK_TEXT:
+            if self.browser == "safari" and selector.lower() != selector:
+                selector = ("""//a[contains(translate(.,"ABCDEFGHIJKLMNOPQR"""
+                            """STUVWXYZ","abcdefghijklmnopqrstuvw"""
+                            """xyz"),"%s")]""" % selector.lower())
+                by = By.XPATH
         return (selector, by)
 
     def __make_css_match_first_element_only(self, selector):

seleniumbase/utilities/selenium_ide/ReadMe.md

@@ -1,6 +1,6 @@
-## Converting Katalon/Selenium IDE recordings into SeleniumBase test scripts
+## Converting Katalon recordings into SeleniumBase test scripts
 
-[Katalon Recorder / Selenium IDE](https://www.katalon.com/resources-center/blog/katalon-automation-recorder/) is a tool that allows you to record and playback actions performed inside a web browser. It's available as a [downloadable Chrome extension](https://chrome.google.com/webstore/detail/katalon-recorder-selenium/ljdobmomdgdljniojadhoplhkpialdid) and a [downloadable Firefox extension](https://addons.mozilla.org/en-US/firefox/addon/katalon-automation-record/). The Katalon Recorder comes with an option to export recordings as various WebDriver test scripts, one of which is ``Python 2 (WebDriver + unittest)``. Unfortunately, these natively-exported scripts can be very messy and don't always run reliably. The purpose of this converter is to clean up and improve the scripts so that they can be used in production-level environments.
+Katalon Recorder (Selenium IDE) is a tool that allows you to record and playback actions performed inside a web browser. It's available as a [downloadable Chrome extension](https://chrome.google.com/webstore/detail/katalon-recorder-selenium/ljdobmomdgdljniojadhoplhkpialdid) and a [downloadable Firefox extension](https://addons.mozilla.org/en-US/firefox/addon/katalon-automation-record/). The Katalon Recorder comes with an option to export recordings as various WebDriver test scripts, one of which is ``Python 2 (WebDriver + unittest)``. Unfortunately, these natively-exported scripts can be very messy and don't always run reliably. The purpose of this converter is to clean up and improve the scripts so that they can be used in production-level environments.
 
 #### Step 1: Make a recording with the Katalon Recorder