Как проверить ответ JSON с помощью RSpec?

у меня есть следующий код в мой контроллер:

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

Я неправильно проверяю ответ?

136
json rspec ruby-on-rails

10 ответов

вы можете изучить объект ответа и убедиться, что он содержит ожидаемое значение:

@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 или необходим реальный экземпляр модели.

158

вы можете проанализировать тело ответа следующим образом:

parsed_body = JSON.parse(response.body)

затем вы можете сделать свои утверждения против этого проанализированного содержимого.

parsed_body["foo"].should == "bar"
148

строительство ответ Кевина Троубриджа

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

есть еще радио счастья. камень, который стоит посмотреть

https://github.com/collectiveidea/json_spec

32

простой и легкий способ сделать это.

# 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
10

другой подход к тестированию только для ответа JSON (не то, что содержимое внутри содержит ожидаемое значение) заключается в анализе ответа с помощью ActiveSupport:

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

Если ответ не является анализируемым JSON, будет создано исключение, и тест завершится ошибкой.

7

вы могли бы заглянуть в 'Content-Type' заголовок, чтобы увидеть, что это правильно?

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

вы также можете определить вспомогательную функцию внутри spec/support/

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

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

и использовать json_body всякий раз, когда вам нужно получить доступ к JSON-ответ.

например, внутри вашей спецификации запроса вы можете использовать ее напрямую

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
5

при использовании Rails 5 (в настоящее время все еще в бета-версии) есть новый метод, parsed_body на тестовом ответе, который вернет ответ, проанализированный как то, на что был закодирован последний запрос.

фиксация на GitHub:https://github.com/rails/rails/commit/eee3534b

4

Я нашел здесь сопоставление клиентов: 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