Skip to content

Commit

Permalink
Rename maven to protobuf_maven in MODULE.bazel (#18641) (#19477)
Browse files Browse the repository at this point in the history
The default name for the rules_jvm_external.maven rule is "maven". When not set, it defaults to "maven". For root modules also using rules_jvm_external, the name clash causes a warning:

```
DEBUG: $TMP/external/rules_jvm_external~/private/extensions/maven.bzl:154:14:
The maven repository 'maven' is used in two different bazel modules,
originally in '<my_workspace>' and now in 'protobuf'
```

Summarizing @shs96c in [1]:

> The common maven repo name allows rulesets to contribute to the user's JARs.
> However, this implies that maven is for the end user, not for transitive
> dependencies. If a ruleset needs private dependencies, it should use a custom
> namespace rather than the maven namespace.

Since protobuf is not contributing to user's JARs, we'll use a custom namespace. There's precedent for using a custom namespace for library modules:

- rules_jvm_external uses `rules_jvm_external_deps` instead of `maven`.
- rules_kotlin uses `kotlin_rules_maven` instead of `maven`.

[1]: bazel-contrib/rules_jvm_external#916 (comment)

Fixes #16839.

Closes #18641

COPYBARA_INTEGRATE_REVIEW=#18641 from jschaf:joe/protobuf-maven bd2c62f
PiperOrigin-RevId: 684625084

Co-authored-by: Joe Schafer <joe.schafer@delta46.us>
  • Loading branch information
zhangskz and jschaf authored Dec 2, 2024
1 parent 5864b50 commit ba6da44
Show file tree
Hide file tree
Showing 9 changed files with 68 additions and 66 deletions.
3 changes: 2 additions & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ use_repo(pip, "pip_deps")
maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")

maven.install(
name = "protobuf_maven",
artifacts = [
"com.google.caliper:caliper:1.0-beta-3",
"com.google.code.findbugs:jsr305:3.0.2",
Expand All @@ -151,7 +152,7 @@ maven.install(
],
)

use_repo(maven, "maven")
use_repo(maven, "protobuf_maven")

# Development dependencies
bazel_dep(
Expand Down
3 changes: 2 additions & 1 deletion WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ rules_jvm_external_setup()
load("@rules_jvm_external//:defs.bzl", "maven_install")

maven_install(
name = "protobuf_maven",
artifacts = PROTOBUF_MAVEN_ARTIFACTS,
# For updating instructions, see:
# https://github.com/bazelbuild/rules_jvm_external#updating-maven_installjson
Expand All @@ -69,7 +70,7 @@ maven_install(
],
)

load("@maven//:defs.bzl", "pinned_maven_install")
load("@protobuf_maven//:defs.bzl", "pinned_maven_install")

pinned_maven_install()

Expand Down
52 changes: 26 additions & 26 deletions java/core/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -391,8 +391,8 @@ protobuf_java_library(
":generic_test_protos_java_proto",
":java_test_protos_java_proto",
":lite_test_protos_java_proto",
"@maven//:com_google_guava_guava",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:junit_junit",
],
)

Expand Down Expand Up @@ -442,10 +442,10 @@ junit_tests(
":java_test_protos_java_proto",
":lite_test_protos_java_proto",
":test_util",
"@maven//:com_google_guava_guava",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@maven//:org_mockito_mockito_core",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@protobuf_maven//:org_mockito_mockito_core",
],
)

Expand All @@ -461,9 +461,9 @@ junit_tests(
],
deps = [
":core",
"@maven//:com_google_guava_guava",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
],
)

Expand Down Expand Up @@ -518,8 +518,8 @@ protobuf_java_library(
":java_test_protos_java_proto_lite",
":lite_runtime_only",
":lite_test_protos_java_proto_lite",
"@maven//:com_google_guava_guava",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:junit_junit",
],
)

Expand Down Expand Up @@ -586,9 +586,9 @@ junit_tests(
":lite",
":lite_test_protos_java_proto_lite",
":test_util_lite",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@maven//:org_mockito_mockito_core",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@protobuf_maven//:org_mockito_mockito_core",
],
)

Expand All @@ -602,8 +602,8 @@ protobuf_java_library(
deps = [
":core",
"//compatibility:v25_test_protos_srcjar",
"@maven//:com_google_guava_guava",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:junit_junit",
],
)

Expand Down Expand Up @@ -634,10 +634,10 @@ junit_tests(
":core",
":v25_test_util_srcjar",
"//compatibility:v25_test_protos_srcjar",
"@maven//:com_google_guava_guava",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@maven//:org_mockito_mockito_core",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@protobuf_maven//:org_mockito_mockito_core",
],
)

Expand All @@ -651,8 +651,8 @@ protobuf_java_library(
deps = [
":core",
"//compatibility:v25_test_protos_jar",
"@maven//:com_google_guava_guava",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:junit_junit",
],
)

Expand Down Expand Up @@ -683,10 +683,10 @@ junit_tests(
":core",
":v25_test_util_jar",
"//compatibility:v25_test_protos_jar",
"@maven//:com_google_guava_guava",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@maven//:org_mockito_mockito_core",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@protobuf_maven//:org_mockito_mockito_core",
],
)

Expand Down
4 changes: 2 additions & 2 deletions java/internal/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ java_test(
srcs = ["JavaVersionTest.java"],
test_class = "JavaVersionTest",
deps = [
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
],
)
12 changes: 6 additions & 6 deletions java/kotlin-lite/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ kt_jvm_library(
"//java/kotlin:only_for_use_in_proto_generated_code_its_generator_and_tests",
"//java/kotlin:shared_runtime",
"//java/lite",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@rules_kotlin//kotlin/compiler:kotlin-test",
],
)
Expand Down Expand Up @@ -210,8 +210,8 @@ kt_jvm_library(
deps = [
":kotlin_unittest_lite",
"//java/core:test_util_lite",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
],
)

Expand All @@ -227,8 +227,8 @@ kt_jvm_library(
deps = [
":kotlin_proto3_unittest_lite",
"//java/core:test_util_lite",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
],
)

Expand Down
22 changes: 11 additions & 11 deletions java/kotlin/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ kt_jvm_library(
deps = [
":bytestring_lib",
"//java/lite",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@rules_kotlin//kotlin/compiler:kotlin-test",
],
)
Expand Down Expand Up @@ -151,9 +151,9 @@ kt_jvm_library(
":example_extensible_message_java_proto",
":only_for_use_in_proto_generated_code_its_generator_and_tests",
":shared_runtime",
"@maven//:com_google_guava_guava_testlib",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_guava_guava_testlib",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@rules_kotlin//kotlin/compiler:kotlin-test",
],
)
Expand All @@ -177,8 +177,8 @@ kt_jvm_library(
":only_for_use_in_proto_generated_code_its_generator_and_tests",
":shared_runtime",
"//java/core",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@rules_kotlin//kotlin/compiler:kotlin-test",
],
)
Expand Down Expand Up @@ -289,8 +289,8 @@ kt_jvm_library(
deps = [
":kotlin_unittest",
"//java/core:test_util",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
"@rules_kotlin//kotlin/compiler:kotlin-reflect",
],
)
Expand All @@ -307,8 +307,8 @@ kt_jvm_library(
deps = [
":kotlin_proto3_unittest",
"//java/core:test_util",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
],
)

Expand Down
4 changes: 2 additions & 2 deletions java/lite/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ junit_tests(
"//java/core:java_test_protos_java_proto_lite",
"//java/core:lite_test_protos_java_proto_lite",
"//java/core:test_util_lite",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
],
)

Expand Down
6 changes: 3 additions & 3 deletions java/osgi/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ java_binary(
srcs = ["OsgiWrapper.java"],
main_class = "com.google.protobuf.osgi.OsgiWrapper",
deps = [
"@maven//:biz_aQute_bnd_biz_aQute_bndlib",
"@maven//:com_google_guava_guava",
"@maven//:info_picocli_picocli",
"@protobuf_maven//:biz_aQute_bnd_biz_aQute_bndlib",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:info_picocli_picocli",
],
)
28 changes: 14 additions & 14 deletions java/util/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ java_library(
visibility = ["//visibility:public"],
deps = [
"//java/core",
"@maven//:com_google_code_findbugs_jsr305",
"@maven//:com_google_code_gson_gson",
"@maven//:com_google_errorprone_error_prone_annotations",
"@maven//:com_google_guava_guava",
"@maven//:com_google_j2objc_j2objc_annotations",
"@protobuf_maven//:com_google_code_findbugs_jsr305",
"@protobuf_maven//:com_google_code_gson_gson",
"@protobuf_maven//:com_google_errorprone_error_prone_annotations",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:com_google_j2objc_j2objc_annotations",
],
)

Expand All @@ -33,11 +33,11 @@ protobuf_versioned_java_library(
visibility = ["//visibility:public"],
deps = [
"//java/core",
"@maven//:com_google_code_findbugs_jsr305",
"@maven//:com_google_code_gson_gson",
"@maven//:com_google_errorprone_error_prone_annotations",
"@maven//:com_google_guava_guava",
"@maven//:com_google_j2objc_j2objc_annotations",
"@protobuf_maven//:com_google_code_findbugs_jsr305",
"@protobuf_maven//:com_google_code_gson_gson",
"@protobuf_maven//:com_google_errorprone_error_prone_annotations",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:com_google_j2objc_j2objc_annotations",
],
)

Expand Down Expand Up @@ -90,10 +90,10 @@ junit_tests(
":util",
"//java/core",
"//java/core:generic_test_protos_java_proto",
"@maven//:com_google_code_gson_gson",
"@maven//:com_google_guava_guava",
"@maven//:com_google_truth_truth",
"@maven//:junit_junit",
"@protobuf_maven//:com_google_code_gson_gson",
"@protobuf_maven//:com_google_guava_guava",
"@protobuf_maven//:com_google_truth_truth",
"@protobuf_maven//:junit_junit",
],
)

Expand Down

0 comments on commit ba6da44

Please sign in to comment.