org.sonar.plugins.jacoco.JacocoConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-jacoco Show documentation
Get code coverage with <a href="http://www.jacoco.org/jacoco/">JaCoCo</a>.
There is a newer version: 5.14.0.18788
/*
 * SonarQube Java
 * Copyright (C) 2010-2017 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plugins.jacoco;

import com.google.common.collect.ImmutableList;
import org.sonar.api.PropertyType;
import org.sonar.api.batch.BatchSide;
import org.sonar.api.config.PropertyDefinition;
import org.sonar.api.config.Settings;
import org.sonar.api.resources.Qualifiers;
import org.sonar.api.utils.Version;
import org.sonar.java.JavaConstants;

import java.util.List;

@BatchSide
public class JacocoConfiguration {
  public static final Version SQ_6_2 = Version.create(6, 2);
  public static final String REPORT_PATHS_PROPERTY = "sonar.jacoco.reportPaths";
  public static final String REPORT_PATHS_DEFAULT_VALUE = "target/jacoco.exec, target/jacoco-it.exec";
  public static final String REPORT_PATH_PROPERTY = "sonar.jacoco.reportPath";
  public static final String REPORT_PATH_DEFAULT_VALUE = "target/jacoco.exec";
  public static final String IT_REPORT_PATH_PROPERTY = "sonar.jacoco.itReportPath";
  public static final String IT_REPORT_PATH_DEFAULT_VALUE = "target/jacoco-it.exec";
  public static final String REPORT_MISSING_FORCE_ZERO = "sonar.jacoco.reportMissing.force.zero";
  public static final boolean REPORT_MISSING_FORCE_ZERO_DEFAULT_VALUE = false;

  private final Settings settings;

  public JacocoConfiguration(Settings settings) {
    this.settings = settings;
  }

  public boolean shouldExecuteOnProject(boolean reportFound) {
    return reportFound || isCoverageToZeroWhenNoReport();
  }

  public String getReportPath() {
    return settings.getString(REPORT_PATH_PROPERTY);
  }

  public String getItReportPath() {
    return settings.getString(IT_REPORT_PATH_PROPERTY);
  }

  private boolean isCoverageToZeroWhenNoReport() {
    return settings.getBoolean(REPORT_MISSING_FORCE_ZERO);
  }

  public static List getPropertyDefinitions(Version sonarQubeVersion) {
    String subCategory = "JaCoCo";
    ImmutableList.Builder properties = ImmutableList.builder();
    if(sonarQubeVersion.isGreaterThanOrEqual(SQ_6_2)) {
      properties.add(
        PropertyDefinition.builder(JacocoConfiguration.REPORT_PATHS_PROPERTY)
          .defaultValue(JacocoConfiguration.REPORT_PATHS_DEFAULT_VALUE)
          .category(JavaConstants.JAVA_CATEGORY)
          .subCategory(subCategory)
          .name("JaCoCo Reports")
          .description("Path to the JaCoCo report files containing coverage data by unit tests. The path may be absolute or relative to the project base directory.")
          .onQualifiers(Qualifiers.PROJECT, Qualifiers.MODULE)
          .build()
      );
    } else {
      properties.add(
        PropertyDefinition.builder(JacocoConfiguration.REPORT_PATH_PROPERTY)
          .defaultValue(JacocoConfiguration.REPORT_PATH_DEFAULT_VALUE)
          .category(JavaConstants.JAVA_CATEGORY)
          .subCategory(subCategory)
          .name("UT JaCoCo Report")
          .description("Path to the JaCoCo report file containing coverage data by unit tests. The path may be absolute or relative to the project base directory.")
          .onQualifiers(Qualifiers.PROJECT, Qualifiers.MODULE)
          .build(),
        PropertyDefinition.builder(JacocoConfiguration.IT_REPORT_PATH_PROPERTY)
          .defaultValue(JacocoConfiguration.IT_REPORT_PATH_DEFAULT_VALUE)
          .category(JavaConstants.JAVA_CATEGORY)
          .subCategory(subCategory)
          .name("IT JaCoCo Report")
          .description("Path to the JaCoCo report file containing coverage data by integration tests. The path may be absolute or relative to the project base directory.")
          .onQualifiers(Qualifiers.PROJECT, Qualifiers.MODULE)
          .build(),
        PropertyDefinition.builder(JacocoConfiguration.REPORT_MISSING_FORCE_ZERO)
          .defaultValue(Boolean.toString(JacocoConfiguration.REPORT_MISSING_FORCE_ZERO_DEFAULT_VALUE))
          .name("Force zero coverage")
          .category(JavaConstants.JAVA_CATEGORY)
          .subCategory(subCategory)
          .description("Force coverage to 0% if no JaCoCo reports are found during analysis.")
          .onQualifiers(Qualifiers.PROJECT, Qualifiers.MODULE)
          .type(PropertyType.BOOLEAN)
          .build()
      );
    }
    return properties.build();
  }

}