forked from SonarSource/SonarJS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CssRuleSensor.java
265 lines (241 loc) · 8.4 KB
/
CssRuleSensor.java
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-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.plugins.javascript.bridge;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.StreamSupport;
import org.sonar.api.SonarProduct;
import org.sonar.api.SonarRuntime;
import org.sonar.api.batch.fs.FilePredicate;
import org.sonar.api.batch.fs.FileSystem;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.rule.CheckFactory;
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.batch.sensor.issue.NewIssueLocation;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.utils.Version;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonar.css.CssLanguage;
import org.sonar.css.CssRules;
import org.sonar.css.StylelintRule;
import org.sonar.plugins.javascript.CancellationException;
import org.sonar.plugins.javascript.utils.ProgressReport;
public class CssRuleSensor extends AbstractBridgeSensor {
private static final Logger LOG = Loggers.get(CssRuleSensor.class);
private final SonarRuntime sonarRuntime;
private final CssRules cssRules;
public CssRuleSensor(
SonarRuntime sonarRuntime,
BridgeServer bridgeServer,
AnalysisWarningsWrapper analysisWarnings,
CheckFactory checkFactory
) {
super(bridgeServer, analysisWarnings, "CSS");
this.sonarRuntime = sonarRuntime;
this.cssRules = new CssRules(checkFactory);
}
@Override
public void describe(SensorDescriptor descriptor) {
descriptor.createIssuesForRuleRepository("css").name("CSS Rules");
processesFilesIndependently(descriptor);
}
private void processesFilesIndependently(SensorDescriptor descriptor) {
if (
sonarRuntime.getProduct() == SonarProduct.SONARQUBE &&
sonarRuntime.getApiVersion().isGreaterThanOrEqual(Version.create(9, 3))
) {
descriptor.processesFilesIndependently();
}
}
@Override
public void execute(SensorContext context) {
this.context = context;
List<InputFile> inputFiles = getInputFiles();
if (inputFiles.isEmpty()) {
LOG.info(
"No CSS, PHP, HTML or VueJS files are found in the project. CSS analysis is skipped."
);
return;
}
super.execute(context);
}
@Override
protected void analyzeFiles(List<InputFile> inputFiles) throws IOException {
ProgressReport progressReport = new ProgressReport(
"Analysis progress",
TimeUnit.SECONDS.toMillis(10)
);
boolean success = false;
List<StylelintRule> rules = cssRules.getStylelintRules();
try {
progressReport.start(inputFiles.size(), inputFiles.iterator().next().absolutePath());
for (InputFile inputFile : inputFiles) {
if (context.isCancelled()) {
throw new CancellationException(
"Analysis interrupted because the SensorContext is in cancelled state"
);
}
analyzeFile(inputFile, context, rules);
progressReport.nextFile(inputFile.absolutePath());
}
success = true;
} finally {
if (success) {
progressReport.stop();
} else {
progressReport.cancel();
}
}
}
void analyzeFile(InputFile inputFile, SensorContext context, List<StylelintRule> rules) {
try {
URI uri = inputFile.uri();
if (!"file".equalsIgnoreCase(uri.getScheme())) {
LOG.debug("Skipping {} as it has not 'file' scheme", uri);
return;
}
LOG.debug("Analyzing file: {}", uri);
String fileContent = contextUtils.shouldSendFileContent(inputFile)
? inputFile.contents()
: null;
BridgeServer.CssAnalysisRequest request = new BridgeServer.CssAnalysisRequest(
new File(uri).getAbsolutePath(),
fileContent,
rules
);
BridgeServer.AnalysisResponse analysisResponse = bridgeServer.analyzeCss(request);
LOG.debug("Found {} issue(s)", analysisResponse.issues.size());
saveIssues(context, inputFile, analysisResponse.issues);
} catch (IOException | RuntimeException e) {
throw new IllegalStateException("Failure during analysis of " + inputFile.uri(), e);
}
}
private void saveIssues(
SensorContext context,
InputFile inputFile,
List<BridgeServer.Issue> issues
) {
for (BridgeServer.Issue issue : issues) {
RuleKey ruleKey = cssRules.getActiveSonarKey(issue.ruleId);
if (ruleKey == null) {
if ("CssSyntaxError".equals(issue.ruleId)) {
String errorMessage = issue.message.replace("(CssSyntaxError)", "").trim();
logWarningOrDebug(
inputFile,
"Failed to parse file {}, line {}, {}",
inputFile.uri(),
issue.line,
errorMessage
);
} else {
logErrorOrDebug(
inputFile,
"Unknown stylelint rule or rule not enabled: '" + issue.ruleId + "'"
);
}
} else {
NewIssue sonarIssue = context.newIssue();
NewIssueLocation location = sonarIssue
.newLocation()
.on(inputFile)
.at(inputFile.selectLine(issue.line))
.message(normalizeMessage(issue.message));
sonarIssue.at(location).forRule(ruleKey).save();
}
}
}
private static void logErrorOrDebug(InputFile file, String msg, Object... arguments) {
if (CssLanguage.KEY.equals(file.language())) {
LOG.error(msg, arguments);
} else {
LOG.debug(msg, arguments);
}
}
private static void logWarningOrDebug(InputFile file, String msg, Object... arguments) {
if (CssLanguage.KEY.equals(file.language())) {
LOG.warn(msg, arguments);
} else {
LOG.debug(msg, arguments);
}
}
@Override
protected void logErrorOrWarn(String msg, Throwable e) {
if (hasCssFiles(context)) {
LOG.error(msg, e);
} else {
LOG.warn(msg);
}
}
@Override
protected List<InputFile> getInputFiles() {
var fileSystem = this.context.fileSystem();
var p = fileSystem.predicates();
var cssFilePredicate = p.and(
p.hasType(InputFile.Type.MAIN),
p.or(p.hasLanguages(CssLanguage.KEY))
);
var webFilePredicate = p.and(
p.hasType(InputFile.Type.MAIN),
p.or(p.hasExtension("htm"), p.hasExtension("html"), p.hasExtension("xhtml"))
);
var vueFilePredicate = p.and(
p.hasType(InputFile.Type.MAIN),
p.hasExtension("vue"),
// by default 'vue' extension is defined for JS language, but 'vue' files can contain TS code and thus language can be changed
p.hasLanguages("js", "ts")
);
return StreamSupport
.stream(
fileSystem
.inputFiles(p.or(cssFilePredicate, webFilePredicate, vueFilePredicate))
.spliterator(),
false
)
.toList();
}
public static boolean hasCssFiles(SensorContext context) {
FileSystem fileSystem = context.fileSystem();
FilePredicate mainFilePredicate = fileSystem
.predicates()
.and(
fileSystem.predicates().hasType(InputFile.Type.MAIN),
fileSystem.predicates().hasLanguages(CssLanguage.KEY)
);
return fileSystem.inputFiles(mainFilePredicate).iterator().hasNext();
}
private static String normalizeMessage(String message) {
// stylelint messages have format "message (rulekey)"
Pattern pattern = Pattern.compile("(.+)\\([a-z\\-]+\\)");
Matcher matcher = pattern.matcher(message);
if (matcher.matches()) {
return matcher.group(1);
} else {
return message;
}
}
}