icu/android_icu4j/Android.bp

//
// Copyright (C) 2017 The Android Open Source Project
//
// 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.
//

package {
    default_team: "trendy_team_java_core_libraries",
    default_visibility: ["//visibility:private"],
    // See: http://go/android-license-faq
    // A large-scale-change added 'default_applicable_licenses' to import
    // all of the 'license_kinds' from "external_icu_license"
    // to get the below license kinds:
    //   SPDX-license-identifier-Apache-2.0
    //   SPDX-license-identifier-BSD
    //   SPDX-license-identifier-ICU
    //   SPDX-license-identifier-MIT
    //   SPDX-license-identifier-Unicode-DFS
    //   legacy_unencumbered
    default_applicable_licenses: ["external_icu_license"],
}

//==========================================================
// build repackaged ICU for target
//
// This is done in the libcore/JavaLibraries.mk file as there are circular
// dependencies between ICU and libcore
//==========================================================
filegroup {
    name: "android_icu4j_public_api_files",
    srcs: [
        ":android_icu4j_repackaged_src_files",
    ],
    path: "src/main/java",
}

filegroup {
    name: "android_icu4j_repackaged_src_files",
    srcs: ["src/main/java/android/icu/**/*.java"],
    path: "src/main/java",
}

// The files contains Android-specific codes to expose intra-core APIs
// from ICU4J/ICU4C to libcore or core platform APIs to the framework.
// The package is com.android.icu.* and should not expose any public APIs.
filegroup {
    name: "libcore_icu_bridge_src_files",
    srcs: ["libcore_bridge/src/java/**/*.java"],
    path: "libcore_bridge/src/java",
}

java_defaults {
    name: "libcore_icu_bridge_defaults",
    srcs: [
        "libcore_bridge/src/java/**/*.java",
        ":app-compat-annotations-source",
    ],
    jarjar_rules: "jarjar-rules.txt",
    plugins: [
        "compat-changeid-annotation-processor",
    ],
}

// A host library containing time zone related classes. Used for
// host-side tools and tests that have to deal with Android
// time zone data.
java_library_host {
    name: "timezone-host",
    visibility: [
        "//packages/modules/RuntimeI18n/apex",
        "//system/timezone/input_tools/version",
    ],
    srcs: [
        "libcore_bridge/src/java/com/android/i18n/timezone/TzDataSetVersion.java",
    ],
    libs: [
        "art.module.api.annotations",
    ],
}

// core-repackaged-icu4j contains only the repackaged ICU4J that does not
// use any internal or android specific code. If it ever did then it could depend on
// art-module-intra-core-api-stubs-system-modules (a superset) instead.
// It is important that core-icu4j is restricted to only use stable APIs from the ART module
// since it is in a different APEX module that can be updated independently.
java_library_static {
    name: "core-repackaged-icu4j",
    installable: false,
    srcs: [":android_icu4j_repackaged_src_files"],
    // The resource files are generated in the downstream branch master-icu-dev.
    java_resource_dirs: ["resources"],
    libs: [
        "unsupportedappusage",
        // Need framework-api-annotations-lib for @FlaggedApi.
        // Put framework-api-annotations into libs to avoid exposing the definition of framework's
        // annotations from ICU (wrong place) instead of framework (correct place).
        "framework-annotations-lib",
    ],
    static_libs: [
        "icu_aconfig_flags_lib",
    ],

    sdk_version: "none",
    system_modules: "art-module-public-api-stubs-system-modules",

    dxflags: ["--core-library"],
    apex_available: [
        "com.android.i18n",
    ],
    errorprone: {
        javacflags: [
            "-Xep:MissingOverride:OFF", // Ignore missing @Override.
            "-Xep:ConstantOverflow:WARN", // Known constant overflow in SplittableRandom
            "-Xep:BoxedPrimitiveEquality:WARN",
            "-Xep:ComparableType:WARN",
            "-Xep:EmptyTopLevelDeclaration:WARN",
        ],
    },
    lint: {
        warning_checks: ["SuspiciousIndentation"],
        baseline_filename: "lint-baseline.xml",
    },
}

// A separated core library that contains ICU4J because ICU4J will be in a different APEX module,
// not in ART module.
java_library {
    name: "core-icu4j",
    defaults: ["libcore_icu_bridge_defaults"],
    visibility: [
        "//art/tools/fuzzer",
        "//packages/modules/RuntimeI18n/apex",
    ],
    apex_available: [
        "com.android.i18n",
    ],
    permitted_packages: [
        "android.icu",
        "com.android.icu",
        "com.android.i18n.system",
        "com.android.i18n.timezone",
        "com.android.i18n.util",
    ],
    installable: true,
    hostdex: false,

    libs: [
        "framework-annotations-lib",
    ],
    static_libs: ["core-repackaged-icu4j"],

    // It is important that core-icu4j is restricted to only use stable APIs from the ART module
    // since it is in a different APEX module that can be updated independently.
    sdk_version: "none",
    system_modules: "art-module-intra-core-api-stubs-system-modules",

    dxflags: ["--core-library"],
}

// Java library for use on host, e.g. by ravenwood, robolectric.
java_library {
    name: "core-icu4j-for-host",
    visibility: [
        "//art/build",
        "//external/robolectric",
        "//external/robolectric-shadows",
        "//frameworks/layoutlib",
        "//frameworks/base/ravenwood:__subpackages__",
        "//packages/modules/RuntimeI18n/apex",
    ],
    static_libs: [
        "core-icu4j",
    ],
    sdk_version: "none",
    system_modules: "none",
}

platform_compat_config {
    name: "icu4j-platform-compat-config",
    src: ":core-icu4j",
    visibility: [
        "//frameworks/base",
    ],
}

java_sdk_library {
    name: "i18n.module.public.api",
    visibility: [
        "//build/soong/java/core-libraries",
        "//frameworks/base",
        "//frameworks/base/api",
        "//packages/modules/RuntimeI18n/apex",
        // Visibility for prebuilt i18n-module-sdk from the prebuilt of
        // this module.
        // TODO(b/155921753): Restrict this when prebuilts are in their proper
        // locations.
        "//prebuilts:__subpackages__",
    ],
    // Added to make sure that no private classes leak out in stubs.
    defaults: ["libcore_icu_bridge_defaults"],
    srcs: [
        // Added to make sure that no private classes leak out in stubs.
        ":android_icu4j_repackaged_src_files",
        ":android_icu4j_public_api_files",
    ],
    libs: [
        "icu_aconfig_flags_lib",
    ],
    droiddoc_options: [
        "--force-convert-to-warning-nullability-annotations +*:-android.*:+android.icu.*:-dalvik.* ",
    ],
    errorprone: {
        javacflags: [
            "-Xep:MissingOverride:OFF",
        ],
    },
    lint: {
        warning_checks: ["SuspiciousIndentation"],
    },

    public: {
        enabled: true,
    },
    system: {
        enabled: true,
    },
    module_lib: {
        enabled: true,
    },

    api_dir: "api/public",
    api_only: true,

    // Emit nullability annotations from the source to the stub files.
    annotations_enabled: true,

    sdk_version: "none",
    system_modules: "art-module-public-api-stubs-system-modules",

    // The base name for the artifacts that are automatically published to the
    // dist and which end up in one of the sub-directories of prebuilts/sdk.
    // As long as this matches the name of the artifacts in prebuilts/sdk then
    // the API will be checked for compatibility against the latest released
    // version of the API.
    dist_stem: "runtime-i18n",
    dist_group: "android",
    aconfig_declarations: [
        "icu_aconfig_flags",
    ],
}

// Generates stub source files for the intra-core API of the I18N module.
// i.e. every class/member that is either in the public API or annotated with
// @IntraCoreApi.
//
// The API specification .txt files managed by this only contain the additional
// classes/members that are in the intra-core API but which are not the public
// API.
java_sdk_library {
    name: "i18n.module.intra.core.api",
    defaults: ["libcore_icu_bridge_defaults"],
    srcs: [
        ":android_icu4j_repackaged_src_files",
    ],
    stub_only_libs: [
        "stub-annotations",
    ],
    visibility: [
        "//libcore:__subpackages__",
        "//packages/modules/RuntimeI18n/apex",
        // Visibility for prebuilt i18n-module-sdk from the prebuilt of
        // this module.
        // TODO(b/155921753): Restrict this when prebuilts are in their proper
        // locations.
        "//prebuilts:__subpackages__",
    ],
    api_dir: "api/intra",
    api_only: true,

    // Emit nullability annotations from the source to the stub files.
    annotations_enabled: true,

    sdk_version: "none",
    system_modules: "art-module-intra-core-api-stubs-system-modules",

    droiddoc_options: [
        "--hide-annotation libcore.api.Hide ",
        "--show-single-annotation libcore.api.IntraCoreApi ",
        // Exclude FlaggedApi as Metalava cannot resolve the flags reference
        // because this is not given the flags library on the classpath as
        // doing so creates a cycle.
        "--exclude-annotation android.annotation.FlaggedApi",
    ],

    public: {
        // Select api-surface defined in build/soong/java/metalava/main-config.xml
        api_surface: "intra-core",
    },

    // Don't copy any output files to the dist.
    no_dist: true,

    lint: {
        warning_checks: ["SuspiciousIndentation"],
    },

    // This module's output stubs contain apis defined in "i18n.module.public.api.stubs",
    // but adding "i18n.module.public.api" as a dependency of this module leads to circular
    // dependency and requires further bootstrapping. Thus, disable stubs generation from the
    // api signature files and generate stubs from the source Java files instead.
    build_from_text_stub: false,
}

// Referenced implicitly from i18n.module.intra.core.api.
filegroup {
    name: "i18n.module.intra.core.api.api.combined.public.latest",
    srcs: [
        "api/intra/last-api.txt",
    ],
}

// Referenced implicitly from i18n.module.intra.core.api.
filegroup {
    name: "i18n.module.intra.core.api-removed.api.combined.public.latest",
    srcs: [
        "api/intra/last-removed.txt",
    ],
}

// Referenced implicitly from i18n.module.intra.core.api.
filegroup {
    name: "i18n.module.intra.core.api-incompatibilities.api.public.latest",
    srcs: [
        "api/intra/last-incompatibilities.txt",
    ],
}

// Referenced implicitly from legacy.i18n.module.platform.api.
filegroup {
    name: "legacy.i18n.module.platform.api.api.combined.public.latest",
    srcs: [
        "api/legacy_platform/last-api.txt",
    ],
}

// Referenced implicitly from legacy.i18n.module.platform.api.
filegroup {
    name: "legacy.i18n.module.platform.api-removed.api.combined.public.latest",
    srcs: [
        "api/legacy_platform/last-removed.txt",
    ],
}

// Referenced implicitly from legacy.i18n.module.platform.api.
filegroup {
    name: "legacy.i18n.module.platform.api-incompatibilities.api.public.latest",
    srcs: [
        "api/legacy_platform/last-incompatibilities.txt",
    ],
}

// Referenced implicitly from stable.i18n.module.platform.api.
filegroup {
    name: "stable.i18n.module.platform.api.api.combined.public.latest",
    srcs: [
        "api/stable_platform/last-api.txt",
    ],
}

// Referenced implicitly from stable.i18n.module.platform.api.
filegroup {
    name: "stable.i18n.module.platform.api-removed.api.combined.public.latest",
    srcs: [
        "api/stable_platform/last-removed.txt",
    ],
}

// Referenced implicitly from stable.i18n.module.platform.api.
filegroup {
    name: "stable.i18n.module.platform.api-incompatibilities.api.public.latest",
    srcs: [
        "api/stable_platform/last-incompatibilities.txt",
    ],
}

// Used by ravenwood for processing
filegroup {
    name: "icu-ravenwood-policies",
    visibility: ["//frameworks/base/ravenwood"],
    srcs: [
        "icu-ravenwood-policies.txt",
    ],
}

// Generates stub source files for the core platform API of the I18N module.
// i.e. every class/member that is either in the public API or annotated with
// @CorePlatformApi.
//
// The API specification .txt files managed by this only contain the additional
// classes/members that are in the intra-core API but which are not in the public
// API.
//
// For notes on the legacy and stable versions see mmodules/core_platform_api/Android.bp.

java_sdk_library {
    name: "legacy.i18n.module.platform.api",
    defaults: ["libcore_icu_bridge_defaults"],
    srcs: [
        ":android_icu4j_repackaged_src_files",
    ],
    visibility: [
        "//build/soong/java/core-libraries",
        "//packages/modules/RuntimeI18n/apex",
        // Visibility for prebuilt i18n-module-sdk from the prebuilt of
        // this module.
        // TODO(b/155921753): Restrict this when prebuilts are in their proper
        // locations.
        "//prebuilts:__subpackages__",
        // We need to know what major version of tzdata a device needs.
        "//system/timezone/apex/tests",
    ],
    hostdex: true,
    api_dir: "api/legacy_platform",
    api_only: true,
    sdk_version: "none",
    system_modules: "art-module-lib-api-stubs-system-modules",

    public: {
        // Select api-surface defined in build/soong/java/metalava/main-config.xml
        api_surface: "core-platform-legacy",
    },

    droiddoc_options: [
        "--hide-annotation libcore.api.Hide ",
        "--show-single-annotation libcore.api.CorePlatformApi ",
    ],

    libs: [
        "icu_aconfig_flags_lib",
    ],

    // Don't copy any output files to the dist.
    no_dist: true,

    lint: {
        warning_checks: ["SuspiciousIndentation"],
    },
}

java_sdk_library {
    name: "stable.i18n.module.platform.api",
    defaults: ["libcore_icu_bridge_defaults"],
    srcs: [
        ":android_icu4j_repackaged_src_files",
    ],
    visibility: [
        "//build/soong/java/core-libraries",
        "//packages/modules/RuntimeI18n/apex",
        // Visibility for prebuilt i18n-module-sdk from the prebuilt of
        // this module.
        // TODO(b/155921753): Restrict this when prebuilts are in their proper
        // locations.
        "//prebuilts:__subpackages__",
    ],
    hostdex: true,
    api_dir: "api/stable_platform",
    api_only: true,
    sdk_version: "none",
    system_modules: "art-module-lib-api-stubs-system-modules",

    droiddoc_options: [
        "--hide-annotation libcore.api.Hide ",
        "--show-single-annotation libcore.api.CorePlatformApi\\(status=libcore.api.CorePlatformApi.Status.STABLE\\)",
    ],

    public: {
        // Select api-surface defined in build/soong/java/metalava/main-config.xml
        api_surface: "core-platform",
    },

    // Don't copy any output files to the dist.
    no_dist: true,

    lint: {
        warning_checks: ["SuspiciousIndentation"],
    },
}

//==========================================================
// build repackaged ICU tests
//
// Target builds against core-libart and core-oj so that it can access all the
// repackaged android.icu classes and methods and not just the ones available
// through the Android API.
//==========================================================
java_defaults {
    name: "android-icu4j-tests-default",
    visibility: [
        "//cts/tests/tests/icu",
    ],
    java_resource_dirs: [
        "src/main/tests",
        "testing/src",
    ],
    libs: [
        "core-icu4j",
    ],
    static_libs: [
        "gson",
        "junit",
        "junit-params",
        "tzdata-testing",
    ],

    patch_module: "java.base",
    sdk_version: "none",
    system_modules: "art-module-intra-core-api-stubs-system-modules",

    errorprone: {
        javacflags: [
            "-Xep:EqualsNull:WARN",
            "-Xep:ArrayToString:WARN",
            "-Xep:SelfEquals:WARN",
            "-Xep:SelfComparison:WARN",
            "-Xep:ReturnValueIgnored:WARN",
            "-Xep:IdentityBinaryExpression:WARN",
            "-Xep:BoxedPrimitiveEquality:WARN",
            "-Xep:ComparableType:WARN",
        ],
    },
}

java_test {
    name: "android-icu4j-tests",
    defaults: ["android-icu4j-tests-default"],
    visibility: [
        "//cts/tests/tests/icu",
    ],
    srcs: [
        "src/main/tests/**/*.java",
        "testing/src/**/*.java",
    ],
    libs: [
        "icu_aconfig_flags_lib",
        "telephony-common",
        "telephony_flags_core_java_lib",
    ],
    static_libs: [
        "flag-junit",
        "junit",
        "platform-parametric-runner-lib",
        "platform-test-annotations",
    ],
}

// Equivalent to android-icu4j-tests, excluding the tests under testing/.
// We run this as ICU CTS on Ravenwood, where the testing/ tests won't pass due to lack of
// libcore.
java_test {
    name: "android-icu4j-tests-core-only",
    defaults: ["android-icu4j-tests-default"],
    visibility: [
        "//cts/tests/tests/icu",
    ],
    srcs: [
        "src/main/tests/**/*.java",
        "testing/src/android/icu/testsharding/**/*.java",
    ],
    // TODO(b/340889954) Un-excluide the excluded tests.
    exclude_srcs: [
        // This class has a "known-failure", which we can't exclude on Ravenwood without
        // modifying this file, so let's just exclude the whole class for now.
        "src/main/tests/android/icu/dev/test/format/NumberFormatRegressionTest.java",

        // This test takes too much time and hits the timeout.
        "src/main/tests/android/icu/dev/test/rbbi/RBBIMonkeyTest.java",
    ],
}