src/test/shell/bazel/android/android_integration_test.sh

#!/bin/bash
#
# Copyright 2015 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# For these tests to run do the following:
#
#   1. Install an Android SDK from https://developer.android.com
#   2. Set the $ANDROID_HOME environment variable
#   3. Uncomment the line in WORKSPACE containing android_sdk_repository
#
# Note that if the environment is not set up as above android_integration_test
# will silently be ignored and will be shown as passing.

# Load the test setup defined in the parent directory
CURRENT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

source "${CURRENT_DIR}/android_helper.sh" \
  || { echo "android_helper.sh not found!" >&2; exit 1; }
fail_if_no_android_sdk

source "${CURRENT_DIR}/../../integration_test_setup.sh" \
  || { echo "integration_test_setup.sh not found!" >&2; exit 1; }

resolve_android_toolchains

function test_allow_custom_manifest_name() {
  create_new_workspace
  setup_android_sdk_support
  create_android_binary
  mv java/bazel/AndroidManifest.xml java/bazel/SomeOtherName.xml

  # macOS requires an argument for the backup file extension.
  sed -i'' -e 's/AndroidManifest/SomeOtherName/' java/bazel/BUILD

  bazel build //java/bazel:bin || fail "Build failed" \
    "Failed to build android_binary with custom Android manifest file name"
}

function test_legacy_multidex() {
  create_new_workspace
  setup_android_sdk_support
  create_android_binary
  mkdir -p java/bazel/multidex
  cat > java/bazel/multidex/BUILD <<EOF
android_binary(
    name = "bin",
    manifest = "AndroidManifest.xml",
    multidex = "legacy",
    deps = ["//java/bazel:lib"],
)
EOF
  cat > java/bazel/multidex/AndroidManifest.xml <<EOF
<manifest package="bazel.multidex" />
EOF
  assert_build //java/bazel/multidex:bin
}

function write_hello_android_files() {
  mkdir -p java/com/example/hello
  mkdir -p java/com/example/hello/res/values
  cat > java/com/example/hello/res/values/strings.xml <<'EOF'
<resources>
    <string name="app_name">HelloWorld</string>
    <string name="title_activity_main">Hello Main</string>
</resources>
EOF

  cat > java/com/example/hello/AndroidManifest.xml <<'EOF'
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.hello"
    android:versionCode="1"
    android:versionName="1.0" >

    <uses-sdk
        android:minSdkVersion="7"
        android:targetSdkVersion="18" />

    <application android:label="@string/app_name">
        <activity
            android:name="com.example.hello.MainActivity"
            android:label="@string/title_activity_main" >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>
EOF

  cat > java/com/example/hello/MainActivity.java <<'EOF'
package com.example.hello;

import android.app.Activity;

public class MainActivity extends Activity {
}
EOF

}

function test_apk_manifest_created_by() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = 'hello',
    manifest = "AndroidManifest.xml",
    srcs = ['MainActivity.java'],
    resource_files = glob(["res/**"]),
)
EOF

  bazel clean
  bazel build //java/com/example/hello:hello || fail "build failed"
  jar xf bazel-bin/java/com/example/hello/hello.apk
  # Check that the apk manifest contains Created-By: Bazel.
  assert_contains "Created\-By: Bazel" META-INF/MANIFEST.MF
  # Clean up the extracted manifest.
  rm META-INF/MANIFEST.MF
}

function test_d8_dexes_hello_android() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = 'hello',
    manifest = "AndroidManifest.xml",
    srcs = ['MainActivity.java'],
    resource_files = glob(["res/**"]),
)
EOF

  bazel clean
  bazel build --define=android_standalone_dexing_tool=d8_compat_dx \
      //java/com/example/hello:hello || fail "build failed"
}

function test_d8_dexes_and_sandbox_desugars_hello_android() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = 'hello',
    manifest = "AndroidManifest.xml",
    srcs = ['MainActivity.java'],
    resource_files = glob(["res/**"]),
)
EOF

  bazel clean
  bazel build --define=android_standalone_dexing_tool=d8_compat_dx \
      --strategy=Desugar=sandboxed \
      //java/com/example/hello:hello || fail "build failed"
}

function test_d8_dexes_and_worker_desugars_hello_android() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = 'hello',
    manifest = "AndroidManifest.xml",
    srcs = ['MainActivity.java'],
    resource_files = glob(["res/**"]),
)
EOF

  bazel clean
  bazel build --define=android_standalone_dexing_tool=d8_compat_dx \
      --strategy=Desugar=worker \
      //java/com/example/hello:hello || fail "build failed"
}

function test_hello_android_bzlmod() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = 'hello',
    manifest = "AndroidManifest.xml",
    srcs = ['MainActivity.java'],
    resource_files = glob(["res/**"]),
)
EOF

  # The next line ensures that the test passes in IPv6-only networks.
  export JAVA_TOOL_OPTIONS="-Djava.net.preferIPv6Addresses=true"

  bazel clean
  # Check that android builds with bzlmod enable work.
  bazel build --experimental_enable_bzlmod \
      //java/com/example/hello:hello || fail "build failed"
}

function test_android_tools_version() {
  create_new_workspace
  setup_android_sdk_support

  cat >> WORKSPACE <<EOF
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "rules_pkg",
    urls = [
        "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.9.1/rules_pkg-0.9.1.tar.gz",
        "https://github.com/bazelbuild/rules_pkg/releases/download/0.9.1/rules_pkg-0.9.1.tar.gz",
    ],
    sha256 = "8f9ee2dc10c1ae514ee599a8b42ed99fa262b757058f65ad3c384289ff70c4b8",
)
EOF

  label="1.2.3 4.5.6 1000000000000000000000000000000000000002"
  bazel build --embed_label="$label" //tools/android/runtime_deps:version.txt
  actual="$(cat bazel-bin/tools/android/runtime_deps/version.txt)"
  expected="bazel_android_tools_version 1.2.3
bazel_repo_commit 1000000000000000000000000000000000000002
built_with_bazel_version 4.5.6"
  assert_equals "$expected" "$actual"
}

function write_large_java_file() {
  f="$1"
  class="$(basename $f .java)"
  package="$(dirname $f | sed 's|java/||' | sed 's|/|.|g')"
  echo package = $package
  echo "package $package;" > "$f"
  echo "public class $class {" >> "$f"
  for i in $(seq 33000); do
    echo "public int foo_$i() { return $i ; }" >> "$f"
  done
  echo "}" >> "$f"
}

function assert_multiple_dex_files() {
  apk="bazel-bin/java/com/example/hello/hello.apk"
  count=$(unzip -l ${apk} | grep classes | wc -l)
  [ "${count}" -gt 1 ] || \
      fail "Expected multiple dex files in apk, found ${count}"
}

function test_native_multidex() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = "hello",
    manifest = "AndroidManifest.xml",
    srcs = glob(["*.java"]),
    resource_files = glob(["res/**"]),
    multidex = "native",
)
EOF

  write_large_java_file java/com/example/hello/Lib1.java
  write_large_java_file java/com/example/hello/Lib2.java

  bazel build java/com/example/hello:hello || fail "build failed"
  assert_multiple_dex_files
}

function test_manual_main_dex() {
  # Substantially cribbed from test_native_multidex()
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
genrule(
    name = "main_dex_list_txt",
    cmd = "echo com.example.hello > $@",
    outs = ["main_dex_list.txt"],
)
android_binary(
    name = "hello",
    manifest = "AndroidManifest.xml",
    srcs = glob(["*.java"]),
    resource_files = glob(["res/**"]),
    multidex = "manual_main_dex",
    main_dex_list = ":main_dex_list_txt",
)
EOF

  write_large_java_file java/com/example/hello/Lib1.java
  write_large_java_file java/com/example/hello/Lib2.java

  bazel build java/com/example/hello:hello || fail "build failed"
  assert_multiple_dex_files
}

function test_native_multidex_proguard() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = "hello",
    manifest = "AndroidManifest.xml",
    srcs = glob(["*.java"]),
    resource_files = glob(["res/**"]),
    multidex = "native",
    proguard_specs = ["proguard.cfg"],
)
EOF

  cat > java/com/example/hello/proguard.cfg <<'EOF'
-keep class com.example.hello.**
-keep class com.example.hello.Lib1 {
  public int foo*();
}
-keep class com.example.hello.Lib2 {
  public int foo*();
}
EOF

  write_large_java_file java/com/example/hello/Lib1.java
  write_large_java_file java/com/example/hello/Lib2.java

  bazel build java/com/example/hello:hello || fail "build failed"
  # Ensures that we didn't accidentally optimize away all the unused methods.
  assert_multiple_dex_files
}

function test_native_multidex_dex_shards() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = "hello",
    manifest = "AndroidManifest.xml",
    srcs = glob(["*.java"]),
    resource_files = glob(["res/**"]),
    multidex = "native",
    dex_shards = 10,
)
EOF

  write_large_java_file java/com/example/hello/Lib1.java
  write_large_java_file java/com/example/hello/Lib2.java

  bazel build java/com/example/hello:hello || fail "build failed"
  assert_multiple_dex_files
}

function test_native_multidex_dex_shards_proguard() {
  write_hello_android_files
  setup_android_sdk_support
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = "hello",
    manifest = "AndroidManifest.xml",
    srcs = glob(["*.java"]),
    resource_files = glob(["res/**"]),
    multidex = "native",
    proguard_specs = ["proguard.cfg"],
    dex_shards = 10,
)
EOF

  cat > java/com/example/hello/proguard.cfg <<'EOF'
-keep class com.example.hello.**
-keep class com.example.hello.Lib1 {
  public int foo*();
}
-keep class com.example.hello.Lib2 {
  public int foo*();
}
EOF

  write_large_java_file java/com/example/hello/Lib1.java
  write_large_java_file java/com/example/hello/Lib2.java

  bazel build java/com/example/hello:hello || fail "build failed"
  # Ensures that we didn't accidentally optimize away all the unused methods.
  assert_multiple_dex_files
}

function test_reduce_merged_assets() {
  write_hello_android_files
  setup_android_sdk_support
  mkdir -p java/com/example/hello/assets
  echo hello > java/com/example/hello/assets/hello.txt
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = "hello",
    manifest = "AndroidManifest.xml",
    deps = [":hello_lib"],
)
android_library(
    name = "hello_lib",
    manifest = "AndroidManifest.xml",
    srcs = glob(["*.java"]),
    resource_files = glob(["res/**"]),
    assets_dir = "assets",
    assets = glob(["assets/**"]),
)
EOF
  # The standard behavior is to output the merged assets as assets.zip
  bazel build //java/com/example/hello:hello_lib --output_library_merged_assets || fail "build failed"
  local tmpdir=$(mktemp -d)
  # Expect the assets.zip to exist.
  unzip bazel-bin/java/com/example/hello/hello_lib_files/assets.zip -d $tmpdir
  # Expect that hello.txt contains hello.
  assert_contains "hello" $tmpdir/assets/hello.txt
  rm -rf $tmpdir
}

function test_dont_reduce_merged_assets() {
  write_hello_android_files
  setup_android_sdk_support
  mkdir -p java/com/example/hello/assets
  echo hello > java/com/example/hello/assets/hello.txt
  cat > java/com/example/hello/BUILD <<'EOF'
android_binary(
    name = "hello",
    manifest = "AndroidManifest.xml",
    deps = [":hello_lib"],
)
android_library(
    name = "hello_lib",
    manifest = "AndroidManifest.xml",
    srcs = glob(["*.java"]),
    resource_files = glob(["res/**"]),
    assets_dir = "assets",
    assets = glob(["assets/**"]),
)
EOF
  bazel build //java/com/example/hello:hello --nooutput_library_merged_assets || fail "build failed"
  # Expect assets.zip to NOT exist.
  if [[ -f bazel-bin/java/com/example/hello/hello_lib_files/assets.zip ]]; then
    fail "assets.zip should NOT exist!"
  fi
}

run_suite "Android integration tests"