让 Sonarqube 显示带有 Jacoco 插件的简单 Java/JUnit/Maven 项目的代码覆盖率分数

Getting Sonarqube to show a code Coverage score for a simple Java/JUnit/Maven project with Jacoco plugin

我正在使用 Jacoco 插件练习一个非常小的 Java/JUnit/Maven 项目,以练习 Sonarqube 的代码覆盖率功能。

示例的核心代码很少。这是正在测试的 class:

package com.somebody.sonarqube;

public class Calculator {
    
    // Method to add two numbers
    public int addNumbers(int one, int two) {
        return one + two;
    }
    
    // Method to subtract two numbers
    public int subtractNumbers(int one, int two) {
        return one - two;
    }
}

下面是单元测试:

package com.somebody.sonarqube;

import static org.junit.Assert.*;

import org.junit.Test;

public class CalculatorTest {

    @Test
    public void testAddNumbers() {
        Calculator myCalc = new Calculator();
        assertEquals(10, myCalc.addNumbers(5, 5));
    }

    @Test
    public void testSubtractNumbers() {
        Calculator myCalc = new Calculator();
        assertEquals(5, myCalc.subtractNumbers(10, 5));
    }

}

被测class中的两个方法分别被两个单元测试覆盖,所以就“代码覆盖率”而言,Sonarqube分数应该是100%。

在 运行 我的“干净测试 sonar:sonar”Maven 构建目标之后尝试获得此分数时,我得到的是 0%:

所以我遇到最多麻烦的部分是让 pom.xml 文件中的各种组件协同工作。此时在底部的 <systemPropertyVariables> 块中有一个警告,报告 Invalid plugin configuration: systemPropertyVariables。这是完整的 pom.xml 文件:

<project xmlns="http://maven.apache.org/POM/4.0.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.somebody.sonarqube</groupId>
   <artifactId>HelloSonarqube</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>HelloSonarqube</name>
   <description>Small example of Sonarqube and JUnit tests.</description>
   
   <properties>
      <maven.compiler.source>11</maven.compiler.source>
      <maven.compiler.target>11</maven.compiler.target>
   </properties>
   
   <dependencies>
      <dependency>
         <groupId>junit</groupId>
         <artifactId>junit</artifactId>
         <version>4.13.2</version>
         <scope>test</scope>
      </dependency>
      <dependency>
         <groupId>org.sonarsource.scanner.maven</groupId>
         <artifactId>sonar-maven-plugin</artifactId>
         <version>3.9.1.2184</version>
      </dependency>
   </dependencies>
   
   <build>
      <plugins>
         <plugin>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.22.2</version>
         </plugin>
         <plugin>
            <artifactId>maven-failsafe-plugin</artifactId>
            <version>2.22.2</version>
         </plugin>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.9.0</version>
            <configuration>
               <release>11</release>
            </configuration>
         </plugin>
         <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.7</version>
            <executions>
               <execution>
                  <id>prepare-agent</id>
                  <goals>
                     <goal>prepare-agent</goal>
                  </goals>
               </execution>
               <execution>
                  <id>report</id>
                  <phase>prepare-package</phase>
                  <goals>
                     <goal>report</goal>
                  </goals>
               </execution>
               <execution>
                  <id>post-unit-test</id>
                  <phase>test</phase>
                  <goals>
                     <goal>report</goal>
                  </goals>
                  <configuration>
                     <dataFile>target/jacoco.exec</dataFile>
                     <outputDirectory>target/jacoco-ut</outputDirectory>
                  </configuration>
               </execution>
            </executions>
            <configuration>
               <systemPropertyVariables>
                  <jacoco-agent.destfile>target/jacoco.exec</jacoco-agent.destfile>
               </systemPropertyVariables>
            </configuration>
         </plugin>
      </plugins>
   </build>
</project>

我已经尝试了很多变体,包括将 JUnit 4 更改为版本 5(我也有兴趣了解这方面的问题)。从我的阅读中我大致了解到 Eclipse/JUnit 生命周期在默认情况下并没有与 Maven 生命周期完全和谐地工作,因此它缺少一些东西。我 seen/tried 的解决方案非常针对某些项目设置,我尝试过手动设置“参数”和其他更改。花了几个小时玩不同的版本,看到你对此的意见真的很激动。

我终于能够根据我刚刚在这个 GitHub 项目中找到的类似示例来回答这个问题: https://github.com/SonarSource/sonar-scanning-examples/tree/master/sonarqube-scanner-maven/maven-basic

简而言之,他们使用“clean verify sonar:sonar”而不是“clean test sonar:sonar”Maven 构建目标。该更改触发了我正在寻找的代码覆盖率插件,用于在 Sonarqube 仪表板中发布代码覆盖率分数。

顺便说一句,我也分享了关于 <systemPropertyVariables> 的警告消息对解决问题并不重要,我决定不使用那部分代码,仍然在 Sonarqube 中获取所有报告我正在寻找的仪表板。