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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/*
* 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.scanner.externalissue;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import javax.annotation.CheckForNull;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.fs.TextPointer;
import org.sonar.api.batch.rule.Severity;
import org.sonar.api.batch.sensor.SensorContext;
import org.sonar.api.batch.sensor.issue.NewExternalIssue;
import org.sonar.api.batch.sensor.issue.NewIssueLocation;
import org.sonar.api.batch.sensor.rule.NewAdHocRule;
import org.sonar.api.issue.impact.SoftwareQuality;
import org.sonar.api.rules.CleanCodeAttribute;
import org.sonar.api.rules.RuleType;
import org.sonar.scanner.externalissue.ExternalIssueReport.Issue;
import org.sonar.scanner.externalissue.ExternalIssueReport.Location;
import org.sonar.scanner.externalissue.ExternalIssueReport.Rule;
import static java.lang.String.format;
import static java.util.Optional.ofNullable;
public class ExternalIssueImporter {
private static final Logger LOG = LoggerFactory.getLogger(ExternalIssueImporter.class);
private static final int MAX_UNKNOWN_FILE_PATHS_TO_PRINT = 5;
private final SensorContext context;
private final ExternalIssueReport report;
private final Set<String> unknownFiles = new LinkedHashSet<>();
private final Set<String> knownFiles = new LinkedHashSet<>();
public ExternalIssueImporter(SensorContext context, ExternalIssueReport report) {
this.context = context;
this.report = report;
}
public void execute() {
if (report.rules != null) {
importNewFormat();
} else {
importDeprecatedFormat();
}
}
private void importDeprecatedFormat() {
int issueCount = 0;
for (Issue issue : report.issues) {
if (importDeprecatedIssue(issue)) {
issueCount++;
}
}
logStatistics(issueCount, StringUtils.EMPTY);
}
private void importNewFormat() {
Map<String, Rule> rulesMap = new HashMap<>();
for (Rule rule : report.rules) {
rulesMap.put(rule.id, rule);
NewAdHocRule adHocRule = createAdHocRule(rule);
adHocRule.save();
}
int issueCount = 0;
for (Issue issue : report.issues) {
if (importIssue(issue, rulesMap.get(issue.ruleId))) {
issueCount++;
}
}
logStatistics(issueCount, StringUtils.EMPTY);
}
private NewAdHocRule createAdHocRule(Rule rule) {
NewAdHocRule adHocRule = context.newAdHocRule();
adHocRule.ruleId(rule.id);
adHocRule.name(rule.name);
adHocRule.description(rule.description);
adHocRule.engineId(rule.engineId);
ofNullable(rule.cleanCodeAttribute).ifPresent(cca -> adHocRule.cleanCodeAttribute(CleanCodeAttribute.valueOf(cca)));
ofNullable(rule.severity).ifPresent(s -> adHocRule.severity(Severity.valueOf(s)));
ofNullable(rule.type).ifPresent(t -> adHocRule.type(RuleType.valueOf(t)));
if (rule.impacts != null) {
for (ExternalIssueReport.Impact impact : rule.impacts) {
adHocRule.addDefaultImpact(SoftwareQuality.valueOf(impact.softwareQuality),
org.sonar.api.issue.impact.Severity.valueOf(impact.severity));
}
}
return adHocRule;
}
private boolean populateCommonValues(Issue issue, NewExternalIssue externalIssue) {
if (issue.effortMinutes != null) {
externalIssue.remediationEffortMinutes(Long.valueOf(issue.effortMinutes));
}
NewIssueLocation primary = fillLocation(context, externalIssue.newLocation(), issue.primaryLocation);
if (primary != null) {
knownFiles.add(issue.primaryLocation.filePath);
externalIssue.at(primary);
if (issue.secondaryLocations != null) {
for (Location l : issue.secondaryLocations) {
NewIssueLocation secondary = fillLocation(context, externalIssue.newLocation(), l);
if (secondary != null) {
externalIssue.addLocation(secondary);
}
}
}
externalIssue.save();
return true;
} else {
unknownFiles.add(issue.primaryLocation.filePath);
return false;
}
}
private boolean importDeprecatedIssue(Issue issue) {
NewExternalIssue externalIssue = context.newExternalIssue()
.engineId(issue.engineId)
.ruleId(issue.ruleId)
.severity(Severity.valueOf(issue.severity))
.type(RuleType.valueOf(issue.type));
return populateCommonValues(issue, externalIssue);
}
private boolean importIssue(Issue issue, ExternalIssueReport.Rule rule) {
NewExternalIssue externalIssue = context.newExternalIssue()
.engineId(rule.engineId)
.ruleId(rule.id);
ofNullable(rule.severity).ifPresent(s -> externalIssue.severity(Severity.valueOf(s)));
ofNullable(rule.type).ifPresent(t -> externalIssue.type(RuleType.valueOf(t)));
return populateCommonValues(issue, externalIssue);
}
private void logStatistics(int issueCount, String additionalInformation) {
String pluralizedIssues = pluralize("issue", issueCount);
String pluralizedFiles = pluralize("file", knownFiles.size());
LOG.info("Imported {} {} in {} {}{}", issueCount, pluralizedIssues, knownFiles.size(), pluralizedFiles, additionalInformation);
int numberOfUnknownFiles = unknownFiles.size();
if (numberOfUnknownFiles > 0) {
String limitedUnknownFiles = this.unknownFiles.stream().limit(MAX_UNKNOWN_FILE_PATHS_TO_PRINT).collect(Collectors.joining(", "));
LOG.info("External issues{} ignored for {} unknown files, including: {}", additionalInformation, numberOfUnknownFiles, limitedUnknownFiles);
}
}
private static String pluralize(String msg, int count) {
if (count == 1) {
return msg;
}
return msg + "s";
}
@CheckForNull
private static NewIssueLocation fillLocation(SensorContext context, NewIssueLocation newLocation, Location location) {
InputFile file = findFile(context, location.filePath);
if (file == null) {
return null;
}
newLocation.on(file);
if (location.message != null) {
newLocation.message(location.message);
}
if (location.textRange != null) {
if (location.textRange.startColumn != null) {
TextPointer start = file.newPointer(location.textRange.startLine, location.textRange.startColumn);
checkStartColumnOnEmptyLine(file, start);
int endLine = (location.textRange.endLine != null) ? location.textRange.endLine : location.textRange.startLine;
int endColumn;
// assume it's until the last character of the end line
endColumn = Objects.requireNonNullElseGet(location.textRange.endColumn, () -> file.selectLine(endLine).end().lineOffset());
TextPointer end = file.newPointer(endLine, endColumn);
newLocation.at(file.newRange(start, end));
} else {
newLocation.at(file.selectLine(location.textRange.startLine));
}
}
return newLocation;
}
private static void checkStartColumnOnEmptyLine(InputFile file, TextPointer startPointer) {
if (file.selectLine(startPointer.line()).end().lineOffset() == 0) {
throw new IllegalArgumentException(format("A 'startColumn' %s cannot be provided when the line is empty", startPointer));
}
}
@CheckForNull
private static InputFile findFile(SensorContext context, String filePath) {
return context.fileSystem().inputFile(context.fileSystem().predicates().hasPath(filePath));
}
}
|
