--- title: Run Watir WebDriver tests on our Grid description: Our Grid supports running WebDriver based Watir tests. source_url: html: https://testingbot.com/support/web-automate/selenium/ruby/watir md: https://testingbot.com/support/web-automate/selenium/ruby/watir/index.md --- # Watir WebDriver Automated Testing See our [Watir example repository](https://github.com/testingbot/ruby-rspec-watir-example) for a simple example on how to run Watir tests in parallel on TestingBot. Watir, pronounced water, is an open-source (BSD) family of Ruby libraries for automating web browsers. To install the Watir gem: gem install watir ## Example with Watir require 'watir' require 'selenium-webdriver' 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' => 'Watir Test' }) browser = Watir::Browser.new( :remote, url: 'https://hub.testingbot.com/wd/hub', options: options ) browser.goto 'https://www.google.com/ncr' browser.text_field(name: 'q').set 'TestingBot' browser.text_field(name: 'q').send_keys :enter puts browser.title browser.quit ## 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:** browser = Watir::Browser.new(:firefox) **After:** options = Selenium::WebDriver::Firefox::Options.new options.add_option('platformName', 'WIN11') options.add_option('browserVersion', 'latest') options.add_option('tb:options', { 'key' => 'API_KEY', 'secret' => 'API_SECRET' }) browser = Watir::Browser.new( :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' }) browser = Watir::Browser.new( :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 Watir test with our Tunnel: 1. [Download our tunnel](https://testingbot.com/support/tunnel) and start the tunnel: java -jar testingbot-tunnel.jar API_KEY API_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: require 'watir' require 'selenium-webdriver' options = Selenium::WebDriver::Firefox::Options.new options.add_option('platformName', 'WIN11') options.add_option('browserVersion', 'latest') options.add_option('tb:options', { 'key' => 'API_KEY', 'secret' => 'API_SECRET', 'name' => 'Watir Tunnel Test' }) browser = Watir::Browser.new( :remote, url: 'http://localhost:4445/wd/hub', options: options ) browser.goto 'https://www.google.com/ncr' browser.text_field(name: 'q').set 'TestingBot' browser.text_field(name: 'q').send_keys :enter puts browser.title browser.quit ## 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. Install it with `gem install testingbot`: require 'testingbot' api = TestingBot::Api.new('API_KEY', 'API_SECRET') api.update_test(browser.driver.session_id, { name: 'My Test', success: true }) ## 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) Minimal (mostly drop-in) replacement for test-unit. ### 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)