如何在Cypress中通过--user-data-dir参数运行带Chrome配置文件的自动化测试

之前Selenium里靠给ChromeOptions传--user-data-dir指定用户配置目录的逻辑，在Cypress里完全可以等价实现，本质都是把启动参数透传给底层拉起的Chrome进程，不需要搞复杂的自定义封装。

操作步骤 #

• 打开项目根目录的cypress.config.js（Cypress 10及以上版本的配置文件，更早的旧版本对应cypress/plugins/index.js入口文件）
• 在配置的节点事件中，拦截浏览器启动的前置钩子，给Chrome的启动参数追加你需要的配置路径，示例代码：

const { defineConfig } = require('cypress')
module.exports = defineConfig({
  e2e: {
    // 保留你原有的baseUrl、测试文件匹配规则等所有配置，不需要改动
    setupNodeEvents(on, config) {
      on('before:browser:launch', (browser, launchOptions) => {
        // 只对系统安装的Chrome生效，不影响其他Chromium内核浏览器的运行
        if (browser.name === 'chrome' && browser.family === 'chromium') {
          // 这行就等价于你之前Selenium代码里的chromeOptions.addArguments(xxx)
          launchOptions.args.push('--user-data-dir=/home/user/.config/google-chrome/Default')
          // 原来在Selenium里加的其他Chrome启动参数，都可以按这个格式追加进args数组
        }
        return launchOptions
      })
    }
  }
})

实际踩坑提醒 #

• 一定要确保测试运行时选中的是你系统安装的Chrome，而不是Cypress默认调用的内置Electron浏览器：可以在启动命令里加--browser chrome指定，比如执行npx cypress run --browser chrome
• 传入的用户配置目录不能被正在运行的日常Chrome进程占用，否则会触发配置锁冲突、启动失败的问题，这个坑和Selenium场景下的报错原因完全一样
• 如果不想把配置路径硬写在代码里，可以改成读环境变量的方式动态传值：

// 替换掉硬编码的路径写法
launchOptions.args.push(`--user-data-dir=${process.env.CHROME_PROFILE_PATH}`)

跑测试的时候临时指定路径就行：CHROME_PROFILE_PATH=/home/user/.config/google-chrome/Default npx cypress run --browser chrome

内容的提问来源于stack exchange，提问作者Александр