blob: 235ed9d60674e9b4f53d1d3617772db31b0d8674 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*
* SonarQube
* Copyright (C) 2009-2025 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.rule.Severity;
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.api.rules.RuleType;
import org.sonar.xoo.Xoo;
public class OneExternalIssuePerLineWithoutMessageSensor implements Sensor {
public static final String RULE_ID = "oneExternalIssuePerLineWithoutMessage";
public static final String ENGINE_ID = "XooEngine";
public static final String SEVERITY = "MAJOR";
public static final Long EFFORT = 10L;
public static final RuleType TYPE = RuleType.BUG;
public static final String ACTIVATE = "sonar.oneExternalIssuePerLineWithoutMessage.activate";
public static final String REGISTER_AD_HOC_RULE = "sonar.oneExternalIssuePerLineWithoutMessage.adhocRule";
private static final String NAME = "One External Issue Per Line Without Message";
@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")
.severity(Severity.BLOCKER)
.type(RuleType.BUG)
.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(""))
.severity(Severity.valueOf(SEVERITY))
.remediationEffortMinutes(EFFORT)
.type(TYPE)
.save();
}
}
}
|
