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.sonar.api.batch.fs.InputFile;
023    import org.sonar.api.batch.sensor.Sensor;
024    import org.sonar.api.batch.sensor.SensorContext;
025    import org.sonar.api.batch.sensor.SensorDescriptor;
026    import org.sonar.api.batch.sensor.issue.Issue.Severity;
027    import org.sonar.api.measures.CoreMetrics;
028    import org.sonar.api.rule.RuleKey;
029    import org.sonar.xoo.Xoo;
030    
031    public class OneIssuePerLineSensor implements Sensor {
032    
033      public static final String RULE_KEY = "OneIssuePerLine";
034      private static final String EFFORT_TO_FIX_PROPERTY = "sonar.oneIssuePerLine.effortToFix";
035      public static final String FORCE_SEVERITY_PROPERTY = "sonar.oneIssuePerLine.forceSeverity";
036    
037      @Override
038      public void describe(SensorDescriptor descriptor) {
039        descriptor
040          .name("One Issue Per Line")
041          .dependsOn(CoreMetrics.LINES)
042          .workOnLanguages(Xoo.KEY)
043          .createIssuesForRuleRepositories(XooRulesDefinition.XOO_REPOSITORY)
044          .workOnFileTypes(InputFile.Type.MAIN, InputFile.Type.TEST);
045      }
046    
047      @Override
048      public void execute(SensorContext context) {
049        for (InputFile file : context.fileSystem().inputFiles(context.fileSystem().predicates().hasLanguages(Xoo.KEY))) {
050          createIssues(file, context);
051        }
052      }
053    
054      private void createIssues(InputFile file, SensorContext context) {
055        RuleKey ruleKey = RuleKey.of(XooRulesDefinition.XOO_REPOSITORY, RULE_KEY);
056        String severity = context.settings().getString(FORCE_SEVERITY_PROPERTY);
057        for (int line = 1; line <= file.lines(); line++) {
058          context.newIssue()
059            .ruleKey(ruleKey)
060            .onFile(file)
061            .atLine(line)
062            .effortToFix(context.settings().getDouble(EFFORT_TO_FIX_PROPERTY))
063            .overrideSeverity(severity != null ? Severity.valueOf(severity) : null)
064            .message("This issue is generated on each line")
065            .save();
066        }
067      }
068    }