FactoryGirlをFixturesで置き換えた話

Transcript

1. FactoryGirlをFixturesで置き 換えた話 Ginzarb 第15回 @y-yagi
2. 前提 置き換えたアプリは単純なTodo管理用のWebサービス 中身は対して無い 元々の構成は Minitest × FactoryGirl
3. 動機 を読ん で、あー、確かに、という部分が多かったので 日本語訳版は 7-reasons-why-im-sticking-with-minitest-and-fixtures-in-rails こちら
4. 7-reasons-why-im-sticking-with-minitest- and-fixtures-in-rails 1. Fixtures force you to test against “real” data 2. Rspec provides more than one way to do something 3. Setting up Capybara is trivial 4. Lack of complex stubbing/mocking constructs simplifies code 5. Snippets can help the uncertainty about Minitest assertion order 6. Minitest is just Ruby 7. Deviating from Rails defaults doesn’t always provide value
5. 'Fixtures force you to test against “real” data'
6. "本当のデータ"でやってみる の良さそうな気がする
7. とはいえ、Fixturesで何が出来 るかよく分かってない
8. まずは、Fixturesで何が出来る のかを調べる
9. Fixturesについて(1) "Fixtures are a way of organizing data that you want to test against; in short, sample data." YAMLファイル モデル毎に1ファイル 格納先は "/test/fixtures/" (ActiveSupport::TestCase.fixture_path で 変更可能) # web_sites.yml rubyonrails: id: 1 # IDは自動生成してくれるので、書かないでもOK name: Ruby on Rails url: http://www.rubyonrails.org google: id: 2 name: Google url: http://www.google.com
10. Fixturesについて(2) テスト環境では、テスト実行前に自動でDBに格納される delete / insert データアクセス用のメソッドも用意されている use_instantiated_fixtures を設定することで、インスタンスの生 成も行われる # web_sites.yml rubyonrails: id: 1 name: Ruby on Rails url: http://www.rubyonrails.org web_sites(:rubyonrails).name # => Ruby on Rails
11. Fixturesについて(3) erb記法が使える # tags.yml ruby: name: ruby created_at: <%= 3.days.ago %> <% 10.times do |i| %> tag_<%= i %>: name: tag<%= i %> <% end %> こんなんがいける
12. Fixturesについて(4) 更にfixture用のヘルパーメソッドも定義可能 ※4.1から使用可能 module FixtureFileHelpers def file_sha(path) Digest::SHA2.hexdigest(File.read(Rails.root.join('test/fixtures', path))) end end ActiveRecord::FixtureSet.context_class.send :include, FixtureFileHelpers photo: name: kitten.png sha: <%= file_sha 'files/kitten.png' %>
13. やり過ぎ注意 Fixturesは、あくまで実際使う(であろう)固定のデータを使用すべき。 動的にデータを設定するのは、基本的には良くない。
14. Fixturesについて(5) アソシエーションはラベル名で定義出来る # authros.yml hyuki: name: 結城浩 matz: name: まつもとゆきひろ # tags.yml programming: name: プログラミング ruby: name: ruby # books.yml コードの未来: name: コードの未来 published_at: 2012­05­12 author: matz tags: programming, ruby 秘密の国のアリス: name: 秘密の国のアリス published_at: 2003­09­30 author: hyuki
15. Fixturesについて(6) YAMLのマージ機能も使える "DEFAULTS"というラベルの値は無視される # stores.yml DEFAULTS: &DEFAULTS closed: false MIYAWAKI_GROUP: &MIYAWAKI_GROUP <<: *DEFAULTS group_id: 10 iwase: <<: *DEFAULTS name: 岩瀬書店 address: どこか miyawaki_honten: <<: *MIYAWAKI_GROUP name: 宮脇書店 本店 address: どこか2 上記例の場合、"DEFAULT"のデータは出来ない が、"MIYAWAKI_GROUP"のデータは出来てしまう
16. Fixturesについて(7) ラベル名で値の定義が出来る matz: name: まつもとゆきひろ is $LABEL test: name: $LABEL nameが"test"というデータと、"まつもとゆきひろ is matz"というデータ が作成される
17. Fixturesについて(最後) primary keyは自動採番してくれる TimeStamp関係のカラムを勝手に埋めてくれる +created_at+, +created_on+, +updated_at+, +updated_on+ ActiveRecordのvalidation/callbackは実施されない
18. Fixturesの話はここまで。ここ からは実際の置き換え作業に ついて。
19. FactoryGirl to Fixtures 今あるFactoryを元にFixturesをモクモクと作成 動的生成の部分は極力固定データに FactoryGirl.createしていた処理をアクセス用メソッドに書き換 え FactoryGirl.buildついては普通のインスタンス生成処理に置 換 一部アクセス用メソッドでごまかした箇所もある テスト用のhelperファイルを整理
20. Good DatabaseCleaner周りの処理を消せたので、helperファイルは少し スッキリした FactoryGirl.create処理をテストから消せたので少しスッキリ ランダムなデータでは無く、"実際使うデータ"で考えるようにする の、個人的にはとても良い 別にFactoryGirl使っても出来るんじゃね、という話はある
21. Bad でかいTableのデータを作る時は、やはりtraitが欲しくなる マージ機能である程度誤魔化せる気はするが、要らんデータ が生成されてしまうのがちょっと気になる そもそもでかいTable作るな、という話もあるが 今回は使わなかったが、ちょっと複雑なインスタンス生成処理が 必要になった時、生成用のヘルパーメソッドが欲しくなりそうな気 がする
22. 事前に質問貰った件について
23. yml作るの面倒ではなかったか? 個人的には特に気にならなかった 一つ一つのテーブルが小さかったというのもある でかいテーブルだと大変そう これはFactoryGirlでも変わらないか
24. 関連周りは? ラベル名で定義できるので、個人的にはむしろやりやすかった 名前重要 # authros.yml hyuki: name: 結城浩 matz: name: まつもとゆきひろ # books.yml コードの未来: name: コードの未来 price: 2800 published_at: 2012­05­12 author: matz tags: programming, ruby 秘密の国のアリス: name: 秘密の国のアリス price: 3240 published_at: 2003­09­30 author: hyuki
25. アプリが大きくなった時対応しきれるか? ラベル名がちゃんと管理出来てればいけそう とりあえず"DEFAULTS"をマージしておくと良さそう あとでカラムの追加があった時に、"DEFAULTS"に追加する だけで逃げれる
26. まとめ (意外と)Fixturesは色々やれる アソシエーションの定義大分楽 データ生成の部分で困る事がありそうな気がする。FactoryGirlと の併用もありかも。(ヘルパーメソッドあれば良い気もするが) "Rails 標準機能"なので、Railsのバージョンアップを恐れる事は 無い。多分。いや、どうだろ。 Railsのテストでも使われているので、少なからずいきなり動か なくなる事は無い "Deviating from Rails defaults doesn’t always provide value" "Railsのデフォルトから外れる事が良い事とは限らない"
27. ご清聴有難う御座いました