-
Notifications
You must be signed in to change notification settings - Fork 238
Update resource_strip_prefix logic to support path handling across modules
#1389
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
Merged
Bencodes
merged 4 commits into
bazelbuild:master
from
agluszak:nested_modules_resources
Nov 11, 2025
+295
−13
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| load("@rules_kotlin//kotlin:jvm.bzl", "kt_jvm_binary") | ||
|
|
||
| kt_jvm_binary( | ||
| name = "main", | ||
| srcs = glob(["*.kt"]), | ||
| main_class = "MainKt", | ||
| deps = ["@nested//:printer"], | ||
| ) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| module(name = "nested_module_resources") | ||
|
|
||
| bazel_dep(name = "rules_kotlin", version = "1.9.5") | ||
| local_path_override( | ||
| module_name = "rules_kotlin", | ||
| path = "../..", | ||
| ) | ||
|
|
||
| bazel_dep(name = "nested", version = "0") | ||
| local_path_override( | ||
| module_name = "nested", | ||
| path = "nested", | ||
| ) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| fun main() { | ||
| printMessage() | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Nested Module Resources Example | ||
|
|
||
| ## What This Tests | ||
|
|
||
| This example tests **resource path resolution across Bazel module boundaries** when using `resource_strip_prefix`. | ||
|
|
||
| ## Problem Statement | ||
|
|
||
| When a target in one Bazel module depends on a library in an external Bazel module that has resources with a custom `resource_strip_prefix`, the resource paths need to be correctly resolved. | ||
|
|
||
| ### Module Structure | ||
|
|
||
| ``` | ||
| nested_module_resources/ # Main module | ||
| ├── MODULE.bazel # bazel_dep(name = "nested") | ||
| ├── Main.kt # Calls @nested//:printer | ||
| └── nested/ # SEPARATE BAZEL MODULE | ||
| ├── MODULE.bazel # module(name = "nested") | ||
| ├── Printer.kt | ||
| ├── BUILD.bazel # resource_strip_prefix = "resourcez" | ||
| └── resourcez/ | ||
| └── resource.txt | ||
| ``` | ||
|
|
||
| **Key Point:** `nested/` is a separate Bazel module with its own `MODULE.bazel`, not just a subdirectory. | ||
|
|
||
| ## The Bug (Before Fix) | ||
|
|
||
| Without the fix in PR #1390, resource paths from external modules included the module path prefix, causing the strip prefix check to fail: | ||
|
|
||
| ### With nested/ in .bazelignore: | ||
| ``` | ||
| Error in fail: Resource file ../nested+/resourcez/resource.txt is not under | ||
| the specified prefix to strip resourcez | ||
| ``` | ||
| - Resource path: `../nested+/resourcez/resource.txt` | ||
| - Strip prefix: `resourcez` | ||
| - Check fails: `../nested+/resourcez/resource.txt` doesn't start with `resourcez` | ||
|
|
||
| ### Without .bazelignore: | ||
| ``` | ||
| Error in fail: Resource file nested/resourcez/resource.txt is not under | ||
| the specified prefix to strip resourcez | ||
| ``` | ||
| - Resource path: `nested/resourcez/resource.txt` | ||
| - Strip prefix: `resourcez` | ||
| - Check fails: `nested/resourcez/resource.txt` doesn't start with `resourcez` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| load("@rules_kotlin//kotlin:jvm.bzl", "kt_jvm_library") | ||
|
|
||
| kt_jvm_library( | ||
| name = "printer", | ||
| srcs = glob(["*.kt"]), | ||
| resource_strip_prefix = "resourcez", | ||
| resources = glob(["resourcez/**"]), | ||
| visibility = ["//visibility:public"], | ||
| ) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| module(name = "nested") | ||
|
|
||
| bazel_dep(name = "rules_kotlin", version = "1.9.5") | ||
| local_path_override( | ||
| module_name = "rules_kotlin", | ||
| path = "../../..", | ||
| ) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| fun printMessage() { | ||
| val resourceName = "resource.txt" | ||
| val resourceUrl = Thread.currentThread().contextClassLoader.getResource(resourceName) | ||
| val resourceText = resourceUrl?.readText() | ||
|
|
||
| println("Hello $resourceText") | ||
| } | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| world |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/bazelbuild/bazel/blob/fc2239dba7db6551439d4f1f96be8433d35fa2a1/src/main/java/com/google/devtools/build/lib/rules/java/JavaHelper.java#L97-L113
Bazel impl. for reference