1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654 |
- // Copyright 2015 Google Inc. 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.
- package java
- // This file contains the module implementations for android_app, android_test, and some more
- // related module types, including their override variants.
- import (
- "fmt"
- "path/filepath"
- "strings"
- "github.com/google/blueprint"
- "github.com/google/blueprint/proptools"
- "android/soong/android"
- "android/soong/bazel"
- "android/soong/cc"
- "android/soong/dexpreopt"
- "android/soong/tradefed"
- )
- func init() {
- RegisterAppBuildComponents(android.InitRegistrationContext)
- pctx.HostBinToolVariable("ModifyAllowlistCmd", "modify_permissions_allowlist")
- }
- var (
- modifyAllowlist = pctx.AndroidStaticRule("modifyAllowlist",
- blueprint.RuleParams{
- Command: "${ModifyAllowlistCmd} $in $packageName $out",
- CommandDeps: []string{"${ModifyAllowlistCmd}"},
- }, "packageName")
- )
- func RegisterAppBuildComponents(ctx android.RegistrationContext) {
- ctx.RegisterModuleType("android_app", AndroidAppFactory)
- ctx.RegisterModuleType("android_test", AndroidTestFactory)
- ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
- ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
- ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
- ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
- }
- // AndroidManifest.xml merging
- // package splits
- type appProperties struct {
- // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
- Additional_certificates []string
- // If set, create package-export.apk, which other packages can
- // use to get PRODUCT-agnostic resource data like IDs and type definitions.
- Export_package_resources *bool
- // Specifies that this app should be installed to the priv-app directory,
- // where the system will grant it additional privileges not available to
- // normal apps.
- Privileged *bool
- // list of resource labels to generate individual resource packages
- Package_splits []string
- // list of native libraries that will be provided in or alongside the resulting jar
- Jni_libs []string `android:"arch_variant"`
- // if true, use JNI libraries that link against platform APIs even if this module sets
- // sdk_version.
- Jni_uses_platform_apis *bool
- // if true, use JNI libraries that link against SDK APIs even if this module does not set
- // sdk_version.
- Jni_uses_sdk_apis *bool
- // STL library to use for JNI libraries.
- Stl *string `android:"arch_variant"`
- // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
- // flag so that they are used from inside the APK at runtime. Defaults to true for android_test modules unless
- // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
- // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
- // libraries are generally preinstalled outside the APK.
- Use_embedded_native_libs *bool
- // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
- // they are used from inside the APK at runtime.
- Use_embedded_dex *bool
- // Forces native libraries to always be packaged into the APK,
- // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
- // True for android_test* modules.
- AlwaysPackageNativeLibs bool `blueprint:"mutated"`
- // If set, find and merge all NOTICE files that this module and its dependencies have and store
- // it in the APK as an asset.
- Embed_notices *bool
- // cc.Coverage related properties
- PreventInstall bool `blueprint:"mutated"`
- IsCoverageVariant bool `blueprint:"mutated"`
- // It can be set to test the behaviour of default target sdk version.
- // Only required when updatable: false. It is an error if updatable: true and this is false.
- Enforce_default_target_sdk_version *bool
- // If set, the targetSdkVersion for the target is set to the latest default API level.
- // This would be by default false, unless updatable: true or
- // enforce_default_target_sdk_version: true in which case this defaults to true.
- EnforceDefaultTargetSdkVersion bool `blueprint:"mutated"`
- // Whether this app is considered mainline updatable or not. When set to true, this will enforce
- // additional rules to make sure an app can safely be updated. Default is false.
- // Prefer using other specific properties if build behaviour must be changed; avoid using this
- // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
- Updatable *bool
- // Specifies the file that contains the allowlist for this app.
- Privapp_allowlist *string `android:"path"`
- }
- // android_app properties that can be overridden by override_android_app
- type overridableAppProperties struct {
- // The name of a certificate in the default certificate directory, blank to use the default product certificate,
- // or an android_app_certificate module name in the form ":module".
- Certificate *string
- // Name of the signing certificate lineage file or filegroup module.
- Lineage *string `android:"path"`
- // For overriding the --rotation-min-sdk-version property of apksig
- RotationMinSdkVersion *string
- // the package name of this app. The package name in the manifest file is used if one was not given.
- Package_name *string
- // the logging parent of this app.
- Logging_parent *string
- // Whether to rename the package in resources to the override name rather than the base name. Defaults to true.
- Rename_resources_package *bool
- // Names of modules to be overridden. Listed modules can only be other binaries
- // (in Make or Soong).
- // This does not completely prevent installation of the overridden binaries, but if both
- // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
- // from PRODUCT_PACKAGES.
- Overrides []string
- }
- type AndroidApp struct {
- android.BazelModuleBase
- Library
- aapt
- android.OverridableModuleBase
- certificate Certificate
- appProperties appProperties
- overridableAppProperties overridableAppProperties
- jniLibs []jniLib
- installPathForJNISymbols android.Path
- embeddedJniLibs bool
- jniCoverageOutputs android.Paths
- bundleFile android.Path
- // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
- installApkName string
- installDir android.InstallPath
- onDeviceDir string
- additionalAaptFlags []string
- overriddenManifestPackageName string
- android.ApexBundleDepsInfo
- javaApiUsedByOutputFile android.ModuleOutPath
- privAppAllowlist android.OptionalPath
- }
- func (a *AndroidApp) IsInstallable() bool {
- return Bool(a.properties.Installable)
- }
- func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
- return nil
- }
- func (a *AndroidApp) ExportedStaticPackages() android.Paths {
- return nil
- }
- func (a *AndroidApp) OutputFile() android.Path {
- return a.outputFile
- }
- func (a *AndroidApp) Certificate() Certificate {
- return a.certificate
- }
- func (a *AndroidApp) JniCoverageOutputs() android.Paths {
- return a.jniCoverageOutputs
- }
- func (a *AndroidApp) PrivAppAllowlist() android.OptionalPath {
- return a.privAppAllowlist
- }
- var _ AndroidLibraryDependency = (*AndroidApp)(nil)
- type Certificate struct {
- Pem, Key android.Path
- presigned bool
- }
- var PresignedCertificate = Certificate{presigned: true}
- func (c Certificate) AndroidMkString() string {
- if c.presigned {
- return "PRESIGNED"
- } else {
- return c.Pem.String()
- }
- }
- func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
- a.Module.deps(ctx)
- if String(a.appProperties.Stl) == "c++_shared" && !a.SdkVersion(ctx).Specified() {
- ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
- }
- sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
- if sdkDep.hasFrameworkLibs() {
- a.aapt.deps(ctx, sdkDep)
- }
- usesSDK := a.SdkVersion(ctx).Specified() && a.SdkVersion(ctx).Kind != android.SdkCorePlatform
- if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
- ctx.PropertyErrorf("jni_uses_sdk_apis",
- "can only be set for modules that do not set sdk_version")
- } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
- ctx.PropertyErrorf("jni_uses_platform_apis",
- "can only be set for modules that set sdk_version")
- }
- for _, jniTarget := range ctx.MultiTargets() {
- variation := append(jniTarget.Variations(),
- blueprint.Variation{Mutator: "link", Variation: "shared"})
- // If the app builds against an Android SDK use the SDK variant of JNI dependencies
- // unless jni_uses_platform_apis is set.
- // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
- // have stable APIs through the VNDK.
- if (usesSDK && !a.RequiresStableAPIs(ctx) &&
- !Bool(a.appProperties.Jni_uses_platform_apis)) ||
- Bool(a.appProperties.Jni_uses_sdk_apis) {
- variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
- }
- ctx.AddFarVariationDependencies(variation, jniLibTag, a.appProperties.Jni_libs...)
- }
- a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
- }
- func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
- cert := android.SrcIsModule(a.getCertString(ctx))
- if cert != "" {
- ctx.AddDependency(ctx.Module(), certificateTag, cert)
- }
- if a.appProperties.Privapp_allowlist != nil && !Bool(a.appProperties.Privileged) {
- // There are a few uids that are explicitly considered privileged regardless of their
- // app's location. Bluetooth is one such app. It should arguably be moved to priv-app,
- // but for now, allow it not to be in priv-app.
- privilegedBecauseOfUid := ctx.ModuleName() == "Bluetooth"
- if !privilegedBecauseOfUid {
- ctx.PropertyErrorf("privapp_allowlist", "privileged must be set in order to use privapp_allowlist (with a few exceptions)")
- }
- }
- for _, cert := range a.appProperties.Additional_certificates {
- cert = android.SrcIsModule(cert)
- if cert != "" {
- ctx.AddDependency(ctx.Module(), certificateTag, cert)
- } else {
- ctx.PropertyErrorf("additional_certificates",
- `must be names of android_app_certificate modules in the form ":module"`)
- }
- }
- }
- func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
- a.generateAndroidBuildActions(ctx)
- }
- func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
- a.checkAppSdkVersions(ctx)
- a.generateAndroidBuildActions(ctx)
- a.generateJavaUsedByApex(ctx)
- }
- func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
- if a.Updatable() {
- if !a.SdkVersion(ctx).Stable() {
- ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.SdkVersion(ctx))
- }
- if String(a.deviceProperties.Min_sdk_version) == "" {
- ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
- }
- if minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx); err == nil {
- a.checkJniLibsSdkVersion(ctx, minSdkVersion)
- android.CheckMinSdkVersion(ctx, minSdkVersion, a.WalkPayloadDeps)
- } else {
- ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
- }
- if !BoolDefault(a.appProperties.Enforce_default_target_sdk_version, true) {
- ctx.PropertyErrorf("enforce_default_target_sdk_version", "Updatable apps must enforce default target sdk version")
- }
- // TODO(b/227460469) after all the modules removes the target sdk version, throw an error if the target sdk version is explicitly set.
- if a.deviceProperties.Target_sdk_version == nil {
- a.SetEnforceDefaultTargetSdkVersion(true)
- }
- }
- a.checkPlatformAPI(ctx)
- a.checkSdkVersions(ctx)
- }
- // If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
- // This check is enforced for "updatable" APKs (including APK-in-APEX).
- func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion android.ApiLevel) {
- // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
- ctx.VisitDirectDeps(func(m android.Module) {
- if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
- return
- }
- dep, _ := m.(*cc.Module)
- // The domain of cc.sdk_version is "current" and <number>
- // We can rely on android.SdkSpec to convert it to <number> so that "current" is
- // handled properly regardless of sdk finalization.
- jniSdkVersion, err := android.SdkSpecFrom(ctx, dep.MinSdkVersion()).EffectiveVersion(ctx)
- if err != nil || minSdkVersion.LessThan(jniSdkVersion) {
- ctx.OtherModuleErrorf(dep, "min_sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
- dep.MinSdkVersion(), minSdkVersion, ctx.ModuleName())
- return
- }
- })
- }
- // Returns true if the native libraries should be stored in the APK uncompressed and the
- // extractNativeLibs application flag should be set to false in the manifest.
- func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
- minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx)
- if err != nil {
- ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.MinSdkVersion(ctx), err)
- }
- apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
- return (minSdkVersion.FinalOrFutureInt() >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
- !apexInfo.IsForPlatform()
- }
- // Returns whether this module should have the dex file stored uncompressed in the APK.
- func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
- if Bool(a.appProperties.Use_embedded_dex) {
- return true
- }
- // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
- // be preinstalled as prebuilts).
- if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
- return true
- }
- if ctx.Config().UnbundledBuild() {
- return false
- }
- return shouldUncompressDex(ctx, &a.dexpreopter)
- }
- func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
- apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
- return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
- !apexInfo.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
- }
- func generateAaptRenamePackageFlags(packageName string, renameResourcesPackage bool) []string {
- aaptFlags := []string{"--rename-manifest-package " + packageName}
- if renameResourcesPackage {
- // Required to rename the package name in the resources table.
- aaptFlags = append(aaptFlags, "--rename-resources-package "+packageName)
- }
- return aaptFlags
- }
- func (a *AndroidApp) OverriddenManifestPackageName() string {
- return a.overriddenManifestPackageName
- }
- func (a *AndroidApp) renameResourcesPackage() bool {
- return proptools.BoolDefault(a.overridableAppProperties.Rename_resources_package, true)
- }
- func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
- usePlatformAPI := proptools.Bool(a.Module.deviceProperties.Platform_apis)
- if ctx.Module().(android.SdkContext).SdkVersion(ctx).Kind == android.SdkModule {
- usePlatformAPI = true
- }
- a.aapt.usesNonSdkApis = usePlatformAPI
- // Ask manifest_fixer to add or update the application element indicating this app has no code.
- a.aapt.hasNoCode = !a.hasCode(ctx)
- aaptLinkFlags := []string{}
- // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided.
- hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
- if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
- aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
- }
- if !Bool(a.aaptProperties.Aapt_include_all_resources) {
- // Product AAPT config
- for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
- aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
- }
- // Product AAPT preferred config
- if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
- aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
- }
- }
- manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
- if overridden || a.overridableAppProperties.Package_name != nil {
- // The product override variable has a priority over the package_name property.
- if !overridden {
- manifestPackageName = *a.overridableAppProperties.Package_name
- }
- aaptLinkFlags = append(aaptLinkFlags, generateAaptRenamePackageFlags(manifestPackageName, a.renameResourcesPackage())...)
- a.overriddenManifestPackageName = manifestPackageName
- }
- aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
- a.aapt.splitNames = a.appProperties.Package_splits
- a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
- if a.Updatable() {
- a.aapt.defaultManifestVersion = android.DefaultUpdatableModuleVersion
- }
- a.aapt.buildActions(ctx, android.SdkContext(a), a.classLoaderContexts,
- a.usesLibraryProperties.Exclude_uses_libs, a.enforceDefaultTargetSdkVersion(), aaptLinkFlags...)
- // apps manifests are handled by aapt, don't let Module see them
- a.properties.Manifest = nil
- }
- func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
- var staticLibProguardFlagFiles android.Paths
- ctx.VisitDirectDeps(func(m android.Module) {
- if lib, ok := m.(LibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
- staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
- }
- })
- staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
- a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
- a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
- }
- func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath {
- var installDir string
- if ctx.ModuleName() == "framework-res" {
- // framework-res.apk is installed as system/framework/framework-res.apk
- installDir = "framework"
- } else if a.Privileged() {
- installDir = filepath.Join("priv-app", a.installApkName)
- } else {
- installDir = filepath.Join("app", a.installApkName)
- }
- return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
- }
- func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
- a.dexpreopter.installPath = a.installPath(ctx)
- a.dexpreopter.isApp = true
- if a.dexProperties.Uncompress_dex == nil {
- // If the value was not force-set by the user, use reasonable default based on the module.
- a.dexProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
- }
- a.dexpreopter.uncompressedDex = *a.dexProperties.Uncompress_dex
- a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
- a.dexpreopter.classLoaderContexts = a.classLoaderContexts
- a.dexpreopter.manifestFile = a.mergedManifestFile
- a.dexpreopter.preventInstall = a.appProperties.PreventInstall
- if ctx.ModuleName() != "framework-res" {
- a.Module.compile(ctx, a.aaptSrcJar)
- }
- return a.dexJarFile.PathOrNil()
- }
- func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, prebuiltJniPackages android.Paths, ctx android.ModuleContext) android.WritablePath {
- var jniJarFile android.WritablePath
- if len(jniLibs) > 0 || len(prebuiltJniPackages) > 0 {
- a.jniLibs = jniLibs
- if a.shouldEmbedJnis(ctx) {
- jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
- a.installPathForJNISymbols = a.installPath(ctx)
- TransformJniLibsToJar(ctx, jniJarFile, jniLibs, prebuiltJniPackages, a.useEmbeddedNativeLibs(ctx))
- for _, jni := range jniLibs {
- if jni.coverageFile.Valid() {
- // Only collect coverage for the first target arch if this is a multilib target.
- // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
- // data file path collisions since the current coverage file path format doesn't contain
- // arch-related strings. This is fine for now though; the code coverage team doesn't use
- // multi-arch targets such as test_suite_* for coverage collections yet.
- //
- // Work with the team to come up with a new format that handles multilib modules properly
- // and change this.
- if len(ctx.Config().Targets[android.Android]) == 1 ||
- ctx.Config().AndroidFirstDeviceTarget.Arch.ArchType == jni.target.Arch.ArchType {
- a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
- }
- }
- }
- a.embeddedJniLibs = true
- }
- }
- return jniJarFile
- }
- func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls {
- var jniSymbols android.RuleBuilderInstalls
- for _, jniLib := range a.jniLibs {
- if jniLib.unstrippedFile != nil {
- jniSymbols = append(jniSymbols, android.RuleBuilderInstall{
- From: jniLib.unstrippedFile,
- To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()),
- })
- }
- }
- return jniSymbols
- }
- // Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
- // isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
- func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate,
- ctx android.ModuleContext) (mainCertificate Certificate, allCertificates []Certificate) {
- if android.SrcIsModule(certPropValue) == "" {
- var mainCert Certificate
- if certPropValue != "" {
- defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
- mainCert = Certificate{
- Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
- Key: defaultDir.Join(ctx, certPropValue+".pk8"),
- }
- } else {
- pem, key := ctx.Config().DefaultAppCertificate(ctx)
- mainCert = Certificate{
- Pem: pem,
- Key: key,
- }
- }
- certificates = append([]Certificate{mainCert}, certificates...)
- }
- if len(certificates) > 0 {
- mainCertificate = certificates[0]
- } else {
- // This can be reached with an empty certificate list if AllowMissingDependencies is set
- // and the certificate property for this module is a module reference to a missing module.
- if !ctx.Config().AllowMissingDependencies() && len(ctx.GetMissingDependencies()) > 0 {
- panic("Should only get here if AllowMissingDependencies set and there are missing dependencies")
- }
- // Set a certificate to avoid panics later when accessing it.
- mainCertificate = Certificate{
- Key: android.PathForModuleOut(ctx, "missing.pk8"),
- Pem: android.PathForModuleOut(ctx, "missing.x509.pem"),
- }
- }
- if !m.Platform() {
- certPath := mainCertificate.Pem.String()
- systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
- if strings.HasPrefix(certPath, systemCertPath) {
- enforceSystemCert := ctx.Config().EnforceSystemCertificate()
- allowed := ctx.Config().EnforceSystemCertificateAllowList()
- if enforceSystemCert && !inList(m.Name(), allowed) {
- ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
- }
- }
- }
- return mainCertificate, certificates
- }
- func (a *AndroidApp) InstallApkName() string {
- return a.installApkName
- }
- func (a *AndroidApp) createPrivappAllowlist(ctx android.ModuleContext) android.Path {
- if a.appProperties.Privapp_allowlist == nil {
- return nil
- }
- isOverrideApp := a.GetOverriddenBy() != ""
- if !isOverrideApp {
- // if this is not an override, we don't need to rewrite the existing privapp allowlist
- return android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist)
- }
- if a.overridableAppProperties.Package_name == nil {
- ctx.PropertyErrorf("privapp_allowlist", "package_name must be set to use privapp_allowlist")
- }
- packageName := *a.overridableAppProperties.Package_name
- fileName := "privapp_allowlist_" + packageName + ".xml"
- outPath := android.PathForModuleOut(ctx, fileName).OutputPath
- ctx.Build(pctx, android.BuildParams{
- Rule: modifyAllowlist,
- Input: android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist),
- Output: outPath,
- Args: map[string]string{
- "packageName": packageName,
- },
- })
- return &outPath
- }
- func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
- var apkDeps android.Paths
- if !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform() {
- a.hideApexVariantFromMake = true
- }
- a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
- a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
- // Check if the install APK name needs to be overridden.
- a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Stem())
- if ctx.ModuleName() == "framework-res" {
- // framework-res.apk is installed as system/framework/framework-res.apk
- a.installDir = android.PathForModuleInstall(ctx, "framework")
- } else if a.Privileged() {
- a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
- } else if ctx.InstallInTestcases() {
- a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
- } else {
- a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
- }
- a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
- a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
- var noticeAssetPath android.WritablePath
- if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
- // The rule to create the notice file can't be generated yet, as the final output path
- // for the apk isn't known yet. Add the path where the notice file will be generated to the
- // aapt rules now before calling aaptBuildActions, the rule to create the notice file will
- // be generated later.
- noticeAssetPath = android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
- a.aapt.noticeFile = android.OptionalPathForPath(noticeAssetPath)
- }
- // For apps targeting latest target_sdk_version
- if Bool(a.appProperties.Enforce_default_target_sdk_version) {
- a.SetEnforceDefaultTargetSdkVersion(true)
- }
- // Process all building blocks, from AAPT to certificates.
- a.aaptBuildActions(ctx)
- // The decision to enforce <uses-library> checks is made before adding implicit SDK libraries.
- a.usesLibrary.freezeEnforceUsesLibraries()
- // Add implicit SDK libraries to <uses-library> list.
- requiredUsesLibs, optionalUsesLibs := a.classLoaderContexts.UsesLibs()
- for _, usesLib := range requiredUsesLibs {
- a.usesLibrary.addLib(usesLib, false)
- }
- for _, usesLib := range optionalUsesLibs {
- a.usesLibrary.addLib(usesLib, true)
- }
- // Check that the <uses-library> list is coherent with the manifest.
- if a.usesLibrary.enforceUsesLibraries() {
- manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
- apkDeps = append(apkDeps, manifestCheckFile)
- }
- a.proguardBuildActions(ctx)
- a.linter.mergedManifest = a.aapt.mergedManifestFile
- a.linter.manifest = a.aapt.manifestPath
- a.linter.resources = a.aapt.resourceFiles
- a.linter.buildModuleReportZip = ctx.Config().UnbundledBuildApps()
- dexJarFile := a.dexBuildActions(ctx)
- jniLibs, prebuiltJniPackages, certificates := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
- jniJarFile := a.jniBuildActions(jniLibs, prebuiltJniPackages, ctx)
- if ctx.Failed() {
- return
- }
- a.certificate, certificates = processMainCert(a.ModuleBase, a.getCertString(ctx), certificates, ctx)
- // Build a final signed app package.
- packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
- v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature)
- var v4SignatureFile android.WritablePath = nil
- if v4SigningRequested {
- v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig")
- }
- var lineageFile android.Path
- if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
- lineageFile = android.PathForModuleSrc(ctx, lineage)
- }
- rotationMinSdkVersion := String(a.overridableAppProperties.RotationMinSdkVersion)
- CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion, Bool(a.dexProperties.Optimize.Shrink_resources))
- a.outputFile = packageFile
- if v4SigningRequested {
- a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
- }
- if a.aapt.noticeFile.Valid() {
- // Generating the notice file rule has to be here after a.outputFile is known.
- noticeFile := android.PathForModuleOut(ctx, "NOTICE.html.gz")
- android.BuildNoticeHtmlOutputFromLicenseMetadata(
- ctx, noticeFile, "", "",
- []string{
- a.installDir.String() + "/",
- android.PathForModuleInstall(ctx).String() + "/",
- a.outputFile.String(),
- })
- builder := android.NewRuleBuilder(pctx, ctx)
- builder.Command().Text("cp").
- Input(noticeFile).
- Output(noticeAssetPath)
- builder.Build("notice_dir", "Building notice dir")
- }
- for _, split := range a.aapt.splits {
- // Sign the split APKs
- packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
- if v4SigningRequested {
- v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig")
- }
- CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion, false)
- a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
- if v4SigningRequested {
- a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
- }
- }
- // Build an app bundle.
- bundleFile := android.PathForModuleOut(ctx, "base.zip")
- BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
- a.bundleFile = bundleFile
- allowlist := a.createPrivappAllowlist(ctx)
- if allowlist != nil {
- a.privAppAllowlist = android.OptionalPathForPath(allowlist)
- }
- apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
- // Install the app package.
- shouldInstallAppPackage := (Bool(a.Module.properties.Installable) || ctx.Host()) && apexInfo.IsForPlatform() && !a.appProperties.PreventInstall
- if shouldInstallAppPackage {
- if a.privAppAllowlist.Valid() {
- allowlistInstallPath := android.PathForModuleInstall(ctx, "etc", "permissions")
- allowlistInstallFilename := a.installApkName + ".xml"
- ctx.InstallFile(allowlistInstallPath, allowlistInstallFilename, a.privAppAllowlist.Path())
- }
- var extraInstalledPaths android.Paths
- for _, extra := range a.extraOutputFiles {
- installed := ctx.InstallFile(a.installDir, extra.Base(), extra)
- extraInstalledPaths = append(extraInstalledPaths, installed)
- }
- ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile, extraInstalledPaths...)
- }
- a.buildAppDependencyInfo(ctx)
- }
- type appDepsInterface interface {
- SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
- MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
- RequiresStableAPIs(ctx android.BaseModuleContext) bool
- }
- func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
- shouldCollectRecursiveNativeDeps bool,
- checkNativeSdkVersion bool) ([]jniLib, android.Paths, []Certificate) {
- var jniLibs []jniLib
- var prebuiltJniPackages android.Paths
- var certificates []Certificate
- seenModulePaths := make(map[string]bool)
- if checkNativeSdkVersion {
- checkNativeSdkVersion = app.SdkVersion(ctx).Specified() &&
- app.SdkVersion(ctx).Kind != android.SdkCorePlatform && !app.RequiresStableAPIs(ctx)
- }
- ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
- otherName := ctx.OtherModuleName(module)
- tag := ctx.OtherModuleDependencyTag(module)
- if IsJniDepTag(tag) || cc.IsSharedDepTag(tag) {
- if dep, ok := module.(cc.LinkableInterface); ok {
- if dep.IsNdk(ctx.Config()) || dep.IsStubs() {
- return false
- }
- lib := dep.OutputFile()
- if lib.Valid() {
- path := lib.Path()
- if seenModulePaths[path.String()] {
- return false
- }
- seenModulePaths[path.String()] = true
- if checkNativeSdkVersion && dep.SdkVersion() == "" {
- ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
- otherName)
- }
- jniLibs = append(jniLibs, jniLib{
- name: ctx.OtherModuleName(module),
- path: path,
- target: module.Target(),
- coverageFile: dep.CoverageOutputFile(),
- unstrippedFile: dep.UnstrippedOutputFile(),
- partition: dep.Partition(),
- })
- } else if ctx.Config().AllowMissingDependencies() {
- ctx.AddMissingDependencies([]string{otherName})
- } else {
- ctx.ModuleErrorf("dependency %q missing output file", otherName)
- }
- } else {
- ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
- }
- return shouldCollectRecursiveNativeDeps
- }
- if info, ok := ctx.OtherModuleProvider(module, JniPackageProvider).(JniPackageInfo); ok {
- prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
- }
- if tag == certificateTag {
- if dep, ok := module.(*AndroidAppCertificate); ok {
- certificates = append(certificates, dep.Certificate)
- } else {
- ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
- }
- }
- return false
- })
- return jniLibs, prebuiltJniPackages, certificates
- }
- func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
- ctx.WalkDeps(func(child, parent android.Module) bool {
- isExternal := !a.DepIsInSameApex(ctx, child)
- if am, ok := child.(android.ApexModule); ok {
- if !do(ctx, parent, am, isExternal) {
- return false
- }
- }
- return !isExternal
- })
- }
- func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
- if ctx.Host() {
- return
- }
- depsInfo := android.DepNameToDepInfoMap{}
- a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
- depName := to.Name()
- // Skip dependencies that are only available to APEXes; they are developed with updatability
- // in mind and don't need manual approval.
- if to.(android.ApexModule).NotAvailableForPlatform() {
- return true
- }
- if info, exist := depsInfo[depName]; exist {
- info.From = append(info.From, from.Name())
- info.IsExternal = info.IsExternal && externalDep
- depsInfo[depName] = info
- } else {
- toMinSdkVersion := "(no version)"
- if m, ok := to.(interface {
- MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
- }); ok {
- if v := m.MinSdkVersion(ctx); !v.IsNone() {
- toMinSdkVersion = v.String()
- }
- } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
- // TODO(b/175678607) eliminate the use of MinSdkVersion returning
- // string
- if v := m.MinSdkVersion(); v != "" {
- toMinSdkVersion = v
- }
- }
- depsInfo[depName] = android.ApexModuleDepInfo{
- To: depName,
- From: []string{from.Name()},
- IsExternal: externalDep,
- MinSdkVersion: toMinSdkVersion,
- }
- }
- return true
- })
- a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depsInfo)
- }
- func (a *AndroidApp) enforceDefaultTargetSdkVersion() bool {
- return a.appProperties.EnforceDefaultTargetSdkVersion
- }
- func (a *AndroidApp) SetEnforceDefaultTargetSdkVersion(val bool) {
- a.appProperties.EnforceDefaultTargetSdkVersion = val
- }
- func (a *AndroidApp) Updatable() bool {
- return Bool(a.appProperties.Updatable)
- }
- func (a *AndroidApp) SetUpdatable(val bool) {
- a.appProperties.Updatable = &val
- }
- func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
- certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
- if overridden {
- return ":" + certificate
- }
- return String(a.overridableAppProperties.Certificate)
- }
- func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
- if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
- return true
- }
- return a.Library.DepIsInSameApex(ctx, dep)
- }
- // For OutputFileProducer interface
- func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
- switch tag {
- // In some instances, it can be useful to reference the aapt-generated flags from another
- // target, e.g., system server implements services declared in the framework-res manifest.
- case ".aapt.proguardOptionsFile":
- return []android.Path{a.proguardOptionsFile}, nil
- case ".aapt.srcjar":
- return []android.Path{a.aaptSrcJar}, nil
- case ".export-package.apk":
- return []android.Path{a.exportPackage}, nil
- }
- return a.Library.OutputFiles(tag)
- }
- func (a *AndroidApp) Privileged() bool {
- return Bool(a.appProperties.Privileged)
- }
- func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
- return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
- }
- func (a *AndroidApp) SetPreventInstall() {
- a.appProperties.PreventInstall = true
- }
- func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
- a.appProperties.IsCoverageVariant = coverage
- }
- func (a *AndroidApp) EnableCoverageIfNeeded() {}
- var _ cc.Coverage = (*AndroidApp)(nil)
- // android_app compiles sources and Android resources into an Android application package `.apk` file.
- func AndroidAppFactory() android.Module {
- module := &AndroidApp{}
- module.Module.dexProperties.Optimize.EnabledByDefault = true
- module.Module.dexProperties.Optimize.Shrink = proptools.BoolPtr(true)
- module.Module.properties.Instrument = true
- module.Module.properties.Supports_static_instrumentation = true
- module.Module.properties.Installable = proptools.BoolPtr(true)
- module.addHostAndDeviceProperties()
- module.AddProperties(
- &module.aaptProperties,
- &module.appProperties,
- &module.overridableAppProperties)
- module.usesLibrary.enforce = true
- android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
- android.InitDefaultableModule(module)
- android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
- android.InitApexModule(module)
- android.InitBazelModule(module)
- return module
- }
- type appTestProperties struct {
- // The name of the android_app module that the tests will run against.
- Instrumentation_for *string
- // If specified, the instrumentation target package name in the manifest is overwritten by it.
- Instrumentation_target_package *string
- // If specified, the mainline module package name in the test config is overwritten by it.
- Mainline_package_name *string
- }
- type AndroidTest struct {
- AndroidApp
- appTestProperties appTestProperties
- testProperties testProperties
- testConfig android.Path
- extraTestConfigs android.Paths
- data android.Paths
- }
- func (a *AndroidTest) InstallInTestcases() bool {
- return true
- }
- type androidTestApp interface {
- includedInTestSuite(searchPrefix string) bool
- }
- func (a *AndroidTest) includedInTestSuite(searchPrefix string) bool {
- return android.PrefixInList(a.testProperties.Test_suites, searchPrefix)
- }
- func (a *AndroidTestHelperApp) includedInTestSuite(searchPrefix string) bool {
- return android.PrefixInList(a.appTestHelperAppProperties.Test_suites, searchPrefix)
- }
- func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
- var configs []tradefed.Config
- if a.appTestProperties.Instrumentation_target_package != nil {
- a.additionalAaptFlags = append(a.additionalAaptFlags,
- "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
- } else if a.appTestProperties.Instrumentation_for != nil {
- // Check if the instrumentation target package is overridden.
- manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
- if overridden {
- a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
- }
- }
- a.generateAndroidBuildActions(ctx)
- for _, module := range a.testProperties.Test_mainline_modules {
- configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
- }
- testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
- a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
- a.testConfig = a.FixTestConfig(ctx, testConfig)
- a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
- a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
- }
- func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
- if testConfig == nil {
- return nil
- }
- fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
- rule := android.NewRuleBuilder(pctx, ctx)
- command := rule.Command().BuiltTool("test_config_fixer").Input(testConfig).Output(fixedConfig)
- fixNeeded := false
- // Auto-generated test config uses `ModuleName` as the APK name. So fix it if it is not the case.
- if ctx.ModuleName() != a.installApkName {
- fixNeeded = true
- command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
- }
- if a.overridableAppProperties.Package_name != nil {
- fixNeeded = true
- command.FlagWithInput("--manifest ", a.manifestPath).
- FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
- }
- if a.appTestProperties.Mainline_package_name != nil {
- fixNeeded = true
- command.FlagWithArg("--mainline-package-name ", *a.appTestProperties.Mainline_package_name)
- }
- if fixNeeded {
- rule.Build("fix_test_config", "fix test config")
- return fixedConfig
- }
- return testConfig
- }
- func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
- a.AndroidApp.DepsMutator(ctx)
- }
- func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
- a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
- if a.appTestProperties.Instrumentation_for != nil {
- // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
- // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
- // use instrumentationForTag instead of libTag.
- ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
- }
- }
- // android_test compiles test sources and Android resources into an Android application package `.apk` file and
- // creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
- func AndroidTestFactory() android.Module {
- module := &AndroidTest{}
- module.Module.dexProperties.Optimize.EnabledByDefault = false
- module.Module.properties.Instrument = true
- module.Module.properties.Supports_static_instrumentation = true
- module.Module.properties.Installable = proptools.BoolPtr(true)
- module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
- module.appProperties.AlwaysPackageNativeLibs = true
- module.Module.dexpreopter.isTest = true
- module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
- module.addHostAndDeviceProperties()
- module.AddProperties(
- &module.aaptProperties,
- &module.appProperties,
- &module.appTestProperties,
- &module.overridableAppProperties,
- &module.testProperties)
- android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
- android.InitDefaultableModule(module)
- android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
- return module
- }
- type appTestHelperAppProperties struct {
- // list of compatibility suites (for example "cts", "vts") that the module should be
- // installed into.
- Test_suites []string `android:"arch_variant"`
- // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
- // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
- // explicitly.
- Auto_gen_config *bool
- // Install the test into a folder named for the module in all test suites.
- Per_testcase_directory *bool
- }
- type AndroidTestHelperApp struct {
- AndroidApp
- appTestHelperAppProperties appTestHelperAppProperties
- }
- func (a *AndroidTestHelperApp) InstallInTestcases() bool {
- return true
- }
- // android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
- // will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
- // test.
- func AndroidTestHelperAppFactory() android.Module {
- module := &AndroidTestHelperApp{}
- // TODO(b/192032291): Disable by default after auditing downstream usage.
- module.Module.dexProperties.Optimize.EnabledByDefault = true
- module.Module.properties.Installable = proptools.BoolPtr(true)
- module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
- module.appProperties.AlwaysPackageNativeLibs = true
- module.Module.dexpreopter.isTest = true
- module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
- module.addHostAndDeviceProperties()
- module.AddProperties(
- &module.aaptProperties,
- &module.appProperties,
- &module.appTestHelperAppProperties,
- &module.overridableAppProperties)
- android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
- android.InitDefaultableModule(module)
- android.InitApexModule(module)
- return module
- }
- type AndroidAppCertificate struct {
- android.ModuleBase
- android.BazelModuleBase
- properties AndroidAppCertificateProperties
- Certificate Certificate
- }
- type AndroidAppCertificateProperties struct {
- // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
- Certificate *string
- }
- // android_app_certificate modules can be referenced by the certificates property of android_app modules to select
- // the signing key.
- func AndroidAppCertificateFactory() android.Module {
- module := &AndroidAppCertificate{}
- module.AddProperties(&module.properties)
- android.InitAndroidModule(module)
- android.InitBazelModule(module)
- return module
- }
- func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
- cert := String(c.properties.Certificate)
- c.Certificate = Certificate{
- Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
- Key: android.PathForModuleSrc(ctx, cert+".pk8"),
- }
- }
- type OverrideAndroidApp struct {
- android.ModuleBase
- android.OverrideModuleBase
- }
- func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
- // All the overrides happen in the base module.
- // TODO(jungjw): Check the base module type.
- }
- // override_android_app is used to create an android_app module based on another android_app by overriding
- // some of its properties.
- func OverrideAndroidAppModuleFactory() android.Module {
- m := &OverrideAndroidApp{}
- m.AddProperties(
- &OverridableDeviceProperties{},
- &overridableAppProperties{},
- )
- android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
- android.InitOverrideModule(m)
- return m
- }
- type OverrideAndroidTest struct {
- android.ModuleBase
- android.OverrideModuleBase
- }
- func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
- // All the overrides happen in the base module.
- // TODO(jungjw): Check the base module type.
- }
- // override_android_test is used to create an android_app module based on another android_test by overriding
- // some of its properties.
- func OverrideAndroidTestModuleFactory() android.Module {
- m := &OverrideAndroidTest{}
- m.AddProperties(&overridableAppProperties{})
- m.AddProperties(&appTestProperties{})
- android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
- android.InitOverrideModule(m)
- return m
- }
- type UsesLibraryProperties struct {
- // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
- Uses_libs []string
- // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
- // required=false.
- Optional_uses_libs []string
- // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
- // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
- Enforce_uses_libs *bool
- // Optional name of the <uses-library> provided by this module. This is needed for non-SDK
- // libraries, because SDK ones are automatically picked up by Soong. The <uses-library> name
- // normally is the same as the module name, but there are exceptions.
- Provides_uses_lib *string
- // A list of shared library names to exclude from the classpath of the APK. Adding a library here
- // will prevent it from being used when precompiling the APK and prevent it from being implicitly
- // added to the APK's manifest's <uses-library> elements.
- //
- // Care must be taken when using this as it could result in runtime errors if the APK actually
- // uses classes provided by the library and which are not provided in any other way.
- //
- // This is primarily intended for use by various CTS tests that check the runtime handling of the
- // android.test.base shared library (and related libraries) but which depend on some common
- // libraries that depend on the android.test.base library. Without this those tests will end up
- // with a <uses-library android:name="android.test.base"/> in their manifest which would either
- // render the tests worthless (as they would be testing the wrong behavior), or would break the
- // test altogether by providing access to classes that the tests were not expecting. Those tests
- // provide the android.test.base statically and use jarjar to rename them so they do not collide
- // with the classes provided by the android.test.base library.
- Exclude_uses_libs []string
- }
- // usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
- // <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
- // uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
- // with knowledge of their shared libraries.
- type usesLibrary struct {
- usesLibraryProperties UsesLibraryProperties
- // Whether to enforce verify_uses_library check.
- enforce bool
- }
- func (u *usesLibrary) addLib(lib string, optional bool) {
- if !android.InList(lib, u.usesLibraryProperties.Uses_libs) && !android.InList(lib, u.usesLibraryProperties.Optional_uses_libs) {
- if optional {
- u.usesLibraryProperties.Optional_uses_libs = append(u.usesLibraryProperties.Optional_uses_libs, lib)
- } else {
- u.usesLibraryProperties.Uses_libs = append(u.usesLibraryProperties.Uses_libs, lib)
- }
- }
- }
- func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, addCompatDeps bool) {
- if !ctx.Config().UnbundledBuild() || ctx.Config().UnbundledBuildImage() {
- ctx.AddVariationDependencies(nil, usesLibReqTag, u.usesLibraryProperties.Uses_libs...)
- ctx.AddVariationDependencies(nil, usesLibOptTag, u.presentOptionalUsesLibs(ctx)...)
- // Only add these extra dependencies if the module is an app that depends on framework
- // libs. This avoids creating a cyclic dependency:
- // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
- if addCompatDeps {
- // Dexpreopt needs paths to the dex jars of these libraries in order to construct
- // class loader context for dex2oat. Add them as a dependency with a special tag.
- ctx.AddVariationDependencies(nil, usesLibCompat29ReqTag, dexpreopt.CompatUsesLibs29...)
- ctx.AddVariationDependencies(nil, usesLibCompat28OptTag, dexpreopt.OptionalCompatUsesLibs28...)
- ctx.AddVariationDependencies(nil, usesLibCompat30OptTag, dexpreopt.OptionalCompatUsesLibs30...)
- }
- } else {
- ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.usesLibraryProperties.Uses_libs...)
- ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.presentOptionalUsesLibs(ctx)...)
- }
- }
- // presentOptionalUsesLibs returns optional_uses_libs after filtering out libraries that don't exist in the source tree.
- func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
- optionalUsesLibs := android.FilterListPred(u.usesLibraryProperties.Optional_uses_libs, func(s string) bool {
- exists := ctx.OtherModuleExists(s)
- if !exists && !android.InList(ctx.ModuleName(), ctx.Config().BuildWarningBadOptionalUsesLibsAllowlist()) {
- fmt.Printf("Warning: Module '%s' depends on non-existing optional_uses_libs '%s'\n", ctx.ModuleName(), s)
- }
- return exists
- })
- return optionalUsesLibs
- }
- // Helper function to replace string in a list.
- func replaceInList(list []string, oldstr, newstr string) {
- for i, str := range list {
- if str == oldstr {
- list[i] = newstr
- }
- }
- }
- // Returns a map of module names of shared library dependencies to the paths to their dex jars on
- // host and on device.
- func (u *usesLibrary) classLoaderContextForUsesLibDeps(ctx android.ModuleContext) dexpreopt.ClassLoaderContextMap {
- clcMap := make(dexpreopt.ClassLoaderContextMap)
- // Skip when UnbundledBuild() is true, but UnbundledBuildImage() is false. With
- // UnbundledBuildImage() it is necessary to generate dexpreopt.config for post-dexpreopting.
- if ctx.Config().UnbundledBuild() && !ctx.Config().UnbundledBuildImage() {
- return clcMap
- }
- ctx.VisitDirectDeps(func(m android.Module) {
- tag, isUsesLibTag := ctx.OtherModuleDependencyTag(m).(usesLibraryDependencyTag)
- if !isUsesLibTag {
- return
- }
- dep := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(m))
- // Skip stub libraries. A dependency on the implementation library has been added earlier,
- // so it will be added to CLC, but the stub shouldn't be. Stub libraries can be distingushed
- // from implementation libraries by their name, which is different as it has a suffix.
- if comp, ok := m.(SdkLibraryComponentDependency); ok {
- if impl := comp.OptionalSdkLibraryImplementation(); impl != nil && *impl != dep {
- return
- }
- }
- if lib, ok := m.(UsesLibraryDependency); ok {
- libName := dep
- if ulib, ok := m.(ProvidesUsesLib); ok && ulib.ProvidesUsesLib() != nil {
- libName = *ulib.ProvidesUsesLib()
- // Replace module name with library name in `uses_libs`/`optional_uses_libs` in
- // order to pass verify_uses_libraries check (which compares these properties
- // against library names written in the manifest).
- replaceInList(u.usesLibraryProperties.Uses_libs, dep, libName)
- replaceInList(u.usesLibraryProperties.Optional_uses_libs, dep, libName)
- }
- clcMap.AddContext(ctx, tag.sdkVersion, libName, tag.optional,
- lib.DexJarBuildPath().PathOrNil(), lib.DexJarInstallPath(),
- lib.ClassLoaderContexts())
- } else if ctx.Config().AllowMissingDependencies() {
- ctx.AddMissingDependencies([]string{dep})
- } else {
- ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", dep)
- }
- })
- return clcMap
- }
- // enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
- // properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
- // unconditionally in the future.
- func (u *usesLibrary) enforceUsesLibraries() bool {
- defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
- len(u.usesLibraryProperties.Optional_uses_libs) > 0
- return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, u.enforce || defaultEnforceUsesLibs)
- }
- // Freeze the value of `enforce_uses_libs` based on the current values of `uses_libs` and `optional_uses_libs`.
- func (u *usesLibrary) freezeEnforceUsesLibraries() {
- enforce := u.enforceUsesLibraries()
- u.usesLibraryProperties.Enforce_uses_libs = &enforce
- }
- // verifyUsesLibraries checks the <uses-library> tags in the manifest against the ones specified
- // in the `uses_libs`/`optional_uses_libs` properties. The input can be either an XML manifest, or
- // an APK with the manifest embedded in it (manifest_check will know which one it is by the file
- // extension: APKs are supposed to end with '.apk').
- func (u *usesLibrary) verifyUsesLibraries(ctx android.ModuleContext, inputFile android.Path,
- outputFile android.WritablePath) android.Path {
- statusFile := dexpreopt.UsesLibrariesStatusFile(ctx)
- // Disable verify_uses_libraries check if dexpreopt is globally disabled. Without dexpreopt the
- // check is not necessary, and although it is good to have, it is difficult to maintain on
- // non-linux build platforms where dexpreopt is generally disabled (the check may fail due to
- // various unrelated reasons, such as a failure to get manifest from an APK).
- global := dexpreopt.GetGlobalConfig(ctx)
- if global.DisablePreopt || global.OnlyPreoptBootImageAndSystemServer {
- return inputFile
- }
- rule := android.NewRuleBuilder(pctx, ctx)
- cmd := rule.Command().BuiltTool("manifest_check").
- Flag("--enforce-uses-libraries").
- Input(inputFile).
- FlagWithOutput("--enforce-uses-libraries-status ", statusFile).
- FlagWithInput("--aapt ", ctx.Config().HostToolPath(ctx, "aapt2"))
- if outputFile != nil {
- cmd.FlagWithOutput("-o ", outputFile)
- }
- if dexpreopt.GetGlobalConfig(ctx).RelaxUsesLibraryCheck {
- cmd.Flag("--enforce-uses-libraries-relax")
- }
- for _, lib := range u.usesLibraryProperties.Uses_libs {
- cmd.FlagWithArg("--uses-library ", lib)
- }
- for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
- cmd.FlagWithArg("--optional-uses-library ", lib)
- }
- rule.Build("verify_uses_libraries", "verify <uses-library>")
- return outputFile
- }
- // verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against
- // the build system and returns the path to a copy of the manifest.
- func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
- outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
- return u.verifyUsesLibraries(ctx, manifest, outputFile)
- }
- // verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the build
- // system and returns the path to a copy of the APK.
- func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) {
- u.verifyUsesLibraries(ctx, apk, nil) // for APKs manifest_check does not write output file
- }
- // For Bazel / bp2build
- type bazelAndroidAppCertificateAttributes struct {
- Certificate string
- }
- func (m *AndroidAppCertificate) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
- androidAppCertificateBp2Build(ctx, m)
- }
- func androidAppCertificateBp2Build(ctx android.TopDownMutatorContext, module *AndroidAppCertificate) {
- var certificate string
- if module.properties.Certificate != nil {
- certificate = *module.properties.Certificate
- }
- attrs := &bazelAndroidAppCertificateAttributes{
- Certificate: certificate,
- }
- props := bazel.BazelTargetModuleProperties{
- Rule_class: "android_app_certificate",
- Bzl_load_location: "//build/bazel/rules/android:android_app_certificate.bzl",
- }
- ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: module.Name()}, attrs)
- }
- type manifestValueAttribute struct {
- MinSdkVersion *string
- }
- type bazelAndroidAppAttributes struct {
- *javaCommonAttributes
- *bazelAapt
- Deps bazel.LabelListAttribute
- Custom_package *string
- Certificate bazel.LabelAttribute
- Certificate_name bazel.StringAttribute
- Manifest_values *manifestValueAttribute
- }
- // ConvertWithBp2build is used to convert android_app to Bazel.
- func (a *AndroidApp) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
- commonAttrs, bp2BuildInfo := a.convertLibraryAttrsBp2Build(ctx)
- depLabels := bp2BuildInfo.DepLabels
- deps := depLabels.Deps
- deps.Append(depLabels.StaticDeps)
- aapt := a.convertAaptAttrsWithBp2Build(ctx)
- certificate, certificateName := android.BazelStringOrLabelFromProp(ctx, a.overridableAppProperties.Certificate)
- manifestValues := &manifestValueAttribute{}
- // TODO(b/274474008 ): Directly convert deviceProperties.Min_sdk_version in bp2build
- // MinSdkVersion(ctx) calls SdkVersion(ctx) if no value for min_sdk_version is set
- minSdkVersion := a.MinSdkVersion(ctx)
- if !minSdkVersion.IsPreview() && !minSdkVersion.IsInvalid() {
- minSdkStr, err := minSdkVersion.EffectiveVersionString(ctx)
- if err == nil {
- manifestValues.MinSdkVersion = &minSdkStr
- }
- }
- appAttrs := &bazelAndroidAppAttributes{
- // TODO(b/209576404): handle package name override by product variable PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
- Custom_package: a.overridableAppProperties.Package_name,
- Certificate: certificate,
- Certificate_name: certificateName,
- Manifest_values: manifestValues,
- }
- props := bazel.BazelTargetModuleProperties{
- Rule_class: "android_binary",
- Bzl_load_location: "//build/bazel/rules/android:android_binary.bzl",
- }
- if !bp2BuildInfo.hasKotlin {
- appAttrs.javaCommonAttributes = commonAttrs
- appAttrs.bazelAapt = aapt
- appAttrs.Deps = deps
- } else {
- ktName := a.Name() + "_kt"
- ctx.CreateBazelTargetModule(
- AndroidLibraryBazelTargetModuleProperties(),
- android.CommonAttributes{Name: ktName},
- &bazelAndroidLibrary{
- javaLibraryAttributes: &javaLibraryAttributes{
- javaCommonAttributes: commonAttrs,
- Deps: deps,
- },
- bazelAapt: aapt,
- },
- )
- appAttrs.bazelAapt = &bazelAapt{Manifest: aapt.Manifest}
- appAttrs.Deps = bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + ktName})
- appAttrs.javaCommonAttributes = &javaCommonAttributes{
- Sdk_version: commonAttrs.Sdk_version,
- }
- }
- ctx.CreateBazelTargetModule(
- props,
- android.CommonAttributes{Name: a.Name(), SkipData: proptools.BoolPtr(true)},
- appAttrs,
- )
- }
|