Support bazel builds of android (bzlmod only)

Author: jdcormie

.bazelrc

@@ -1 +1,3 @@
 build --cxxopt=-std=c++17 --host_cxxopt=-std=c++17
+
+common:skip_android --deleted_packages=android

.github/workflows/testing.yml

@@ -98,10 +98,10 @@ jobs:
         key: ${{ runner.os }}-bazel-${{ env.USE_BAZEL_VERSION }}-${{ hashFiles('WORKSPACE', 'repositories.bzl') }}
 
     - name: Run bazel build
-      run: bazelisk build //... --enable_bzlmod=${{ matrix.bzlmod }} --enable_workspace=${{ !matrix.bzlmod }}
+      run: bazelisk build //... --config=skip_android --enable_bzlmod=${{ matrix.bzlmod }} --enable_workspace=${{ !matrix.bzlmod }}
 
     - name: Run bazel test
-      run: bazelisk test //... --enable_bzlmod=${{ matrix.bzlmod }} --enable_workspace=${{ !matrix.bzlmod }}
+      run: bazelisk test //... --config=skip_android --enable_bzlmod=${{ matrix.bzlmod }} --enable_workspace=${{ !matrix.bzlmod }}
 
     - name: Run example bazel build
       run: bazelisk build //... --enable_bzlmod=${{ matrix.bzlmod }} --enable_workspace=${{ !matrix.bzlmod }}

COMPILING.md

@@ -164,5 +164,14 @@ To build the grpc-java library:
 $ bazelisk build //...
 ```
 
+Some parts of grpc-java depend on Android. Bazel can build these parts too but,
+for size, licensing and maintenance reasons, it requires a locally installed
+Android SDK. If you don't have the SDK and/or don't care about Android, use the
+`skip_android` configuration to skip building the Android parts:
+
+```sh
+$ bazelisk build //... --config=skip_android
+```
+
 You cannot run the tests from Bazel at this time.
 

MODULE.bazel

@@ -46,16 +46,31 @@ IO_GRPC_GRPC_JAVA_ARTIFACTS = [
 ]
 # GRPC_DEPS_END
 
+ANDROID_ARTIFACTS = [
+    "androidx.annotation:annotation:1.6.0",
+    "androidx.annotation:annotation-jvm:1.6.0",
+    "androidx.core:core:1.13.1",
+    "androidx.lifecycle:lifecycle-common:2.6.2",
+]
+
 bazel_dep(name = "abseil-cpp", version = "20250512.1")
 bazel_dep(name = "bazel_jar_jar", version = "0.1.11.bcr.1")
 bazel_dep(name = "bazel_skylib", version = "1.7.1")
 bazel_dep(name = "googleapis", version = "0.0.0-20240326-1c8d509c5", repo_name = "com_google_googleapis")
 bazel_dep(name = "grpc-proto", version = "0.0.0-20240627-ec30f58.bcr.1", repo_name = "io_grpc_grpc_proto")
 bazel_dep(name = "protobuf", version = "33.4", repo_name = "com_google_protobuf")
+bazel_dep(name = "rules_android", version = "0.7.2")
 bazel_dep(name = "rules_cc", version = "0.0.9")
 bazel_dep(name = "rules_java", version = "9.1.0")
 bazel_dep(name = "rules_jvm_external", version = "6.0")
 
+android_sdk_repository_extension = use_extension(
+    "@rules_android//rules/android_sdk_repository:rule.bzl",
+    "android_sdk_repository_extension",
+)
+use_repo(android_sdk_repository_extension, "androidsdk")
+register_toolchains("@androidsdk//:sdk-toolchain", "@androidsdk//:all")
+
 maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")
 maven.install(
     artifacts = IO_GRPC_GRPC_JAVA_ARTIFACTS,
@@ -64,7 +79,36 @@ maven.install(
     ],
     strict_visibility = True,
 )
-use_repo(maven, "maven")
+
+# We isolate Android-specific deps in this separate repo ('grpc_android_maven') instead of the one
+# above (having default name 'maven').
+#
+# Under bzlmod, rules_jvm_external merges all contributions to the same named repository (like the
+# default 'maven' repo) across the entire dependency graph. If we put Android dependencies there,
+# then *every* downstream consumer's merged 'maven' repository would include these Android
+# artifacts.
+#
+# Because merged repositories are resolved using only the root module's (the consumer's)
+# repository list, any consumer without 'maven.google.com' configured in their root module
+# would fail to resolve these artifacts, breaking their build even if they don't use Android.
+#
+# By using a distinct name ('grpc_android_maven'), we prevent merging. This repository is resolved
+# independently, allowing it to use grpc-java's own repository config (which includes
+# maven.google.com) without affecting downstream consumers' default 'maven' repo.
+maven.install(
+    name = "grpc_android_maven",
+    artifacts = ANDROID_ARTIFACTS,
+    repositories = [
+        "https://repo.maven.apache.org/maven2/",
+        "https://maven.google.com", # for androidx.*
+    ],
+    strict_visibility = True,
+    # Enable Starlark Android rules in rules_jvm_external for Bazel 8+ compatibility.
+    use_starlark_android_rules = True,
+    # Explicitly set the label for aar_import since the default guess is incorrect under Bzlmod.
+    aar_import_bzl_label = "@rules_android//rules:rules.bzl",
+)
+use_repo(maven, "maven", "grpc_android_maven")
 
 maven.override(
     coordinates = "com.google.protobuf:protobuf-java",

android/BUILD.bazel

@@ -0,0 +1,21 @@
+load("@rules_android//rules:rules.bzl", "android_library")
+load("@rules_jvm_external//:defs.bzl", "artifact")
+
+licenses(["notice"])
+
+android_library(
+    name = "android",
+    srcs = glob([
+        "src/main/java/**/*.java",
+    ]),
+    manifest = "src/main/AndroidManifest.xml",
+    custom_package = "io.grpc.android",
+    visibility = ["//visibility:public"],
+    deps = [
+        "//api",
+        "//core:internal",
+        artifact("com.google.code.findbugs:jsr305"),
+        artifact("com.google.errorprone:error_prone_annotations"),
+        artifact("com.google.guava:guava"),
+    ],
+)

buildscripts/kokoro/android.sh

@@ -19,14 +19,32 @@ cat <<EOF >> gradle.properties
 org.gradle.jvmargs=-Xmx2048m -XX:MaxMetaspaceSize=1024m
 EOF
 
-export ANDROID_HOME=/tmp/Android/Sdk
+export ANDROID_HOME=$HOME/Android/Sdk
 mkdir -p "${ANDROID_HOME}/cmdline-tools"
 curl -Ls -o cmdline.zip \
     "https://dl.google.com/android/repository/commandlinetools-linux-9477386_latest.zip"
 unzip -qd "${ANDROID_HOME}/cmdline-tools" cmdline.zip
 rm cmdline.zip
 mv "${ANDROID_HOME}/cmdline-tools/cmdline-tools" "${ANDROID_HOME}/cmdline-tools/latest"
 (yes || true) | "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses
+
+# Bazel/android_rules requires build-tools at least version 35.0.0 and, unlike
+# gradle, won't download anything for itself.
+# TODO(jdcormie): Keep this version in sync with AGP's default and any
+# `buildToolsVersion` config.
+"${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --install "build-tools;35.0.1"
+
+# Bazelisk takes care of installing the proper version(s) of Bazel.
+mkdir -p /tmp/bazelisk
+curl -Ls -o /tmp/bazelisk/bazelisk https://github.com/bazelbuild/bazelisk/releases/download/v1.19.0/bazelisk-linux-amd64
+chmod +x /tmp/bazelisk/bazelisk
+export PATH=/tmp/bazelisk:$PATH
+
+# TODO(jdcormie): Use the same SDK version as build.gradle's compileSdkVersion.
+"${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --install "platforms;android-34"
+bazelisk build \
+  //android
+
 curl -Ls https://github.com/Kitware/CMake/releases/download/v3.26.3/cmake-3.26.3-linux-x86_64.tar.gz | \
     tar xz -C /tmp
 export PATH=/tmp/cmake-3.26.3-linux-x86_64/bin:$PATH