Rails/RSpec测试中Capybara默认驱动被忽略问题排查

问题场景 #

想要配置RSpec/Capybara系统测试：

• 默认以无头模式运行测试
• 当测试标记js:true时，切换为标准有头Chrome浏览器，方便观察测试执行、排查失败原因

但按现有配置设置Capybara.default_driver和Capybara.javascript_driver为:selenium_chrome后，带js:true的测试依然使用selenium_chrome_headless驱动，只有手动在测试里设置current_driver才会启动有头浏览器。

原因分析 #

当测试类型为type: :system时，RSpec Rails的系统测试框架会通过driven_by机制管理驱动，这个机制会覆盖你直接设置的Capybara全局驱动配置。也就是说，你在rails_helper.rb里设置的Capybara.default_driver和Capybara.javascript_driver不会自动应用到系统测试上。

解决方案 #

在RSpec的配置块中，针对type: :system的测试，根据js标记动态切换驱动：

1. 注册自定义Chrome驱动（可选，如需自定义浏览器选项） #

如果需要自定义浏览器行为（比如启动时最大化窗口），取消你注释的驱动注册代码并调整：

Capybara.register_driver :chrome do |app|
  options = Selenium::WebDriver::Chrome::Options.new
  options.add_argument('--start-maximized') # 自定义选项
  Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
end

# 注册无头驱动（如果需要自定义无头选项）
Capybara.register_driver :chrome_headless do |app|
  options = Selenium::WebDriver::Chrome::Options.new
  options.add_argument('--headless=new') # 新版无头模式
  options.add_argument('--disable-gpu')
  Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
end

2. 配置系统测试的驱动切换逻辑 #

在RSpec.configure块中添加以下代码，针对系统测试动态选择驱动：

RSpec.configure do |config|
  # ... 其他现有配置 ...

  # 系统测试驱动切换逻辑
  config.before(:each, type: :system) do
    if example.metadata[:js]
      driven_by :chrome # 或默认的:selenium_chrome
    else
      driven_by :chrome_headless # 或默认的:selenium_chrome_headless
    end
  end
end

如果不需要自定义驱动，直接使用Capybara默认注册的驱动，也可以简化为：

RSpec.configure do |config|
  # ... 其他现有配置 ...

  config.before(:each, type: :system) do
    driven_by example.metadata[:js] ? :selenium_chrome : :selenium_chrome_headless
  end
end

3. 移除无效的全局驱动设置 #

可以删除之前设置的全局驱动配置，因为现在通过driven_by管理：

# 移除这两行
# Capybara.default_driver = :selenium_chrome
# Capybara.javascript_driver = :selenium_chrome

验证修改 #

修改后重新运行带js:true的测试，你会看到Capybara.current_driver变为:selenium_chrome（或你自定义的:chrome），同时标准Chrome浏览器会自动弹出，方便你观察测试执行过程。

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