A Capybara driver for headless WebKit to test JavaScript web apps

Go to file

Matthew Mongeau d8c640d186 Added note about mailing list for compilation errors.		2012-01-13 11:44:20 -05:00
bin	Suppress the webkit_server Dock icon on Mac OS X.	2011-06-14 10:33:53 -04:00
gemfiles	Use Bundler gem conventions.	2011-11-11 20:59:24 -05:00
lib	Choose platform more reliably. (Works with Jruby.)	2012-01-13 11:22:19 -05:00
spec	Add command to retrieve URL modified by Javascript	2012-01-13 11:02:09 -05:00
src	Add command to retrieve URL modified by Javascript	2012-01-13 11:02:09 -05:00
templates	Refactor Connection/Command so that arguments are passed in as a single QStringList instead of in consecutive calls to argumentReceived	2011-02-25 23:29:36 -05:00
.gitignore	Adding ability to render webpage to a PNG	2011-07-03 14:10:53 -04:00
.rspec	Added rspec options	2011-02-24 23:14:52 -05:00
Appraisals	Add appraisal to test across versions; fix support for capybara 1.0	2011-09-30 16:56:14 -05:00
CONTRIBUTING.md	Format the code block better for the contribution guide	2011-07-22 17:03:55 -04:00
Gemfile	Use Bundler gem conventions.	2011-11-11 20:59:24 -05:00
Gemfile.lock	Fixed for 1.8; removed debugging message	2011-12-06 19:30:04 -05:00
LICENSE	Updated license ane readme	2011-03-09 17:55:40 -05:00
README.md	Added note about mailing list for compilation errors.	2012-01-13 11:44:20 -05:00
Rakefile	Use Bundler gem conventions.	2011-11-11 20:59:24 -05:00
capybara-webkit.gemspec	Use Bundler gem conventions.	2011-11-11 20:59:24 -05:00
extconf.rb	Move code that compiles Webkit into separate file to support Ruby 1.9.2	2011-04-15 17:53:31 -04:00
webkit_server.pro	Initial commit	2011-02-24 23:13:11 -05:00

README.md

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.

If you are having compiling issues please post to the mailing list.

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.

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.

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.