Testing web apps in Ruby using Selenium WebDriver

Running Tests with Applitools

Prerequisites

1. A free Applitools account and Applitools API KEY

Tip: Unsure how to find your API key?

Read Retrieving your API key to find your API key.

2. Ruby

3. Git

Note: Installing git is optional

Installing git is used to clone the demo project from the Github repository. Instead of installing git, you can simply download the Zip file from the repository. Further, if you are Mac, you already have git.

4. Google Chrome Browser

5. ChromeDriver

ChromeDriver must be installed and in your PATH

Below are some resources from the internet that'll help you

• Install on Mac

• Install on windows

On Mac, place the chromedriver executable in /usr/local/bin folder so Eclipse and IntelliJ can find it.

Option 1 - Run With The Ultrafast Grid

1. Clone or download the repository and navigate to that folder

git clone https://github.com/applitools/tutorial-selenium-ruby-ultrafastgrid.git
cd tutorial-selenium-ruby-ultrafastgrid

Note: you can alternatively download the project as a Zip file and extract it

2. Install the dependencies

gem install bundler && bundle install

3. Run the example test

APPLITOOLS_API_KEY="[Your API Key]" bundle exec ruby simple_test_script.rb

This will first set your APPLITOOLS_API_KEY into the node process then run bundle exec.

Adding Applitools Eyes to an Existing Project

1. Install Applitools Eyes dependencies

gem install eyes_selenium

2. Add an example test

Option 2 - Run Locally

1. Clone or download the repository and navigate to that folder

git clone https://github.com/applitools/tutorial-selenium-ruby-basic.git
cd tutorial-selenium-ruby-basic

Note: you can alternatively download the project as a Zip file and extract it

2. Install the dependencies

gem install bundler && bundle install

3. Run the example test

APPLITOOLS_API_KEY="[Your API Key]" bundle exec ruby simple_test_script.rb

This will first set your APPLITOOLS_API_KEY into the node process then run bundle exec.

Adding Applitools Eyes to an Existing Project

1. Install Applitools Eyes dependencies

gem install eyes_selenium

2. Add an example test

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