bazel: Support maven_install

maven_install is strongly superior to previous forms of grabbing dependencies from Maven as it computes the appropriate versions to use from the full transitive dependencies of all libraries used by an application. It also has much less boilerplate and includes dependencies with generated targets. In the future we will drop the jvm_maven_import_external usages and require maven_install, at which point we can swap to using the `@maven' repository and no longer depend on compat_repositories. Fixes #5359
2019-12-18 14:51:08 -08:00 · 2019-12-18 14:51:08 -08:00 · c606519a5d
parent 6a5ee19695
commit c606519a5d
9 changed files with 126 additions and 38 deletions
--- a/27
+++ b/27
@ -1,8 +1,35 @@
 workspace(name = "io_grpc_grpc_java")

+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+    name = "rules_jvm_external",
+    sha256 = "62133c125bf4109dfd9d2af64830208356ce4ef8b165a6ef15bbff7460b35c3a",
+    strip_prefix = "rules_jvm_external-3.0",
+    url = "https://github.com/bazelbuild/rules_jvm_external/archive/3.0.zip",
+)
+
+load("@rules_jvm_external//:defs.bzl", "maven_install")
+load("//:repositories.bzl", "IO_GRPC_GRPC_JAVA_ARTIFACTS")
+load("//:repositories.bzl", "IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS")
+
+maven_install(
+    artifacts = IO_GRPC_GRPC_JAVA_ARTIFACTS,
+    generate_compat_repositories = True,
+    override_targets = IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS,
+    repositories = [
+        "https://repo.maven.apache.org/maven2/",
+    ],
+)
+
+load("@maven//:compat.bzl", "compat_repositories")
+
+compat_repositories()
+
 load("//:repositories.bzl", "grpc_java_repositories")

 grpc_java_repositories()

 load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
+
 protobuf_deps()
--- a/buildscripts/kokoro/bazel.sh
+++ b/buildscripts/kokoro/bazel.sh
@ -3,7 +3,7 @@
 set -exu -o pipefail
 cat /VERSION

-use_bazel.sh 0.28.1
+use_bazel.sh 1.0.1
 bazel version

 cd github/grpc-java
--- a/examples/BUILD.bazel
+++ b/examples/BUILD.bazel
@ -70,15 +70,15 @@ java_library(
        ":helloworld_java_proto",
        ":route_guide_java_grpc",
        ":route_guide_java_proto",
-        "@com_google_api_grpc_proto_google_common_protos//jar",
-        "@com_google_code_findbugs_jsr305//jar",
-        "@com_google_code_gson_gson",
-        "@com_google_guava_guava//jar",
        "@com_google_protobuf//:protobuf_java",
        "@com_google_protobuf//:protobuf_java_util",
        "@io_grpc_grpc_java//api",
        "@io_grpc_grpc_java//protobuf",
        "@io_grpc_grpc_java//stub",
+        "@maven//:com_google_api_grpc_proto_google_common_protos",
+        "@maven//:com_google_code_findbugs_jsr305",
+        "@maven//:com_google_code_gson_gson",
+        "@maven//:com_google_guava_guava",
    ],
 )

--- a/examples/WORKSPACE
+++ b/examples/WORKSPACE
@ -12,25 +12,41 @@ local_repository(
    path = "..",
 )

+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+    name = "rules_jvm_external",
+    sha256 = "62133c125bf4109dfd9d2af64830208356ce4ef8b165a6ef15bbff7460b35c3a",
+    strip_prefix = "rules_jvm_external-3.0",
+    url = "https://github.com/bazelbuild/rules_jvm_external/archive/3.0.zip",
+)
+
+load("@rules_jvm_external//:defs.bzl", "maven_install")
+load("@io_grpc_grpc_java//:repositories.bzl", "IO_GRPC_GRPC_JAVA_ARTIFACTS")
+load("@io_grpc_grpc_java//:repositories.bzl", "IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS")
+
+maven_install(
+    artifacts = [
+        "com.google.api.grpc:grpc-google-cloud-pubsub-v1:0.1.24",
+        "com.google.api.grpc:proto-google-cloud-pubsub-v1:0.1.24",
+    ] + IO_GRPC_GRPC_JAVA_ARTIFACTS,
+    generate_compat_repositories = True,
+    override_targets = IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS,
+    repositories = [
+        "https://repo.maven.apache.org/maven2/",
+    ],
+)
+
+load("@maven//:compat.bzl", "compat_repositories")
+
+compat_repositories()
+
 load("@io_grpc_grpc_java//:repositories.bzl", "grpc_java_repositories")

-
-
-maven_jar(
-        name = "com_google_api_grpc_cloud_pubsub_v1",
-        artifact = "com.google.api.grpc:grpc-google-cloud-pubsub-v1:0.1.24",
-        sha1 = "601d8be0fd0cc0e050b1af3b88f191ada9a2f4e5",
-)
-
-maven_jar(
-        name = "com_google_api_grpc_proto_cloud_pubsub_v1",
-        artifact = "com.google.api.grpc:proto-google-cloud-pubsub-v1:0.1.24",
-        sha1 = "e6dd66635f674b4e380dfd3de252ae019a51a67e",
-)
-
-
-
+# Run grpc_java_repositories after compat_repositories to ensure the
+# maven_install-selected dependencies are used.
 grpc_java_repositories()

 load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
+
 protobuf_deps()
--- a/examples/example-gauth/BUILD.bazel
+++ b/examples/example-gauth/BUILD.bazel
@ -7,13 +7,13 @@ java_library(
        ["src/main/java/**/*.java"],
    ),
    deps = [
-        "@com_google_api_grpc_cloud_pubsub_v1//jar",
-        "@com_google_api_grpc_proto_cloud_pubsub_v1//jar",
-        "@com_google_auth_google_auth_library_oauth2_http//jar",
        "@io_grpc_grpc_java//api",
        "@io_grpc_grpc_java//auth",
        "@io_grpc_grpc_java//protobuf",
        "@io_grpc_grpc_java//stub",
+        "@maven//:com_google_api_grpc_grpc_google_cloud_pubsub_v1",
+        "@maven//:com_google_api_grpc_proto_google_cloud_pubsub_v1",
+        "@maven//:com_google_auth_google_auth_library_oauth2_http",
    ],
 )

--- a/examples/example-tls/BUILD.bazel
+++ b/examples/example-tls/BUILD.bazel
@ -24,7 +24,7 @@ java_library(
        ["src/main/java/**/*.java"],
    ),
    runtime_deps = [
-        "@io_netty_netty_tcnative_boringssl_static//jar",
+        "@maven//:io_netty_netty_tcnative_boringssl_static",
    ],
    deps = [
        ":helloworld_java_grpc",
@ -33,7 +33,7 @@ java_library(
        "@io_grpc_grpc_java//netty",
        "@io_grpc_grpc_java//protobuf",
        "@io_grpc_grpc_java//stub",
-        "@io_netty_netty_handler//jar",
+        "@maven//:io_netty_netty_handler",
    ],
 )

--- a/netty/shaded/BUILD.bazel
+++ b/netty/shaded/BUILD.bazel
@ -5,6 +5,6 @@ java_library(
    runtime_deps = [
        "//netty",
        "@io_netty_netty_tcnative_boringssl_static//jar",
-        "@io_netty_netty_transport_native_epoll//jar",
+        "@io_netty_netty_transport_native_epoll_linux_x86_64//jar",
    ],
 )
--- a/protobuf/BUILD.bazel
+++ b/protobuf/BUILD.bazel
@ -12,6 +12,5 @@ java_library(
        "@com_google_guava_guava//jar",
        "@com_google_j2objc_j2objc_annotations//jar",
        "@com_google_protobuf//:protobuf_java",
-        "@com_google_protobuf//:protobuf_java_util",
    ],
 )
--- a/repositories.bzl
+++ b/repositories.bzl
@ -3,6 +3,48 @@
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 load("@bazel_tools//tools/build_defs/repo:jvm.bzl", "jvm_maven_import_external")

+# For use with maven_install's artifacts.
+# maven_install(
+#     ...
+#     artifacts = [
+#         # Your own deps
+#     ] + IO_GRPC_GRPC_JAVA_ARTIFACTS,
+# )
+IO_GRPC_GRPC_JAVA_ARTIFACTS = [
+    "com.google.android:annotations:4.1.1.4",
+    "com.google.api.grpc:proto-google-common-protos:1.17.0",
+    "com.google.auth:google-auth-library-credentials:0.19.0",
+    "com.google.auth:google-auth-library-oauth2-http:0.19.0",
+    "com.google.code.findbugs:jsr305:3.0.2",
+    "com.google.code.gson:gson:jar:2.8.6",
+    "com.google.errorprone:error_prone_annotations:2.3.3",
+    "com.google.guava:failureaccess:1.0.1",
+    "com.google.guava:guava:28.1-android",
+    "com.google.j2objc:j2objc-annotations:1.3",
+    "com.google.truth:truth:1.0",
+    "com.squareup.okhttp:okhttp:2.5.0",
+    "com.squareup.okio:okio:1.13.0",
+    "io.netty:netty-buffer:4.1.42.Final",
+    "io.netty:netty-codec-http2:4.1.42.Final",
+    "io.netty:netty-codec-http:4.1.42.Final",
+    "io.netty:netty-codec-socks:4.1.42.Final",
+    "io.netty:netty-codec:4.1.42.Final",
+    "io.netty:netty-common:4.1.42.Final",
+    "io.netty:netty-handler-proxy:4.1.42.Final",
+    "io.netty:netty-handler:4.1.42.Final",
+    "io.netty:netty-resolver:4.1.42.Final",
+    "io.netty:netty-tcnative-boringssl-static:2.0.26.Final",
+    "io.netty:netty-transport-native-epoll:jar:linux-x86_64:4.1.42.Final",
+    "io.netty:netty-transport:4.1.42.Final",
+    "io.opencensus:opencensus-api:0.24.0",
+    "io.opencensus:opencensus-contrib-grpc-metrics:0.24.0",
+    "io.perfmark:perfmark-api:0.19.0",
+    "javax.annotation:javax.annotation-api:1.2",
+    "junit:junit:4.12",
+    "org.apache.commons:commons-lang3:3.5",
+    "org.codehaus.mojo:animal-sniffer-annotations:1.18",
+]
+
 # For use with maven_install's override_targets.
 # maven_install(
 #     ...
@ -22,6 +64,9 @@ load("@bazel_tools//tools/build_defs/repo:jvm.bzl", "jvm_maven_import_external")
 #         "your.target:artifact": "@//third_party/artifact",
 #     )
 IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS = {
+    "com.google.protobuf:protobuf-java": "@com_google_protobuf//:protobuf_java",
+    "com.google.protobuf:protobuf-java-util": "@com_google_protobuf//:protobuf_java_util",
+    "com.google.protobuf:protobuf-javalite": "@com_google_protobuf_javalite//:protobuf_java_lite",
    "io.grpc:grpc-alts": "@io_grpc_grpc_java//alts",
    "io.grpc:grpc-api": "@io_grpc_grpc_java//api",
    "io.grpc:grpc-auth": "@io_grpc_grpc_java//auth",
@ -39,6 +84,13 @@ IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS = {

 def grpc_java_repositories():
    """Imports dependencies for grpc-java."""
+    if not native.existing_rule("com_google_protobuf"):
+        com_google_protobuf()
+    if not native.existing_rule("com_google_protobuf_javalite"):
+        com_google_protobuf_javalite()
+    if not native.existing_rule("io_grpc_grpc_proto"):
+        io_grpc_grpc_proto()
+
    if not native.existing_rule("com_google_android_annotations"):
        com_google_android_annotations()
    if not native.existing_rule("com_google_api_grpc_proto_google_common_protos"):
@ -59,14 +111,8 @@ def grpc_java_repositories():
        com_google_guava_failureaccess()
    if not native.existing_rule("com_google_j2objc_j2objc_annotations"):
        com_google_j2objc_j2objc_annotations()
-    if not native.existing_rule("com_google_protobuf"):
-        com_google_protobuf()
-    if not native.existing_rule("com_google_protobuf_javalite"):
-        com_google_protobuf_javalite()
    if not native.existing_rule("com_google_truth_truth"):
        com_google_truth_truth()
-    if not native.existing_rule("io_grpc_grpc_proto"):
-        io_grpc_grpc_proto()
    if not native.existing_rule("com_squareup_okhttp_okhttp"):
        com_squareup_okhttp_okhttp()
    if not native.existing_rule("com_squareup_okio_okio"):
@ -93,8 +139,8 @@ def grpc_java_repositories():
        io_netty_netty_tcnative_boringssl_static()
    if not native.existing_rule("io_netty_netty_transport"):
        io_netty_netty_transport()
-    if not native.existing_rule("io_netty_netty_transport_native_epoll"):
-        io_netty_netty_transport_native_epoll()
+    if not native.existing_rule("io_netty_netty_transport_native_epoll_linux_x86_64"):
+        io_netty_netty_transport_native_epoll_linux_x86_64()
    if not native.existing_rule("io_opencensus_opencensus_api"):
        io_opencensus_opencensus_api()
    if not native.existing_rule("io_opencensus_opencensus_contrib_grpc_metrics"):
@ -368,9 +414,9 @@ def io_netty_netty_transport():
        licenses = ["notice"],  # Apache 2.0
    )

-def io_netty_netty_transport_native_epoll():
+def io_netty_netty_transport_native_epoll_linux_x86_64():
    jvm_maven_import_external(
-        name = "io_netty_netty_transport_native_epoll",
+        name = "io_netty_netty_transport_native_epoll_linux_x86_64",
        artifact = "io.netty:netty-transport-native-epoll:jar:linux-x86_64:4.1.42.Final",
        server_urls = ["https://repo.maven.apache.org/maven2/"],
        artifact_sha256 = "7bdf3003d5b60b061b494e62d1bafc420caf800efb743b14ec01ceaef1d3fa3e",