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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-jacoco-plugin Show documentation

JaCoCo is an alternative to Clover and Cobertura to measure coverage by unit tests.

There is a newer version: 0.6

/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2010 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * Sonar 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.
 *
 * Sonar 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 Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */

package org.sonar.plugins.jacoco;

import org.sonar.api.Plugin;
import org.sonar.api.Properties;
import org.sonar.api.Property;

import java.util.Arrays;
import java.util.List;

/**
 * @author Evgeny Mandrikov
 */
@Properties({
    @Property(
        key = JaCoCoPlugin.REPORT_PATH_PROPERTY,
        name = "File with execution data",
        defaultValue = JaCoCoPlugin.REPORT_PATH_DEFAULT_VALUE,
        description = "Path (absolute or relative) to the file with execution data.",
        module = true,
        project = true,
        global = false
    )
})
public class JaCoCoPlugin implements Plugin {

  public static final String REPORT_PATH_PROPERTY = "sonar.jacoco.reportPath";
  public static final String REPORT_PATH_DEFAULT_VALUE = "target/jacoco.exec";

  public String getKey() {
    return "jacoco";
  }

  public String getName() {
    return "JaCoCo";
  }

  public String getDescription() {
    return "JaCoCo calculates coverage of unit tests." +
        " Set the parameter 'Code coverage plugin' to jacoco in the General plugin.";
  }

  public List getExtensions() {
    return Arrays.asList(SurefireMavenPluginHandler.class, JaCoCoSensor.class);
  }

  @Override
  public String toString() {
    return getKey();
  }

}