web-dev-qa-db-fra.com

Comment vérifier une réponse JSON à l'aide de RSpec?

J'ai le code suivant dans mon contrôleur:

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

Dans mon test de contrôleur RSpec, je veux vérifier qu'un scénario donné reçoit une réponse JSON réussie. J'ai donc la ligne suivante:

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

Bien que lorsque j'exécute mes tests, l'erreur suivante apparaît:

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

Est-ce que je vérifie la réponse de manière incorrecte?

ruby-on-railsjsonrspec
139
Fizz

Vous pouvez examiner l'objet de réponse et vérifier qu'il contient la valeur attendue:

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

EDIT

Changer ceci en post le rend un peu plus compliqué. Voici un moyen de le gérer:

 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

Notez que mock_model ne répond pas à to_json. Par conséquent, stub_model ou une instance de modèle réelle est nécessaire.

161
zetetic

Vous pouvez analyser le corps de la réponse comme ceci:

parsed_body = JSON.parse(response.body)

Ensuite, vous pouvez faire vos affirmations contre ce contenu analysé.

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

Construire à partir de réponse de Kevin Trowbridge

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

Il y a aussi le gem json_spec , qui vaut le détour

https://github.com/collectiveidea/json_spec

34
acw

Simple et facile de faire cela.

# 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

Vous pourriez regarder dans l'en-tête 'Content-Type' pour voir qu'il est correct?

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

Vous pouvez également définir une fonction d'assistance dans spec/support/

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

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

et utilisez json_body chaque fois que vous devez accéder à la réponse JSON.

Par exemple, dans votre spécification de demande, vous pouvez l'utiliser directement.

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
Lorem Ipsum Dolor

Une autre approche permettant de tester uniquement une réponse JSON (le contenu ne contient pas une valeur attendue) consiste à analyser la réponse à l'aide d'ActiveSupport:

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

Si la réponse n'est pas JSON analysable, une exception sera levée et le test échouera.

7
Clinton

Lorsque vous utilisez Rails 5 (toujours en version bêta), il existe une nouvelle méthode, parsed_body sur la réponse au test, qui renverra la réponse analysée de la même manière que la dernière demande a été codée.

Le commit sur GitHub: https://github.com/Rails/rails/commit/eee3534b

4
Koen.

Si vous souhaitez tirer parti du hachage fourni par Rspec, il est préférable d'analyser le corps et de le comparer à un hachage. Le moyen le plus simple que j'ai trouvé:

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

J'ai trouvé un client matcher ici: https://raw.github.com/Gist/917903/92d7101f643e07896659f84609c117c4c279dfad/have_content_type.rb

Mettez-le dans spec/support/matchers/have_content_type.rb et assurez-vous de charger des éléments du support avec quelque chose comme ceci dans spec/spec_helper.rb

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

Voici le code lui-même, juste au cas où il aurait disparu du lien donné.

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