Skip to main content

Capybara with Selenium: Tutorial to Run Your First Test on LambdaTest

In this topic, you will learn how to configure and run your Java automation testing scripts on LambdaTest Selenium cloud platform using Ruby framework Capybara.

Objective​

By the end of this topic, you will be able to:

  1. Set up an environment for testing your hosted web pages using Capybara framework with Selenium.
  2. Run a sample Selenium with CapyBara Ruby on LambdaTest Automation.
  3. Setting up environment for testing your locally hosted web pages or website.
  4. Run multiple tests in parallel with CapyBara Ruby using LambdaTest Selenium Grid.

Note: All the code samples in this documentation can be found in the LambdaTest's Repository on GitHub. You can either download or clone the repository to quickly run your tests.

Prerequisites For Running CapyBara Ruby Using Selenium Grid​

Before you can start performing Ruby automation testing with Selenium, you would need to:

  • Install Ruby and gem on your local system. Follow these instructions to install on different operating systems.
    • For Windows, you can download from the official website.
    • For Linux or Ubuntu, you can run a simple apt command like below:
    sudo apt-get install ruby-full
    • For macOS, you can run a Homebrew command like this:
    brew install ruby
  • To run tests in parallel you will require the parallel_tests gem.
  • LambdaTest binary file for running tests on your locally hosted web pages.

Installing Selenium Dependencies and Tutorial Repo​

Step 1: Clone the LambdaTest’s Capybara-Ruby repository and navigate to the code directory as shown below:

git clone https://github.com/LambdaTest/Capybara-Cucumber-Ruby.git
cd Capybara-Cucumber-Ruby

Step 2: After navigating to the cloned directory, install project dependencies using the below commands:

bundle install

Setting up Your Authentication​

Make sure you have your LambdaTest credentials with you to run test automation scripts with Capybara on LambdaTest Selenium Grid. You can obtain these credentials from the LambdaTest Automation Dashboard or through LambdaTest Profile.

Step 3: Set LambdaTest Username and Access Key in environment variables.

  • For Linux/macOS: export LT_USERNAME="YOUR_USERNAME" export LT_ACCESS_KEY="YOUR ACCESS KEY"
  • For Windows: set LT_USERNAME="YOUR_USERNAME" set LT_ACCESS_KEY="YOUR ACCESS KEY"

Run Your First Test​

Sample Test with Capybara Ruby​

The example mentioned below would help you to execute your automation test using CapyBara Ruby.

# lambdatest.rb

require 'yaml'
require 'selenium/webdriver'
require 'capybara/cucumber'

# monkey patch to avoid reset sessions
class Capybara::Selenium::Driver < Capybara::Driver::Base
  def reset!
    if @browser
      @browser.navigate.to('about:blank')
    end
  end
end

TASK_ID = (ENV['TASK_ID'] || 0).to_i
CONFIG_NAME = ENV['CONFIG_NAME'] || 'single'

CONFIG = YAML.load(File.read(File.join(File.dirname(__FILE__), "../../config/#{CONFIG_NAME}.config.yml")))
CONFIG['user'] = ENV['LT_USERNAME'] || CONFIG['user']
CONFIG['key'] = ENV['LT_ACCESS_KEY'] || CONFIG['key']


Capybara.register_driver :lambdatest do |app|
  @caps = CONFIG['common_caps'].merge(CONFIG['browser_caps'][TASK_ID])


if (CONFIG_NAME=='jenkins')
puts ENV['LT_GRID_URL']
lt_browser = ENV['LT_BROWSER_NAME'] 
lt_os = ENV['LT_PLATFORM']
lt_browser_version = ENV['LT_BROWSER_VERSION']
lt_res = ENV['LT_RESOLUTION']
@caps={
        "browserName"=>lt_browser, 
        "version"=>lt_browser_version, 
        "platform"=>lt_os, 
        "resolution"=>lt_res, 
        "build"=>"capybara-lambdatest", 
        "name"=>"single-Test-Jenkins",
        "video"=>true, 
        "network"=>true, 
        "console"=>true, 
        "visual"=>true 
      }

Capybara::Selenium::Driver.new(app,
        :browser => :remote,
        :url => ENV['LT_GRID_URL'],
        :desired_capabilities => @caps
      )

else 
  Capybara::Selenium::Driver.new(app,
    :browser => :remote,
    :url => "https://#{CONFIG['user']}:#{CONFIG['key']}@#{CONFIG['server']}/wd/hub",
    :desired_capabilities => @caps
  )
end
end

Capybara.default_driver = :lambdatest
Capybara.run_server = false

Configuration of Your Test Capabilities​

Step 4: In the test script, you need to update your test capabilities. In this code, we are passing browser, browser version, and operating system information, along with LambdaTest Selenium grid capabilities via capabilities object. The capabilities in the above code are defined as:

@caps = {                       
            "browserName"=>lt_browser, 
            "version"=>lt_browser_version, 
            "platform"=>lt_os, 
            "resolution"=>lt_res, 
            "build"=>"capybara-lambdatest", 
            "name"=>"single-Test-Jenkins",
            "video"=>true, 
            "network"=>true, 
            "console"=>true, 
            "visual"=>true 
        }

You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool.

Executing the Test​

Step 5: Navigate to the directory where you cloned the sample of CapyBara Ruby and run the following command.

bundle exec rake single

Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on LambdaTest automation dashboard. LambdaTest Automation Dashboard will help you view all your text logs, screenshots and video recording for your entire automation tests.

Running Your Parallel Tests Using Capybara Framework​

Executing Parallel Tests Using Capybara​

Navigate to the directory where you cloned the sample of CapyBara Ruby and run the following command.

bundle exec rake parallel

Testing Locally Hosted or Privately Hosted Projects​

You can test your locally hosted or privately hosted projects with LambdaTest Selenium grid cloud using LambdaTest Tunnel app. All you would have to do is set up an SSH tunnel using LambdaTest Tunnel app and pass toggle tunnel = True via desired capabilities. LambdaTest Tunnel establishes a secure SSH protocol based tunnel that allows you in testing your locally hosted or privately hosted pages, even before they are made live.

Refer our LambdaTest Tunnel documentation for more information.

Here’s how you can establish LambdaTest Tunnel.

Download the binary file of:

Open command prompt and navigate to the binary folder.

Run the following command:

LT -user {user’s login email} -key {user’s access key}

So if your user name is lambdatest@example.com and key is 123456, the command would be:

LT -user lambdatest@example.com -key 123456

Once you are able to connect LambdaTest Tunnel successfully, you would just have to pass on tunnel capabilities in the code shown below :

Tunnel Capability

caps = {             
            ...          
            :tunnel => true,         
            ...
        }
Last updated on