如何为Karate构建流程产出的Cucumber报告添加选项,排除带指定标签的场景统计与展示
可实现的技术方案
所有方案均适配Karate生成标准Cucumber JSON结果、Bamboo流水线构建、现有固定样式Cucumber HTML报告的现有流程,不需要重写核心报告逻辑:
方案1:JSON预处理+导航跳转(改动最小,适配现有流水线)
完全沿用现有的Karate执行、报告生成链路,仅在Bamboo流水线上加轻量处理步骤,不需要替换现有报告工具:
- Karate执行完成输出原始
cucumber-result.json后,新增一个简单的预处理脚本(用Python/Node.js写十几行即可,直接作为Bamboo的一个构建步骤运行):- 读取原始结果文件,生成两份独立的JSON副本:
cucumber-full.json:1:1保留所有原始场景,不做任何修改,用于生成原有的完整报告cucumber-excluded.json:遍历所有特性和场景,把打了@bug=abc-12345标签的场景从列表里移除,同步更新对应特性的用例总数、各状态(通过/失败/跳过)的用例计数、特性通过率等字段,保证过滤后的数据逻辑完全自洽,不会出现数字和列表对不上的问题
- 读取原始结果文件,生成两份独立的JSON副本:
- 调整报告生成步骤的输出配置:
- 用
cucumber-full.json按原有逻辑生成完整报告,输出到原来的默认路径,保证老的访问链接不受影响 - 用
cucumber-excluded.json生成同结构的报告,输出到独立的子路径(比如excluded-fails/)
- 用
- 等两个报告都生成完成后,加一个批量替换的小步骤,修改生成后的HTML导航栏:
- 在原有导航栏(就是带Features/Tags/Steps/Failures那几个项的导航块)新增Excluded Fails导航项,点击后直接跳转到
excluded-fails/overview-features.html - 在过滤后的报告导航栏,加一个跳回完整报告的入口,方便两个视图切换
- 在原有导航栏(就是带Features/Tags/Steps/Failures那几个项的导航块)新增Excluded Fails导航项,点击后直接跳转到
这个方案完全不碰原始测试结果,过滤逻辑透明可控。后续关联的缺陷修复、对应场景重新跑通后,只要删掉场景上的@bug标签,预处理的时候自然就会把它纳入统计,不用额外改配置就能感知到这个变化。
方案2:前端运行时过滤(无需改动流水线构建步骤)
如果当前使用的Cucumber HTML报告是前端渲染类型的(就是所有测试数据都内嵌在页面的JS变量里,打开HTML就能看,不需要后端接口读数据),可以完全不用改Bamboo的现有任务,等报告生成完之后,批量注入一段前端过滤逻辑即可:
- 在报告页面的全局JS环境里,配好要排除的标签规则,比如设置全局常量
EXCLUDE_TAG = '@bug=abc-12345' - 在导航栏加Excluded Fails按钮,点击后触发内置的过滤逻辑:
- 遍历当前页面加载的所有特性列表、场景列表,把匹配排除标签的场景从DOM里移除
- 重新计算页面顶部的统计字段:总用例数、通过数、失败数、通过率,把被排除场景的相关数据从统计值里扣减掉
- 完全复用原有页面的渲染组件展示过滤后的内容,不需要重写任何样式或布局
- 给过滤后的视图加个URL hash标记(比如
#excluded),之后直接打开带这个标记的链接,就能自动看到过滤后的通过率视图,方便快速判断回归情况
方案3:自定义报告生成插件(长期可扩展)
如果后续还有更多类似的需求(比如排除其他类型的标签、做不同维度的过滤视图),可以基于现有Cucumber报告的生成能力,开发个轻量的自定义插件:
- 插件支持在配置里传入需要排除的标签列表
- 插件直接读取原始的
cucumber-result.json,自动生成多套视图数据,不需要手动预处理多份JSON文件 - 插件会自动在导航栏注入对应视图的切换入口,不需要手动改HTML模板
这个方案前期开发成本稍高,但后续维护性好,适合长期有报告自定义需求的团队。
实现关键注意点
- 不要改动或删除原始
cucumber-result.json里的带标签场景:所有过滤动作都在数据副本或者前端展示层做,原始测试结果要完整留存,方便后续排查问题 - 统计逻辑要完全同步:过滤场景的时候,一定要联动更新特性级别的计数、整体页面的通过率等指标,避免出现列表里少了场景,但统计数字还没更新的问题
- 标签匹配要做严格校验:只匹配完全等于
@bug=abc-12345的标签,别把其他带相似文本的标签场景误过滤了
内容的提问来源于stack exchange,提问作者Corey Snow
相关产品推荐
相关产品推荐

