如何用Ruby与Cucumber优雅测试异步行为？含邮件场景实践

问题背景 #

我正基于Ruby、Cucumber、Capybara和SitePrism搭建自动化测试项目，目标是构建清晰易维护的架构，但在测试异步行为时遇到了挑战。其中一个场景是：完成交易后，系统会将邮件放入队列异步发送给买家（耗时约1-3分钟）。测试环境中，已发送的邮件会被存储到数据库，我需要通过访问数据库、搜索邮件主题来断言收件人是否正确。

场景定义 #

Scenario: Send sale email
Given I'm logged in as "send_sale_email"
When I make a sale
Then the system should send a sale confirmation email

初始Step Definitions代码 #

Then "the system should send a sale confirmation email" do
  buyer_email = 'buyer_email@email.com'
  email_subject = "Sale confirmation #{@sale_number}"
  email_recipients = get_email_recipients(email_subject)
  expect email_recipients.to include(buyer_email)
end

问题在于交易完成后立即查询数据库时，邮件尚未发送。目前用重试+sleep的方式实现功能，但这种方式不够优雅，且系统内还有多个类似异步操作（如重新加载页面查找内容），虽然可以抽离重试逻辑复用，但担心长期维护问题，希望找到更精炼的异步测试方案。

优化方案 #

1. 复用Capybara的内置等待机制 #

Capybara本身为异步页面操作设计了自动重试逻辑，你可以把数据库查询的断言包装成符合Capybara等待规则的代码，或者直接使用Capybara.wait_for方法：

Then "the system should send a sale confirmation email" do
  buyer_email = 'buyer_email@email.com'
  email_subject = "Sale confirmation #{@sale_number}"
  
  Capybara.wait_for(180) do # 最长等待3分钟
    email_recipients = get_sent_email_recipients(email_subject)
    expect(email_recipients).to include(buyer_email)
  end
end

wait_for会自动捕获断言失败的异常，在超时前反复执行代码块，无需手动处理重试计数和sleep，逻辑更简洁。

2. 封装通用的异步断言工具类 #

如果有多个类似的异步场景，可以封装一个通用的重试方法，集中管理重试逻辑，避免代码重复：

# 在support/async_helper.rb中定义
module AsyncHelper
  def wait_for_assertion(timeout: 180, interval: 10)
    start_time = Time.now
    loop do
      begin
        yield
        return
      rescue RSpec::Expectations::ExpectationNotMetError, StandardError => e
        if Time.now - start_time > timeout
          raise e
        end
        sleep interval
      end
    end
  end
end

World(AsyncHelper) # 让Cucumber步骤可调用该方法

在Step中调用：

Then "the system should send a sale confirmation email" do
  buyer_email = 'buyer_email@email.com'
  email_subject = "Sale confirmation #{@sale_number}"
  
  wait_for_assertion(timeout: 180, interval: 30) do
    email_recipients = get_sent_email_recipients(email_subject)
    expect(email_recipients).to include(buyer_email)
  end
end

这种方式把重试逻辑集中维护，后续调整超时时间、重试间隔只需修改工具类，避免散落在各个Step里。

3. 调整测试环境的异步逻辑（推荐） #

如果测试环境允许，直接跳过队列异步等待，改成同步执行：

# 测试环境配置（如features/support/env.rb）
if ENV['RAILS_ENV'] == 'test'
  # 若使用Sidekiq队列，设置为同步执行
  Sidekiq::Testing.inline!
  # 若邮件系统支持同步发送，修改投递方式
  YourMailer.delivery_method = :sync
end

这样交易完成后邮件会立即发送，测试无需等待，速度更快，逻辑更简单，是最理想的异步测试优化方式。

4. 使用RSpec的retry特性 #

如果用RSpec作为断言库，可以开启RSpec的重试功能，针对特定测试自动重试：

# 在spec_helper.rb中配置
RSpec.configure do |config|
  config.around(:example, :retry) do |ex|
    ex.run_with_retry retry: 6, wait: 30
  end
end

需要注意的是，这种方式更适合RSpec示例，在Cucumber场景中需结合钩子使用，相对繁琐。

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