如何在 Cucumber-JS 中准确获取失败步骤的文本与位置信息

本文详解如何在 Cucumber-js 中通过 AfterStep 钩子结合 step.pickleStep 和 step.result 捕获具体失败步骤的文本、类型及源码位置，解决 scenario.pickle.steps 中无状态字段导致无法直接定位失败步的常见痛点。

本文详解如何在 cucumber-js 中通过 `afterstep` 钩子结合 `step.picklestep` 和 `step.result` 捕获具体失败步骤的文本、类型及源码位置，解决 `scenario.pickle.steps` 中无状态字段导致无法直接定位失败步的常见痛点。

在 Cucumber-JS（v7+）中，scenario.pickle.steps 本身不包含执行状态（如 PASSED/FAILED），这是初学者常踩的误区。官方设计将步骤执行结果（status、duration、Error）与步骤定义（text、type、id）分离存储：前者在 AfterStep 钩子的 step.result 中，后者在 step.pickleStep 中。因此，要精准提取失败步骤（如 “Then status should be 400″），必须在 AfterStep 中实时比对并缓存。

✅ 正确实现方案：三钩子协同采集

需配合 Before、AfterStep 和 After 三个生命周期钩子，构建完整的步骤追踪链：

1. Before 钩子：初始化场景上下文

在 World 实例中挂载空数组，用于暂存所有步骤及其结果：

Before(function(scenario) {   this.currentScenario = {     name: scenario.pickle.name,     uri: scenario.pickle.uri,     steps: [] // 用于后续填充 { text, type, status, error }   }; });

2. AfterStep 钩子：捕获每步执行结果（核心！）

此处是关键——step.pickleStep 提供 Gherkin 文本，step.result 提供状态与错误堆栈：

AfterStep(function(step) {   if (!this.currentScenario) return;    const stepData = {     text: step.pickleStep.text,        // e.g., "Then status should be 400"     type: step.pickleStep.type,        // "Given"/"When"/"Then"/"And"     status: step.result.status,        // "PASSED", "FAILED", "SKIPPED"     duration: step.result.duration,     error: step.result.status === 'FAILED' ? step.result.message : null,     // 可选：从 error.stack 提取行号（需解析 stack 字符串）   };    this.currentScenario.steps.push(stepData);    // 【进阶】立即标记首个失败步（避免多次失败干扰）   if (stepData.status === 'FAILED' && !this.currentScenario.failedStep) {     this.currentScenario.failedStep = stepData;   } });

3. After 钩子：生成最终报告数据

在场景结束时，提取失败步骤并写入自定义 json：

After(function(scenario) {   if (scenario.result.status === 'FAILED' && this.currentScenario?.failedStep) {     const failedStep = this.currentScenario.failedStep;      // 构建符合你需求的 failed.json 结构     const reportEntry = {       status: 'FAILED',       feature: this.currentScenario.name,       from: this.currentScenario.uri,       failedStepText: failedStep.text, // ← 关键字段："Then status should be 400"       failedStepType: failedStep.type,       error: failedStep.error,       details: scenario.result.message || ''     };      // 写入文件或推送到报告系统     require('fs').appendFileSync(       'failed.json',       JSON.stringify(reportEntry, null, 2) + ',n'     );   }    // 清理内存   this.currentScenario = null; });

⚠️ 注意事项与避坑指南

• 不要依赖 scenario.pickle.steps[i].result：该属性在 Cucumber-JS v7+ 中根本不存在，pickleStep 是纯声明式结构，不含运行时状态。
• step.result.status 是唯一可信状态源：其值为 ‘PASSED’ | ‘FAILED’ | ‘SKIPPED’ | ‘PENDING’ | ‘undefined’，且 FAILED 时 step.result.message 包含断言错误摘要。
• 错误堆栈定位需手动解析：step.result.message 不含文件行号，但 scenario.result.message 的堆栈（如 at …/stepdefs.js:133:10）可映射到具体步骤。建议在 AfterStep 中结合 step.pickleStep.astNodeIds 与 Gherkin AST 做精准溯源（高级用法）。
• 并发安全：若启用多线程（–parallel），每个 World 实例独立，无需额外锁机制；但 failed.json 文件写入需加锁或使用流式追加。

✅ 最终效果验证

运行失败场景后，你的 failed.json 将包含明确的失败步骤文本：

{   "status": "FAILED",   "feature": "tc795639 To verify the negative validation check for field "family_name" with incorrect data",   "from": "features/address_post_validation.feature",   "failedStepText": "Then status should be 400",   "failedStepType": "Outcome",   "error": "Expected values to be strictly equal:nn401 !== 400",   "details": "AssertionError [ERR_ASSERTION]: Expected values to be strictly equal:nn401 !== 400n    at World.<anonymous> (.../stepdefs_common_func.js:133:10)" }

此方案完全规避了“遍历 scenario.pickle.steps 查 result”的无效尝试，直击 Cucumber-JS 的事件驱动本质，是构建高精度自定义报告的可靠基础。