更新日: 2014年3月14日
RSpec

RSpecでAjaxリクエストに対しRequest Spec（結合テスト）を行う

Request Spec で Ajax リクエストに対するテストを行う方法です。ちょっとはまりました。Controller Spec（spec/controllers）での Ajax リクエストに対するテストの情報はたくさん見つかりましたが、Controller Spec（コントローラーテスト）での Devise ユーザーのログインが上手くできず挫折..。

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

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

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

Controller Spec の場合 xhr メソッドの第二引数はアクション名を書きますが、Request Spec（結合テスト）の場合 xhr メソッドの第二引数には HTTP メソッド名（post や delete）に対応するパスを指定します。

Request Spec で Ajax リクエストをテストするコード

spec/requests/comment_pages_spec.rb

describe "Comment pages" do
  let(:user) { FactoryGirl.create(:user) }
  before { login user }
  subject { page }

  describe "Ajax request on CommentsController" do
    describe "creating a comment with Ajax" do

      it "should increment the Comment count" do
        expect do
          xhr :post, comments_path, comment: { message: "hello" }
        end.to change(Comment, :count).by(1)
      end

      it "should respond with success" do
        xhr :post, comments_path, comment: { message: "hello" }
        response.code.should == "200"
      end
    end

    describe "destroying a comment with Ajax" do
      before { FactoryGirl.create(:comment, user: user) }
      let(:comment) { user.comments.first }

      it "should decrement the Comment count" do
        expect do
          xhr :delete, comment_path(comment.id), id: comment.id
        end.to change(Comment, :count).by(-1)
      end

      it "should respond with success" do
        xhr :delete, comment_path(comment.id), id: comment.id
        response.code.should == "200"
      end
    end
  end
end

describe "Comment pages" do

let(:user) { FactoryGirl.create(:user) }

before { login user }

subject { page }

describe "Ajax request on CommentsController" do

describe "creating a comment with Ajax" do

it "should increment the Comment count" do

expect do

xhr :post, comments_path, comment: { message: "hello" }

end.to change(Comment, :count).by(1)

end

it "should respond with success" do

xhr :post, comments_path, comment: { message: "hello" }

response.code.should == "200"

end

describe "destroying a comment with Ajax" do

before { FactoryGirl.create(:comment, user: user) }

let(:comment) { user.comments.first }

it "should decrement the Comment count" do

expect do

xhr :delete, comment_path(comment.id), id: comment.id

end.to change(Comment, :count).by(-1)

end

it "should respond with success" do

xhr :delete, comment_path(comment.id), id: comment.id

response.code.should == "200"

end

Ajax の場合、expect(response).to be_success より、response.code.should == “200” のほうが、テスト失敗時にHTTPステータスコードが把握できるので分かりやすい。また、post, delete のリクエストで、Comment テーブルのレコード数が増減しているかをチェックしています。

FactoryGirl と login メソッドについて

省略していますが、FactoryGirl で User, Comment モデルのオブジェクトを生成させるファイルは以下のような感じ。

spec/factories.rb

FactoryGirl.define do
  factory :user do
    sequence(:name)  { |n| "Person #{n}" }
    sequence(:email) { |n| "person_#{n}@example.com"}
    password "hogefuga"
    password_confirmation "hogefuga"
  end

  factory :comment do
    message "good morning"
    user
  end
end