Check for classpath alignment on LinkageErrors #4244
Merged
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
The Launcher now checks for classpath alignment in case a LinkageError such as a ClassNotFoundError is thrown from one of the methods of the Launcher or TestEngine interfaces. If it finds unaligned versions, it wraps the LinkageError in a JUnitException with a message listing the detected versions and a link to the User Guide. Resolves #3935.
marcphilipp
commented
Jan 12, 2025
| assertEquals(1, result.exitCode()); | ||
| assertEquals("", result.stdErr()); | ||
| assertTrue(result.stdOutLines().contains("[INFO] BUILD FAILURE")); | ||
| assertThat(result.stdOut()) // |
Member
Author
There was a problem hiding this comment.
Sample Maven output:
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.325 s
[INFO] Finished at: 2025-01-12T17:47:19+01:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:3.5.2:test (default-test) on project maven-starter:
[ERROR]
[ERROR] See /tmp/junit-11800371830507414181/target/surefire-reports for the individual test results.
[ERROR] See dump files (if any exist) [date].dump, [date]-jvmRun[N].dump and [date].dumpstream.
[ERROR] There was an error in the forked process
[ERROR] org.junit.platform.commons.JUnitException: The wrapped NoClassDefFoundError is likely caused by the versions of JUnit jars on the classpath/module path not being properly aligned.
[ERROR] Please ensure consistent versions are used (see https://junit.org/junit5/docs/5.12.0-SNAPSHOT/user-guide/#dependency-metadata).
[ERROR] The following versions were detected:
[ERROR] - org.junit.platform.commons: 1.11.4
[ERROR] - org.junit.platform.engine: 1.12.0-SNAPSHOT
[ERROR] - org.junit.platform.launcher: 1.12.0-SNAPSHOT
Member
There was a problem hiding this comment.
How about "The following conflicting versions were detected"?
Out of curiosity, why does the link point to 5.12.0-SNAPSHOT instead of snapshot? Is that version pulled from a JAR manifest?
Member
There was a problem hiding this comment.
Out of curiosity, why does the link point to
5.12.0-SNAPSHOTinstead ofsnapshot? Is that version pulled from a JAR manifest?
Never mind: I just noticed in the code that the latter is the case.
Member
Author
There was a problem hiding this comment.
How about "The following conflicting versions were detected"?
Done in d11a104
marcphilipp
commented
Jan 12, 2025
Comment on lines
+56
to
+57
| Function<String, Package> packageLookup = name -> ReflectionSupport.findMethod(ClassLoader.class, | ||
| "getDefinedPackage", String.class) // |
marcphilipp
commented
Jan 12, 2025
Comment on lines
+56
to
+59
| Function<String, Package> packageLookup = name -> ReflectionSupport.findMethod(ClassLoader.class, | ||
| "getDefinedPackage", String.class) // | ||
| .map(m -> (Package) ReflectionSupport.invokeMethod(m, classLoader, name)) // | ||
| .orElseGet(() -> getPackage(name)); |
Member
Author
There was a problem hiding this comment.
This only works for packages for which classes have already been loaded by the class loader and thus is likely to contain the conflicting JARs.
mpkorstanje
reviewed
Jan 12, 2025
...tform-launcher/src/main/java/org/junit/platform/launcher/core/ClasspathAlignmentChecker.java
Show resolved
Hide resolved
marcphilipp
force-pushed
the
marc/3935-classpath-alignment-check
branch
from
7c2621b to
3461d16
Compare
sbrannen
approved these changes
Jan 13, 2025
Member
sbrannen
left a comment
sbrannen
left a comment
There was a problem hiding this comment.
I only skimmed over the implementation and tests, but the resulting output looks good. 👍
Thanks, Marc
Sign up for free
to 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.
The Launcher now checks for classpath alignment in case a LinkageError
such as a ClassNotFoundError is thrown from one of the methods of the
Launcher or TestEngine interfaces. If it finds unaligned versions, it
wraps the LinkageError in a JUnitException with a message listing the
detected versions and a link to the User Guide.
Resolves #3935.