如何使用RSpec编写GitLab Pages域名验证API的成功场景测试

你直接 stub PagesDomains.is_page_domain_verified 触发NoMethodError的核心原因是：Grape API 定义的 helper 方法属于实例方法，会混入到API端点的执行上下文里，API::PagesDomains类本身没有这个类方法，直接 stub 类方法自然找不到对应定义。

GitLab 基于 RSpec 的 API 测试可以用以下两种方案实现 stub：

方案1：直接 stub API 实例方法（适用方法直接写在API类的helper块的场景） #

# 前置数据准备可复用你原有失败用例的配置
let(:project) { create(:project, :pages_enabled) }
let(:domain) { create(:pages_domain, project: project) }
let(:current_user) { create(:user, maintainer_of: project) }

before do
  # 匹配API实例的方法调用，返回true
  allow_any_instance_of(API::PagesDomains)
    .to receive(:is_page_domain_verified)
    .with(domain)
    .and_return(true)
end

it 'returns success when domain is verified' do
  get api("/projects/#{project.id}/pages/domains/#{domain.domain}/verify", current_user)

  expect(response).to have_gitlab_http_status(:ok)
  expect(json_response['verification']['status']).to eq('success')
end

方案2：Stub 独立 Helper 模块（适用方法抽离到独立Helper模块的场景） #

如果你将is_page_domain_verified定义在独立的 helper 模块（比如API::Helpers::PagesDomains），可以用更精准的 stub 方式，避免allow_any_instance_of的全局影响：

before do
  allow(API::Helpers::PagesDomains)
    .to receive(:is_page_domain_verified)
    .with(domain)
    .and_return(true)
end

• 如果你的方法调用时传参和你stub的参数不匹配，可以添加.with(any_args)匹配任意参数
• 单测执行完成后如果需要恢复原有方法逻辑，可以添加.and_call_original避免影响其他用例

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