mirror of
https://github.com/DatabaseCleaner/database_cleaner
synced 2023-03-27 23:22:03 -04:00
Merge pull request #377 from eliotsykes/patch-1
Explain & strengthen RSpec+Capybara config
This commit is contained in:
commit
f32abebc4f
1 changed files with 54 additions and 3 deletions
|
@ -221,7 +221,30 @@ end
|
|||
|
||||
### RSpec with Capybara Example
|
||||
|
||||
If you're using Capybara with RSpec and using an external browser (not using RackTest) you'll almost certainly need to use truncation rather than transactions for tests tagged `:js`.
|
||||
You'll typically discover a feature spec is incorrectly using transaction
|
||||
instead of truncation strategy when the data created in the spec is not
|
||||
visible in the app-under-test.
|
||||
|
||||
A frequently occurring example of this is when, after creating a user in a
|
||||
spec, the spec mysteriously fails to login with the user. This happens because
|
||||
the user is created inside of an uncommitted transaction on one database
|
||||
connection, while the login attempt is made using a separate database
|
||||
connection. This separate database connection cannot access the
|
||||
uncommitted user data created over the first database connection due to
|
||||
transaction isolation.
|
||||
|
||||
For feature specs using a Capybara driver for an external
|
||||
JavaScript-capable browser (in practice this is all drivers except
|
||||
`:rack_test`), the Rack app under test and the specs do not share a
|
||||
database connection.
|
||||
|
||||
When a spec and app-under-test do not share a database connection,
|
||||
you'll likely need to use the truncation strategy instead of the
|
||||
transaction strategy.
|
||||
|
||||
See the suggested config below to temporarily enable truncation strategy
|
||||
for affected feature specs only. This config continues to use transaction
|
||||
strategy for all other specs.
|
||||
|
||||
```ruby
|
||||
RSpec.configure do |config|
|
||||
|
@ -229,11 +252,39 @@ RSpec.configure do |config|
|
|||
config.use_transactional_fixtures = false
|
||||
|
||||
config.before(:suite) do
|
||||
if config.use_transactional_fixtures?
|
||||
raise(<<-MSG)
|
||||
Delete line `config.use_transactional_fixtures = true` from rails_helper.rb
|
||||
(or set it to false) to prevent uncommitted transactions being used in
|
||||
JavaScript-dependent specs.
|
||||
|
||||
During testing, the app-under-test that the browser driver connects to
|
||||
uses a different database connection to the database connection used by
|
||||
the spec. The app's database connection would not be able to access
|
||||
uncommitted transaction data setup over the spec's database connection.
|
||||
MSG
|
||||
end
|
||||
DatabaseCleaner.clean_with(:truncation)
|
||||
end
|
||||
|
||||
config.before(:each) do
|
||||
DatabaseCleaner.strategy = :transaction
|
||||
end
|
||||
|
||||
config.before(:each) do |example|
|
||||
DatabaseCleaner.strategy = example.metadata[:js] ? :truncation : :transaction
|
||||
config.before(:each, type: :feature) do
|
||||
# :rack_test driver's Rack app under test shares database connection
|
||||
# with the specs, so continue to use transaction strategy for speed.
|
||||
driver_shares_db_connection_with_specs = Capybara.current_driver == :rack_test
|
||||
|
||||
if !driver_shares_db_connection_with_specs
|
||||
# Driver is probably for an external browser with an app
|
||||
# under test that does *not* share a database connection with the
|
||||
# specs, so use truncation strategy.
|
||||
DatabaseCleaner.strategy = :truncation
|
||||
end
|
||||
end
|
||||
|
||||
config.before(:each) do
|
||||
DatabaseCleaner.start
|
||||
end
|
||||
|
||||
|
|
Loading…
Reference in a new issue