更新日: 2014年3月3日
RSpec

Rails モデルの RSpec 単体テストで validation と DB に対するテストを区別した

モデルの単体テストで validation と DB に対するテストで、describe ブロックを区別して書くように修正しました。

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

— 環境 —
rails-4.0.1
rspec-rails-2.14.0
capybara-2.2.0

以下の記事を読んだのがきっかけです。

それでは，ActiveRecord モデルの，どこの何をテストすればよいのでしょうか．先に答えを言ってしまうと，どこをテストするのかについては
・Validation
・データベース
です．
…
データベースに関するテストでは，
制約テスト
・CHECK
・NOT NULL
・UNIQUE
参照整合性テスト
・FOREIGN KEY
を行ないます．

Rails の ActiveRecord モデルテストの書き方ガイドライン – passingloopの日記

テストの書き方は超勉強中なので、こういう実践的な記事はとてもありがたい。これまで、validation と DB に対するテストは意識して書くようにしていて、それが正解なのを確認できたのは良かったです。しかし、両者のテストコードがごちゃ混ぜになっており、頭が混乱しがちでした。

describe ブロックを validation と DB で分けた

モデルの単体テスト（spec/models/user_spec.rb）で、validation に対するテストと DB に対するテストで describe ブロックを分けました。これで随分と見通しが良くなった。

spec/models/user_spec.rb

describe User do

  #...

  describe "with validation" do
    #...
  end

  describe "with DB" do
    describe "column having not-null constraint" do
      #...
    end
      
    describe "column having unique-key constraint" do
      #...
    end

    describe "column having foreign-key constraint" do
      #...
    end
  end

  #...
end

describe User do

#...

describe "with validation" do

#...

end

describe "with DB" do

describe "column having not-null constraint" do

#...

end

describe "column having unique-key constraint" do

#...

end

describe "column having foreign-key constraint" do

#...

end

#...

end

validation を RSpec でテスト

元記事は、Test::Unit を使われていますが、私は RSpec を使っているので、validation が invalid な場合に対する各々の具体的なテストは以下のように書く。

例えば、uid 属性が presence: true の validation なら以下。

describe "when uid is not present" do
  before { @user.uid = " " }
  it { should_not be_valid }
end

describe "when uid is not present" do

before { @user.uid = " " }

it { should_not be_valid }

end

uid が空の場合、it { should_not be_valid } で、@user が正当でないとテストできます。

データベースの例外発生を RSpec でテスト

再び引用。DB に対するテストについてです。

データベースに対するネガティブテストではデータベース例外の発生を確認します．具体的には，
・ActiveRecord::StatementInvalid … NOT NULL, CHECK 制約違反
・ActiveRecord::RecordNotUnique … UNIQUE 制約違反
・ActiveRecord::InvalidForeignKey … FOREIGN KEY 制約違反
が発生することを確認します．

Rails の ActiveRecord モデルテストの書き方ガイドライン – passingloopの日記

RSpec で例外発生をテストするのは次の書き方を使う。

expect do
  # do something
end.to raise_error( 例外クラス名 )

expect do

# do something

end.to raise_error( 例外クラス名 )

または、

lambda do
  # do something
end.should raise_error( 例外クラス名 )

lambda do

# do something

end.should raise_error( 例外クラス名 )

例えば DB の email カラムに unique 制約が付いているのをテストする場合は以下。

describe "with DB" do
    
  describe "column having unique-key constraint" do

    describe "when email address is already taken" do
      before { @user.save! }

      it "should raise error ActiveRecord::RecordNotUnique" do
        expect do
          user_with_same_email = @user.dup
          user_with_same_email.email = @user.email
          user_with_same_email.save!
        end.to raise_error( ActiveRecord::RecordNotUnique )
      end
    end

  end

  #...
end