Rspec 使用请求和 rswag 测试登录（设计）时出现问题

Question

我很想使用 rswag 和 rspec 来记录 REST API 并同时编写测试。 我正在尝试阅读教程和文档，但我无法让登录端点正常工作（devise - session）。

当我运行 rspec 时，我收到状态代码错误。

require 'swagger_helper'
require 'rails_helper'
require 'shared_context'

describe 'Sonaaar REST API', type: :request do

...

  path '/users/sign_in' do
    post 'Sign In' do
      tags 'Session'
      consumes 'application/json'
      produces 'application/json'
      parameter name: :user, in: :body, schema: {
        type: :object,
        properties: {
          email: { type: :string },
          password: { type: :string },
        },
        required: ['email', 'password']
      }

     response '201', 'sign in', { 'HTTP_ACCEPT' => "application/json" } do
         response '201', 'sign in', { 'HTTP_ACCEPT' => "application/json" } do
        #
        # let(:user) do
        #   create(:user,  email: '[email protected]', password: 'Password1')
        # end
        #Error
        # Failure/Error:
        #        raise UnexpectedResponse,
        #          "Expected response code '#{response.code}' to match '#{expected}'\n" \
        #            "Response body: #{response.body}"
        #
        #      Rswag::Specs::UnexpectedResponse:
        #        Expected response code '401' to match '201'
        #        Response body: {"error":"You need to sign in or sign up before continuing."}


        let(:user) { { user: { login: '[email protected]', password: 'Password1' } } }
        # Rswag::Specs::UnexpectedResponse:
        #   Expected response code '401' to match '201'
        #   Response body: {"error":"You need to sign in or sign up before continuing."}
        #   /Users/filip/.rvm/gems/ruby-2.7.1/gems/rswag-specs-2.4.0/lib/rswag/specs/r
        run_test!
      end

我确实有 RSpec 错误：

1) Sonaaar REST API /users/sign_in post sign in returns a 201 response
     Failure/Error:
       raise UnexpectedResponse,
         "Expected response code '#{response.code}' to match '#{expected}'\n" \
           "Response body: #{response.body}"

     Rswag::Specs::UnexpectedResponse:
       Expected response code '401' to match '201'
       Response body: {"error":"You need to sign in or sign up before continuing."}

身份验证：JWT 令牌 内容类型：应用程序/json 堆叠/宝石：

• Ruby on Rails (Rails 6.1.2.1)
• 设计（4.7.3）
• devise-jwt (0.7.0)
• rspec-rails (4.0.2)
• rswag (2.4.0) - https://github.com/rswag/rswag

Answer 1

请求规范需要更多的帮助，而不仅仅是适用于功能规范的普通典狱长助手：

RSpec.configure do |config|
  config.include Warden::Test::Helpers
end

添加到

rails_helper

或其他文件并在rails_helper中要求：

module DeviseRequestSpecHelpers

  include Warden::Test::Helpers

  def sign_in(user)
    login_as(user, scope: :user)
  end

  def sign_out
    logout(:user)
  end

end

然后在

rails_helper

添加

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

您现在应该可以通过以下方式登录请求规范：

context 'some context' do
  scenario 'some scenario' do
    login_as(user)
  end
end

Answer 2

正如@sam所说，但实际上你可以只包括典狱长助手

RSpec.configure do |config|
  config.include Warden::Test::Helpers
end

然后

let(:admin) { create(:admin) } # for this case it's devise :admins

before do
  login_as(admin, scope: :admin)
end

# If you want to logout admin
after do
  logout(:admin)
end

it 'should return 200 'do
   get 'some_path_that_needs_session'
   expect(response).to have_http_status(200)
end

可以参考 [Warden::Test::Helpers] (https://www.rubydoc.info/github/hassox/warden/Warden/Test/Helpers) 文档

Answer 3

对于 RSpec，请使用 Devise 帮助程序方法 sign_in 在测试中对用户进行身份验证。

定义一个 header 方法如下：

def header(user)
  sign_in(user)
  { 'Authorization' => "Bearer #{user.jti}" }
end

在测试中包含 header 方法，并在向各种路径发出请求时将 header 方法分配给 headers 参数。

更详细的解释请阅读以下文章：

[https://medium.com/@cc.baqir/how-to-use-jwt-authentication-with-rspec-using-devise-jwt-1ee5d77d355f]