Awesome

Appium Safari Driver

This is Appium driver for automating Safari on macOS and iOS since version 13. The driver only supports Safari automation using W3C WebDriver protocol. Under the hood this driver is a wrapper/proxy over Apple's safaridriver binary. Check the output of man safaridriver command to get more details on the supported features and possible pitfalls.

Note

Since version 3.0.0 Safari driver has dropped the support of Appium 1, and is only compatible to Appium 2. Use the appium driver install safari command to add it to your Appium 2 dist.

Usage

It is mandatory to run the safaridriver --enable command from the macOS terminal and provide your administrator password before any automated session will be executed. In order to automate Safari on real devices it is also necessary to enable Remote Automation switch in Settings → Safari → Advanced → Remote Automation for these particular devices.

Then you need to decide where the automated test is going to be executed. Safari driver supports the following target platforms:

• macOS (High Sierra or newer)
• iOS Simulator (iOS version 13 or newer)
• iOS Real Device (iOS version 13 or newer)

Safari driver allows to define multiple criterions for platform selection and also to fine-tune your automation session properties. This could be done via the following session capabilities:

Example

# Python3 + PyTest
import pytest
import time

from appium import webdriver
# Options are available in Python client since v2.6.0
from appium.options.ios import SafariOptions
from selenium.webdriver.common.by import By


def generate_options():
    common_caps = {
        # It does not really matter what to put there, although setting 'Safari' might cause a failure
        # depending on the particular client library
        'browserName': 'AppiumSafari',
    }
    real_device_opts = SafariOptions().load_capabilities(common_caps)
    # This is optional
    real_device_opts.device_type = 'iPhone'
    # Do not forget to verify that Remote Automation is enabled for this device
    real_device_opts.device_udid = '<MyDeviceUDID>'
    real_device_opts.use_simulator = False

    simulator_opts = SafariOptions().load_capabilities(common_caps)
    simulator_opts.platform_version = '14.1'
    simulator_opts.device_name = 'iPad Air 2'
    simulator_opts.use_simulator = True

    desktop_browser_opts = SafariOptions().load_capabilities({
        **common_caps,
        'platformName': 'Mac',
    })
    return [real_device_opts, simulator_opts, desktop_browser_opts]


@pytest.fixture(params=generate_options())
def driver(request):
    # The default URL is http://127.0.0.1:4723/wd/hub in Appium1
    drv = webdriver.Remote('http://127.0.0.1:4723', options=request.param)
    yield drv
    drv.quit()


class TimeoutError(Exception):
    pass


def wait_until_truthy(func, timeout_sec=5.0, interval_sec=0.5):
    started = time.time()
    original_error = None
    while time.time() - started < timeout_sec:
        original_error = None
        try:
            result = func()
            if result:
                return result
        except Exception as e:
            original_error = e
        time.sleep(interval_sec)
    if original_error is None:
        raise TimeoutError(f'Condition unmet after {timeout_sec}s timeout')
    raise original_error


def test_feature_status_page_search(driver):
    driver.get('https://webkit.org/status/')

    # Enter "CSS" into the search box.
    # Ensures that at least one result appears in search
    # !!! Remember there are no ID and NAME locators in W3C standard
    # These two have been superseded by CSS ones
    search_box = driver.find_element_by_css('#search')
    search_box.send_keys('CSS')
    value = search_box.get_attribute('value')
    assert len(value) > 0
    search_box.submit()
    # Count the visible results when filters are applied
    # so one result shows up in at most one filter
    assert wait_until_truthy(lambda: len(driver.execute_script("return document.querySelectorAll('li.feature:not(.is-hidden)')")) > 0)


def test_feature_status_page_filters(driver):
    driver.get('https://webkit.org/status/')

    assert wait_until_truthy(lambda: len(driver.execute_script("return document.querySelectorAll('.filter-toggle')")) == 7)

    # Make sure every filter is turned off.
    for checked_filter in filter(lambda f: f.is_selected(), filters):
        checked_filter.click()

    # Make sure you can select every filter.
    for filt in filters:
        filt.click()
        assert filt.is_selected()
        filt.click()

Development

# clone repo, then in repo dir:
npm install
npm run lint
npm run test