Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 3.62 KB

README.md

File metadata and controls

107 lines (72 loc) · 3.62 KB

capybara-webkit

A capybara driver that uses WebKit via QtWebKit.

Qt Dependency

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

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.

CI

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, or try out the headless gem.

Usage

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.

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

Setting Webkit options

The capybara-webkit driver allows access to some of the underlying QtWebKit's configuration options. You can use

# to set a flag:
driver.browser.set_attribute(:flag_name, true)

# to unset a flag explicitly:
driver.browser.set_attribute(:flag_name, false)

# to reset a flag to default:
driver.browser.reset_attribute(:flag_name)

Supported are the flag names listed below:

  • :auto_load_images
  • :dns_prefetch_enabled
  • :plugins_enabled
  • :private_browsing_enabled
  • :javascript_can_open_windows
  • :javascript_can_access_clipboard
  • :offline_storage_database_enabled
  • :offline_web_application_cache_enabled
  • :local_storage_enabled
  • :local_storage_database_enabled
  • :local_content_can_access_remote_urls
  • :local_content_can_access_file_urls
  • :accelerated_compositing_enabled
  • :site_specific_quirks_enabled

Please consult the Qt documentation for more information about those options. If you need more flags to be supported, please contact us.

Contributing

See the CONTRIBUTING document.

About

The capybara WebKit driver is maintained by Joe Ferris and Matt Mongeau. It was written by thoughtbot, inc with the help of numerous contributions from the open source community.

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

thoughtbot

The names and logos for thoughtbot are trademarks of thoughtbot, inc.

Notes

capybara-webkit will listen on port 8200. This may conflict with other services.

License

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