Log invalid search path roots #4823

currenjin · 2025-08-09T11:59:35Z

Summary

Detect and log non-existent, unreadable, or non-dir/jar classpath roots in ConsoleLauncher before discovery.

This change improves diagnostics when using --scan-class-path with invalid entries, addressing issue #4772.

Motivation

Currently, invalid search path roots are silently ignored, which may cause users to miss that some tests are not being discovered.

This PR makes such issues visible by logging them at ~~INFO~~ -> WARN level, helping users
quickly identify and fix misconfigured paths.

Changes

Added validateAndLogInvalidRoots() to DiscoveryRequestCreator
Logs invalid roots with the format:
"Ignoring invalid search path root: %s (exists=%s, readable=%s, dirOrJar=%s)"
Retains the existing behaviour of skipping invalid roots
Added a test verifying that an invalid root triggers the log entry
Updated User Guide to mention this logging behaviour

Before / After Example

Before (invalid path silently ignored):

0 tests found

After:

Ignoring invalid search path root: /does/not/exist (exists=false, readable=false, dirOrJar=false)
0 tests found

Related Issue

Closes #4772

I hereby agree to the terms of the JUnit Contributor License Agreement.

Definition of Done

There are no TODOs left in the code
Method preconditions are checked and documented in the method's Javadoc
Coding conventions (e.g. for logging) have been followed
Change is covered by automated tests including corner cases, errors, and exception handling
Public API has Javadoc and @API annotations
Change is documented in the User Guide and Release Notes

sormuras · 2025-08-09T12:44:56Z

I note that javac emits the following messages for invalid entries in search paths:

warning: [path] bad path element "${PATH}": no such file or directory

currenjin · 2025-08-09T12:51:54Z

@sormuras
Yes, exactly. This change makes the ConsoleLauncher behave more like javac in that it logs invalid classpath roots instead of silently ignoring them. While javac emits a warning to stderr, JUnit logs them at INFO level so that users can see misconfigurations during discovery.

maxandersen · 2025-08-09T17:59:19Z

Love it.

But should this not be WARN's ? Or as pointed out for javac - stderr message ?

currenjin · 2025-08-09T23:43:10Z

@maxandersen

Good point. Updated the log level from INFO to WARN so that users can better notice invalid search path roots.

currenjin · 2025-08-10T00:08:14Z

@maxandersen

Thanks for the feedback! I switched the level to WARN, but that surfaced an issue in platform-tooling-support-tests (StandaloneTests.execute*) where console output expectations are strict.

To keep the console output stable while still alerting users, would you prefer:

WARN only for explicitly provided roots (e.g., via --scan-class-path <paths> or --classpath), while system-derived roots are filtered silently (or at DEBUG), or
WARN for all invalid roots, but accept extra warnings on stderr and update the expected output accordingly?

I can implement (1) right away; it avoids changing the console output in common scenarios and keeps the tests green. If you’d rather go with (2), I’ll update the tests and docs.

Also, do we want to mention this behavior in the User Guide (ConsoleLauncher section)?

currenjin · 2025-08-10T10:41:30Z

@maxandersen

Found the root cause of the test failure.

I was running the build in Korea (ko_KR locale), and the execute-related tests did not explicitly set the language.
This caused JUL log levels in the output to be localized (INFO → 정보), so the expected-err.txt assertions failed.

I fixed this by forcing -Duser.language=en and -Duser.country=US in the relevant tests.

…m#4772)

...platform-console/src/main/java/org/junit/platform/console/tasks/DiscoveryRequestCreator.java

platform-tests/src/test/java/org/junit/platform/console/tasks/DiscoveryRequestCreatorTests.java

...platform-console/src/main/java/org/junit/platform/console/tasks/DiscoveryRequestCreator.java

platform-tests/src/test/java/org/junit/platform/console/tasks/DiscoveryRequestCreatorTests.java

…sing filtered list

currenjin · 2025-08-14T16:01:35Z

@marcphilipp Thanks! All suggested changes have been applied — please take a look when you can.

...platform-console/src/main/java/org/junit/platform/console/tasks/DiscoveryRequestCreator.java

platform-tests/src/test/java/org/junit/platform/console/tasks/DiscoveryRequestCreatorTests.java

...platform-console/src/main/java/org/junit/platform/console/tasks/DiscoveryRequestCreator.java

marcphilipp

Could you please add an entry to documentation/src/docs/asciidoc/release-notes/release-notes-6.0.0-RC1.adoc in the "JUnit Platform" > "New Features and Improvements" section?

…validation

currenjin · 2025-08-15T15:10:44Z

Added a new entry in release-notes-6.0.0-RC1.adoc under JUnit Platform > New Features and Improvements documenting the improved validation of additional classpath roots.

marcphilipp · 2025-08-18T13:10:51Z

Thank you for you contribution, @currenjin! 🙇

Bumps `junit.version` from 5.13.4 to 6.0.0. Updates `org.junit.jupiter:junit-jupiter-engine` from 5.13.4 to 6.0.0 Release notes *Sourced from [org.junit.jupiter:junit-jupiter-engine's releases](https://github.com/junit-team/junit-framework/releases).* > JUnit 6.0.0 = Platform 6.0.0 + Jupiter 6.0.0 + Vintage 6.0.0 > > See [Release Notes](https://docs.junit.org/6.0.0/release-notes/). > > New Contributors > ---------------- > > * [`@2897robo`](https://github.com/2897robo) made their first contribution in [junit-team/junit-framework#4525](https://github.com/junit-team/junit-framework/pull/4525) > * [`@strangelookingnerd`](https://github.com/strangelookingnerd) made their first contribution in [junit-team/junit-framework#4683](https://github.com/junit-team/junit-framework/pull/4683) > * [`@eric6iese`](https://github.com/eric6iese) made their first contribution in [junit-team/junit-framework#4717](https://github.com/junit-team/junit-framework/pull/4717) > * [`@raccoonback`](https://github.com/raccoonback) made their first contribution in [junit-team/junit-framework#4822](https://github.com/junit-team/junit-framework/pull/4822) > * [`@currenjin`](https://github.com/currenjin) made their first contribution in [junit-team/junit-framework#4823](https://github.com/junit-team/junit-framework/pull/4823) > * [`@mehulimukherjee`](https://github.com/mehulimukherjee) made their first contribution in [junit-team/junit-framework#4913](https://github.com/junit-team/junit-framework/pull/4913) > * [`@lslonina`](https://github.com/lslonina) made their first contribution in [junit-team/junit-framework#4629](https://github.com/junit-team/junit-framework/pull/4629) > > **Full Changelog**: <junit-team/junit-framework@r5.14.0...r6.0.0> > > JUnit 6.0.0-RC3 = Platform 6.0.0-RC3 + Jupiter 6.0.0-RC3 + Vintage 6.0.0-RC3 > > See [Release Notes](https://docs.junit.org/6.0.0-RC3/release-notes/). > > New Contributors > ---------------- > > * [`@mehulimukherjee`](https://github.com/mehulimukherjee) made their first contribution in [junit-team/junit-framework#4913](https://github.com/junit-team/junit-framework/pull/4913) > * [`@lslonina`](https://github.com/lslonina) made their first contribution in [junit-team/junit-framework#4629](https://github.com/junit-team/junit-framework/pull/4629) > > **Full Changelog**: <junit-team/junit-framework@r6.0.0-RC2...r6.0.0-RC3> > > JUnit 6.0.0-RC2 = Platform 6.0.0-RC2 + Jupiter 6.0.0-RC2 + Vintage 6.0.0-RC2 > > See [Release Notes](https://docs.junit.org/6.0.0-RC2/release-notes/). > > **Full Changelog**: <junit-team/junit-framework@r6.0.0-RC1...r6.0.0-RC2> > > JUnit 6.0.0-RC1 = Platform 6.0.0-RC1 + Jupiter 6.0.0-RC1 + Vintage 6.0.0-RC1 > > See [Release Notes](https://docs.junit.org/6.0.0-RC1/release-notes/). > > New Contributors > ---------------- > > * [`@raccoonback`](https://github.com/raccoonback) made their first contribution in [junit-team/junit-framework#4822](https://github.com/junit-team/junit-framework/pull/4822) > * [`@currenjin`](https://github.com/currenjin) made their first contribution in [junit-team/junit-framework#4823](https://github.com/junit-team/junit-framework/pull/4823) > > **Full Changelog**: <junit-team/junit-framework@r6.0.0-M2...r6.0.0-RC1> > > JUnit 6.0.0-M2 = Platform 6.0.0-M2 + Jupiter 6.0.0-M2 + Vintage 6.0.0-M2 > > See [Release Notes](https://docs.junit.org/6.0.0-M2/release-notes/). > > New Contributors > ---------------- > > * [`@eric6iese`](https://github.com/eric6iese) made their first contribution in [junit-team/junit-framework#4717](https://github.com/junit-team/junit-framework/pull/4717) > > **Full Changelog**: <junit-team/junit-framework@r6.0.0-M1...r6.0.0-M2> ... (truncated) Commits * [`4f79594`](junit-team/junit-framework@4f79594) Release 6.0.0 * [`55af30a`](junit-team/junit-framework@55af30a) Revert "Use `develop/6.x` branch for junit-examples during release build" * [`df3cfdd`](junit-team/junit-framework@df3cfdd) Release 5.14.0 * [`fcb84a2`](junit-team/junit-framework@fcb84a2) Disable backward compatibility check when offline * [`c9c8344`](junit-team/junit-framework@c9c8344) Prune 5.14.0 release notes * [`03d8a72`](junit-team/junit-framework@03d8a72) Update broken link to using API Gaurdian with bndtools * [`3a0b29b`](junit-team/junit-framework@3a0b29b) Use temporary JUnit 6 logo * [`6603caa`](junit-team/junit-framework@6603caa) Rename `eclipseClasspath` to `eclipseConventions` to avoid confusion * [`ab3470b`](junit-team/junit-framework@ab3470b) Make sealed `MediaType` work in Eclipse * [`a8cd41e`](junit-team/junit-framework@a8cd41e) Remove annotations not visible in Eclipse * Additional commits viewable in [compare view](junit-team/junit-framework@r5.13.4...r6.0.0) Updates `org.junit.jupiter:junit-jupiter-params` from 5.13.4 to 6.0.0 Release notes *Sourced from [org.junit.jupiter:junit-jupiter-params's releases](https://github.com/junit-team/junit-framework/releases).* > JUnit 6.0.0 = Platform 6.0.0 + Jupiter 6.0.0 + Vintage 6.0.0 > > See [Release Notes](https://docs.junit.org/6.0.0/release-notes/). > > New Contributors > ---------------- > > * [`@2897robo`](https://github.com/2897robo) made their first contribution in [junit-team/junit-framework#4525](https://github.com/junit-team/junit-framework/pull/4525) > * [`@strangelookingnerd`](https://github.com/strangelookingnerd) made their first contribution in [junit-team/junit-framework#4683](https://github.com/junit-team/junit-framework/pull/4683) > * [`@eric6iese`](https://github.com/eric6iese) made their first contribution in [junit-team/junit-framework#4717](https://github.com/junit-team/junit-framework/pull/4717) > * [`@raccoonback`](https://github.com/raccoonback) made their first contribution in [junit-team/junit-framework#4822](https://github.com/junit-team/junit-framework/pull/4822) > * [`@currenjin`](https://github.com/currenjin) made their first contribution in [junit-team/junit-framework#4823](https://github.com/junit-team/junit-framework/pull/4823) > * [`@mehulimukherjee`](https://github.com/mehulimukherjee) made their first contribution in [junit-team/junit-framework#4913](https://github.com/junit-team/junit-framework/pull/4913) > * [`@lslonina`](https://github.com/lslonina) made their first contribution in [junit-team/junit-framework#4629](https://github.com/junit-team/junit-framework/pull/4629) > > **Full Changelog**: <junit-team/junit-framework@r5.14.0...r6.0.0> > > JUnit 6.0.0-RC3 = Platform 6.0.0-RC3 + Jupiter 6.0.0-RC3 + Vintage 6.0.0-RC3 > > See [Release Notes](https://docs.junit.org/6.0.0-RC3/release-notes/). > > New Contributors > ---------------- > > * [`@mehulimukherjee`](https://github.com/mehulimukherjee) made their first contribution in [junit-team/junit-framework#4913](https://github.com/junit-team/junit-framework/pull/4913) > * [`@lslonina`](https://github.com/lslonina) made their first contribution in [junit-team/junit-framework#4629](https://github.com/junit-team/junit-framework/pull/4629) > > **Full Changelog**: <junit-team/junit-framework@r6.0.0-RC2...r6.0.0-RC3> > > JUnit 6.0.0-RC2 = Platform 6.0.0-RC2 + Jupiter 6.0.0-RC2 + Vintage 6.0.0-RC2 > > See [Release Notes](https://docs.junit.org/6.0.0-RC2/release-notes/). > > **Full Changelog**: <junit-team/junit-framework@r6.0.0-RC1...r6.0.0-RC2> > > JUnit 6.0.0-RC1 = Platform 6.0.0-RC1 + Jupiter 6.0.0-RC1 + Vintage 6.0.0-RC1 > > See [Release Notes](https://docs.junit.org/6.0.0-RC1/release-notes/). > > New Contributors > ---------------- > > * [`@raccoonback`](https://github.com/raccoonback) made their first contribution in [junit-team/junit-framework#4822](https://github.com/junit-team/junit-framework/pull/4822) > * [`@currenjin`](https://github.com/currenjin) made their first contribution in [junit-team/junit-framework#4823](https://github.com/junit-team/junit-framework/pull/4823) > > **Full Changelog**: <junit-team/junit-framework@r6.0.0-M2...r6.0.0-RC1> > > JUnit 6.0.0-M2 = Platform 6.0.0-M2 + Jupiter 6.0.0-M2 + Vintage 6.0.0-M2 > > See [Release Notes](https://docs.junit.org/6.0.0-M2/release-notes/). > > New Contributors > ---------------- > > * [`@eric6iese`](https://github.com/eric6iese) made their first contribution in [junit-team/junit-framework#4717](https://github.com/junit-team/junit-framework/pull/4717) > > **Full Changelog**: <junit-team/junit-framework@r6.0.0-M1...r6.0.0-M2> ... (truncated) Commits * [`4f79594`](junit-team/junit-framework@4f79594) Release 6.0.0 * [`55af30a`](junit-team/junit-framework@55af30a) Revert "Use `develop/6.x` branch for junit-examples during release build" * [`df3cfdd`](junit-team/junit-framework@df3cfdd) Release 5.14.0 * [`fcb84a2`](junit-team/junit-framework@fcb84a2) Disable backward compatibility check when offline * [`c9c8344`](junit-team/junit-framework@c9c8344) Prune 5.14.0 release notes * [`03d8a72`](junit-team/junit-framework@03d8a72) Update broken link to using API Gaurdian with bndtools * [`3a0b29b`](junit-team/junit-framework@3a0b29b) Use temporary JUnit 6 logo * [`6603caa`](junit-team/junit-framework@6603caa) Rename `eclipseClasspath` to `eclipseConventions` to avoid confusion * [`ab3470b`](junit-team/junit-framework@ab3470b) Make sealed `MediaType` work in Eclipse * [`a8cd41e`](junit-team/junit-framework@a8cd41e) Remove annotations not visible in Eclipse * Additional commits viewable in [compare view](junit-team/junit-framework@r5.13.4...r6.0.0) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

feat: log invalid search path roots (junit-team#4772)

9d5c59c

github-actions bot added component: Platform theme: diagnostics theme: discovery type: new feature labels Aug 9, 2025

sormuras changed the title ~~feat: log invalid search path roots (#4772)~~ Log invalid search path roots Aug 9, 2025

Merge branch 'main' into feat/issue-4772-log-invalid-roots

9800997

injae-kim mentioned this pull request Aug 10, 2025

Add logging to have console launcher inform about bad/missing searchpath roots #4772

Closed

currenjin force-pushed the feat/issue-4772-log-invalid-roots branch from 4237525 to 54426fe Compare August 10, 2025 10:14

currenjin added 2 commits August 10, 2025 19:43

feat: change log level to WARN for invalid classpath roots (junit-tea…

648a9cd

…m#4772)

test: force English locale in execute* tests to match expected logs

cb782d9

currenjin force-pushed the feat/issue-4772-log-invalid-roots branch from 744c29a to cb782d9 Compare August 10, 2025 10:43

marcphilipp requested changes Aug 14, 2025

View reviewed changes

marcphilipp reviewed Aug 14, 2025

View reviewed changes

platform-tests/src/test/java/org/junit/platform/console/tasks/DiscoveryRequestCreatorTests.java Outdated Show resolved Hide resolved

currenjin added 2 commits August 15, 2025 00:45

test: logsInvalidSearchPathRoots using TrackLogRecords

230c429

feat: log and skip only non-existent classpath roots

eadc9b7

currenjin force-pushed the feat/issue-4772-log-invalid-roots branch from c161e9b to d38f38c Compare August 14, 2025 15:46

currenjin added 5 commits August 15, 2025 00:47

test: add doesNotLogInvalidAdditionalClasspathRoots

d3317a3

fix: remove unused import

62243dd

fix: lint

9974ad3

refactor: validate additional classpath entries directly instead of u…

41b397f

…sing filtered list

fix: lint

0a6ba3d

currenjin force-pushed the feat/issue-4772-log-invalid-roots branch from d38f38c to 0a6ba3d Compare August 14, 2025 15:48

Merge branch 'main' into feat/issue-4772-log-invalid-roots

c303e7f

marcphilipp requested changes Aug 15, 2025

View reviewed changes

currenjin and others added 4 commits August 15, 2025 23:58

refactor: simplify classpath root validation logic

060a399

test: reformat assertion in DiscoveryRequestCreatorTests

ccf18ce

refactor: validate classpath roots once in createClasspathRootSelectors

83201a1

Merge branch 'main' into feat/issue-4772-log-invalid-roots

cf7d4ee

currenjin requested a review from marcphilipp August 15, 2025 15:03

marcphilipp reviewed Aug 15, 2025

View reviewed changes

docs: add release notes entry for improved additional classpath root …

e086c3d

…validation

currenjin requested a review from marcphilipp August 15, 2025 15:11

currenjin and others added 4 commits August 16, 2025 23:29

Merge branch 'main' into feat/issue-4772-log-invalid-roots

551422f

Merge branch 'main' into feat/issue-4772-log-invalid-roots

31c3713

Polish wording of logged message

8157446

Polish release notes entry and move it to the right section

52d31b6

marcphilipp approved these changes Aug 18, 2025

View reviewed changes

marcphilipp and others added 3 commits August 18, 2025 10:45

Fix formatting

35c99ce

Merge branch 'main' into feat/issue-4772-log-invalid-roots

316b6b4

Fix tests on Windows

eed3f07

marcphilipp merged commit da404fe into junit-team:main Aug 18, 2025
14 checks passed

currenjin deleted the feat/issue-4772-log-invalid-roots branch August 18, 2025 13:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Log invalid search path roots #4823

Log invalid search path roots #4823

Uh oh!

currenjin commented Aug 9, 2025 •

edited by marcphilipp

Loading

Uh oh!

sormuras commented Aug 9, 2025

Uh oh!

currenjin commented Aug 9, 2025

Uh oh!

maxandersen commented Aug 9, 2025

Uh oh!

currenjin commented Aug 9, 2025

Uh oh!

currenjin commented Aug 10, 2025

Uh oh!

currenjin commented Aug 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

currenjin commented Aug 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marcphilipp left a comment

Uh oh!

currenjin commented Aug 15, 2025

Uh oh!

Uh oh!

marcphilipp commented Aug 18, 2025

Uh oh!

Uh oh!

Uh oh!

Log invalid search path roots #4823

Log invalid search path roots #4823

Uh oh!

Conversation

currenjin commented Aug 9, 2025 • edited by marcphilipp Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Motivation

Changes

Before / After Example

Related Issue

Definition of Done

Uh oh!

sormuras commented Aug 9, 2025

Uh oh!

currenjin commented Aug 9, 2025

Uh oh!

maxandersen commented Aug 9, 2025

Uh oh!

currenjin commented Aug 9, 2025

Uh oh!

currenjin commented Aug 10, 2025

Uh oh!

currenjin commented Aug 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

currenjin commented Aug 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marcphilipp left a comment

Choose a reason for hiding this comment

Uh oh!

currenjin commented Aug 15, 2025

Uh oh!

Uh oh!

marcphilipp commented Aug 18, 2025

Uh oh!

Uh oh!

currenjin commented Aug 9, 2025 •

edited by marcphilipp

Loading

currenjin commented Aug 10, 2025 •

edited

Loading