org.sonar.plugins.groovy.codenarc.CodeNarcRunner Maven / Gradle / Ivy

Go to download

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

Enables analysis of Groovy projects.

There is a newer version: 1.1

/*
 * 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.groovy.codenarc;

import org.codenarc.analyzer.FilesystemSourceAnalyzer;
import org.codenarc.report.XmlReportWriter;
import org.sonar.api.checks.profiles.CheckProfile;
import org.sonar.api.resources.Project;
import org.sonar.api.utils.SonarException;
import org.sonar.plugins.groovy.utils.GroovyUtils;

import java.io.File;
import java.io.IOException;
import java.util.Arrays;

public class CodeNarcRunner {

  public void execute(File sourceDir, CheckProfile checkProfile, Project project) {
    GroovyUtils.LOG.info("Executing CodeNarc");

    org.codenarc.CodeNarcRunner runner = new org.codenarc.CodeNarcRunner();
    FilesystemSourceAnalyzer analyzer = new FilesystemSourceAnalyzer();

    // only one source directory
    analyzer.setBaseDirectory(sourceDir.getAbsolutePath());
    analyzer.setIncludes("**/*.groovy");
    runner.setSourceAnalyzer(analyzer);

    // generated xml report
    XmlReportWriter xmlReport = new XmlReportWriter();
    xmlReport.setTitle("Sonar");
    xmlReport.setDefaultOutputFile(new File(project.getFileSystem().getSonarWorkingDirectory(), "codenarc-report.xml").getAbsolutePath());
    runner.setReportWriters(Arrays.asList(xmlReport));

    File conf = new File(project.getFileSystem().getSonarWorkingDirectory(), "checkProfile.xml");
    try {
      new CodeNarcCheckProfile().save(checkProfile, conf);
    }
    catch (IOException e) {
      throw new SonarException("Can not generate the configuration file: " + conf, e);
    }
    runner.setRuleSetFiles("file:" + conf.getAbsolutePath());

    // TODO : might be possible to process results object to get violations
    runner.execute();
  }
}