web-dev-qa-db-ja.com

RSpecを使用してJSON応答を確認する方法は？

コントローラーに次のコードがあります。

format.json { render :json => { 
        :flashcard  => @flashcard,
        :lesson     => @lesson,
        :success    => true
}

RSpecコントローラーテストでは、特定のシナリオが成功のjson応答を受信することを確認したいので、次の行がありました。

controller.should_receive(:render).with(hash_including(:success => true))

テストを実行すると、次のエラーが表示されます。

Failure/Error: controller.should_receive(:render).with(hash_including(:success => false))
 (#<AnnoController:0x00000002de0560>).render(hash_including(:success=>false))
     expected: 1 time
     received: 0 times

応答を間違ってチェックしていますか？

ruby-on-railsjsonrspec
138
Fizz

応答オブジェクトを調べて、期待値が含まれていることを確認できます。

@expected = { 
        :flashcard  => @flashcard,
        :lesson     => @lesson,
        :success    => true
}.to_json
get :action # replace with action name / params as necessary
response.body.should == @expected

編集

これをpostに変更すると、少し複雑になります。これを処理する方法を次に示します。

 it "responds with JSON" do
    my_model = stub_model(MyModel,:save=>true)
    MyModel.stub(:new).with({'these' => 'params'}) { my_model }
    post :create, :my_model => {'these' => 'params'}, :format => :json
    response.body.should == my_model.to_json
  end

mock_modelはto_jsonに応答しないため、stub_modelまたは実際のモデルインスタンスのいずれかが必要です。

160
zetetic

次のように応答本文を解析できます。

parsed_body = JSON.parse(response.body)

次に、解析されたコンテンツに対してアサーションを作成できます。

parsed_body["foo"].should == "bar"
153
brentmc79

Kevin Trowbridge's answer からの構築

response.header['Content-Type'].should include 'application/json'
45
lightyrs

json_specgemもあります。

https://github.com/collectiveidea/json_spec

34
acw

これを行う簡単で簡単な方法。

# set some variable on success like :success => true in your controller
controller.rb
render :json => {:success => true, :data => data} # on success

spec_controller.rb
parse_json = JSON(response.body)
parse_json["success"].should == true
11
Chitrank Samaiya

'Content-Type'ヘッダーを調べて、正しいことを確認できますか？

response.header['Content-Type'].should include 'text/javascript'
7
Kevin Trowbridge

spec/support/内でヘルパー関数を定義することもできます

module ApiHelpers
  def json_body
    JSON.parse(response.body)
  end
end

RSpec.configure do |config| 
  config.include ApiHelpers, type: :request
end

jSONレスポンスにアクセスする必要があるときはいつでもjson_bodyを使用します。

たとえば、リクエスト仕様内で直接使用できます

context 'when the request contains an authentication header' do
  it 'should return the user info' do
    user  = create(:user)
    get URL, headers: authenticated_header(user)

    expect(response).to have_http_status(:ok)
    expect(response.content_type).to eq('application/vnd.api+json')
    expect(json_body["data"]["attributes"]["email"]).to eq(user.email)
    expect(json_body["data"]["attributes"]["name"]).to eq(user.name)
  end
end
7
Xinyang Li

JSON応答のみをテストする別のアプローチ（中のコンテンツに期待される値が含まれていないこと）は、ActiveSupportを使用して応答を解析することです：

ActiveSupport::JSON.decode(response.body).should_not be_nil

応答が解析可能なJSONでない場合、例外がスローされ、テストは失敗します。

7
Clinton

Rails 5（現在まだベータ版）を使用する場合、テストレスポンスにparsed_bodyという新しいメソッドがあり、最後のリクエストがエンコードされたものとして解析されたレスポンスを返します。

GitHubのコミット： https://github.com/Rails/rails/commit/eee3534b

4
Koen.

Rspecが提供するハッシュdiffを利用したい場合は、本文を解析してハッシュと比較することをお勧めします。私が見つけた最も簡単な方法：

it 'asserts json body' do
  expected_body = {
    my: 'json',
    hash: 'ok'
  }.stringify_keys

  expect(JSON.parse(response.body)).to eql(expected_body)
end
1
Damien Roche

ここに顧客マッチャーを見つけました： https://raw.github.com/Gist/917903/92d7101f643e07896659f84609c117c4c279dfad/have_content_type.rb

それをspec/support/matchers/have_content_type.rbに置き、spec/spec_helper.rbでこのようなものをサポートからロードするようにしてください

Dir[Rails.root.join('spec/support/**/*.rb')].each {|f| require f}

これは、指定されたリンクから消えた場合に備えて、コード自体です。

RSpec::Matchers.define :have_content_type do |content_type|
  CONTENT_HEADER_MATCHER = /^(.*?)(?:; charset=(.*))?$/

  chain :with_charset do |charset|
    @charset = charset
  end

  match do |response|
    _, content, charset = *content_type_header.match(CONTENT_HEADER_MATCHER).to_a

    if @charset
      @charset == charset && content == content_type
    else
      content == content_type
    end
  end

  failure_message_for_should do |response|
    if @charset
      "Content type #{content_type_header.inspect} should match #{content_type.inspect} with charset #{@charset}"
    else
      "Content type #{content_type_header.inspect} should match #{content_type.inspect}"
    end
  end

  failure_message_for_should_not do |model|
    if @charset
      "Content type #{content_type_header.inspect} should not match #{content_type.inspect} with charset #{@charset}"
    else
      "Content type #{content_type_header.inspect} should not match #{content_type.inspect}"
    end
  end

  def content_type_header
    response.headers['Content-Type']
  end
end
0
Zeke Fast