A Capybara driver for headless WebKit to test JavaScript web apps
Ruby C++ JavaScript QMake Shell
Clone or download
pocke and mhoran [Bug fix] Support `:numpad8` for `send_keys` method
`:numpad9` is duplicated instead of `:numpad8`, so `send_keys` method raises an error when it receives `:numpad8`.
We can reproduce this behaviour with the added test case.

This pull request fixes the problem.


I found this bug with `RUBYOPT=-w`.  For example: (The second warning)

$ ruby -Ilib -rcapybara-webkit -e ''
/path/to/lib/ruby/gems/2.6.0/gems/addressable-2.5.2/lib/addressable/idna/pure.rb:154: warning: assigned but unused variable - startercc
/path/to/lib/capybara/webkit/node.rb:217: warning: duplicated when clause is ignored
Latest commit 41c4306 Jul 21, 2018
Failed to load latest commit information.
bin Make sure webkit_server process runs in background Jan 27, 2015
gemfiles Support Capybara 3 current_url/title being for top level browsing con… Mar 21, 2018
lib [Bug fix] Support `:numpad8` for `send_keys` method Jul 21, 2018
spec [Bug fix] Support `:numpad8` for `send_keys` method Jul 21, 2018
src Support Capybara 3 current_url/title being for top level browsing con… Mar 21, 2018
templates Update for Capybara 2.3.0 Jul 2, 2014
test Allow Qt 5.6 with QtWebKit module Apr 18, 2016
.gitignore No support for fullscreen mode Jul 9, 2018
.rspec Added rspec options Feb 25, 2011
.travis.yml Update Travis build matrix due to Capybara 3 release Apr 9, 2018
Appraisals Add support for keys and offset with mouse clicks coming in Capybara 3 Jan 11, 2018
CONTRIBUTING.md Link to thoughtbot's contributor code of conduct Apr 9, 2015
Gemfile Update Travis build matrix due to Capybara 3 release Apr 9, 2018
Gemfile.lock Update Travis build matrix due to Capybara 3 release Apr 9, 2018
LICENSE Update links and credits in README Mar 9, 2015
NEWS.md Update version and NEWS Feb 7, 2018
README.md Change Read Me to new rspec command Jan 30, 2018
Rakefile Install bundler Gem tasks in bundler namespace Jul 3, 2014
Vagrantfile Add Vagrant configuration. Jan 16, 2013
capybara-webkit.gemspec Add support for keys and offset with mouse clicks coming in Capybara 3 Jan 11, 2018
extconf.rb Expose INCLUDEPATH and LIBS qmake variables Dec 17, 2014
vagrant_setup.sh Add Vagrant configuration. Jan 16, 2013
webkit_server.pro Rewrite qInstallMsgHandler test in C++ Nov 10, 2013



Build Status Code Climate

A capybara driver that uses WebKit via QtWebKit.

Qt Dependency and Installation Issues

capybara-webkit depends on a WebKit implementation from Qt, a cross-platform development toolkit. You'll need to download the Qt libraries to build and install the gem. You can find instructions for downloading and installing Qt on the capybara-webkit wiki. capybara-webkit requires Qt version 4.8 or greater.

Windows Support

Currently 32-bit Windows will compile capybara-webkit. Support for Windows is provided by the open source community and Windows related issues should be posted to Stack Overflow.

Reporting Issues

Without access to your application code we can't easily debug most crashes or generic failures, so we've included a debug version of the driver that prints a log of what happened during each test. Before filing a crash bug, please see Reporting Crashes. You're much more likely to get a fix if you follow those instructions.

If you're having trouble compiling or installing, please check out the wiki. If you don't have any luck there, please post to Stack Overflow. Please don't open a Github issue for a system-specific compiler issue.


If you're like us, you'll be using capybara-webkit on CI.

On Linux platforms, capybara-webkit requires an X server to run, although it doesn't create any visible windows. Xvfb works fine for this. You can setup Xvfb yourself and set a DISPLAY variable, try out the headless gem, or use the xvfb-run utility as follows:

xvfb-run -a bundle exec rspec

This automatically sets up a virtual X server on a free server number.


Add the capybara-webkit gem to your Gemfile:

gem "capybara-webkit"

Set your Capybara Javascript driver to webkit:

Capybara.javascript_driver = :webkit

In cucumber, tag scenarios with @javascript to run them using a headless WebKit browser.

In RSpec, use the :js => true flag. See the capybara documentation for more information about using capybara with RSpec.

Take note of the transactional fixtures section of the capybara README.

If you're using capybara-webkit with Sinatra, don't forget to set

Capybara.app = MySinatraApp.new


You can configure global options using Capybara::Webkit.configure:

Capybara::Webkit.configure do |config|
  # Enable debug mode. Prints a log of everything the driver is doing.
  config.debug = true

  # By default, requests to outside domains (anything besides localhost) will
  # result in a warning. Several methods allow you to change this behavior.

  # Silently return an empty 200 response for any requests to unknown URLs.

  # Allow pages to make requests to any URL without issuing a warning.

  # Allow a specific domain without issuing a warning.

  # Allow a specific URL and path without issuing a warning.

  # Wildcards are allowed in URL expressions.

  # Silently return an empty 200 response for any requests to the given URL.

  # Timeout if requests take longer than 5 seconds
  config.timeout = 5

  # Don't raise errors when SSL certificates can't be validated

  # Don't load images

  # Use a proxy
    host: "example.com",
    port: 1234,
    user: "proxy",
    pass: "secret"

  # Raise JavaScript errors as exceptions
  config.raise_javascript_errors = true

These options will take effect for all future sessions and only need to be set once. It's recommended that you configure these in your spec_helper.rb or test_helper.rb rather than a before or setup block.

Offline Application Cache

The offline application cache needs a directory to write to for the cached files. Capybara-webkit will look at if the working directory has a tmp directory and when it exists offline application cache will be enabled.

Non-Standard Driver Methods

capybara-webkit supports a few methods that are not part of the standard capybara API. You can access these by calling driver on the capybara session. When using the DSL, that will look like page.driver.method_name.

console_messages: returns an array of messages printed using console.log

// In Javascript:
# In Ruby:
=> [{:source=>"http://example.com", :line_number=>1, :message=>"hello"}]

error_messages: returns an array of Javascript errors that occurred

=> [{:source=>"http://example.com", :line_number=>1, :message=>"SyntaxError: Parse error"}]

cookies: allows read-only access of cookies for the current session

=> "abc"

header: set the given HTTP header for subsequent requests

page.driver.header 'Referer', 'https://www.thoughtbot.com'


See the CONTRIBUTING document. Thank you, contributors!


capybara-webkit is Copyright (c) 2010-2015 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.


The capybara WebKit driver is maintained by Joe Ferris and Matt Horan.

Code for rendering the current webpage to a PNG is borrowed from Phantom.js' implementation.


capybara-webkit is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects or hire us to help build your product.