使用 Powermock 在 Sonarqube 中配置 jacoco 以进行集成和单元测试报告

Posted 2023-02-19

【中文标题】使用 Powermock 在 Sonarqube 中配置 jacoco 以进行集成和单元测试报告

【英文标题】：Configuring jacoco for integration and unit test reporting in Sonarqube with Powermock

【发布时间】：2019-06-26 11:41:21

【问题描述】：

我正在使用 Sonarqube 跟踪多模块 Maven 项目的单元和集成测试覆盖率。

这是在我进行更改之前用于在本地生成 Sonarqube 报告的父 pom.xml 中的现有配置文件：

在 Sonarqube 本地生成所有单元测试覆盖率的配置文件

<profiles>
  <profile>
    <id>coverage</id>
    <properties>
       <maven.compiler.source>1.8</maven.compiler.source>
       <maven.compiler.target>1.8</maven.compiler.target> 
       <sonar.jacoco.reportPaths>$project.basedir/../target/jacoco.exec</sonar.jacoco.reportPaths>
       <sonar.projectName>plan-advantage-serverless-$project.artifactId</sonar.projectName>
       <sonar.projectKey>$project.groupId-MPA-$project.artifactId</sonar.projectKey>
       <sonar.exclusions>file:**/generated-sources/**,**/*Model.java,**/models/**/*</sonar.exclusions>
       <sonar.test.exclusions>**/test/*</sonar.test.exclusions>
       <sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
       <sonar.dynamicAnalysis>reuseReports</sonar.dynamicAnalysis>
       <sonar.language>java</sonar.language>
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
       <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    </properties>
    <build>
      <plugins>
        <plugin>
          <groupId>org.jacoco</groupId>
          <artifactId>jacoco-maven-plugin</artifactId>
          <version>0.8.2</version>
          <configuration>
            <append>true</append>
            <excludes>
              <exclude>**/test/*</exclude>
            </excludes>
          </configuration>
          <executions>
            <execution>
              <id>default-instrument</id>
              <goals>
                <goal>instrument</goal>
              </goals>
            </execution>
            <execution>
              <id>default-restore-instrumented-classes</id>
              <goals>
                <goal>restore-instrumented-classes</goal>
              </goals>
            </execution>
          </executions>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.3</version>
          <configuration>
            <source>1.8</source>
            <target>1.8</target>
            <showWarnings>true</showWarnings>
            <compilerArgs>
              <arg>-Xlint:all</arg>
              <arg>-Xlint:-processing</arg>
            </compilerArgs>
          </configuration>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.0</version>
          <configuration>
            <argLine>-XX:-UseSplitVerifier</argLine>
            <systemPropertyVariables>
              <jacoco-agent.destfile>$sonar.jacoco.reportPaths</jacoco-agent.destfile>
            </systemPropertyVariables>
          </configuration>

        <dependencies>
          <!-- needed for powermock to run correctly with surefire-->
          <dependency>
            <groupId>org.apache.maven.surefire</groupId>
            <artifactId>surefire-junit47</artifactId>
            <version>2.22.0</version>
          </dependency>
        </dependencies>
      </plugin>
      <plugin>
        <groupId>org.sonarsource.scanner.maven</groupId>
        <artifactId>sonar-maven-plugin</artifactId>
        <version>3.5.0.1254</version>
      </plugin>
    </plugins>
  </build>
</profile>

这将生成预期的测试覆盖率（无集成测试） 当我运行 mvn clean install -P coverage sonar:sonar 时，Sonarqube 在本地运行。

到目前为止，我已经能够使用以下添加添加集成覆盖作为概念证明 到父 pom.xml：

在 Sonarqube 中包含集成测试覆盖但不包括某些单元测试的 pom.xml

<properties>
  <maven.compiler.source>1.8</maven.compiler.source>
  <maven.compiler.target>1.8</maven.compiler.target>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  <jacoco.version>0.7.9</jacoco.version> . <sonar.jacoco.reportPaths>$project.basedir/../target/jacoco.exec</sonar.jacoco.reportPaths>
  <sonar.jacoco.itReportPath>$project.basedir/../target/jacoco-it.exec</sonar.jacoco.itReportPath>
  <sonar.language>java</sonar.language>
  <sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
</properties>
...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-failsafe-plugin</artifactId>
      <version>3.0.0-M3</version>
      <goals>
        <goal>integration-test</goal>
          <goal>verify</goal>
        </goals>
        <dependencies>
          <dependency>
            <groupId>org.apache.maven.surefire</groupId>
            <artifactId>surefire-junit47</artifactId>
            <version>3.0.0-M3</version>
          </dependency>
        </dependencies>
    </plugin>
    <plugin>
      <groupId>org.jacoco</groupId>
      <artifactId>jacoco-maven-plugin</artifactId>
      <version>$jacoco.version</version>
      <executions>
          <execution>
              <id>agent-for-ut</id>
              <goals>
                  <goal>prepare-agent</goal>
              </goals>
              <configuration>
                  <append>true</append>
                  <destFile>$sonar.jacoco.reportPaths</destFile>
              </configuration>
          </execution>
          <execution>
              <id>agent-for-it</id>
              <phase>package</phase>
              <goals>
                  <goal>prepare-agent-integration</goal>
              </goals>
              <configuration>
                  <append>true</append>
                  <destFile>$sonar.jacoco.itReportPath</destFile>
              </configuration>
          </execution>
      </executions>
    </plugin>
  </plugins>
</build>

这是受到here 的示例的启发。

但是，当我使用命令 mvn clean install failsafe:integration-test sonar:sonar 运行它时，它会导致之前覆盖的一些单元测试不会显示在 Sonarqube 输出中。我相信 prepare-agent 和 prepare-agent 集成目标正在使用动态检测。根据 JaCoCo 的文档，在使用 PowerMock（我的项目正在使用）时无法进行即时检测，因此我们必须为 JaCoCo 使用离线检测。

我查看了这个 example 以使用离线检测，并将以下 pom.xml 与命令 mvn clean install test sonar:sonar 一起使用：

由于 NoClassDefFound 错误而无法构建的父 pom.xml

<build>
...
  <plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>$jacoco.version</version>
    <executions>
      <execution>
        <id>default-instrument</id>
        <goals>
          <goal>instrument</goal>
        </goals>
      </execution>
      <execution>
        <id>default-restore-instrumented-classes</id>
        <goals>
          <goal>restore-instrumented-classes</goal>
        </goals>
      </execution>
    </executions> 
  </plugin>
</build>

这是产生的错误：

对于正确的 pom.xml 配置以使离线仪器获得集成和单元测试覆盖率以显示在 Sonarqube 中的任何想法？

【参考方案1】：

我知道这个问题已经 10 个月了，但是对于遇到此问题的其他人，您需要将其添加到 pom.xml 文件中的依赖项中。

<dependency>
    <groupId>org.jacoco</groupId>
    <artifactId>org.jacoco.agent</artifactId>
    <classifier>runtime</classifier>
    <version>$jacoco.version</version>
    <scope>test</scope>
</dependency>