Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Database Cleaner issue with Capybara webkit

I am using Cucumber to write my integration tests and Database Cleaner to keep my db clean. Everything perfectly works as my tests don't require Javascript.

I can make these last tests pass using Capybara webkit, but then my db is not cleaned at all.

Here is my features/support/env.rb file:

require 'simplecov'
SimpleCov.start 'rails'
require 'cucumber/rails'

Capybara.default_selector = :css
Capybara.javascript_driver = :webkit

begin
  require 'database_cleaner'
  require 'database_cleaner/cucumber'
  DatabaseCleaner[:active_record].strategy = :transaction
rescue NameError
  raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
end


Before do
  DatabaseCleaner.start
end

After do |scenario|
  DatabaseCleaner.clean
end

I tried something similar to this to check which driver is used by Capybara but it didn't work. I also tried the hack mentioned in the third part of this post but then nothing worked at all...

I really don't know how to achieve this and any help would be greatly appreciated.

Thanks in advance.

like image 301
siekfried Avatar asked Apr 11 '13 09:04

siekfried


1 Answers

Quick answer:

Configure your JavaScript tests to use truncation instead of transactions:

DatabaseCleaner.strategy = :truncation

Longer explanation:

The transaction strategy doesn't work well with JavaScript tests, because most JavaScript-capable capybara drivers run the tests in a different thread than the application code.

Here's a basic outline of the process:

  • Capybara boots up your rack application using webrick or thin in a background thread.
  • The main thread sets up the driver, providing the port the rack application is running on.
  • Your tests ask the driver to interact with the application, which causes the fake web browser to perform requests against your application.

This is necessary because it's difficult to make a fake browser that performs requests against an in-memory Rack application. In some database drivers, it isn't safe to perform queries from multiple threads against the same transaction.

The end result of this is that you need to commit transactions in your test code in order for the data to be visible in your application code. The easiest way to fix this is to use the truncation database cleaner strategy.

You can configure RSpec (or Cucumber) to use transactions for everything but JavaScript tests. This will be faster for non-JavaScript tests while still working for JavaScript tests.

Avdi Grimm has a good blog post on this subject that describes the solution in detail: http://devblog.avdi.org/2012/08/31/configuring-database_cleaner-with-rails-rspec-capybara-and-selenium/

like image 64
Joe Ferris Avatar answered Oct 05 '22 23:10

Joe Ferris