Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(PoC) [java] Verify JDK API Version #5299

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

adangel
Copy link
Member

@adangel adangel commented Oct 31, 2024

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 on https://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.

        <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 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?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

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 pmd#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 on https://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.

```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 when
executing PMD, this adds the java 8 runtime and false positives
such as pmd#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.
@pmd-test
Copy link

1 Message
📖 Compared to main:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact

Generated by 🚫 Danger

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants