machinio/cuprite

Cuprite - Headless Chrome driver for Capybara

Build Status

Cuprite is a pure Ruby driver (read as no Java/Selenium/WebDriver/ChromeDriver requirement) for Capybara. It allows you to run your Capybara tests on a headless Chrome or Chromium browser by CDP protocol.

The emphasis was made on raw CDP protocol because Headless Chrome allows you to do so many cool things that are barely supported by WebDriver because it should have consistent design with other browsers. The design of the driver will be as close to Poltergeist as possible but it's not a goal.

Installation

gem "cuprite"

and run bundle install.

In your test setup add:

require "capybara/cuprite"
Capybara.javascript_driver = :cuprite

Installing Chromium

As Chromium is stopped being built as a package for Linux don't even try to install it this way because it will either be outdated or unofficial package. Both are bad. Download it from official source.

Supported features

All the mandatory capybara features plus optional ones:

  • page.evaluate_script and page.execute_script
  • page.within_frame
  • page.status_code
  • page.response_headers
  • page.save_screenshot
  • page.driver.render_base64(format, options)
  • page.driver.scroll_to(left, top)
  • page.driver.basic_authorize(user, password)
  • element.send_keys(*keys)
  • page.driver.set_proxy(ip, port, type, user, password)
  • window API
  • cookie handling

Remote debugging

If you use the inspector: true option, remote debugging will be enabled. When this option is enabled, you can insert page.driver.debug into your tests to pause the test and launch a browser which gives you the Chrome inspector to view all your open pages and inspect them.

You can register this debugger driver with a different name and set it as the current javascript driver. By example, in your helper file:

Capybara.register_driver :cuprite_debug do |app|
  Capybara::Cuprite::Driver.new(app, inspector: true)
end

Capybara.javascript_driver = :cuprite_debug

Clicking coordinates

Sometimes its desirable to click a very specific area of the screen. You can accomplish this with page.driver.click(x, y), where x and y are the screen coordinates.

Manipulating request headers

Manipulate HTTP request headers like a boss:

page.driver.headers # => {}
page.driver.headers = { "User-Agent" => "Cuprite" }
page.driver.add_headers("Referer" => "https://example.com")
page.driver.headers # => { "User-Agent" => "Cuprite", "Referer" => "https://example.com" }

Notice that headers= will overwrite already set headers. You should use add_headers if you want to add a few more. These headers will apply to all subsequent HTTP requests (including requests for assets, AJAX, etc). They will be automatically cleared at the end of the test.

Inspecting network traffic

You can inspect the network traffic (i.e. what resources have been loaded) on the current page by calling page.driver.network_traffic. This returns an array of request objects. A request object has a response method containing data about the response.

Please note that network traffic is not cleared when you visit new page. You can manually clear the network traffic by calling page.driver.clear_network_traffic or page.driver.reset

Manipulating cookies

The following methods are used to inspect and manipulate cookies:

  • page.driver.cookies - a hash of cookies accessible to the current page. The keys are cookie names. The values are Cookie objects, with the following methods: name, value, domain, path, size, secure?, httponly?, session?, expires.
  • page.driver.set_cookie(name, value, options = {}) - set a cookie. The options hash can take the following keys: :domain, :path, :secure, :httponly, :expires. :expires should be a Time object.
  • page.driver.remove_cookie(name) - remove a cookie
  • page.driver.clear_cookies - clear all cookies

Customization

You can customize the way that Capybara sets up Cuprite via the following code in your test setup:

Capybara.register_driver :cuprite do |app|
  Capybara::Cuprite::Driver.new(app, options)
end

options is a hash of options. The following options are supported:

  • :browser_path (String) - Path to chrome binary, you can also set ENV variable as BROWSER_PATH=some/path/chrome bundle exec rspec.
  • :headless (Boolean) - Set browser as headless or not, true by default.
  • :slowmo (Integer | Float) - Set a delay to wait before sending command. Usefull companion of headless option, so that you have time to see changes.
  • :logger (Object responding to puts) - When present, debug output is written to this object.
  • :timeout (Numeric) - The number of seconds we'll wait for a response when communicating with browser. Default is 30.
  • :js_errors (Boolean) - When true, JavaScript errors get re-raised in Ruby.
  • :window_size (Array) - The dimensions of the browser window in which to test, expressed as a 2-element array, e.g. [1024, 768]. Default: [1024, 768]
  • :browser_options (Hash) - Additional command line options, see them all e.g. { "ignore-certificate-errors" => nil }
  • :extensions (Array) - An array of JS files to be preloaded into the browser
  • :port (Integer) - Remote debugging port for headless Chrome
  • :host (String) - Remote debugging address for headless Chrome
  • :url (String) - URL for a running instance of Chrome. If this is set, a browser process will not be spawned.
  • :url_blacklist (Array) - array of strings to match against requested URLs
  • :url_whitelist (Array) - array of strings to match against requested URLs
  • :process_timeout (Integer) - How long to wait for the Chrome process to respond on startup

Running in Docker

In docker as root you must pass the no-sandbox browser option:

Capybara.register_driver :cuprite do |app|
  Capybara::Cuprite::Driver.new(
    app,
    browser_options: {
      'no-sandbox': nil
    }
  )
end

URL Blacklisting & Whitelisting

Cuprite supports URL blacklisting, which allows you to prevent scripts from running on designated domains:

page.driver.browser.url_blacklist = ["http://www.example.com"]

and also URL whitelisting, which allows scripts to only run on designated domains:

page.driver.browser.url_whitelist = ["http://www.example.com"]

If you are experiencing slower run times, consider creating a URL whitelist of domains that are essential or a blacklist of domains that are not essential, such as ad networks or analytics, to your testing environment.

License

Copyright 2018-2019 Machinio

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

machinio/cuprite
See more ...