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
|
/*
* 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.sarif;
import java.util.Collection;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.function.Predicate;
import javax.annotation.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.sarif.pojo.ReportingConfiguration;
import org.sonar.sarif.pojo.ReportingDescriptor;
import org.sonar.sarif.pojo.Result;
import org.sonar.sarif.pojo.Run;
import org.sonar.sarif.pojo.Tool;
import org.sonar.sarif.pojo.ToolComponent;
import static java.util.Collections.emptyMap;
import static java.util.Collections.emptySet;
import static java.util.stream.Collectors.toMap;
import static org.sonar.scanner.externalissue.sarif.ResultMapper.DEFAULT_IMPACT_SEVERITY;
import static org.sonar.scanner.externalissue.sarif.ResultMapper.DEFAULT_SEVERITY;
public class RulesSeverityDetector {
private static final Logger LOG = LoggerFactory.getLogger(RulesSeverityDetector.class);
private static final String UNSUPPORTED_RULE_SEVERITIES_WARNING = "Unable to detect rules severity for issue detected by tool {}, falling back to default rule severity: {}";
private RulesSeverityDetector() {}
public static Map<String, Result.Level> detectRulesSeverities(Run run, String driverName) {
Map<String, Result.Level> resultDefinedRuleSeverities = getResultDefinedRuleSeverities(run);
if (!resultDefinedRuleSeverities.isEmpty()) {
return resultDefinedRuleSeverities;
}
Map<String, Result.Level> driverDefinedRuleSeverities = getDriverDefinedRuleSeverities(run);
if (!driverDefinedRuleSeverities.isEmpty()) {
return driverDefinedRuleSeverities;
}
Map<String, Result.Level> extensionDefinedRuleSeverities = getExtensionsDefinedRuleSeverities(run);
if (!extensionDefinedRuleSeverities.isEmpty()) {
return extensionDefinedRuleSeverities;
}
LOG.warn(UNSUPPORTED_RULE_SEVERITIES_WARNING, driverName, DEFAULT_SEVERITY.name());
return emptyMap();
}
public static Map<String, Result.Level> detectRulesSeveritiesForNewTaxonomy(Run run, String driverName) {
Map<String, Result.Level> driverDefinedRuleSeverities = getDriverDefinedRuleSeverities(run);
if (!driverDefinedRuleSeverities.isEmpty()) {
return driverDefinedRuleSeverities;
}
Map<String, Result.Level> extensionDefinedRuleSeverities = getExtensionsDefinedRuleSeverities(run);
if (!extensionDefinedRuleSeverities.isEmpty()) {
return extensionDefinedRuleSeverities;
}
LOG.warn(UNSUPPORTED_RULE_SEVERITIES_WARNING, driverName, DEFAULT_IMPACT_SEVERITY.name());
return emptyMap();
}
private static Map<String, Result.Level> getResultDefinedRuleSeverities(Run run) {
Predicate<Result> hasResultDefinedLevel = result -> Optional.ofNullable(result).map(Result::getLevel).isPresent();
return run.getResults()
.stream()
.filter(hasResultDefinedLevel)
.collect(toMap(Result::getRuleId, Result::getLevel, (x, y) -> y));
}
private static Map<String, Result.Level> getDriverDefinedRuleSeverities(Run run) {
Set<ReportingDescriptor> rules = run.getTool().getDriver().getRules();
if (rules == null) {
return emptyMap();
}
return rules.stream()
.filter(RulesSeverityDetector::hasRuleDefinedLevel)
.collect(toMap(ReportingDescriptor::getId, x -> Result.Level.valueOf(x.getDefaultConfiguration().getLevel().name())));
}
private static Map<String, Result.Level> getExtensionsDefinedRuleSeverities(Run run) {
return getExtensions(run)
.stream()
.map(ToolComponent::getRules)
.filter(Objects::nonNull)
.flatMap(Collection::stream)
.filter(RulesSeverityDetector::hasRuleDefinedLevel)
.collect(toMap(ReportingDescriptor::getId, rule -> Result.Level.valueOf(rule.getDefaultConfiguration().getLevel().name())));
}
private static Set<ToolComponent> getExtensions(Run run) {
return Optional.of(run)
.map(Run::getTool)
.map(Tool::getExtensions)
.orElse(emptySet());
}
private static boolean hasRuleDefinedLevel(@Nullable ReportingDescriptor rule) {
return Optional.ofNullable(rule)
.map(ReportingDescriptor::getDefaultConfiguration)
.map(ReportingConfiguration::getLevel)
.isPresent();
}
}
|
