DatabaseCleanerの設定内容がよくわかりません

Question

railsでRspecを使っていますが、テストデータベースをexampleごとにクリーンにするためにDatabaseCleanerを使いたいと思っています。

こちらのDatabaseCleanerのREADMEにはrspecでDatabaseCleanerを使う場合の例が載っていますが、各ブロックで何をやっているのかいまいち理解できませんでした。

Everyday Rails - RSpecによるRailsテスト入門にもREADMEとほぼ同じ内容の下記設定がありますが、この説明文を見ても理解できません。

RSpec.configure do |config|
  # Configure DatabaseCleaner to reset data between tests
  config.before(:suite) do
    DatabaseCleaner.strategy = :transaction
    DatabaseCleaner.clean_with :truncation
  end

  config.around(:each) do |example|
    DatabaseCleaner.cleaning do
      example.run
    end
  end

  config.after(:each) do
    DatabaseCleaner.clean
  end
end

よく理解できない点

config.before(:suite) ブロック

各example前にトランザクションでロールバックして、次にトランケートでデータの全件削除をしていると思いますが、何故このように2段階の処理をする必要があるのか?

config.around(:each)ブロック

• config.aroundが何のブロックかわからない
• DatabaseCleaner.cleaningブロックはDatabaseCleaner.startとDatabaseCleaner.cleanをするブロックだと思うが、本当にそうなのかよくわからない
• example.runの意味がわからない

config.after(:each)ブロック

example後にデータの削除をしているのだと思うのですが、前述のconfig.before(:suite)でデータの削除を事前にするのに、何故事後にもわざわざ削除をしようとしているかがわからない

---

各ブロックでやっていることや関連性についてご教示いただければ幸いです。

Answer 1

config.before(xxx) は DatabaseCleaner ではなくRSpecのフックです。
フックスコープのための新しい名前: :example と :context にわかりやすく書いてありました。

c.before(:each)  { } # 全てのテストスイート中のそれぞれのexampleの前に実行される
c.before(:all)   { } # それぞれのトップレベルのグループの最初のexampleの前に実行される
c.before(:suite) { } # 全てのspecファイルがロードされたあと、最初のspecが実行される前に一度だけ実行される

で、その各フックのブロックの中に書いてあるものが DatabaseCleaner に関するものです。

  config.before(:suite) do
    DatabaseCleaner.strategy = :transaction
    DatabaseCleaner.clean_with :truncation
  end

は、どのようにDatabaseCleanerを動作させるかの設定です。
最初に1回だけやればいいので before(:suite) です。

  config.around(:each) do |example|
    DatabaseCleaner.cleaning do
      example.run
    end
  end

こちらが実施にDataBaseCleanerを動かすところ
example毎にDatabaseCleanerをstartさせて example を実行し DatabaseCleaner で clean する動きです。

  config.after(:each) do
    DatabaseCleaner.clean
  end

こちらも実施にDataBaseCleanerを動かすところですが
DatabaseCleanerをstartさせず example を実行し DatabaseCleaner で clean する動きです。

最後の config.after はたぶん例のために書いてあるだけで実際は config.around が書いてあれば不要だと思います。

最新の例も

RSpec.configure do |config|

  config.before(:suite) do
    DatabaseCleaner.strategy = :transaction
    DatabaseCleaner.clean_with(:truncation)
  end

  config.around(:each) do |example|
    DatabaseCleaner.cleaning do
      example.run
    end
  end

end

config.afterは書いてないですね。

---

Readmeをみると、start clean cleaningの３つが、書かれているのですが、どのように使いわけるのでしょうか。

READMEに書いてありますが。。。

startは

Some strategies need to be started before tests are run (for example the :transaction strategy needs to know to open up a transaction). This can be accomplished by calling DatabaseCleaner.start at the beginning of the run, or by running the tests inside a block to Database.cleaning.

という事です。
strategies によっては事前処理が必要でそれを行うのが DatabaseCleaner.start です。

で実際に削除を行うのが DatabaseCleaner.clean

そんでもって Database.cleaning は block を実行する前に DatabaseCleaner.start して 終ったら DatabaseCleaner.clean してくれるそうです。

Comments

[shyamahira]

大変よく理解できました。ありがとうございました。

ただ、'DatabaseCleanerをstartさせる' とはどのような意味があるのかがまだモヤっとしています。

Readmeをみると、start clean cleaningの３つが、書かれているのですが、どのように使いわけるのでしょうか。

[shyamahira]

> strategies によっては事前処理が必要でそれを行うのが DatabaseCleaner.start です。
> で実際に削除を行うのが DatabaseCleaner.clean
> そんでもって Database.cleaning は block を実行する前に DatabaseCleaner.start して 終ったら DatabaseCleaner.clean してくれるそうです。

すみません。READMEをちゃんと読んでませんた。

ご回答ありがとうございました。