Question

我正在使用rspec请求来测试需要在每个请求的标头中使用api-key的JSON API。

我知道我可以这样做：

get "/v1/users/janedoe.json", {}, { 'HTTP_AUTHORIZATION'=>"Token token=\"mytoken\"" }

但为每个请求执行此操作非常繁琐。

我尝试在前一个块中设置request.env，但由于请求不存在，我得到了no method NilClass error。

我需要某种方式，可能在spec-helper中，全局获取此标头随所有请求一起发送。

Answer 1

要在之前的挂钩中设置它，您需要像

一样访问它

config.before(:each) do
  controller.request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Token.encode_credentials('mytoken')
end

我也讨厌巨型哈希，但更喜欢在不同的步骤中明确授权用户。毕竟，它是一个非常重要的部分，而且。所以我的解决方案是：

#spec/helpers/controller_spec_helpers.rb
module ControllerSpecHelpers
  def authenticate user
    token = Token.where(user_id: user.id).first || Factory.create(:token, user_id: user.id)
    request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Token.encode_credentials(token.hex)
  end
end

#spec/spec_helper.rb
RSpec.configure do |config|
  ...
  config.include ControllerSpecHelpers, :type => :controller

然后我可以像这样使用它

describe Api::V1::Users, type: :controller do
  it 'retrieves the user' do
    user = create :user, name: "Jane Doe"
    authorize user
    get '/v1/users/janedoe.json'
  end
end

我觉得这非常适合测试不同的授权级别。或者，您可以使用辅助方法指定授权函数并获得相同的结果，如此

#spec/helpers/controller_spec_helpers.rb
module ControllerSpecHelpers
  def authenticate
    controller.stub(:authenticate! => true)
  end
end

然而，为了获得极致的速度和控制，你可以将它们结合起来

#spec/helpers/controller_spec_helpers.rb
module ControllerSpecHelpers
  def authenticate user = nil
    if user
      token = Token.where(user_id: user.id).first || Factory.create(:token, user_id: user.id)
      request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Token.encode_credentials(token.hex)
    else
      controller.stub(:authenticate! => true)
    end
  end
end

然后使用

授权整个块

#spec/spec_helper.rb
...
RSpec.configure do |config|
  ...
  config.before(:each, auth: :skip) { authenticate }

#**/*_spec.rb
describe Api::V1::Users, type: :controller do
  context 'authorized', auth: :skip do
    ...

Answer 2

如果您正在发帖，这是另一种方法。

@authentication_params = { 'HTTP_AUTHORIZATION' => ActionController::HttpAuthentication::Token.encode_credentials(Temp::Application.config.api_key) }

expect { post "/api/interactions", @interaction_params, @authentication_params }.to change(Interaction, :count).by(1)

注意interaction_params只是我传入的json对象。

Answer 3

我知道这个问题已经得到了回答，但这是我的看法。对我有用的东西：

request.headers['Authorization'] = token

而不是：

request.env['Authorization'] = token

Answer 4

如果您没有测试标头本身，我认为您不应该依赖于标头，您应该存根检查HTTP_AUTORIZATION是否存在的方法并使其对所有规格都返回true，除了测试该特定的规范头

像......这样的...... 在控制器上

Controller...
  before_filter :require_http_autorization_token

  methods....

  protected
  def require_http_autorization_token
    something
  end

在规范

上

before(:each) do
  controller.stub!(:require_http_autorization_token => true)
end

describe 'GET user' do
  it 'returns something' do
    #call the action without the auth token
  end

  it 'requires an http_autorization_token' do
    controller.unstub(:require_http_autorization_token)
    #test that the actions require that token
  end
end

这样可以忘记令牌并测试你真正想要测试的内容

RSpec请求 - 如何为所有请求设置http授权标头

4 个答案: