org.sonar.plugins.clover.CloverSensor Maven / Gradle / Ivy

Go to download

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

Get code coverage with <a href="http://www.atlassian.com/software/clover/">Atlassian Clover</a>.

The newest version!

/*
 * Sonar Clover Plugin
 * Copyright (C) 2008 SonarSource
 * [email protected]
 *
 * 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  02
 */

package org.sonar.plugins.clover;

import org.codehaus.plexus.util.StringUtils;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.CoverageExtension;
import org.sonar.api.batch.Sensor;
import org.sonar.api.batch.SensorContext;
import org.sonar.api.config.Settings;
import org.sonar.api.resources.Project;

import java.io.File;

public class CloverSensor implements Sensor, CoverageExtension {
  public static final String REPORT_PATH_PROPERTY = "sonar.clover.reportPath";
  private final CloverXmlReportParserFactory factory;
  private Settings settings;

  public CloverSensor(Settings settings, CloverXmlReportParserFactory factory) {
    this.settings = settings;
    this.factory = factory;
  }

  public boolean shouldExecuteOnProject(Project project) {
    return StringUtils.isNotEmpty(settings.getString(REPORT_PATH_PROPERTY));
  }

  public void analyse(Project project, SensorContext context) {
    File report = getReportFromProperty(project);
    if (reportExists(report)) {
      factory.create(project, context).collect(report);
    } else {
      LoggerFactory.getLogger(getClass()).warn("Clover XML report not found");
    }
  }

  private File getReportFromProperty(Project project) {
    String path = settings.getString(REPORT_PATH_PROPERTY);
    if (StringUtils.isNotEmpty(path)) {
      return project.getFileSystem().resolvePath(path);
    }
    return null;
  }

  private boolean reportExists(File report) {
    return report != null && report.exists() && report.isFile();
  }

}