Skip to content

8300228: ModuleReader.find on exploded module throws if resource name maps to invalid file path #12035

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

Closed
wants to merge 1 commit into from

Conversation

AlanBateman
Copy link
Contributor

@AlanBateman AlanBateman commented Jan 17, 2023

The ModuleReader implementation for exploded modules maps resource names to file paths. A small oversight is that it doesn't handle InvalidPathException which is thrown when the resource name maps to something that can't be parsed as a file path. This has a knock on impact to Class/ClassLoader getResourceXXX and other usages of ModuleReader.

The existing ModuleReaderTest is updated to include additional resource names to test. I've also moved @Test annotation to the test methods so that it's a bit clearer which are the test methods in this source file.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8300228: ModuleReader.find on exploded module throws if resource name maps to invalid file path

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/12035/head:pull/12035
$ git checkout pull/12035

Update a local copy of the PR:
$ git checkout pull/12035
$ git pull https://git.openjdk.org/jdk pull/12035/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12035

View PR using the GUI difftool:
$ git pr show -t 12035

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/12035.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 17, 2023

👋 Welcome back alanb! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Jan 17, 2023

@AlanBateman The following label will be automatically applied to this pull request:

  • core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the core-libs core-libs-dev@openjdk.org label Jan 17, 2023
@AlanBateman AlanBateman marked this pull request as ready for review January 17, 2023 11:57
@openjdk openjdk bot added the rfr Pull request is ready for review label Jan 17, 2023
@mlbridge
Copy link

mlbridge bot commented Jan 17, 2023

Webrevs

Copy link
Member

@jaikiran jaikiran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Should we also add a C:/java (one with a forward slash) to the new junk resource names added in this test, to exercise the path where a forward slash is present in a resource name which also has the Windows disallowed : character in it?

@openjdk
Copy link

openjdk bot commented Jan 17, 2023

@AlanBateman This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8300228: ModuleReader.find on exploded module throws if resource name maps to invalid file path

Reviewed-by: jpai, chegar, cstein

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 4 new commits pushed to the master branch:

  • 85d70ac: Merge
  • e15bdc5: 8299789: Compilation of gtest causes build to fail if runtime libraries are in different dirs
  • b7fb8ef: 8299323: Allow extended registers for cmpw
  • 07d5753: 8300168: Typo in AccessibleJTableHeaderEntry javadoc

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Jan 17, 2023
Copy link
Member

@ChrisHegarty ChrisHegarty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@AlanBateman
Copy link
Contributor Author

Should we also add a C:/java (one with a forward slash) to the new junk resource names added in this test, to exercise the path where a forward slash is present in a resource name which also has the Windows disallowed : character in it?

C:/java is a legal file path so there wouldn't be InvalidPathException for that case. The reason that resource name will be rejected on Windows is because it has a root component. So yes, it could be added as a test case, just wouldn't add any more test coverage to the existing tests.

@jaikiran
Copy link
Member

So yes, it could be added as a test case, just wouldn't add any more test coverage to the existing tests.

Thank you for the explanation, Alan. The current state of the test, in the PR, looks fine to me then.

@AlanBateman
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Jan 17, 2023

Going to push as commit fb147aa.
Since your change was applied there have been 5 commits pushed to the master branch:

  • 4cd166f: 8300125: Serial: Remove unused Generation::reset_saved_marks
  • 85d70ac: Merge
  • e15bdc5: 8299789: Compilation of gtest causes build to fail if runtime libraries are in different dirs
  • b7fb8ef: 8299323: Allow extended registers for cmpw
  • 07d5753: 8300168: Typo in AccessibleJTableHeaderEntry javadoc

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Jan 17, 2023
@openjdk openjdk bot closed this Jan 17, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jan 17, 2023
@openjdk
Copy link

openjdk bot commented Jan 17, 2023

@AlanBateman Pushed as commit fb147aa.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

4 participants