testing

バックエンドテスト規約

RSpec

• Factory Bot: テストデータ作成

テスト実装のルール

RSpec ルール

• テスト対象となるメソッドやスコープは、subjectを使用して定義する

  • subjectは、テストの意図が明確になるようにし、describeの直後に定義する

• ActiveRecord/ActiveModelのオブジェクトを検証する時は、なるべく have_attributes を使うことで、まとめて検証を行う。

• FactoryBotを使用してテストデータを作成する

  # Bad
  expect(thing.name).to eq name
  expect(thing.hoge).to eq hoge
  expect(thing.email).to eq email
  
  # Good
  expect(thing).to have_attributes(
    name,
    hoge,
    email,
  )
  

同じケースに対するテスト

• 同じケースに対する複数の検証は、可能な限り1つの it ブロックにまとめる
• 複数の it ブロックに分けるのではなく、1つの it ブロックで複数の expect を使用する
• it の行数が長くなる場合は、一定の塊にわけて記述し、塊の先頭に説明をコメントで記述する

# 良い例
it "ユーザーが正しく作成されること" do
  subject
  expect(user.name).to eq "山田太郎"
  expect(user.email).to eq "[email protected]"
  expect(user.active).to be true
end

# 良くない例
it "nameが正しく設定されること" do
  subject
  expect(user.name).to eq "山田太郎"
end

it "emailが正しく設定されること" do
  subject
  expect(user.email).to eq "[email protected]"
end

it "activeがtrueであること" do
  subject
  expect(user.active).to be true
end

テストデータの作成（FactoryBot）

全般

• ./spec/factories にファイルを作成する
• ファイル名はモデル名の複数形でスネークケースとする。ネームスペースがある場合は、ネームスペースでディレクトリを分ける 例1: Fruitモデルの場合は、spec/factories/fruits.rb 例2: Food::Fruitモデルの場合は、spec/factories/food/fruits.rb
• factory はモデルごとにファイルを分けてください
• factory名はモデル名のスネークケースとする。ネームスペースがある場合は、アンダースコアで繋げる 例: Food::Fruitモデルの場合は、food_fruitとする

Factoryの実装

• それぞれの値はなるべくすべて設定する
  • nilをテストする場合はテストでfactoryを上書きする
• それぞれの値はなるべくランダム値を設定する

# 良い例
FactoryBot.define do
  factory :fruit do
    name { ["りんご", "みかん", "レモン"].sample }
    active { [true, false].sample }
  end
end

# 良くない例
FactoryBot.define do
  factory :fruit do
    name { "りんご" }
    active { true }
  end
end

関連付けの実装

• 関連付けは外部キーをもつモデルにのみデフォルトで記述する。
• 外部キーをもたないモデルはtraitで記述する。
  • デフォルトでは with_associations というtraitを記述し、すべての関連するモデルを作成する
  • 個別にモデルを作成する必要がある場合は別途traitを作成し、 trait名は with_{association}とする

trait :with_users do
  users { build_list(:user, 2) }
end