Testing web apps on mobile browsers in Ruby using Appium

Appium Web Ruby Tutorial

The Applitools Eyes Appium Ruby SDK allows you to easily add visual checkpoints to your Ruby Appium tests. It takes care of getting screenshots of your application from the underlying WebDriver, sending them to the Eyes server for validation and failing the test in case differences are found.

Install the SDK

gem install eyes_selenium

Run your first test

Applitools Eyes reports differences by comparing screenshots of your application with baseline images that define the expected appearance of the application at each step of the test. By default, the Eyes SDK detects the environment in which the application is running (namely, the operating system, the type of browser and its viewport size) and compares the screenshots against baseline images that are specific to that environment. The first time you run a test in a given environment, its screenshots will be automatically saved as its baseline. Starting from the second run onward, you always have a baseline to compare against.

The test below is a simple program that visually validates the Hello World web-page at https://applitools.com/helloworld. It consists of two visual checkpoints, each validating the entire application window. The first time you run this test a new baseline will be created, and subsequent test runs will be compared to this baseline. If any screenshot mismatch its baseline image in a perceptible way, eyes.close() will throw a DiffsFoundException which includes a URL that points to a detailed report where you can see the detected differences and take appropriate actions such as reporting bugs, updating the baseline and more.

Before running the test, make sure to set the API key that identifies your account in the environment variable APPLITOOLS_API_KEY or directly assign it to the eyes.api_key property. You can find your API key under the user menu located at the right hand side of the test manager toolbar. If you don't yet have an account create it now to obtain your key.

IOS Simulator

require 'selenium-webdriver'
require 'eyes_selenium'
require 'rubygems'

eyes = Applitools::Selenium::Eyes.new
# This is your api key, make sure you use it in all your tests.
eyes.api_key = 'YOUR_API_KEY'

# Setup appium - Ensure the capabilities meets your environment.
# Refer to http://appium.io documentation if required.
capabilities = {
  'platformName' => 'iOS',
  'deviceName' => 'iPhone 12',
  'browserName' => 'Safari',
  'automationName' => 'XCUITest'
}

# Open browser.
wd = Selenium::WebDriver.for :remote,
                             :url => 'http://127.0.0.1:4723/wd/hub',
                             :desired_capabilities => capabilities

# Navigate the browser to the "hello world!" web-site.
wd.navigate.to('https://applitools.com/helloworld')

begin

  # Start the test.
  eyes.test(app_name: 'hello world!', test_name: 'My first Appium web Ruby test!', driver: wd) do |driver|

    # Visual checkpoint #1.
    eyes.check_window('Hello!')

    # Click the "Click me!" button.
    driver.find_element(:tag_name => 'button').click

    # Visual checkpoint #2.
    eyes.check_window('Click!')

    # End the test.
    eyes.close
  end
ensure
  wd.quit
  eyes.abort_if_not_closed
end

Android (Real Device)

require 'selenium-webdriver'
require 'eyes_selenium'
require 'rubygems'


class HelloWorld

  capabilities = {
          platformName:     'Android',
          platformVersion:  'PLATFORM_VERSION',
          browserName:       'BROWSER_NAME',
          deviceName:       'DEVICE_NAME',
  }

  # Open browser.
  wd = Selenium::WebDriver.for :remote,
                               :url => 'http://127.0.0.1:4723/wd/hub',
                               :desired_capabilities => capabilities

  # Initialize the eyes SDK and set your private API key.
  eyes = Applitools::Selenium::Eyes.new
  eyes.api_key = 'YOUR_API_KEY'

  # Navigate the browser to the "hello world!" web-site.
  wd.navigate.to('https://applitools.com/helloworld')

  begin

    # Start the test.
    eyes.test(app_name: 'hello world!', test_name: 'My first Appium web Ruby test!', driver: wd) do |driver|

      # Visual checkpoint #1.
      eyes.check_window('Hello!')

      # Click the "Click me!" button.
      driver.find_element(:tag_name => 'button').click

      # Visual checkpoint #2.
      eyes.check_window('Click!')

      # End the test.
      eyes.close

    end

  ensure

    # Close the browser.
    wd.quit

    # If the test was aborted before eyes.close was called, ends the test as aborted.
    eyes.abort_if_not_closed

  end

end

Analyze your test results

Congratulations! You've successfully run your first visual UI test with Applitools Eyes! A detailed report is ready for your inspection at the Applitools Eyes test manager. Watch this 5 minute video to get acquainted with the test manager and to learn the basics of baseline maintenance.

Login to Applitools and analyze the results.

Having Trouble?

Don't suffer in silence! Let us help you. Please reach out to us to get your project working.

Taking the next steps with Applitools

Congratulations on completing this quickstart! There's still so much to learn about visual testing with Applitools, but you're off to a great start.

Resources for next steps:

1. ↔️ Setting match levels for visual checkpoints
2. Organizing Tests Into Batches

You can also:

• Request a demo