Ruby with Selenium: Tutorial to Run Your First Test on LambdaTest
In this topic, you will learn how to configure and run your Ruby automation testing scripts on LambdaTest Selenium cloud platform.
Objective
By the end of this topic, you will be able to:
- Set up an environment for testing your hosted web pages using Ruby with Selenium.
- Understand and configure the core capabilities required for your Selenium test suite.
- Test your locally hosted pages on LambdaTest platform.
- Explore advanced features of LambdaTest.
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 Ruby With Selenium
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 ruby-selenium-sample repository and navigate to the code directory as shown below:
git clone https://github.com/LambdaTest/ruby-selenium-sample.git
cd ruby-selenium-sample
Step 2: Install selenium dependencies for Ruby automation testing.
sudo gem install selenium-webdriver
Setting up Your Authentication
Make sure you have your LambdaTest credentials with you to run test automation scripts with Jest 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 Ruby
Step 4: Let's check the sample ruby test script todo-click-test.rb. The code will select the basic capabilities such as OS, browser, browser version and so on. The Ruby automation testing script below tests a simple google search functionality.
#todo-click-test.rb
require 'selenium-webdriver'
require 'test/unit'
class LtTest < Test::Unit::TestCase
"""
LambdaTest selenium automation sample example
Configuration
----------
username: Username can be found at automation dashboard
accessToken: AccessToken can be generated from automation dashboard or profile section
Result
-------
Execute Ruby Automation Tests on LambdaTest Distributed Selenium Grid
"""
def setup
"""
Setup remote driver
Params
----------
platform : Supported platform - (Windows 10, Windows 8.1, Windows 8, Windows 7, macOS High Sierra, macOS Sierra, OS X El Capitan, OS X Yosemite, OS X Mavericks)
browserName : Supported platform - (chrome, firefox, Internet Explorer, MicrosoftEdge)
version : Supported list of version can be found at https://www.lambdatest.com/capabilities-generator/
Result
-------
"""
username= ENV["LT_USERNAME"] || "LT_Username" #Enter your username here
accessToken= ENV["LT_ACCESS_KEY"] || "LT_AccessKey" #Enter your Access Key here
gridUrl = "hub.lambdatest.com/wd/hub"
caps = {
:browserName => "chrome",
:version => "67.0",
:platform => "win10",
:geoLocation => "US",
:name => "LambdaTest ruby google search name",
:build => "LambdaTest ruby google search build",
:network => false,
:visual => false,
:video => true,
:console => false
}
puts (caps)
# URL: https://{username}:{accessToken}@hub.lambdatest.com/wd/hub
@driver = Selenium::WebDriver.for(:remote,
:url => "https://"+username+":"+accessToken+"@"+gridUrl,
:desired_capabilities => caps)
end
def test_Login
"""
Setup remote driver
Params
----------
Execute test: navigate google.com search LambdaTest
Result
-------
print title
"""
puts("Searching lambdatest on google.com ")
sleep(15)
@driver.get("https://www.google.com/")
elem = @driver.find_element(:name, 'q')
elem.send_keys("lambdatest.com")
elem.submit()
puts("Printing title of current page :"+@driver.title)
end
def teardown
"""
Quit selenium driver
"""
@driver.quit
end
end
Configuration of Your Test Capabilities
Step 5: 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 => "chrome",
:version => "67.0",
:platform => "win10",
:geoLocation => "US",
:name => "LambdaTest ruby google search name",
:build => "LambdaTest ruby google search build",
:network => false,
:visual => false,
:video => true,
:console => false
}
You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool.
Executing the Test
Step 6: To execute the test script, run the following script on terminal/cmd.
ruby todo-click-test.rb
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.
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,
...
}