使用devise-jwt时如何在身份验证前生成token用于Cypress测试？

以下方案均适配Rails + React + Cypress 技术栈，完全满足测试原子性要求，无需预先植入固定用户：

方案1：测试环境豁免用户创建接口的JWT校验 #

如果仅创建用户的接口需要提前持有Token，可直接在测试环境跳过该接口的认证逻辑，无需修改生产环境配置：

• 找到用户创建接口对应的控制器，修改authenticate_user!前置校验逻辑：

# app/controllers/users_controller.rb
before_action :authenticate_user!, only: [:create], unless: -> { Rails.env.test? }

• 如果你用的是devise-jwt的全局路由校验，可在初始化配置中添加跳过规则：

# config/initializers/devise_jwt.rb
Devise.setup do |config|
  config.jwt do |jwt|
    # 其他原有配置
    jwt.request_formats = { user: [:json] }
    jwt.skip = ->(env) do
      Rails.env.test? && 
        env['PATH_INFO'] == '/users' && 
        env['REQUEST_METHOD'] == 'POST'
    end
  end
end

改完后测试环境下直接发送POST请求创建用户即可，不需要携带Token。

方案2：测试环境新增专属Token生成端点 #

如果你的业务逻辑要求必须有管理员权限才能创建用户，可以仅在测试环境挂载一个无认证的Token生成接口，调用时返回合法的管理员Token：

• 新增仅测试环境生效的路由：

# config/routes.rb
if Rails.env.test?
  post '/test/generate_admin_token', to: 'test_utils#generate_admin_token'
end

• 实现对应控制器逻辑，直接用devise-jwt内置编码器生成Token：

# app/controllers/test_utils_controller.rb
class TestUtilsController < ApplicationController
  skip_before_action :authenticate_user!

  def generate_admin_token
    # 临时生成管理员用户，测试结束后数据库重置会自动清除
    admin = User.create!(
      email: "test_admin_#{SecureRandom.uuid}@example.com",
      password: 'testpass123',
      role: :admin
    )
    token = Devise::JWT::Encoder.encode(
      payload: { sub: admin.id, exp: 24.hours.from_now.to_i },
      user: admin
    )[0]
    render json: { token: token }
  end
end

Cypress测试运行时先请求该接口拿到Token，再携带Token创建测试用户即可。

方案3：Cypress Task直接调用Rails接口生成Token（推荐） #

该方案完全不修改业务代码，也不需要额外加测试接口，最符合测试原子性要求：

• 先在Cypress配置中新增自定义Task，用于调用Rails命令行生成用户和对应Token：

// cypress.config.js
const { defineConfig } = require('cypress')
const { execSync } = require('child_process')

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      on('task', {
        generateTestUserToken(userParams = {}) {
          const params = JSON.stringify(userParams).replace(/"/g, '\\"')
          const command = `rails runner "
            user_params = JSON.parse('${params}')
            default_params = { email: \"test_#{SecureRandom.uuid}@example.com\", password: 'testpass123' }
            user = User.create!(default_params.merge(user_params))
            token = Devise::JWT::Encoder.encode(payload: { sub: user.id }, user: user)[0]
            puts JSON.generate({ token: token, user: user.as_json })
          "`
          const result = execSync(command).toString()
          return JSON.parse(result)
        }
      })
    },
  },
})

• 测试用例中直接调用该Task即可直接拿到可用的Token和用户数据：

// cypress/e2e/your_test.cy.js
describe('你的测试场景', () => {
  it('测试用例', () => {
    cy.task('generateTestUserToken', { role: 'admin' }).then(({ token, user }) => {
      // 携带Token发起创建用户等请求
      cy.request({
        method: 'POST',
        url: '/users',
        headers: { Authorization: `Bearer ${token}` },
        body: { /* 新用户参数 */ }
      })
    })
  })
})

该方案生成的所有用户都会在每个测试开始前的数据库重置环节被清除，完全无遗留依赖。

内容的提问来源于stack exchange，提问作者msmith1114