Maven项目Jenkins集成SonarQube未统计Cucumber测试覆盖率求助

我之前在Maven+Jenkins+SonarQube的技术栈里碰到过一模一样的问题——JUnit覆盖率显示正常，但Cucumber的测试完全没被算进覆盖率统计，导致整体数据严重偏低。结合我的踩坑经验，你可以按下面的步骤排查和修复：

1. 确认Cucumber测试是否生成了JaCoCo覆盖率数据 #

SonarQube本身不直接生成测试覆盖率，它依赖JaCoCo（或其他覆盖率工具）输出的报告文件。首先要确保你的Cucumber测试在执行时，JaCoCo已经拦截并生成了对应的exec文件：

• 执行mvn verify后，去target/jacoco目录下查看，有没有类似jacoco-it.exec或自定义名称的exec文件（Cucumber通常属于集成测试范畴，会生成带it标识的exec文件）。
• 如果没有，说明JaCoCo没配置成监控Cucumber测试，得先搞定这一步。

2. 调整Maven的JaCoCo配置，覆盖Cucumber测试 #

在你的pom.xml里，需要确保JaCoCo插件同时监控单元测试（JUnit）和集成测试（Cucumber）。示例配置如下：

<build>
    <plugins>
        <!-- JaCoCo 核心插件配置 -->
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.10</version> <!-- 使用与项目兼容的最新版本 -->
            <executions>
                <!-- 单元测试覆盖率（JUnit） -->
                <execution>
                    <id>jacoco-ut</id>
                    <goals>
                        <goal>prepare-agent</goal>
                    </goals>
                    <configuration>
                        <destFile>${project.build.directory}/jacoco/jacoco-ut.exec</destFile>
                    </configuration>
                </execution>
                <!-- 集成测试覆盖率（Cucumber） -->
                <execution>
                    <id>jacoco-it</id>
                    <goals>
                        <goal>prepare-agent-integration</goal>
                    </goals>
                    <configuration>
                        <destFile>${project.build.directory}/jacoco/jacoco-it.exec</destFile>
                    </configuration>
                </execution>
                <!-- 生成本地可查看的覆盖率报告（可选，方便验证） -->
                <execution>
                    <id>jacoco-report</id>
                    <phase>verify</phase>
                    <goals>
                        <goal>report</goal>
                        <goal>report-integration</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <!-- Cucumber 测试插件配置，绑定到集成测试阶段 -->
        <plugin>
            <groupId>io.cucumber</groupId>
            <artifactId>cucumber-maven-plugin</artifactId>
            <version>7.14.0</version> <!-- 匹配你的Cucumber版本 -->
            <executions>
                <execution>
                    <id>run-cucumber-tests</id>
                    <phase>integration-test</phase>
                    <goals>
                        <goal>test</goal>
                    </goals>
                    <configuration>
                        <features>src/test/resources/features</features>
                        <glue>com.yourcompany.stepdefs</glue>
                        <plugin>json:target/cucumber-report.json</plugin>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

重点是把Cucumber测试绑定到integration-test阶段，同时让JaCoCo的prepare-agent-integration目标在该阶段生效，生成集成测试的覆盖率数据。

3. 配置SonarQube扫描参数，包含集成测试覆盖率 #

在Jenkins的SonarQube扫描步骤（或Maven命令的Sonar参数）里，需要明确告诉Sonar要读取集成测试的覆盖率文件：

• 如果用Maven命令执行Sonar扫描，添加以下参数：

mvn sonar:sonar \
  -Dsonar.projectKey=your-project-key \
  -Dsonar.host.url=http://your-sonar-url \
  -Dsonar.login=your-sonar-token \
  -Dsonar.jacoco.reportPaths=target/jacoco/jacoco-ut.exec \
  -Dsonar.jacoco.itReportPaths=target/jacoco/jacoco-it.exec

这里的sonar.jacoco.itReportPaths是关键，它告诉Sonar去读取Cucumber测试生成的集成覆盖率数据。如果你的exec文件名称或路径不同，要对应修改。

4. 验证SonarQube是否扫描到了被Cucumber覆盖的代码 #

有时候Sonar没统计覆盖率，是因为它根本没扫描到对应的代码文件：

• 进入SonarQube项目页面的Administration > Settings > General > Sources，确认源代码路径（比如src/main/java）配置正确，没有排除被Cucumber覆盖的包或类。
• 检查Administration > Settings > General > Tests，确保测试代码路径（比如src/test/java、src/test/resources）被正确识别，Sonar需要明确哪些是测试代码，才能关联覆盖率数据。

5. 检查版本兼容性问题 #

如果上面的配置都没问题，可能是版本不兼容：

• 确保JaCoCo版本与你的Cucumber、Maven版本兼容（比如JaCoCo 0.8.x兼容Cucumber 7.x）。
• 确保SonarQube服务器版本支持读取最新的JaCoCo报告格式（比如SonarQube 9.x以上对JaCoCo 0.8.x的支持更完善）。

按这个流程走下来，基本能解决Cucumber覆盖率不被统计的问题。我当时就是漏了配置sonar.jacoco.itReportPaths，导致Sonar完全忽略了集成测试的覆盖率数据。

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