---
title: Run Selenium tests in Ruby with RSpec
description: Test websites with Ruby, RSpec and Selenium WebDriver
source_url:
  html: https://testingbot.com/support/web-automate/selenium/ruby/rspec
  md: https://testingbot.com/support/web-automate/selenium/ruby/rspec/index.md
---
# RSpec Automated Testing

See our [RSpec example repository](https://github.com/testingbot/ruby-rspec-example) for a simple example on how to run RSpec tests in parallel on TestingBot.

First, install the required gems:

    gem install rspec selenium-webdriver testingbot

Next, let's create a `testingbot_driver.rb` file which makes it easy to run tests on TestingBot:

    require "selenium/webdriver"
    
    module TestingbotDriver
      class << self
        def testingbot_endpoint
          "https://hub.testingbot.com/wd/hub"
        end
    
        def new_driver
          options = Selenium::WebDriver::Chrome::Options.new
          options.add_option('platformName', 'WIN11')
          options.add_option('browserVersion', 'latest')
          options.add_option('tb:options', {
            'key' => 'API_KEY',
            'secret' => 'API_SECRET',
            'name' => 'RSpec Test'
          })
    
          Selenium::WebDriver.for :remote, url: testingbot_endpoint, options: options
        end
      end
    end

Now, we need to tell RSpec to use our custom driver to run the test.   
 The best way to do this, is by defining an around hook:

**spec\_helper.rb** : 

    require "rspec"
    require_relative "testingbot_driver"
    
    RSpec.configure do |config|
      config.around(:example) do |example|
        @driver = TestingbotDriver.new_driver
        begin
          example.run
        ensure
          @driver.quit
        end
      end
    end

Now, let's create an actual test that will use TestingBot:

    rspec example.rb

    require_relative "spec_helper"
    
    describe "Google's Search Functionality" do
      it "can find search results" do
        @driver.manage.timeouts.implicit_wait = 10
        @driver.navigate.to "https://www.google.com"
    
        raise "Unable to load Google." unless @driver.title.include? "Google"
    
        query = @driver.find_element :name, "q"
        query.send_keys "TestingBot"
        query.submit
    
        puts @driver.title
      end
    end

## Configuring capabilities

To run your existing tests on TestingBot, your tests will need to be configured to use the TestingBot remote machines. If the test was running on your local machine or network, you can simply change your existing test like this:

**Before:**

    driver = Selenium::WebDriver.for :chrome

**After:**

    options = Selenium::WebDriver::Chrome::Options.new
    options.add_option('platformName', 'WIN11')
    options.add_option('browserVersion', 'latest')
    options.add_option('tb:options', {
      'key' => 'API_KEY',
      'secret' => 'API_SECRET'
    })
    
    driver = Selenium::WebDriver.for(:remote,
      url: "https://hub.testingbot.com/wd/hub",
      options: options
    )

## Specify Browsers & Devices

To let TestingBot know on which browser/platform/device you want to run your test on, you need to specify the browsername, version, OS and other optional options in the capabilities field.

    options = Selenium::WebDriver::Chrome::Options.new
    options.add_option('platformName', 'WIN11')
    options.add_option('browserVersion', 'latest')
    options.add_option('tb:options', {
      'key' => 'API_KEY',
      'secret' => 'API_SECRET'
    })
    
    driver = Selenium::WebDriver.for(:remote,
      url: "https://hub.testingbot.com/wd/hub",
      options: options
    )

To see how to do this, please select a combination of browser, version and platform in the drop-down menus below.

  ![OS selected](https://testingbot.com/assets/environments/svg/windows11-0e1b28bc0fdd5034d3e4d3dc8d346c500a8c6522facf4b45d0da56537c1f1c6d.svg) Windows 11 › ![Browser Selected](https://testingbot.com/assets/environments/svg/chrome-c4081ff447d2d898d4afcb8f074a907c960e6f007716c1a1d119eee6803c4042.svg) Chrome 139 

Loading environments...

Please wait while we load the available browsers and platforms.

    

## Testing Internal Websites

We've built [TestingBot Tunnel](https://testingbot.com/support/tunnel), to provide you with a secure way to run tests against your staged/internal webapps.  
Please see our [TestingBot Tunnel documentation](https://testingbot.com/support/tunnel) for more information about this easy to use tunneling solution.

The example below shows how to easily run a RSpec test with our Tunnel:

1. [Download our tunnel](https://testingbot.com/support/tunnel) and start the tunnel:

    java -jar testingbot-tunnel.jar key secret

2. Adjust your test: instead of pointing to `'hub.testingbot.com/wd/hub'` like the example above - change it to point to your tunnel's IP address.   
 Assuming you run the tunnel on the same machine you run your tests, change to `'localhost:4445/wd/hub'`. localhost is the machine running the tunnel, 4445 is the default port of the tunnel.

This way your test will go securely through the tunnel to TestingBot and back:

**testingbot\_driver.rb**

    require "selenium/webdriver"
    
    module TestingbotDriver
      class << self
        def testingbot_endpoint
          "http://localhost:4445/wd/hub"
        end
    
        def new_driver
          options = Selenium::WebDriver::Chrome::Options.new
          options.add_option('platformName', 'WIN11')
          options.add_option('browserVersion', 'latest')
          options.add_option('tb:options', {
            'key' => 'API_KEY',
            'secret' => 'API_SECRET',
            'name' => 'RSpec Tunnel Test'
          })
    
          Selenium::WebDriver.for :remote, url: testingbot_endpoint, options: options
        end
      end
    end

## Run tests in Parallel

Parallel Testing means running the same test, or multiple tests, simultaneously. This greatly reduces your total testing time.

You can run the same tests on all different browser configurations or run different tests all on the same browser configuration.   
 TestingBot has a large grid of machines and browsers, which means you can use our service to do efficient parallel testing. It is one of the key features we provide to greatly cut down on your total testing time.

Add the parallel\_tests gem to your Gemfile:

    gem "rspec"
    gem "parallel_tests"

Now create some more tests in the same spec directory. Make sure the tests also end with `_spec.rb` in the filename.

Once you have some more tests, you can run the tests in parallel with this command:

    bundle exec parallel_rspec -n 2 spec/

The `-n 2` means how many tests you will run concurrently. This should match up with the number of parallel tests you have with your TestingBot paid plan or 2 for the free trial.

### Queuing

Every plan we provide comes with a limit of parallel tests.   
 If you exceed the number of parallel tests assigned to your account, TestingBot will queue the additional tests (for up to 6 minutes) and run the tests as soon as slots become available.

## Mark tests as passed/failed

As TestingBot has no way to determine whether your test passed or failed (it is determined by your business logic), we offer a way to send the test status back to TestingBot. This is useful if you want to see if a test succeeded or failed from the TestingBot member area.

You can use our [Ruby API client](https://github.com/testingbot/testingbot_ruby) to report back test results. Wire it into the `around` hook in `spec_helper.rb` so the status reflects the actual result. Read the session id and outcome **before** calling `@driver.quit` (the session id is no longer available after quit):

    require 'testingbot'
    
    RSpec.configure do |config|
      config.around(:example) do |example|
        @driver = TestingbotDriver.new_driver
        begin
          example.run
        ensure
          api = TestingBot::Api.new('API_KEY', 'API_SECRET')
          api.update_test(@driver.session_id, { name: example.description, success: example.exception.nil? })
          @driver.quit
        end
      end
    end

## Other Ruby Framework examples

- [Capybara](https://testingbot.com/support/web-automate/selenium/ruby/capybara)

Capybara is an integration testing tool for rack based web applications.

- [Cucumber](https://testingbot.com/support/web-automate/selenium/ruby/cucumber)

Cucumber is a Ruby based test tool for BDD.

- [RSpec](https://testingbot.com/support/web-automate/selenium/ruby/rspec)

RSpec is a behavior-driven development (BDD) framework, inspired by JBehave.

- [Test::Unit](https://testingbot.com/support/web-automate/selenium/ruby/testunit)

Test-Unit is a xUnit family unit testing framework for Ruby.

- [Minitest](https://testingbot.com/support/web-automate/selenium/ruby/minitest)

Minitest is a minimal replacement for test-unit with a complete suite of testing facilities.

- [Watir](https://testingbot.com/support/web-automate/selenium/ruby/watir)

Watir, pronounced water, is an open-source family of Ruby libraries for automating web browsers.

### Looking for more help?

Have questions or need more information? Reach out via email or Slack.

[Email us](https://testingbot.com/contact/new)[Slack Join our Slack](https://join.slack.com/t/testingb0t/shared_invite/zt-3bcw9xch-jk19~6XPs_xBrsAgAedkCw)