Настройка JaCoCo plugin в Maven проекте для анализа покрытия тестами

В этой статье я бы хотел написать, как можно настроить библиотеку JaCoCo для анализа покрытия кода (code coverage) юнит тестами в Maven проекте.

Добавить библиотеку в проект, чтобы она автоматически выполнила анализ покрытия кода при выполнении юнит тестов и сохранила результаты в бинарном формате, крайне просто. Необходимо добавить в секцию <build> -> <plugins> плагин jacoco-maven-plugin с целью prepare-agent.

    
   <plugin>
      <groupid>org.jacoco</groupid>
      <artifactid>jacoco-maven-plugin</artifactid>
      <version>0.8.2</version>
      <executions>
        <execution>
          <id>jacoco-prepare-agent</id>
          <goals>
           <goal>prepare-agent</goal>
          </goals>
        </execution>
      </executions>
    </plugin>

Параметры задаются в секции configuration внутри секции execution. Полный список параметров и значения их по умолчанию можно прочитать здесь .

С параметрами по умолчанию данный плагин после завершения сборки проекта и выполнения тестов сгенерирует отчет в бинарном формате по пути ${project.build.directory}/jacoco.exec.

Этот отчет можно открыть в IDE, например, как описано в конце этой статьи. Либо использовать плагин для отображения отчета в среде где происходит автоматическое выполнение тестов (в Jenkins, например).

Если же требуется чтобы библиотека сгенерировала отчет в читаемом для человека html формате, в конфигурацию плагина следует дополнительно добавить дополнительно execution с целью report.

    <plugin>
      <groupid>org.jacoco</groupid>
      <artifactid>jacoco-maven-plugin</artifactid>
      <version>0.8.2</version>
      <executions>
        <execution>
          <id>jacoco-prepare-agent</id>
          <goals>
           <goal>prepare-agent</goal>
          </goals>
        </execution>
        <execution>
          <id>report</id>
          <phase>prepare-package</phase>
          <goals>
            <goal>report</goal>
          </goals>
        </execution>
      </executions>
    </plugin>

Список возможных параметров для цели report можно посмотреть здесь

На этом все, как видно добавление анализа покрытия с использованием библотеки JaCoCo для юнит тестов выполняется крайне просто и требует минимум усилий.