org.sonar.plugins.cxx.veraxx.CxxVeraxxSensor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-cxx-plugin Show documentation
C++ Plugin for Sonar (Community Edition)
The newest version!
/*
 * Sonar Cxx Plugin, open source software quality management tool.
 * Copyright (C) 2010 - 2011, Neticoa SAS France - Tous droits reserves.
 * Author(s) : Franck Bonin, Neticoa SAS France.
 *
 * Sonar Cxx Plugin 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 Cxx Plugin 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 Cxx Plugin; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.cxx.veraxx;

import java.io.File;
import org.codehaus.staxmate.in.SMHierarchicCursor;
import org.codehaus.staxmate.in.SMInputCursor;
import org.sonar.api.batch.SensorContext;
import org.sonar.api.config.Settings;
import org.sonar.api.profiles.RulesProfile;
import org.sonar.api.resources.Project;
import org.sonar.api.rules.RuleFinder;
import org.sonar.api.utils.StaxParser;
import org.sonar.plugins.cxx.utils.CxxReportSensor;
import org.sonar.plugins.cxx.utils.CxxUtils;
/**
 * {@inheritDoc}
 */
public class CxxVeraxxSensor extends CxxReportSensor {
  public static final String REPORT_PATH_KEY = "sonar.cxx.vera.reportPath";
  private static final String DEFAULT_REPORT_PATH = "vera++-reports/vera++-result-*.xml";
  private RulesProfile profile;
  
  /**
   * {@inheritDoc}
   */
  public CxxVeraxxSensor(RuleFinder ruleFinder, Settings conf, RulesProfile profile) {
    super(ruleFinder, conf);
    this.profile = profile;
  }
  
  /**
   * {@inheritDoc}
   */
  @Override
  public boolean shouldExecuteOnProject(Project project) {
    return super.shouldExecuteOnProject(project)
      && !profile.getActiveRulesByRepository(CxxVeraxxRuleRepository.KEY).isEmpty();
  }
  
  @Override
  protected String reportPathKey() {
    return REPORT_PATH_KEY;
  }
  
  @Override
  protected String defaultReportPath() {
    return DEFAULT_REPORT_PATH;
  }
  
  @Override
  protected void processReport(final Project project, final SensorContext context, File report)
    throws javax.xml.stream.XMLStreamException
  {
    try {  
	    StaxParser parser = new StaxParser(new StaxParser.XmlStreamHandler() {
	      /**
	       * {@inheritDoc}
	       */
	      public void stream(SMHierarchicCursor rootCursor) throws javax.xml.stream.XMLStreamException {
	        rootCursor.advance();
	
	        SMInputCursor fileCursor = rootCursor.childElementCursor("file");
	        while (fileCursor.getNext() != null) {
	          String name = fileCursor.getAttrValue("name");
	
	          SMInputCursor errorCursor = fileCursor.childElementCursor("error");
	          while (errorCursor.getNext() != null) {
	        	  if (!name.equals("error")) {
		            int line = Integer.parseInt(errorCursor.getAttrValue("line"));
		            String message = errorCursor.getAttrValue("message");
		            String source = errorCursor.getAttrValue("source");
		
		            saveViolation(project, context, CxxVeraxxRuleRepository.KEY,
		                          name, line, source, message);
	        	  } else {
	                CxxUtils.LOG.debug("Error in file '{}', with message '{}'",
	                        errorCursor.getAttrValue("line"),
	                        errorCursor.getAttrValue("message"));
	        	  }
	          }
	        }
	      }
	    });
	
	    parser.parse(report);
		} catch (com.ctc.wstx.exc.WstxUnexpectedCharException e){
			CxxUtils.LOG.error("Ignore XML error from Veraxx '{}'",e.toString());
		}
  }
}