Maven/Jacoco：将Cucumber测试结果纳入Jacoco代码覆盖率概览

1. 如何在Jacoco概览中展示Cucumber功能测试的代码覆盖率？ #

Cucumber测试本质上依托JUnit/TestNG这类框架运行，核心思路是让Jacoco在Cucumber测试执行时捕获代码覆盖数据，最终纳入统一报告。下面分两种常用构建工具说明：

Maven配置步骤：

• 在pom.xml中配置Jacoco插件，确保它在测试阶段注入Agent收集数据，同时绑定Cucumber测试目标：

  <build>
    <plugins>
      <!-- Jacoco核心插件 -->
      <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>0.8.10</version> <!-- 使用最新稳定版 -->
        <executions>
          <!-- 为测试准备Agent，生成基础执行数据 -->
          <execution>
            <id>prepare-agent</id>
            <goals>
              <goal>prepare-agent</goal>
            </goals>
          </execution>
          <!-- 绑定到集成测试阶段，生成包含Cucumber数据的报告 -->
          <execution>
            <id>generate-report</id>
            <phase>integration-test</phase>
            <goals>
              <goal>report</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <!-- Cucumber Maven插件，配置测试路径 -->
      <plugin>
        <groupId>io.cucumber</groupId>
        <artifactId>cucumber-maven-plugin</artifactId>
        <version>7.14.0</version>
        <executions>
          <execution>
            <id>run-cucumber-tests</id>
            <phase>integration-test</phase>
            <goals>
              <goal>test</goal>
            </goals>
            <configuration>
              <glue>com.yourproject.stepdefs</glue> <!-- 你的步骤定义包路径 -->
              <features>src/test/resources/features</features> <!-- Feature文件存放路径 -->
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  

• 执行mvn clean integration-test，Jacoco会自动收集Cucumber测试的覆盖数据，报告生成在target/site/jacoco目录，打开index.html就能看到包含Cucumber覆盖的概览。

Gradle配置步骤：

• 在build.gradle中引入Jacoco和Cucumber插件，关联测试任务与覆盖率收集：

  plugins {
    id 'java'
    id 'jacoco'
    id 'io.cucumber' version '7.14.0'
  }
  
  jacoco {
    toolVersion = "0.8.10"
  }
  
  // 配置Cucumber测试任务
  tasks.named('cucumber') {
    glue = 'com.yourproject.stepdefs'
    features = fileTree('src/test/resources/features')
    // 确保Jacoco收集该任务的覆盖数据
    finalizedBy jacocoTestReport
  }
  
  // 配置Jacoco报告包含Cucumber测试数据
  jacocoTestReport {
    dependsOn tasks.cucumber
    reports {
      html.required = true // 开启HTML报告
      xml.required = true // 可选，用于CI集成
    }
  }
  

• 执行./gradlew clean cucumber jacocoTestReport，合并后的报告生成在build/reports/jacoco/test/html目录。

2. 是否可以将Cucumber结果与单元测试/集成测试结果合并？ #

完全可以！Jacoco支持合并多个测试阶段生成的覆盖率执行文件，生成统一的综合覆盖率报告。具体实现如下：

Maven合并方案：

• 先为不同测试类型生成独立的执行文件，再通过Jacoco的merge目标合并，最后生成综合报告：

  <plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.10</version>
    <executions>
      <!-- 单元测试Agent，指定独立输出文件 -->
      <execution>
        <id>prepare-agent-unit</id>
        <goals>
          <goal>prepare-agent</goal>
        </goals>
        <configuration>
          <destFile>${project.build.directory}/jacoco-unit.exec</destFile>
        </configuration>
      </execution>
      <!-- Cucumber测试Agent，指定独立输出文件 -->
      <execution>
        <id>prepare-agent-cucumber</id>
        <phase>pre-integration-test</phase>
        <goals>
          <goal>prepare-agent</goal>
        </goals>
        <configuration>
          <destFile>${project.build.directory}/jacoco-cucumber.exec</destFile>
        </configuration>
      </execution>
      <!-- 合并多个执行文件 -->
      <execution>
        <id>merge-coverage</id>
        <phase>post-integration-test</phase>
        <goals>
          <goal>merge</goal>
        </goals>
        <configuration>
          <fileSets>
            <fileSet>
              <directory>${project.build.directory}</directory>
              <includes>
                <include>jacoco-unit.exec</include>
                <include>jacoco-cucumber.exec</include>
                <!-- 可添加集成测试的执行文件，如jacoco-integration.exec -->
              </includes>
            </fileSet>
          </fileSets>
          <destFile>${project.build.directory}/jacoco-merged.exec</destFile>
        </configuration>
      </execution>
      <!-- 基于合并文件生成综合报告 -->
      <execution>
        <id>generate-merged-report</id>
        <phase>verify</phase>
        <goals>
          <goal>report</goal>
        </goals>
        <configuration>
          <dataFile>${project.build.directory}/jacoco-merged.exec</dataFile>
          <outputDirectory>${project.reporting.outputDirectory}/jacoco-merged</outputDirectory>
        </configuration>
      </execution>
    </executions>
  </plugin>
  

• 执行mvn clean verify，综合报告生成在target/site/jacoco-merged目录。

Gradle合并方案：

• 自定义合并任务和综合报告任务：

  // 合并多个测试任务的覆盖率数据
  task jacocoMerge(type: JacocoMerge) {
    destinationFile = file("$buildDir/jacoco/jacoco-merged.exec")
    executionData tasks.test, tasks.cucumber // 可添加其他测试任务，如集成测试task
  }
  
  // 基于合并数据生成综合报告
  task jacocoMergedReport(type: JacocoReport) {
    dependsOn jacocoMerge
    executionData file("$buildDir/jacoco/jacoco-merged.exec")
    sourceSets sourceSets.main
    reports {
      html.required = true
      xml.required = true
    }
  }
  

• 执行./gradlew clean test cucumber jacocoMergedReport，综合报告生成在build/reports/jacoco/jacocoMergedReport/html目录。

小提示 #

• 确保所有测试任务都启用了Jacoco Agent，否则对应覆盖数据不会被收集。
• 多模块项目可在父模块配置合并逻辑，或在子模块生成报告后统一合并。

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