12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697 |
- /*
- * SonarQube
- * Copyright (C) 2009-2022 SonarSource SA
- * mailto:info AT sonarsource DOT com
- *
- * 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 02110-1301, USA.
- */
- package org.sonar.education.sensors;
-
- import java.io.BufferedReader;
- import java.io.IOException;
- import java.io.InputStreamReader;
- import org.sonar.api.batch.fs.FileSystem;
- import org.sonar.api.batch.fs.InputFile;
- import org.sonar.api.batch.rule.ActiveRules;
- import org.sonar.api.batch.sensor.Sensor;
- import org.sonar.api.batch.sensor.SensorContext;
- import org.sonar.api.batch.sensor.SensorDescriptor;
- import org.sonar.api.batch.sensor.issue.NewIssue;
- import org.sonar.api.rule.RuleKey;
-
- import static org.sonar.education.EducationRulesDefinition.EDUCATION_KEY;
- import static org.sonar.education.EducationRulesDefinition.EDUCATION_RULE_REPOSITORY_KEY;
-
- public abstract class EducationRuleSensor implements Sensor {
-
- private final FileSystem fs;
- private final ActiveRules activeRules;
- private final String ruleKeyName;
- private final String tag;
-
- EducationRuleSensor(FileSystem fs, ActiveRules activeRules, String ruleKey) {
- this.fs = fs;
- this.activeRules = activeRules;
- this.ruleKeyName = ruleKey;
- this.tag = ruleKey;
- }
-
- @Override
- public void describe(SensorDescriptor descriptor) {
- descriptor
- .name("Education sensor for " + tag)
- .createIssuesForRuleRepository(EDUCATION_RULE_REPOSITORY_KEY);
- }
-
- @Override
- public void execute(SensorContext context) {
- RuleKey ruleKey = RuleKey.of(EDUCATION_RULE_REPOSITORY_KEY, ruleKeyName);
- if (activeRules.find(ruleKey) == null) {
- return;
- }
- for (InputFile inputFile : fs.inputFiles(fs.predicates().hasLanguage(EDUCATION_KEY))) {
- processFile(inputFile, context, ruleKey);
- }
- }
-
- protected String getDetectedContext() {
- return null;
- }
-
- protected void processFile(InputFile inputFile, SensorContext context, RuleKey ruleKey) {
- try {
- int[] lineCounter = {1};
- try (InputStreamReader isr = new InputStreamReader(inputFile.inputStream(), inputFile.charset());
- BufferedReader reader = new BufferedReader(isr)) {
- reader.lines().forEachOrdered(lineStr -> {
- int startIndex = -1;
- while ((startIndex = lineStr.indexOf(tag, startIndex + 1)) != -1) {
- NewIssue newIssue = context.newIssue();
- newIssue
- .forRule(ruleKey)
- .at(newIssue.newLocation()
- .on(inputFile)
- .at(inputFile.newRange(lineCounter[0], startIndex, lineCounter[0], startIndex + tag.length())))
- .setRuleDescriptionContextKey(getDetectedContext())
- .save();
- }
- lineCounter[0]++;
- });
- }
- } catch (IOException e) {
- throw new IllegalStateException("Fail to process " + inputFile, e);
- }
- }
- }
|