123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 |
- /*
- * SonarQube
- * Copyright (C) 2009-2024 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.xoo.rule;
-
- import org.sonar.api.batch.fs.FilePredicates;
- import org.sonar.api.batch.fs.FileSystem;
- import org.sonar.api.batch.fs.InputFile;
- 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.NewExternalIssue;
- import org.sonar.xoo.Xoo;
-
- import static org.sonar.api.issue.impact.Severity.LOW;
- import static org.sonar.api.issue.impact.Severity.MEDIUM;
- import static org.sonar.api.issue.impact.SoftwareQuality.MAINTAINABILITY;
- import static org.sonar.api.issue.impact.SoftwareQuality.RELIABILITY;
- import static org.sonar.api.rules.CleanCodeAttribute.CLEAR;
-
- public class OneExternalIssueCctPerLineSensor implements Sensor {
- public static final String RULE_ID = "OneExternalIssueWithPerLineSensor";
- public static final String ENGINE_ID = "XooEngine";
- public static final Long EFFORT = 10L;
- public static final String ACTIVATE = "sonar.oneExternalIssueWithPerLineSensor.activate";
- public static final String REGISTER_AD_HOC_RULE = "sonar.oneExternalIssueWithPerLineSensor.adhocRule";
- private static final String NAME = "One External Issue Per Line in Clean Code Taxonomy format";
-
- @Override
- public void describe(SensorDescriptor descriptor) {
- descriptor
- .name(NAME)
- .onlyOnLanguages(Xoo.KEY)
- .onlyWhenConfiguration(c -> c.getBoolean(ACTIVATE).orElse(false));
- }
-
- @Override
- public void execute(SensorContext context) {
- FileSystem fs = context.fileSystem();
- FilePredicates p = fs.predicates();
- for (InputFile file : fs.inputFiles(p.and(p.hasLanguages(Xoo.KEY), p.hasType(InputFile.Type.MAIN)))) {
- createIssues(file, context);
- }
- if (context.config().getBoolean(REGISTER_AD_HOC_RULE).orElse(false)) {
- context.newAdHocRule()
- .engineId(ENGINE_ID)
- .ruleId(RULE_ID)
- .name("An ad hoc rule")
- .description("blah blah")
- .cleanCodeAttribute(CLEAR)
- .addDefaultImpact(MAINTAINABILITY, MEDIUM)
- .addDefaultImpact(RELIABILITY, LOW)
- .save();
- }
- }
-
- private static void createIssues(InputFile file, SensorContext context) {
- for (int line = 1; line <= file.lines(); line++) {
- NewExternalIssue newIssue = context.newExternalIssue();
- newIssue
- .engineId(ENGINE_ID)
- .ruleId(RULE_ID)
- .at(newIssue.newLocation()
- .on(file)
- .at(file.selectLine(line))
- .message("This issue is generated on each line"))
- .remediationEffortMinutes(EFFORT)
- .save();
- }
- }
- }
|