Cypress+Cucumber：commands.js中excelData函数在步骤定义中失效

问题分析 #

你的TestCommandsJS能正常运行，说明自定义命令的基础配置没问题，但excelData失效，核心原因在于浏览器环境直接读取本地文件的权限限制，以及异步处理逻辑未适配Cypress命令队列机制：

1. Cypress运行在浏览器环境，直接调用exceljs读取本地文件存在权限与异步兼容性问题
2. 硬编码绝对路径易导致路径错误，且无法适配不同运行环境
3. 原命令未添加错误捕获，读取失败时无法定位具体问题

解决方案 #

1. 改用Cypress Task处理Excel读取（推荐方案） #

将Excel读取逻辑移到Node环境执行（通过cy.task），避开浏览器环境限制，同时契合Cypress的异步处理模式：

修改cypress/support/commands.js

// 模块引用移至文件顶部，避免重复加载
const ExcelJs = require('exceljs')

Cypress.Commands.add('excelData', () => {
  // 使用Cypress内置下载文件夹路径，替代硬编码绝对路径
  const filePath = `${Cypress.config('downloadsFolder')}/exceldata.xlsx`
  
  return cy.task('readExcel', filePath).then(columnArray => {
    // 移除第一行数据
    columnArray.splice(0, 1)
    return cy.wrap(columnArray)
  })
})

Cypress.Commands.add('TestCommandsJS', () => {
  return 'TestCommandsJS works'
})

在cypress.config.js中添加Task配置

const { defineConfig } = require("cypress");

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      // 注册读取Excel的Task
      on('task', {
        async readExcel(filePath) {
          const workbook = new ExcelJs.Workbook()
          
          try {
            await workbook.xlsx.readFile(filePath)
          } catch (err) {
            throw new Error(`读取Excel失败：${err.message}`)
          }

          const worksheet = workbook.getWorksheet('sampledatab')
          if (!worksheet) {
            throw new Error('工作表「sampledatab」不存在，请检查名称拼写（大小写敏感）')
          }

          const columnArray = []
          worksheet.eachRow((row) => {
            row.eachCell((cell) => {
              columnArray.push(cell.value)
            })
          })

          return columnArray
        }
      })
    },
  },
});

2. 关键优化点说明 #

• Node环境执行文件操作：cy.task运行在Node环境，拥有完整文件系统权限，规避浏览器安全限制
• 动态路径适配：使用Cypress.config('downloadsFolder')获取下载目录，适配不同运行环境，避免路径硬编码错误
• 明确错误提示：添加try-catch和工作表存在性检查，读取失败时抛出清晰错误，便于快速定位问题

3. 验证步骤 #

1. 确认exceldata.xlsx文件存在于Cypress下载目录中
2. 检查工作表名称sampledatab拼写正确（注意大小写敏感）
3. 重新运行测试，cy.excelData()即可正常返回Excel数据

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