Skip to content

Commit

Permalink
fix(SARIF): Correcting reporting descriptor lookup (refs #154)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tomasbjerre
tomasbjerre committed Aug 26, 2022
1 parent d9e0a8d commit 6608422
Show file tree
Hide file tree
Showing 2 changed files with 148 additions and 30 deletions.
176 changes: 147 additions & 29 deletions src/main/java/se/bjurr/violations/lib/parsers/SarifParser.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
import java.util.Optional;
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Function;
import java.util.stream.Collectors;
import se.bjurr.violations.lib.ViolationsLogger;
import se.bjurr.violations.lib.model.SEVERITY;
Expand All @@ -31,14 +30,23 @@
import se.bjurr.violations.lib.model.generated.sarif.Region;
import se.bjurr.violations.lib.model.generated.sarif.ReportingConfiguration;
import se.bjurr.violations.lib.model.generated.sarif.ReportingDescriptor;
import se.bjurr.violations.lib.model.generated.sarif.ReportingDescriptorReference;
import se.bjurr.violations.lib.model.generated.sarif.Result;
import se.bjurr.violations.lib.model.generated.sarif.Result.Level;
import se.bjurr.violations.lib.model.generated.sarif.Run;
import se.bjurr.violations.lib.model.generated.sarif.SarifSchema;
import se.bjurr.violations.lib.model.generated.sarif.ToolComponent;
import se.bjurr.violations.lib.model.generated.sarif.ToolComponentReference;
import se.bjurr.violations.lib.reports.Parser;
import se.bjurr.violations.lib.util.Utils;

public class SarifParser implements ViolationsParser {
/** 3.52.3 */
public enum DescriptorElementOf {
RULES,
NOTIFICATIONS
}

public static final String SARIF_RESULTS_CORRELATION_GUID = "correlationGuid";

public class ParsedPhysicalLocation {
Expand Down Expand Up @@ -127,7 +135,6 @@ ReportingConfiguration.Level.class, new ReportingConfigurationDeserializer())

private Set<Violation> parseResults(final Run run) {
final Set<Violation> violations = new TreeSet<>();
final Map<String, ReportingDescriptor> rulesById = this.getRulesById(run);
final String reporter = this.getReporter(run);
for (final Result result : run.getResults()) {
final String ruleId = result.getRuleId();
Expand All @@ -143,8 +150,8 @@ private Set<Violation> parseResults(final Run run) {
if (!isNullOrEmpty(correlationGuid)) {
specifics.put(SARIF_RESULTS_CORRELATION_GUID, correlationGuid);
}

final ReportingDescriptor reportingDescriptor = rulesById.get(ruleId);
final ReportingDescriptor reportingDescriptor =
this.findReportingDescriptor(run, result, DescriptorElementOf.RULES).orElse(null);
final String category = this.getCategory(reportingDescriptor);

final Optional<String> helpTextOpt = this.findHelpText(reportingDescriptor);
Expand Down Expand Up @@ -189,12 +196,18 @@ private Set<Violation> parseResults(final Run run) {

private Set<Violation> parseNotifications(final Run run) {
final Set<Violation> violations = new TreeSet<>();
final List<ReportingDescriptor> notifications = this.getNotifications(run);
this.getNotifications(run);
final String reporter = this.getReporter(run);
for (final Invocation invocation : run.getInvocations()) {
for (final Notification notification : invocation.getToolConfigurationNotifications()) {
final ReportingDescriptorReference ref = notification.getAssociatedRule();
final Integer ruleIndex = this.getRuleIndex(ref);
final String ruleId = null;
final ReportingDescriptor reportingDescriptor =
this.getReportingDescriptor(notifications, notification);
this.findReportingDescriptor(
run, DescriptorElementOf.NOTIFICATIONS, ref, ruleIndex, ruleId)
.orElse(null);

final String reportingDescriptorName = this.getName(reportingDescriptor);
final SEVERITY severity = this.toSeverity(notification.getLevel(), reportingDescriptor);
final List<Location> locations = this.filter(notification.getLocations());
Expand All @@ -221,13 +234,18 @@ private Set<Violation> parseNotifications(final Run run) {
.build());
}
} else {
final String message =
this.extractMessage(notification.getMessage(), reportingDescriptor);
if (message.isEmpty()) {
continue;
}
violations.add(
violationBuilder()
.setParser(Parser.SARIF)
.setFile(Violation.NO_FILE)
.setStartLine(Violation.NO_LINE)
.setRule(reportingDescriptorName)
.setMessage(this.extractMessage(notification.getMessage(), reportingDescriptor))
.setMessage(message)
.setSeverity(severity)
.setReporter(reporter)
.build());
Expand All @@ -237,6 +255,17 @@ private Set<Violation> parseNotifications(final Run run) {
return violations;
}

private Integer getRuleIndex(final ReportingDescriptorReference ref) {
Integer ruleIndex = null;
if (ref != null) {
ruleIndex = ref.getIndex();
}
if (ruleIndex == null || ruleIndex == -1) {
return null;
}
return ruleIndex;
}

private String getName(final ReportingDescriptor reportingDescriptor) {
if (reportingDescriptor != null) {
return reportingDescriptor.getName();
Expand Down Expand Up @@ -295,18 +324,6 @@ private List<Location> filterLocations(final List<Location> locations) {
.collect(Collectors.toList());
}

private ReportingDescriptor getReportingDescriptor(
final List<ReportingDescriptor> notifications, final Notification notification) {
if (notification.getDescriptor() == null) {
return null;
}
final Integer notificationIndex = notification.getDescriptor().getIndex();
if (notificationIndex == null) {
return null;
}
return notifications.get(notificationIndex);
}

private String toMessage(
final Message message,
final Optional<String> helpTextOpt,
Expand Down Expand Up @@ -392,16 +409,6 @@ private String extractMessage(
return "";
}

private Map<String, ReportingDescriptor> getRulesById(final Run run) {
if (run.getTool() != null
&& run.getTool().getDriver() != null
&& run.getTool().getDriver().getRules() != null) {
return run.getTool().getDriver().getRules().stream()
.collect(Collectors.toMap(ReportingDescriptor::getId, Function.identity()));
}
return new HashMap<>();
}

private Optional<String> findHelpText(final ReportingDescriptor r) {
if (r == null) {
return Optional.empty();
Expand Down Expand Up @@ -461,4 +468,115 @@ private Optional<SEVERITY> toSeverity(final ReportingDescriptor reportingDescrip
}
return Optional.empty();
}

private Optional<ReportingDescriptor> findReportingDescriptor(
final Run run, final Result result, final DescriptorElementOf lookIn) {
final ReportingDescriptorReference ref = result.getRule();
final Integer ruleIndex = this.findRuleIndex(result, ref);
final String ruleId = result.getRuleId();
return this.findReportingDescriptor(run, lookIn, ref, ruleIndex, ruleId);
}

private Optional<ReportingDescriptor> findReportingDescriptor(
final Run run,
final DescriptorElementOf lookIn,
final ReportingDescriptorReference ref,
final Integer ruleIndex,
final String ruleId) {
final ToolComponent tool = this.findToolComponent(run, ref);
if (tool == null) {
return Optional.empty();
}
if (ruleIndex != null) {
return Optional.of(this.getReportingDescriptorByIndex(tool, ruleIndex, lookIn));
}

if (ref != null && ref.getGuid() != null) {
return this.findReportingDescriptorByGui(tool, ref.getGuid(), lookIn);
}
if (ruleId != null) {
return this.findReportingDescriptorByRuleId(tool, ruleId, lookIn);
}
return Optional.empty();
}

private Integer findRuleIndex(final Result result, final ReportingDescriptorReference ref) {
Integer ruleIndex = result.getRuleIndex();
if (ruleIndex == -1) {
ruleIndex = null;
}
if (ruleIndex == null && ref != null) {
ruleIndex = ref.getIndex();
}
return ruleIndex;
}

private ToolComponent findToolComponent(final Run run, final ReportingDescriptorReference ref) {
if (run.getTool() == null) {
return null;
}
if (ref == null) {
return run.getTool().getDriver();
}
final ToolComponentReference toolRef = ref.getToolComponent();
if (toolRef.getGuid() != null) {
return this.getToolComponentByGui(run, toolRef.getGuid());
}
if (toolRef.getIndex() != null) {
return this.getToolComponentByIndex(run, toolRef.getIndex());
}
return run.getTool().getDriver();
}

private ReportingDescriptor getReportingDescriptorByIndex(
final ToolComponent tool, final Integer index, final DescriptorElementOf lookIn) {
if (lookIn == DescriptorElementOf.RULES) {
return new ArrayList<>(tool.getRules()).get(index);
}
if (lookIn == DescriptorElementOf.NOTIFICATIONS) {
return new ArrayList<>(tool.getNotifications()).get(index);
}
throw new IllegalStateException(lookIn + " cannot find ReportingDescriptor");
}

private Optional<ReportingDescriptor> findReportingDescriptorByGui(
final ToolComponent tool, final String guid, final DescriptorElementOf lookIn) {
if (lookIn == DescriptorElementOf.RULES) {
return tool.getRules().stream()
.filter((it) -> it.getGuid() != null && it.getGuid().equals(guid))
.findFirst();
}
if (lookIn == DescriptorElementOf.NOTIFICATIONS) {
return tool.getNotifications().stream()
.filter((it) -> it.getGuid() != null && it.getGuid().equals(guid))
.findFirst();
}
return Optional.empty();
}

private Optional<ReportingDescriptor> findReportingDescriptorByRuleId(
final ToolComponent tool, final String ruleId, final DescriptorElementOf lookIn) {
if (lookIn == DescriptorElementOf.RULES) {
return tool.getRules().stream()
.filter((it) -> it.getId() != null && it.getId().equals(ruleId))
.findFirst();
}
if (lookIn == DescriptorElementOf.NOTIFICATIONS) {
return tool.getNotifications().stream()
.filter((it) -> it.getId() != null && it.getId().equals(ruleId))
.findFirst();
}
throw new IllegalStateException(lookIn + " cannot find ReportingDescriptor");
}

private ToolComponent getToolComponentByIndex(final Run run, final Integer index) {
return new ArrayList<>(run.getTool().getExtensions()).get(index);
}

private ToolComponent getToolComponentByGui(final Run run, final String guid) {
return run.getTool().getExtensions().stream()
.filter((it) -> it.getGuid() != null && it.getGuid().equals(guid))
.findFirst()
.get();
}
}
2 changes: 1 addition & 1 deletion src/test/java/se/bjurr/violations/lib/SarifParserTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public void testThatViolationsCanBeParsed_smoke() {
.violations();

assertThat(actual) //
.hasSize(54);
.hasSize(53);
}

@Test
Expand Down

0 comments on commit 6608422

Please sign in to comment.