CI/CD / 系统课时

发布测试报告与失败记录

发布测试报告与失败记录

测试命令返回失败只能告诉 Jenkins“测试没通过”,却不能帮助开发者快速定位具体用例。本节把 JUnit XML 报告交给 Jenkins 持久化,让每次构建都能查看失败测试、错误信息和历史结果,并保证测试失败时报告仍会被收集。

学习目标

  • 在 Pipeline 中使用 junit 发布 JUnit 格式测试报告
  • 理解为什么报告收集应放在 post 阶段
  • 能区分测试执行失败与测试报告缺失两类问题

先让测试工具生成报告

Jenkins 不负责执行单元测试,也不会从普通控制台日志中自动识别测试结果。测试框架应先生成 JUnit XML,再由 Jenkins 的 junit 步骤读取。Maven Surefire 默认会把测试结果写入 target/surefire-reports/,因此 Java 项目通常可以直接收集其中的 XML 文件。

下面是一份 Declarative Pipeline。关键点是把报告发布放在 post { always { ... } } 中:即使 mvn test 因失败用例返回非零状态,流水线仍会进入报告收集步骤。

groovy
pipeline {
    agent any

    stages {
        stage('Test') {
            steps {
                sh 'mvn -B test'
            }
            post {
                always {
                    junit testResults: 'target/surefire-reports/*.xml',
                          allowEmptyResults: false
                }
            }
        }
    }
}

预期结果:测试全部通过时,构建记录保存测试结果;存在失败用例时,测试命令会导致阶段失败,但 junit 仍会读取已经生成的 XML,并把失败用例关联到本次 Build。控制台中的具体 Maven 行可能随项目和版本不同。

text
[Pipeline] sh
<TEST_OUTPUT>
[Pipeline] junit
Recording test results

allowEmptyResults: false 表示匹配不到报告不能被静默忽略。这样可以避免测试命令因配置错误没有产生 XML,而流水线却让人误以为测试报告已经正常发布。

报告如何进入构建记录

测试执行、XML 文件和 Jenkins Build 是三个不同对象。测试框架先把用例结果写入工作区,junit 再解析这些文件,并把测试结果保存到当前构建。之后查看某次 Build 时,就可以从 Jenkins 保存的测试数据定位失败用例,而不必只翻控制台日志。

测试结果从执行到构建记录的流向

这里要特别区分两种失败:测试失败表示报告存在,其中记录了失败用例;报告缺失则表示 Jenkins 找不到预期 XML,常见原因是测试根本没执行、报告目录配置错误或文件匹配模式写错。两者的排查方向完全不同。

从失败记录定位问题

当构建因测试失败变红时,先确认 junit 是否成功执行。如果报告已经发布,应优先查看具体失败测试及其错误信息,再回到控制台日志补充上下文。这样比直接在大量 Maven 输出中搜索 FAILURE 更容易找到真正失败的用例。

如果控制台出现找不到测试报告的错误,则先检查工作区中的实际文件。可以临时加入诊断命令确认 Maven 是否生成了预期 XML:

bash
find target/surefire-reports -maxdepth 1 -type f -name '*.xml' -print

预期输出:存在测试报告时会列出实际 XML 路径;文件名由测试类决定,因此使用动态占位表示。

text
target/surefire-reports/<TEST_REPORT>.xml

如果没有任何输出,应先修复测试工具的报告生成配置,而不是把 allowEmptyResults 改成 true 掩盖问题。

保留报告而不是掩盖失败

发布测试报告的目的不是把失败构建改成成功,而是让失败变得可定位、可追踪。可靠的流水线应同时保留两件事:测试失败继续影响构建状态,已经产生的测试报告仍被收集。这样 Jenkins Build 才既能阻止有问题的版本继续流转,又能留下足够的失败证据供开发者排查。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

发布测试报告与失败记录

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通