1
0
Fork 0
mirror of https://github.com/thoughtbot/capybara-webkit synced 2023-03-27 23:22:28 -04:00
capybara-webkit/README.md

2.4 KiB

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

Tag scenarios with @javascript to run them using a headless WebKit browser.

Use the :js => true flag on RSpec tests as usual And note the Transactional fixtures section of the capybara README

Contributing

See the CONTRIBUTING document.

About

The capybara WebKit driver was written by Joe Ferris, Tristan Dunn, and Jason Morrison from thoughtbot, inc.

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.