Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork1.5k
(PoC) [java] Verify JDK API Version#5299
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
adangel wants to merge1 commit intopmd:mainChoose a base branch fromadangel:poc/auxclasspath-jdk-version
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Draft
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This is just a PoC to get the idea out. We should implement somethinglike this to warn users, if they execute PMD with incorrect javaversions. Using the wrong java version on the auxclasspath leadsto issues likepmd#4620 - the Java API changed between andtyperesolution works as designed. But with the wrong Java Runtimeon the auxclasspath, false positives are detected.You can specify the java runtime on the auxclasspath viaCLI as described onhttps://docs.pmd-code.org/latest/pmd_languages_java.html#providing-the-auxiliary-classpath .But if no java runtime is provided, we fall back to theruntime java version, which might or might not be correct.Note: For maven, there is currently no official way to configurethe java runtime onto the auxclasspath. You can workaround byadding a system scoped dependency to your project, e.g.```xml <dependency> <groupId>java8</groupId> <artifactId>java8-rt</artifactId> <version>8</version> <scope>system</scope> <systemPath>/path/to/jdk-8/jre/lib/rt.jar</systemPath> </dependency>```Since maven adds all project dependencies to the auxclasspath whenexecuting PMD, this adds the java 8 runtime and false positivessuch aspmd#4620 disappear.In theory, you could also use maven toolchains to execute PMDwith the correct java version.At the beginning I think, we should issue a warning, if wedetect a mismatch between the java language version and the javaversion, that we resolve from the auxclasspath. Note - thewarning I added in this PR only appears in DEBUG mode.And I assume (needs to be verified) that we could do this checkonce at the beginning and don't need to issue a warning forevery file...Once the warning is out there and we provided enough documentationaround how to resolve this warning, we could make this into afatal error, aborting the PMD analysis. We might even thinkabout not falling back to the runtime classpath for type resolution,forcing users to always configure the intended java versionexplicitly.
ghost commentedOct 31, 2024
Generated by 🚫Danger |
4 tasks
adangel added a commit that referenced this pull requestJun 26, 2025
* Update build-tools from 30 to 32This enables the new rule UnnecessaryWarningSuppressionRefpmd/build-tools#74Ref#5803* Fix UnnecessaryWarningSuppression for missing overrideRefs#4291#5299For now, the rule is disabled for this single class
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe the PR
This is just a PoC to get the idea out. We should implement something like this to warn users, if they execute PMD with incorrect java versions. Using the wrong java version on the auxclasspath leads to issues like#4620 - the Java API changed between and typeresolution works as designed. But with the wrong Java Runtime on the auxclasspath, false positives are detected.
You can specify the java runtime on the auxclasspath via CLI as described onhttps://docs.pmd-code.org/latest/pmd_languages_java.html#providing-the-auxiliary-classpath . But if no java runtime is provided, we fall back to the runtime java version, which might or might not be correct.
Note: For maven, there is currently no official way to configure the java runtime onto the auxclasspath. You can workaround by adding a system scoped dependency to your project, e.g.
Since maven adds all project dependencies to the auxclasspath when executing PMD, this adds the java 8 runtime and false positives such as#4620 disappear.
In theory, you could also use maven toolchains to execute PMD with the correct java version.
At the beginning I think, we should issue a warning, if we detect a mismatch between the java language version and the java version, that we resolve from the auxclasspath. Note - the warning I added in this PR only appears in DEBUG mode. And I assume (needs to be verified) that we could do this check once at the beginning and don't need to issue a warning for every file...
Once the warning is out there and we provided enough documentation around how to resolve this warning, we could make this into a fatal error, aborting the PMD analysis. We might even think about not falling back to the runtime classpath for type resolution, forcing users to always configure the intended java version explicitly.
Related issues
Ready?
./mvnw clean verify
passes (checked automatically by github actions)