org.sonar.plugins.cobertura.CoberturaSensor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-cobertura-plugin Show documentation
Code coverage analysis using Cobertura
The newest version!
/*
 * SonarQube Cobertura Plugin
 * Copyright (C) 2013 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.cobertura;

import org.slf4j.Logger;
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 org.sonar.api.scan.filesystem.FileQuery;
import org.sonar.api.scan.filesystem.FileType;
import org.sonar.api.scan.filesystem.ModuleFileSystem;
import org.sonar.api.scan.filesystem.PathResolver;
import org.sonar.plugins.java.api.JavaResourceLocator;

import java.io.File;

public class CoberturaSensor implements Sensor, CoverageExtension {

  private static final Logger LOGGER = LoggerFactory.getLogger(CoberturaSensor.class);

  private ModuleFileSystem moduleFileSystem;
  private PathResolver pathResolver;
  private Settings settings;
  private final JavaResourceLocator javaResourceLocator;

  public CoberturaSensor(ModuleFileSystem moduleFileSystem, PathResolver pathResolver, Settings settings, JavaResourceLocator javaResourceLocator) {
    this.moduleFileSystem = moduleFileSystem;
    this.pathResolver = pathResolver;
    this.settings = settings;
    this.javaResourceLocator = javaResourceLocator;
  }

  public boolean shouldExecuteOnProject(Project project) {
    return !moduleFileSystem.files(FileQuery.on(FileType.SOURCE).onLanguage("java")).isEmpty();
  }

  public void analyse(Project project, SensorContext context) {
    String path = settings.getString(CoberturaPlugin.COBERTURA_REPORT_PATH_PROPERTY);
    File report = pathResolver.relativeFile(moduleFileSystem.baseDir(), path);
    if (!report.isFile()) {
      LOGGER.warn("Cobertura report not found at {}", report);
      return;
    }
    parseReport(report, context);
  }

  protected void parseReport(File xmlFile, SensorContext context) {
    LOGGER.info("parsing {}", xmlFile);
    CoberturaReportParser.parseReport(xmlFile, context, javaResourceLocator);
  }

  @Override
  public String toString() {
    return getClass().getSimpleName();
  }

}