pmd / pmd / 196

Committed 16 Oct 2025 08:33AM UTC coverage: 78.642% (-0.02%) from 78.661%

Build # 196

Build Type

push

github

Committed by

web-flow

Commit Message

chore: fix dogfood issues from new rules (#6056)

Run Details

18180 of 23973 branches covered (75.84%)

Branch coverage included in aggregate %.

2 of 27 new or added lines in 14 files covered. (7.41%)

2 existing lines in 1 file now uncovered.

39693 of 49617 relevant lines covered (80.0%)

0.81 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.83

/pmd-core/src/main/java/net/sourceforge/pmd/renderers/internal/sarif/SarifLogBuilder.java

/*
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.renderers.internal.sarif;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;

import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.lang.rule.RulePriority;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingConfiguration;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification;
import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification;
import net.sourceforge.pmd.reporting.Report;
import net.sourceforge.pmd.reporting.RuleViolation;
import net.sourceforge.pmd.util.AssertionUtil;

public class SarifLogBuilder {
    private final List<ReportingDescriptor> rules = new ArrayList<>();
    private final List<Result> results = new ArrayList<>();
    private final List<ToolConfigurationNotification> toolConfigurationNotifications = new ArrayList<>();
    private final List<ToolExecutionNotification> toolExecutionNotifications = new ArrayList<>();

    public static SarifLogBuilder sarifLogBuilder() {
        return new SarifLogBuilder();
    }

    public SarifLogBuilder add(RuleViolation violation) {
        final ReportingDescriptor ruleDescriptor = getReportingDescriptor(violation);
        int ruleIndex = rules.indexOf(ruleDescriptor);
        if (ruleIndex == -1) {
            rules.add(ruleDescriptor);
            ruleIndex = rules.size() - 1;
        }

        final Location location = getRuleViolationLocation(violation);
        final Result result = resultFrom(ruleDescriptor, ruleIndex, location, violation.getRule().getPriority());
        results.add(result);

        return this;
    }

    public SarifLogBuilder addRunTimeError(Report.ProcessingError error) {
        ArtifactLocation artifactLocation = ArtifactLocation.builder()
                .uri(error.getFileId().getUriString())
                .build();

        PhysicalLocation physicalLocation = PhysicalLocation.builder()
                .artifactLocation(artifactLocation)
                .build();

        Location location = Location
                .builder()
                .physicalLocation(physicalLocation)
                .build();

        Message message = Message.builder()
                .text(error.getMsg())
                .build();

        Exception exception = Exception.builder()
                .message(error.getDetail())
                .build();

        ToolExecutionNotification toolExecutionNotification = ToolExecutionNotification.builder()
                .locations(Collections.singletonList(location))
                .message(message)
                .exception(exception)
                .build();

        toolExecutionNotifications.add(toolExecutionNotification);

        return this;
    }

    public SarifLogBuilder addConfigurationError(Report.ConfigurationError error) {
        AssociatedRule associatedRule = AssociatedRule.builder()
                .id(error.rule().getName())
                .build();

        Message message = Message.builder().text(error.issue()).build();

        ToolConfigurationNotification toolConfigurationNotification = ToolConfigurationNotification.builder()
                .associatedRule(associatedRule)
                .message(message)
                .build();

        toolConfigurationNotifications.add(toolConfigurationNotification);

        return this;
    }

    public SarifLog build() {
        final Component driver = getDriverComponent().toBuilder().rules(rules).build();
        final Tool tool = Tool.builder().driver(driver).build();
        final Invocation invocation = Invocation.builder()
                .toolExecutionNotifications(toolExecutionNotifications)
                .toolConfigurationNotifications(toolConfigurationNotifications)
                .executionSuccessful(isExecutionSuccessful())
                .build();
        final Run run = Run.builder()
                .tool(tool)
                .results(results)
                .invocations(Collections.singletonList(invocation))
                .build();

        List<Run> runs = Collections.singletonList(run);

        return SarifLog.builder().runs(runs).build();
    }

    private boolean isExecutionSuccessful() {
        return toolExecutionNotifications.isEmpty() && toolConfigurationNotifications.isEmpty();
    }

    private Result resultFrom(ReportingDescriptor rule, Integer ruleIndex, Location location, RulePriority rulePriority) {
        final Result result = Result.builder()
                .ruleId(rule.getId())
                .ruleIndex(ruleIndex)
                .level(pmdPriorityToSarifSeverityLevel(rulePriority))
                .build();

        final Message message = Message.builder()
                .text(rule.getShortDescription().getText())
                .build();

        result.setMessage(message);
        result.setLocations(Collections.singletonList(location));

        return result;
    }

    private Location getRuleViolationLocation(RuleViolation rv) {
        ArtifactLocation artifactLocation = ArtifactLocation.builder()
                .uri(rv.getFileId().getUriString())
                .build();

        Region region = Region.builder()
            .startLine(rv.getBeginLine())
            .endLine(rv.getEndLine())
            .startColumn(rv.getBeginColumn())
            .endColumn(rv.getEndColumn())
            .build();

        PhysicalLocation physicalLocation = PhysicalLocation.builder()
                .artifactLocation(artifactLocation)
                .region(region)
                .build();

        return Location.builder()
            .physicalLocation(physicalLocation)
            .build();
    }

    private ReportingDescriptor getReportingDescriptor(RuleViolation rv) {
        return ReportingDescriptor.builder()
            .id(rv.getRule().getName())
            .shortDescription(new MultiformatMessage(rv.getDescription()))
            .fullDescription(new MultiformatMessage(rv.getRule().getDescription()))
            .helpUri(rv.getRule().getExternalInfoUrl())
            .help(new MultiformatMessage(rv.getRule().getDescription()))
            .properties(getRuleProperties(rv))
            .defaultConfiguration(getDefaultConfigForRuleViolation(rv))
            .build();
    }

    private ReportingConfiguration getDefaultConfigForRuleViolation(RuleViolation rv) {
        return ReportingConfiguration.builder()
                // get pmd level from rv and translate it to sarif level (for the config)
                .level(pmdPriorityToSarifSeverityLevel(rv.getRule().getPriority()))
                .build();
    }

    private PropertyBag getRuleProperties(RuleViolation rv) {
        return PropertyBag.builder()
                .ruleset(rv.getRule().getRuleSetName())
                .priority(rv.getRule().getPriority().getPriority())
                .tags(new HashSet<>(Arrays.asList(rv.getRule().getRuleSetName())))
                .build();
    }

    private Component getDriverComponent() {
        return Component.builder()
                .name("PMD")
                .version(PMDVersion.VERSION)
                .informationUri("https://docs.pmd-code.org/latest/")
                .build();
    }


    /**
     * Converts PMD's rule priority into the corresponding Sarif severity level.
     * @param rulePriority of a rule violation.
     * @return sarif's severity level.
     * @see net.sourceforge.pmd.lang.rule.RulePriority
     */
    private String pmdPriorityToSarifSeverityLevel(RulePriority rulePriority) {
        switch (rulePriority) {
        case HIGH:
        case MEDIUM_HIGH:
            return "error";
        case MEDIUM:
            return "warning";
        case MEDIUM_LOW:
        case LOW:
            return "note";
        }
        // should not occur, above switch is exhaustive
        throw AssertionUtil.shouldNotReachHere("invalid rule priority " + rulePriority);
    }
}

1	/*
2	* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
3	*/
4
5	package net.sourceforge.pmd.renderers.internal.sarif;
6
7	import java.util.ArrayList;
8	import java.util.Arrays;
9	import java.util.Collections;
10	import java.util.HashSet;
11	import java.util.List;
12
13	import net.sourceforge.pmd.PMDVersion;
14	import net.sourceforge.pmd.lang.rule.RulePriority;
15	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ArtifactLocation;
16	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.AssociatedRule;
17	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Component;
18	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Exception;
19	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Invocation;
20	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Location;
21	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Message;
22	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.MultiformatMessage;
23	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PhysicalLocation;
24	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.PropertyBag;
25	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Region;
26	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingConfiguration;
27	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ReportingDescriptor;
28	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result;
29	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Run;
30	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Tool;
31	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolConfigurationNotification;
32	import net.sourceforge.pmd.renderers.internal.sarif.SarifLog.ToolExecutionNotification;
33	import net.sourceforge.pmd.reporting.Report;
34	import net.sourceforge.pmd.reporting.RuleViolation;
35	import net.sourceforge.pmd.util.AssertionUtil;
36
37	public class SarifLogBuilder {	1✔
38	private final List<ReportingDescriptor> rules = new ArrayList<>();	1✔
39	private final List<Result> results = new ArrayList<>();	1✔
40	private final List<ToolConfigurationNotification> toolConfigurationNotifications = new ArrayList<>();	1✔
41	private final List<ToolExecutionNotification> toolExecutionNotifications = new ArrayList<>();	1✔
42
43	public static SarifLogBuilder sarifLogBuilder() {
44	return new SarifLogBuilder();	1✔
45	}
46
47	public SarifLogBuilder add(RuleViolation violation) {
48	final ReportingDescriptor ruleDescriptor = getReportingDescriptor(violation);	1✔
49	int ruleIndex = rules.indexOf(ruleDescriptor);	1✔
50	if (ruleIndex == -1) {	1✔
51	rules.add(ruleDescriptor);	1✔
52	ruleIndex = rules.size() - 1;	1✔
53	}
54
55	final Location location = getRuleViolationLocation(violation);	1✔
56	final Result result = resultFrom(ruleDescriptor, ruleIndex, location, violation.getRule().getPriority());	1✔
57	results.add(result);	1✔
58
59	return this;	1✔
60	}
61
62	public SarifLogBuilder addRunTimeError(Report.ProcessingError error) {
63	ArtifactLocation artifactLocation = ArtifactLocation.builder()	1✔
64	.uri(error.getFileId().getUriString())	1✔
65	.build();	1✔
66
67	PhysicalLocation physicalLocation = PhysicalLocation.builder()	1✔
68	.artifactLocation(artifactLocation)	1✔
69	.build();	1✔
70
71	Location location = Location
72	.builder()	1✔
73	.physicalLocation(physicalLocation)	1✔
74	.build();	1✔
75
76	Message message = Message.builder()	1✔
77	.text(error.getMsg())	1✔
78	.build();	1✔
79
80	Exception exception = Exception.builder()	1✔
81	.message(error.getDetail())	1✔
82	.build();	1✔
83
84	ToolExecutionNotification toolExecutionNotification = ToolExecutionNotification.builder()	1✔
85	.locations(Collections.singletonList(location))	1✔
86	.message(message)	1✔
87	.exception(exception)	1✔
88	.build();	1✔
89
90	toolExecutionNotifications.add(toolExecutionNotification);	1✔
91
92	return this;	1✔
93	}
94
95	public SarifLogBuilder addConfigurationError(Report.ConfigurationError error) {
96	AssociatedRule associatedRule = AssociatedRule.builder()	1✔
97	.id(error.rule().getName())	1✔
98	.build();	1✔
99
100	Message message = Message.builder().text(error.issue()).build();	1✔
101
102	ToolConfigurationNotification toolConfigurationNotification = ToolConfigurationNotification.builder()	1✔
103	.associatedRule(associatedRule)	1✔
104	.message(message)	1✔
105	.build();	1✔
106
107	toolConfigurationNotifications.add(toolConfigurationNotification);	1✔
108
109	return this;	1✔
110	}
111
112	public SarifLog build() {
113	final Component driver = getDriverComponent().toBuilder().rules(rules).build();	1✔
114	final Tool tool = Tool.builder().driver(driver).build();	1✔
115	final Invocation invocation = Invocation.builder()	1✔
116	.toolExecutionNotifications(toolExecutionNotifications)	1✔
117	.toolConfigurationNotifications(toolConfigurationNotifications)	1✔
118	.executionSuccessful(isExecutionSuccessful())	1✔
119	.build();	1✔
120	final Run run = Run.builder()	1✔
121	.tool(tool)	1✔
122	.results(results)	1✔
123	.invocations(Collections.singletonList(invocation))	1✔
124	.build();	1✔
125
126	List<Run> runs = Collections.singletonList(run);	1✔
127
128	return SarifLog.builder().runs(runs).build();	1✔
129	}
130
131	private boolean isExecutionSuccessful() {
132	return toolExecutionNotifications.isEmpty() && toolConfigurationNotifications.isEmpty();	1✔
133	}
134
135	private Result resultFrom(ReportingDescriptor rule, Integer ruleIndex, Location location, RulePriority rulePriority) {
136	final Result result = Result.builder()	1✔
137	.ruleId(rule.getId())	1✔
138	.ruleIndex(ruleIndex)	1✔
139	.level(pmdPriorityToSarifSeverityLevel(rulePriority))	1✔
140	.build();	1✔
141
142	final Message message = Message.builder()	1✔
143	.text(rule.getShortDescription().getText())	1✔
144	.build();	1✔
145
146	result.setMessage(message);	1✔
147	result.setLocations(Collections.singletonList(location));	1✔
148
149	return result;	1✔
150	}
151
152	private Location getRuleViolationLocation(RuleViolation rv) {
153	ArtifactLocation artifactLocation = ArtifactLocation.builder()	1✔
154	.uri(rv.getFileId().getUriString())	1✔
155	.build();	1✔
156
157	Region region = Region.builder()	1✔
158	.startLine(rv.getBeginLine())	1✔
159	.endLine(rv.getEndLine())	1✔
160	.startColumn(rv.getBeginColumn())	1✔
161	.endColumn(rv.getEndColumn())	1✔
162	.build();	1✔
163
164	PhysicalLocation physicalLocation = PhysicalLocation.builder()	1✔
165	.artifactLocation(artifactLocation)	1✔
166	.region(region)	1✔
167	.build();	1✔
168
169	return Location.builder()	1✔
170	.physicalLocation(physicalLocation)	1✔
171	.build();	1✔
172	}
173
174	private ReportingDescriptor getReportingDescriptor(RuleViolation rv) {
175	return ReportingDescriptor.builder()	1✔
176	.id(rv.getRule().getName())	1✔
177	.shortDescription(new MultiformatMessage(rv.getDescription()))	1✔
178	.fullDescription(new MultiformatMessage(rv.getRule().getDescription()))	1✔
179	.helpUri(rv.getRule().getExternalInfoUrl())	1✔
180	.help(new MultiformatMessage(rv.getRule().getDescription()))	1✔
181	.properties(getRuleProperties(rv))	1✔
182	.defaultConfiguration(getDefaultConfigForRuleViolation(rv))	1✔
183	.build();	1✔
184	}
185
186	private ReportingConfiguration getDefaultConfigForRuleViolation(RuleViolation rv) {
187	return ReportingConfiguration.builder()	1✔
188	// get pmd level from rv and translate it to sarif level (for the config)
189	.level(pmdPriorityToSarifSeverityLevel(rv.getRule().getPriority()))	1✔
190	.build();	1✔
191	}
192
193	private PropertyBag getRuleProperties(RuleViolation rv) {
194	return PropertyBag.builder()	1✔
195	.ruleset(rv.getRule().getRuleSetName())	1✔
196	.priority(rv.getRule().getPriority().getPriority())	1✔
197	.tags(new HashSet<>(Arrays.asList(rv.getRule().getRuleSetName())))	1✔
198	.build();	1✔
199	}
200
201	private Component getDriverComponent() {
202	return Component.builder()	1✔
203	.name("PMD")	1✔
204	.version(PMDVersion.VERSION)	1✔
205	.informationUri("https://docs.pmd-code.org/latest/")	1✔
206	.build();	1✔
207	}
208
209
210	/**
211	* Converts PMD's rule priority into the corresponding Sarif severity level.
212	* @param rulePriority of a rule violation.
213	* @return sarif's severity level.
214	* @see net.sourceforge.pmd.lang.rule.RulePriority
215	*/
216	private String pmdPriorityToSarifSeverityLevel(RulePriority rulePriority) {
217	switch (rulePriority) {	1!
218	case HIGH:
219	case MEDIUM_HIGH:
220	return "error";	1✔
221	case MEDIUM:
222	return "warning";	×
223	case MEDIUM_LOW:
224	case LOW:
225	return "note";	1✔
226	}
227	// should not occur, above switch is exhaustive
NEW 228	throw AssertionUtil.shouldNotReachHere("invalid rule priority " + rulePriority);	×
229	}
230	}

pmd / pmd / 196

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous