001 /* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * SonarQube is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * SonarQube is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020 package org.sonar.xoo.rule; 021 022 import org.slf4j.LoggerFactory; 023 import org.sonar.api.batch.fs.InputFile; 024 import org.sonar.api.batch.sensor.Sensor; 025 import org.sonar.api.batch.sensor.SensorContext; 026 import org.sonar.api.batch.sensor.SensorDescriptor; 027 import org.sonar.api.batch.sensor.issue.IssueBuilder; 028 import org.sonar.api.batch.sensor.measure.Measure; 029 import org.sonar.api.measures.CoreMetrics; 030 import org.sonar.api.rule.RuleKey; 031 import org.sonar.xoo.Xoo; 032 033 public class OneIssuePerLineSensor implements Sensor { 034 035 public static final String RULE_KEY = "OneIssuePerLine"; 036 private static final String EFFORT_TO_FIX_PROPERTY = "sonar.oneIssuePerLine.effortToFix"; 037 private static final String FORCE_SEVERITY_PROPERTY = "sonar.oneIssuePerLine.forceSeverity"; 038 039 @Override 040 public void describe(SensorDescriptor descriptor) { 041 descriptor 042 .name("One Issue Per Line") 043 .dependsOn(CoreMetrics.LINES) 044 .workOnLanguages(Xoo.KEY) 045 .createIssuesForRuleRepositories(XooRulesDefinition.XOO_REPOSITORY) 046 .workOnFileTypes(InputFile.Type.MAIN, InputFile.Type.TEST); 047 } 048 049 @Override 050 public void execute(SensorContext context) { 051 for (InputFile file : context.fileSystem().inputFiles(context.fileSystem().predicates().hasLanguages(Xoo.KEY))) { 052 createIssues(file, context); 053 } 054 } 055 056 private void createIssues(InputFile file, SensorContext context) { 057 RuleKey ruleKey = RuleKey.of(XooRulesDefinition.XOO_REPOSITORY, RULE_KEY); 058 Measure<Integer> linesMeasure = context.getMeasure(file, CoreMetrics.LINES); 059 if (linesMeasure == null) { 060 LoggerFactory.getLogger(getClass()).warn("Missing measure " + CoreMetrics.LINES_KEY + " on " + file); 061 } else { 062 IssueBuilder issueBuilder = context.issueBuilder(); 063 for (int line = 1; line <= (Integer) linesMeasure.value(); line++) { 064 context.addIssue(issueBuilder 065 .ruleKey(ruleKey) 066 .onFile(file) 067 .atLine(line) 068 .effortToFix(context.settings().getDouble(EFFORT_TO_FIX_PROPERTY)) 069 .severity(context.settings().getString(FORCE_SEVERITY_PROPERTY)) 070 .message("This issue is generated on each line") 071 .build()); 072 } 073 } 074 } 075 }