Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 1 | // Copyright 2015 Google Inc. All rights reserved. |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
| 15 | package java |
| 16 | |
| 17 | // This file contains the module types for compiling Android apps. |
| 18 | |
| 19 | import ( |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 20 | "path/filepath" |
| 21 | "reflect" |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 22 | "sort" |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 23 | "strconv" |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 24 | "strings" |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 25 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 26 | "github.com/google/blueprint" |
| 27 | "github.com/google/blueprint/proptools" |
| 28 | |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 29 | "android/soong/android" |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 30 | "android/soong/cc" |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 31 | "android/soong/tradefed" |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 32 | ) |
| 33 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 34 | var supportedDpis = []string{"ldpi", "mdpi", "hdpi", "xhdpi", "xxhdpi", "xxxhdpi"} |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 35 | |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 36 | func init() { |
Paul Duffin | f9b1da0 | 2019-12-18 19:51:55 +0000 | [diff] [blame] | 37 | RegisterAppBuildComponents(android.InitRegistrationContext) |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 38 | |
| 39 | initAndroidAppImportVariantGroupTypes() |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 40 | } |
| 41 | |
Paul Duffin | f9b1da0 | 2019-12-18 19:51:55 +0000 | [diff] [blame] | 42 | func RegisterAppBuildComponents(ctx android.RegistrationContext) { |
| 43 | ctx.RegisterModuleType("android_app", AndroidAppFactory) |
| 44 | ctx.RegisterModuleType("android_test", AndroidTestFactory) |
| 45 | ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory) |
| 46 | ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory) |
| 47 | ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory) |
| 48 | ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory) |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 49 | ctx.RegisterModuleType("override_runtime_resource_overlay", OverrideRuntimeResourceOverlayModuleFactory) |
Paul Duffin | f9b1da0 | 2019-12-18 19:51:55 +0000 | [diff] [blame] | 50 | ctx.RegisterModuleType("android_app_import", AndroidAppImportFactory) |
| 51 | ctx.RegisterModuleType("android_test_import", AndroidTestImportFactory) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 52 | ctx.RegisterModuleType("runtime_resource_overlay", RuntimeResourceOverlayFactory) |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 53 | ctx.RegisterModuleType("android_app_set", AndroidApkSetFactory) |
| 54 | } |
| 55 | |
| 56 | type AndroidAppSetProperties struct { |
| 57 | // APK Set path |
| 58 | Set *string |
| 59 | |
| 60 | // Specifies that this app should be installed to the priv-app directory, |
| 61 | // where the system will grant it additional privileges not available to |
| 62 | // normal apps. |
| 63 | Privileged *bool |
| 64 | |
| 65 | // APKs in this set use prerelease SDK version |
| 66 | Prerelease *bool |
| 67 | |
| 68 | // Names of modules to be overridden. Listed modules can only be other apps |
| 69 | // (in Make or Soong). |
| 70 | Overrides []string |
| 71 | } |
| 72 | |
| 73 | type AndroidAppSet struct { |
| 74 | android.ModuleBase |
| 75 | android.DefaultableModuleBase |
| 76 | prebuilt android.Prebuilt |
| 77 | |
| 78 | properties AndroidAppSetProperties |
| 79 | packedOutput android.WritablePath |
| 80 | masterFile string |
Jaewoong Jung | 8bec026 | 2020-06-29 19:18:44 -0700 | [diff] [blame] | 81 | apkcertsFile android.ModuleOutPath |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | func (as *AndroidAppSet) Name() string { |
| 85 | return as.prebuilt.Name(as.ModuleBase.Name()) |
| 86 | } |
| 87 | |
| 88 | func (as *AndroidAppSet) IsInstallable() bool { |
| 89 | return true |
| 90 | } |
| 91 | |
| 92 | func (as *AndroidAppSet) Prebuilt() *android.Prebuilt { |
| 93 | return &as.prebuilt |
| 94 | } |
| 95 | |
| 96 | func (as *AndroidAppSet) Privileged() bool { |
| 97 | return Bool(as.properties.Privileged) |
| 98 | } |
| 99 | |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 100 | func (as *AndroidAppSet) OutputFile() android.Path { |
| 101 | return as.packedOutput |
| 102 | } |
| 103 | |
| 104 | func (as *AndroidAppSet) MasterFile() string { |
| 105 | return as.masterFile |
| 106 | } |
| 107 | |
Colin Cross | 7e2b36c | 2020-07-09 19:05:35 -0700 | [diff] [blame] | 108 | func (as *AndroidAppSet) APKCertsFile() android.Path { |
| 109 | return as.apkcertsFile |
| 110 | } |
| 111 | |
Jaewoong Jung | 8cf307e | 2020-05-14 14:15:24 -0700 | [diff] [blame] | 112 | var TargetCpuAbi = map[string]string{ |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 113 | "arm": "ARMEABI_V7A", |
| 114 | "arm64": "ARM64_V8A", |
| 115 | "x86": "X86", |
| 116 | "x86_64": "X86_64", |
| 117 | } |
| 118 | |
Jaewoong Jung | 8cf307e | 2020-05-14 14:15:24 -0700 | [diff] [blame] | 119 | func SupportedAbis(ctx android.ModuleContext) []string { |
Jaewoong Jung | 829b713 | 2020-06-10 12:23:32 -0700 | [diff] [blame] | 120 | abiName := func(targetIdx int, deviceArch string) string { |
Jaewoong Jung | 8cf307e | 2020-05-14 14:15:24 -0700 | [diff] [blame] | 121 | if abi, found := TargetCpuAbi[deviceArch]; found { |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 122 | return abi |
| 123 | } |
Jaewoong Jung | 829b713 | 2020-06-10 12:23:32 -0700 | [diff] [blame] | 124 | ctx.ModuleErrorf("Target %d has invalid Arch: %s", targetIdx, deviceArch) |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 125 | return "BAD_ABI" |
| 126 | } |
| 127 | |
Jaewoong Jung | 829b713 | 2020-06-10 12:23:32 -0700 | [diff] [blame] | 128 | var result []string |
| 129 | for i, target := range ctx.Config().Targets[android.Android] { |
| 130 | result = append(result, abiName(i, target.Arch.ArchType.String())) |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 131 | } |
| 132 | return result |
| 133 | } |
| 134 | |
| 135 | func (as *AndroidAppSet) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 136 | as.packedOutput = android.PathForModuleOut(ctx, ctx.ModuleName()+".zip") |
Jaewoong Jung | 8bec026 | 2020-06-29 19:18:44 -0700 | [diff] [blame] | 137 | as.apkcertsFile = android.PathForModuleOut(ctx, "apkcerts.txt") |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 138 | // We are assuming here that the master file in the APK |
| 139 | // set has `.apk` suffix. If it doesn't the build will fail. |
| 140 | // APK sets containing APEX files are handled elsewhere. |
Sasha Smundak | 854c14f | 2020-06-16 10:28:22 -0700 | [diff] [blame] | 141 | as.masterFile = as.BaseModuleName() + ".apk" |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 142 | screenDensities := "all" |
| 143 | if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 { |
| 144 | screenDensities = strings.ToUpper(strings.Join(dpis, ",")) |
| 145 | } |
| 146 | // TODO(asmundak): handle locales. |
| 147 | // TODO(asmundak): do we support device features |
| 148 | ctx.Build(pctx, |
| 149 | android.BuildParams{ |
Jaewoong Jung | 8bec026 | 2020-06-29 19:18:44 -0700 | [diff] [blame] | 150 | Rule: extractMatchingApks, |
| 151 | Description: "Extract APKs from APK set", |
| 152 | Output: as.packedOutput, |
| 153 | ImplicitOutput: as.apkcertsFile, |
| 154 | Inputs: android.Paths{as.prebuilt.SingleSourcePath(ctx)}, |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 155 | Args: map[string]string{ |
Jaewoong Jung | 8cf307e | 2020-05-14 14:15:24 -0700 | [diff] [blame] | 156 | "abis": strings.Join(SupportedAbis(ctx), ","), |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 157 | "allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)), |
| 158 | "screen-densities": screenDensities, |
| 159 | "sdk-version": ctx.Config().PlatformSdkVersion(), |
Sasha Smundak | 3c904e8 | 2020-06-22 16:53:33 -0700 | [diff] [blame] | 160 | "stem": as.BaseModuleName(), |
Jaewoong Jung | 8bec026 | 2020-06-29 19:18:44 -0700 | [diff] [blame] | 161 | "apkcerts": as.apkcertsFile.String(), |
| 162 | "partition": as.PartitionTag(ctx.DeviceConfig()), |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 163 | }, |
| 164 | }) |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 165 | } |
| 166 | |
| 167 | // android_app_set extracts a set of APKs based on the target device |
| 168 | // configuration and installs this set as "split APKs". |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 169 | // The extracted set always contains 'master' APK whose name is |
| 170 | // _module_name_.apk and every split APK matching target device. |
| 171 | // The extraction of the density-specific splits depends on |
| 172 | // PRODUCT_AAPT_PREBUILT_DPI variable. If present (its value should |
| 173 | // be a list density names: LDPI, MDPI, HDPI, etc.), only listed |
| 174 | // splits will be extracted. Otherwise all density-specific splits |
| 175 | // will be extracted. |
Sasha Smundak | 4de27a5 | 2020-04-23 09:49:59 -0700 | [diff] [blame] | 176 | func AndroidApkSetFactory() android.Module { |
| 177 | module := &AndroidAppSet{} |
| 178 | module.AddProperties(&module.properties) |
| 179 | InitJavaModule(module, android.DeviceSupported) |
| 180 | android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set") |
| 181 | return module |
Paul Duffin | f9b1da0 | 2019-12-18 19:51:55 +0000 | [diff] [blame] | 182 | } |
| 183 | |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 184 | // AndroidManifest.xml merging |
| 185 | // package splits |
| 186 | |
Colin Cross | fabb608 | 2018-02-20 17:22:23 -0800 | [diff] [blame] | 187 | type appProperties struct { |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 188 | // Names of extra android_app_certificate modules to sign the apk with in the form ":module". |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 189 | Additional_certificates []string |
| 190 | |
| 191 | // If set, create package-export.apk, which other packages can |
| 192 | // use to get PRODUCT-agnostic resource data like IDs and type definitions. |
Nan Zhang | ea568a4 | 2017-11-08 21:20:04 -0800 | [diff] [blame] | 193 | Export_package_resources *bool |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 194 | |
Colin Cross | 1605606 | 2017-12-13 22:46:28 -0800 | [diff] [blame] | 195 | // Specifies that this app should be installed to the priv-app directory, |
| 196 | // where the system will grant it additional privileges not available to |
| 197 | // normal apps. |
| 198 | Privileged *bool |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 199 | |
| 200 | // list of resource labels to generate individual resource packages |
| 201 | Package_splits []string |
Jason Monk | d4122be | 2018-08-10 09:33:36 -0400 | [diff] [blame] | 202 | |
| 203 | // Names of modules to be overridden. Listed modules can only be other binaries |
| 204 | // (in Make or Soong). |
| 205 | // This does not completely prevent installation of the overridden binaries, but if both |
| 206 | // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed |
| 207 | // from PRODUCT_PACKAGES. |
| 208 | Overrides []string |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 209 | |
| 210 | // list of native libraries that will be provided in or alongside the resulting jar |
| 211 | Jni_libs []string `android:"arch_variant"` |
| 212 | |
Colin Cross | 76583a4 | 2020-05-06 17:51:39 -0700 | [diff] [blame] | 213 | // if true, use JNI libraries that link against platform APIs even if this module sets |
Colin Cross | ee87c60 | 2020-02-19 16:57:15 -0800 | [diff] [blame] | 214 | // sdk_version. |
| 215 | Jni_uses_platform_apis *bool |
| 216 | |
Colin Cross | 76583a4 | 2020-05-06 17:51:39 -0700 | [diff] [blame] | 217 | // if true, use JNI libraries that link against SDK APIs even if this module does not set |
| 218 | // sdk_version. |
| 219 | Jni_uses_sdk_apis *bool |
| 220 | |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 221 | // STL library to use for JNI libraries. |
| 222 | Stl *string `android:"arch_variant"` |
| 223 | |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 224 | // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest |
| 225 | // flag so that they are used from inside the APK at runtime. Defaults to true for android_test modules unless |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 226 | // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for |
| 227 | // android_app modules that are embedded to APEXes, defaults to false for other module types where the native |
| 228 | // libraries are generally preinstalled outside the APK. |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 229 | Use_embedded_native_libs *bool |
Colin Cross | 46abdad | 2019-02-07 13:07:08 -0800 | [diff] [blame] | 230 | |
| 231 | // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that |
| 232 | // they are used from inside the APK at runtime. |
| 233 | Use_embedded_dex *bool |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 234 | |
| 235 | // Forces native libraries to always be packaged into the APK, |
| 236 | // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed. |
| 237 | // True for android_test* modules. |
| 238 | AlwaysPackageNativeLibs bool `blueprint:"mutated"` |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 239 | |
| 240 | // If set, find and merge all NOTICE files that this module and its dependencies have and store |
| 241 | // it in the APK as an asset. |
| 242 | Embed_notices *bool |
Jaewoong Jung | 37ca4a1 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 243 | |
| 244 | // cc.Coverage related properties |
| 245 | PreventInstall bool `blueprint:"mutated"` |
| 246 | HideFromMake bool `blueprint:"mutated"` |
| 247 | IsCoverageVariant bool `blueprint:"mutated"` |
Artur Satayev | e5ac15a | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 248 | |
| 249 | // Whether this app is considered mainline updatable or not. When set to true, this will enforce |
Artur Satayev | 1196210 | 2020-04-16 13:43:02 +0100 | [diff] [blame] | 250 | // additional rules to make sure an app can safely be updated. Default is false. |
| 251 | // Prefer using other specific properties if build behaviour must be changed; avoid using this |
| 252 | // flag for anything but neverallow rules (unless the behaviour change is invisible to owners). |
Artur Satayev | e5ac15a | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 253 | Updatable *bool |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 254 | } |
| 255 | |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 256 | // android_app properties that can be overridden by override_android_app |
| 257 | type overridableAppProperties struct { |
| 258 | // The name of a certificate in the default certificate directory, blank to use the default product certificate, |
| 259 | // or an android_app_certificate module name in the form ":module". |
| 260 | Certificate *string |
Jaewoong Jung | 6f373f6 | 2019-03-13 10:13:24 -0700 | [diff] [blame] | 261 | |
Liz Kammer | 70dd74d | 2020-05-07 13:24:05 -0700 | [diff] [blame] | 262 | // Name of the signing certificate lineage file. |
| 263 | Lineage *string |
| 264 | |
Jaewoong Jung | 6f373f6 | 2019-03-13 10:13:24 -0700 | [diff] [blame] | 265 | // the package name of this app. The package name in the manifest file is used if one was not given. |
| 266 | Package_name *string |
Baligh Uddin | 5b16dfb | 2020-02-11 17:27:19 -0800 | [diff] [blame] | 267 | |
| 268 | // the logging parent of this app. |
| 269 | Logging_parent *string |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 270 | } |
| 271 | |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 272 | // runtime_resource_overlay properties that can be overridden by override_runtime_resource_overlay |
| 273 | type OverridableRuntimeResourceOverlayProperties struct { |
| 274 | // the package name of this app. The package name in the manifest file is used if one was not given. |
| 275 | Package_name *string |
| 276 | |
| 277 | // the target package name of this overlay app. The target package name in the manifest file is used if one was not given. |
| 278 | Target_package_name *string |
| 279 | } |
| 280 | |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 281 | type AndroidApp struct { |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 282 | Library |
| 283 | aapt |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 284 | android.OverridableModuleBase |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 285 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 286 | usesLibrary usesLibrary |
| 287 | |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 288 | certificate Certificate |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 289 | |
Colin Cross | fabb608 | 2018-02-20 17:22:23 -0800 | [diff] [blame] | 290 | appProperties appProperties |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 291 | |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 292 | overridableAppProperties overridableAppProperties |
| 293 | |
Colin Cross | b32b712 | 2020-07-06 14:15:24 -0700 | [diff] [blame] | 294 | jniLibs []jniLib |
| 295 | installPathForJNISymbols android.Path |
| 296 | embeddedJniLibs bool |
| 297 | jniCoverageOutputs android.Paths |
Colin Cross | f623721 | 2018-10-29 23:14:58 -0700 | [diff] [blame] | 298 | |
| 299 | bundleFile android.Path |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 300 | |
| 301 | // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES. |
| 302 | installApkName string |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 303 | |
Colin Cross | 70dda7e | 2019-10-01 22:05:35 -0700 | [diff] [blame] | 304 | installDir android.InstallPath |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 305 | |
Jaewoong Jung | 7dd4ae2 | 2019-09-27 17:13:15 -0700 | [diff] [blame] | 306 | onDeviceDir string |
| 307 | |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 308 | additionalAaptFlags []string |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 309 | |
| 310 | noticeOutputs android.NoticeOutputs |
Jiyong Park | af8998c | 2020-02-28 16:51:07 +0900 | [diff] [blame] | 311 | |
| 312 | overriddenManifestPackageName string |
Artur Satayev | d9b503a | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 313 | |
| 314 | android.ApexBundleDepsInfo |
Colin Cross | e1731a5 | 2017-12-14 11:22:55 -0800 | [diff] [blame] | 315 | } |
| 316 | |
Martin Stjernholm | 6d41527 | 2020-01-31 17:10:36 +0000 | [diff] [blame] | 317 | func (a *AndroidApp) IsInstallable() bool { |
| 318 | return Bool(a.properties.Installable) |
| 319 | } |
| 320 | |
Colin Cross | 89c3158 | 2018-04-30 15:55:11 -0700 | [diff] [blame] | 321 | func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths { |
| 322 | return nil |
| 323 | } |
| 324 | |
Colin Cross | 66f7882 | 2018-05-02 12:58:28 -0700 | [diff] [blame] | 325 | func (a *AndroidApp) ExportedStaticPackages() android.Paths { |
| 326 | return nil |
| 327 | } |
| 328 | |
Sundong Ahn | e1f05aa | 2019-08-27 13:55:42 +0900 | [diff] [blame] | 329 | func (a *AndroidApp) OutputFile() android.Path { |
| 330 | return a.outputFile |
| 331 | } |
| 332 | |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 333 | func (a *AndroidApp) Certificate() Certificate { |
| 334 | return a.certificate |
| 335 | } |
| 336 | |
Jaewoong Jung | 37ca4a1 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 337 | func (a *AndroidApp) JniCoverageOutputs() android.Paths { |
| 338 | return a.jniCoverageOutputs |
| 339 | } |
| 340 | |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 341 | var _ AndroidLibraryDependency = (*AndroidApp)(nil) |
| 342 | |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 343 | type Certificate struct { |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 344 | Pem, Key android.Path |
| 345 | presigned bool |
| 346 | } |
| 347 | |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 348 | var PresignedCertificate = Certificate{presigned: true} |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 349 | |
| 350 | func (c Certificate) AndroidMkString() string { |
| 351 | if c.presigned { |
| 352 | return "PRESIGNED" |
| 353 | } else { |
| 354 | return c.Pem.String() |
| 355 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 356 | } |
| 357 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 358 | func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) { |
| 359 | a.Module.deps(ctx) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 360 | |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 361 | if String(a.appProperties.Stl) == "c++_shared" && !a.sdkVersion().specified() { |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 362 | ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared") |
| 363 | } |
| 364 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 365 | sdkDep := decodeSdkDep(ctx, sdkContext(a)) |
| 366 | if sdkDep.hasFrameworkLibs() { |
| 367 | a.aapt.deps(ctx, sdkDep) |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 368 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 369 | |
Colin Cross | 1dd9c44 | 2020-05-08 11:20:24 -0700 | [diff] [blame] | 370 | usesSDK := a.sdkVersion().specified() && a.sdkVersion().kind != sdkCorePlatform |
| 371 | |
| 372 | if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) { |
| 373 | ctx.PropertyErrorf("jni_uses_sdk_apis", |
| 374 | "can only be set for modules that do not set sdk_version") |
| 375 | } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) { |
| 376 | ctx.PropertyErrorf("jni_uses_platform_apis", |
| 377 | "can only be set for modules that set sdk_version") |
| 378 | } |
| 379 | |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 380 | tag := &jniDependencyTag{} |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 381 | for _, jniTarget := range ctx.MultiTargets() { |
Colin Cross | 0f7d2ef | 2019-10-16 11:03:10 -0700 | [diff] [blame] | 382 | variation := append(jniTarget.Variations(), |
| 383 | blueprint.Variation{Mutator: "link", Variation: "shared"}) |
Colin Cross | 01fd7cc | 2020-02-19 16:54:04 -0800 | [diff] [blame] | 384 | |
| 385 | // If the app builds against an Android SDK use the SDK variant of JNI dependencies |
| 386 | // unless jni_uses_platform_apis is set. |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 387 | // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already |
| 388 | // have stable APIs through the VNDK. |
| 389 | if (usesSDK && !a.RequiresStableAPIs(ctx) && |
| 390 | !Bool(a.appProperties.Jni_uses_platform_apis)) || |
Colin Cross | 76583a4 | 2020-05-06 17:51:39 -0700 | [diff] [blame] | 391 | Bool(a.appProperties.Jni_uses_sdk_apis) { |
Colin Cross | 01fd7cc | 2020-02-19 16:54:04 -0800 | [diff] [blame] | 392 | variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"}) |
| 393 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 394 | ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...) |
| 395 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 396 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 397 | a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs()) |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 398 | } |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 399 | |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 400 | func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) { |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 401 | cert := android.SrcIsModule(a.getCertString(ctx)) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 402 | if cert != "" { |
| 403 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 404 | } |
| 405 | |
| 406 | for _, cert := range a.appProperties.Additional_certificates { |
| 407 | cert = android.SrcIsModule(cert) |
| 408 | if cert != "" { |
| 409 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 410 | } else { |
| 411 | ctx.PropertyErrorf("additional_certificates", |
| 412 | `must be names of android_app_certificate modules in the form ":module"`) |
| 413 | } |
| 414 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 415 | } |
| 416 | |
Jeongik Cha | 538c0d0 | 2019-07-11 15:54:27 +0900 | [diff] [blame] | 417 | func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 418 | a.generateAndroidBuildActions(ctx) |
| 419 | } |
| 420 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 421 | func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Artur Satayev | e5ac15a | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 422 | a.checkAppSdkVersions(ctx) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 423 | a.generateAndroidBuildActions(ctx) |
| 424 | } |
| 425 | |
Artur Satayev | e5ac15a | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 426 | func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) { |
Artur Satayev | 2b4b7bb | 2020-04-28 14:57:42 +0100 | [diff] [blame] | 427 | if a.Updatable() { |
Artur Satayev | e5ac15a | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 428 | if !a.sdkVersion().stable() { |
| 429 | ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.sdkVersion()) |
| 430 | } |
Artur Satayev | 1196210 | 2020-04-16 13:43:02 +0100 | [diff] [blame] | 431 | if String(a.deviceProperties.Min_sdk_version) == "" { |
| 432 | ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.") |
| 433 | } |
Jooyung Han | af7f91f | 2020-04-29 14:01:06 +0900 | [diff] [blame] | 434 | if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil { |
| 435 | a.checkJniLibsSdkVersion(ctx, minSdkVersion) |
| 436 | } else { |
| 437 | ctx.PropertyErrorf("min_sdk_version", "%s", err.Error()) |
| 438 | } |
Artur Satayev | e5ac15a | 2020-04-08 19:09:30 +0100 | [diff] [blame] | 439 | } |
| 440 | |
| 441 | a.checkPlatformAPI(ctx) |
| 442 | a.checkSdkVersions(ctx) |
| 443 | } |
| 444 | |
Jooyung Han | af7f91f | 2020-04-29 14:01:06 +0900 | [diff] [blame] | 445 | // If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it. |
| 446 | // This check is enforced for "updatable" APKs (including APK-in-APEX). |
| 447 | // b/155209650: until min_sdk_version is properly supported, use sdk_version instead. |
| 448 | // because, sdk_version is overridden by min_sdk_version (if set as smaller) |
| 449 | // and linkType is checked with dependencies so we can be sure that the whole dependency tree |
| 450 | // will meet the requirements. |
| 451 | func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) { |
| 452 | // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType() |
| 453 | ctx.VisitDirectDeps(func(m android.Module) { |
| 454 | if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) { |
| 455 | return |
| 456 | } |
| 457 | dep, _ := m.(*cc.Module) |
Jooyung Han | 9d2c0f7 | 2020-05-20 17:12:13 +0900 | [diff] [blame] | 458 | // The domain of cc.sdk_version is "current" and <number> |
| 459 | // We can rely on sdkSpec to convert it to <number> so that "current" is handled |
| 460 | // properly regardless of sdk finalization. |
| 461 | jniSdkVersion, err := sdkSpecFrom(dep.SdkVersion()).effectiveVersion(ctx) |
| 462 | if err != nil || minSdkVersion < jniSdkVersion { |
Jooyung Han | af7f91f | 2020-04-29 14:01:06 +0900 | [diff] [blame] | 463 | ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)", |
| 464 | dep.SdkVersion(), minSdkVersion, ctx.ModuleName()) |
| 465 | return |
| 466 | } |
| 467 | |
| 468 | }) |
| 469 | } |
| 470 | |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 471 | // Returns true if the native libraries should be stored in the APK uncompressed and the |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 472 | // extractNativeLibs application flag should be set to false in the manifest. |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 473 | func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool { |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 474 | minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx) |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 475 | if err != nil { |
| 476 | ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err) |
| 477 | } |
| 478 | |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 479 | return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) || |
| 480 | !a.IsForPlatform() |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 481 | } |
| 482 | |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 483 | // Returns whether this module should have the dex file stored uncompressed in the APK. |
| 484 | func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool { |
Colin Cross | 46abdad | 2019-02-07 13:07:08 -0800 | [diff] [blame] | 485 | if Bool(a.appProperties.Use_embedded_dex) { |
| 486 | return true |
| 487 | } |
| 488 | |
Colin Cross | 53a87f5 | 2019-06-25 13:35:30 -0700 | [diff] [blame] | 489 | // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may |
| 490 | // be preinstalled as prebuilts). |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 491 | if ctx.Config().UncompressPrivAppDex() && a.Privileged() { |
Nicolas Geoffray | fa6e9ec | 2019-02-12 13:12:16 +0000 | [diff] [blame] | 492 | return true |
| 493 | } |
| 494 | |
Colin Cross | 53a87f5 | 2019-06-25 13:35:30 -0700 | [diff] [blame] | 495 | if ctx.Config().UnbundledBuild() { |
| 496 | return false |
| 497 | } |
| 498 | |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 499 | return shouldUncompressDex(ctx, &a.dexpreopter) |
Colin Cross | 5a0dcd5 | 2018-10-05 14:20:06 -0700 | [diff] [blame] | 500 | } |
| 501 | |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 502 | func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool { |
| 503 | return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) || |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 504 | !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 505 | } |
| 506 | |
Jiyong Park | af8998c | 2020-02-28 16:51:07 +0900 | [diff] [blame] | 507 | func (a *AndroidApp) OverriddenManifestPackageName() string { |
| 508 | return a.overriddenManifestPackageName |
| 509 | } |
| 510 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 511 | func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) { |
David Brazdil | d25060a | 2019-02-18 18:24:16 +0000 | [diff] [blame] | 512 | a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis) |
| 513 | |
Jaewoong Jung | c27ab66 | 2019-05-30 15:51:14 -0700 | [diff] [blame] | 514 | // Ask manifest_fixer to add or update the application element indicating this app has no code. |
| 515 | a.aapt.hasNoCode = !a.hasCode(ctx) |
| 516 | |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 517 | aaptLinkFlags := []string{} |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 518 | |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 519 | // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided. |
Jaewoong Jung | 3aff578 | 2020-02-11 07:54:35 -0800 | [diff] [blame] | 520 | hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product") |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 521 | if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 522 | aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics()) |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 523 | } |
| 524 | |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 525 | if !Bool(a.aaptProperties.Aapt_include_all_resources) { |
| 526 | // Product AAPT config |
| 527 | for _, aaptConfig := range ctx.Config().ProductAAPTConfig() { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 528 | aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig) |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 529 | } |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 530 | |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 531 | // Product AAPT preferred config |
| 532 | if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 { |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 533 | aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig()) |
Dan Willemsen | 72be590 | 2018-10-24 20:24:57 -0700 | [diff] [blame] | 534 | } |
Colin Cross | e78dcd3 | 2018-04-19 15:25:19 -0700 | [diff] [blame] | 535 | } |
| 536 | |
Jiyong Park | 7f67f48 | 2019-01-05 12:57:48 +0900 | [diff] [blame] | 537 | manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName()) |
Jaewoong Jung | 6f373f6 | 2019-03-13 10:13:24 -0700 | [diff] [blame] | 538 | if overridden || a.overridableAppProperties.Package_name != nil { |
| 539 | // The product override variable has a priority over the package_name property. |
| 540 | if !overridden { |
| 541 | manifestPackageName = *a.overridableAppProperties.Package_name |
| 542 | } |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 543 | aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName) |
Jiyong Park | af8998c | 2020-02-28 16:51:07 +0900 | [diff] [blame] | 544 | a.overriddenManifestPackageName = manifestPackageName |
Jiyong Park | 7f67f48 | 2019-01-05 12:57:48 +0900 | [diff] [blame] | 545 | } |
| 546 | |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 547 | aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...) |
| 548 | |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 549 | a.aapt.splitNames = a.appProperties.Package_splits |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 550 | a.aapt.sdkLibraries = a.exportedSdkLibs |
Baligh Uddin | 5b16dfb | 2020-02-11 17:27:19 -0800 | [diff] [blame] | 551 | a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent) |
Jaewoong Jung | de4c02f | 2019-01-22 11:19:56 -0800 | [diff] [blame] | 552 | a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...) |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 553 | |
Colin Cross | 46c9b8b | 2017-06-22 16:51:17 -0700 | [diff] [blame] | 554 | // apps manifests are handled by aapt, don't let Module see them |
Dan Willemsen | 34cc69e | 2015-09-23 15:26:20 -0700 | [diff] [blame] | 555 | a.properties.Manifest = nil |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 556 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 557 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 558 | func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) { |
Colin Cross | 89c3158 | 2018-04-30 15:55:11 -0700 | [diff] [blame] | 559 | var staticLibProguardFlagFiles android.Paths |
| 560 | ctx.VisitDirectDeps(func(m android.Module) { |
| 561 | if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag { |
| 562 | staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...) |
| 563 | } |
| 564 | }) |
| 565 | |
| 566 | staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles) |
| 567 | |
| 568 | a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...) |
| 569 | a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile) |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 570 | } |
Colin Cross | 66dbc0b | 2017-12-28 12:23:20 -0800 | [diff] [blame] | 571 | |
Colin Cross | b32b712 | 2020-07-06 14:15:24 -0700 | [diff] [blame] | 572 | func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath { |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 573 | var installDir string |
| 574 | if ctx.ModuleName() == "framework-res" { |
| 575 | // framework-res.apk is installed as system/framework/framework-res.apk |
| 576 | installDir = "framework" |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 577 | } else if a.Privileged() { |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 578 | installDir = filepath.Join("priv-app", a.installApkName) |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 579 | } else { |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 580 | installDir = filepath.Join("app", a.installApkName) |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 581 | } |
Colin Cross | b32b712 | 2020-07-06 14:15:24 -0700 | [diff] [blame] | 582 | |
| 583 | return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk") |
| 584 | } |
| 585 | |
| 586 | func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path { |
| 587 | a.dexpreopter.installPath = a.installPath(ctx) |
David Srbecky | 98c7122 | 2020-05-20 22:20:28 +0100 | [diff] [blame] | 588 | if a.deviceProperties.Uncompress_dex == nil { |
| 589 | // If the value was not force-set by the user, use reasonable default based on the module. |
| 590 | a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx)) |
| 591 | } |
| 592 | a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 593 | a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries() |
| 594 | a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs |
| 595 | a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx) |
| 596 | a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx) |
| 597 | a.dexpreopter.manifestFile = a.mergedManifestFile |
| 598 | |
Colin Cross | 5ab4e6d | 2017-11-22 16:20:45 -0800 | [diff] [blame] | 599 | if ctx.ModuleName() != "framework-res" { |
| 600 | a.Module.compile(ctx, a.aaptSrcJar) |
| 601 | } |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 602 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 603 | return a.maybeStrippedDexJarFile |
| 604 | } |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 605 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 606 | func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 607 | var jniJarFile android.WritablePath |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 608 | if len(jniLibs) > 0 { |
Colin Cross | b32b712 | 2020-07-06 14:15:24 -0700 | [diff] [blame] | 609 | a.jniLibs = jniLibs |
Jaewoong Jung | bc625cd | 2019-05-06 15:48:44 -0700 | [diff] [blame] | 610 | if a.shouldEmbedJnis(ctx) { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 611 | jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip") |
Colin Cross | b32b712 | 2020-07-06 14:15:24 -0700 | [diff] [blame] | 612 | a.installPathForJNISymbols = a.installPath(ctx).ToMakePath() |
Sasha Smundak | 6ad7725 | 2019-05-01 13:16:22 -0700 | [diff] [blame] | 613 | TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx)) |
Jaewoong Jung | 37ca4a1 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 614 | for _, jni := range jniLibs { |
| 615 | if jni.coverageFile.Valid() { |
Jaewoong Jung | e62e594 | 2020-04-07 13:07:55 -0700 | [diff] [blame] | 616 | // Only collect coverage for the first target arch if this is a multilib target. |
| 617 | // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage |
| 618 | // data file path collisions since the current coverage file path format doesn't contain |
| 619 | // arch-related strings. This is fine for now though; the code coverage team doesn't use |
| 620 | // multi-arch targets such as test_suite_* for coverage collections yet. |
| 621 | // |
| 622 | // Work with the team to come up with a new format that handles multilib modules properly |
| 623 | // and change this. |
| 624 | if len(ctx.Config().Targets[android.Android]) == 1 || |
| 625 | ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType { |
| 626 | a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path()) |
| 627 | } |
Jaewoong Jung | 37ca4a1 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 628 | } |
| 629 | } |
Colin Cross | b32b712 | 2020-07-06 14:15:24 -0700 | [diff] [blame] | 630 | a.embeddedJniLibs = true |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 631 | } |
| 632 | } |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 633 | return jniJarFile |
| 634 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 635 | |
Colin Cross | b32b712 | 2020-07-06 14:15:24 -0700 | [diff] [blame] | 636 | func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls { |
| 637 | var jniSymbols android.RuleBuilderInstalls |
| 638 | for _, jniLib := range a.jniLibs { |
| 639 | if jniLib.unstrippedFile != nil { |
| 640 | jniSymbols = append(jniSymbols, android.RuleBuilderInstall{ |
| 641 | From: jniLib.unstrippedFile, |
| 642 | To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()), |
| 643 | }) |
| 644 | } |
| 645 | } |
| 646 | return jniSymbols |
| 647 | } |
| 648 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 649 | func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 650 | // Collect NOTICE files from all dependencies. |
| 651 | seenModules := make(map[android.Module]bool) |
| 652 | noticePathSet := make(map[android.Path]bool) |
| 653 | |
| 654 | ctx.WalkDeps(func(child android.Module, parent android.Module) bool { |
| 655 | // Have we already seen this? |
| 656 | if _, ok := seenModules[child]; ok { |
| 657 | return false |
| 658 | } |
| 659 | seenModules[child] = true |
| 660 | |
| 661 | // Skip host modules. |
| 662 | if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross { |
| 663 | return false |
| 664 | } |
| 665 | |
| 666 | path := child.(android.Module).NoticeFile() |
| 667 | if path.Valid() { |
| 668 | noticePathSet[path.Path()] = true |
| 669 | } |
| 670 | return true |
| 671 | }) |
| 672 | |
| 673 | // If the app has one, add it too. |
| 674 | if a.NoticeFile().Valid() { |
| 675 | noticePathSet[a.NoticeFile().Path()] = true |
| 676 | } |
| 677 | |
| 678 | if len(noticePathSet) == 0 { |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 679 | return |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 680 | } |
| 681 | var noticePaths []android.Path |
| 682 | for path := range noticePathSet { |
| 683 | noticePaths = append(noticePaths, path) |
| 684 | } |
| 685 | sort.Slice(noticePaths, func(i, j int) bool { |
| 686 | return noticePaths[i].String() < noticePaths[j].String() |
| 687 | }) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 688 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 689 | a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 690 | } |
| 691 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 692 | // Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it |
| 693 | // isn't a cert module reference. Also checks and enforces system cert restriction if applicable. |
| 694 | func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate { |
| 695 | if android.SrcIsModule(certPropValue) == "" { |
| 696 | var mainCert Certificate |
| 697 | if certPropValue != "" { |
| 698 | defaultDir := ctx.Config().DefaultAppCertificateDir(ctx) |
| 699 | mainCert = Certificate{ |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 700 | Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"), |
| 701 | Key: defaultDir.Join(ctx, certPropValue+".pk8"), |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 702 | } |
| 703 | } else { |
| 704 | pem, key := ctx.Config().DefaultAppCertificate(ctx) |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 705 | mainCert = Certificate{ |
| 706 | Pem: pem, |
| 707 | Key: key, |
| 708 | } |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 709 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 710 | certificates = append([]Certificate{mainCert}, certificates...) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 711 | } |
| 712 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 713 | if !m.Platform() { |
| 714 | certPath := certificates[0].Pem.String() |
Jeongik Cha | c946414 | 2019-01-07 12:07:27 +0900 | [diff] [blame] | 715 | systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String() |
| 716 | if strings.HasPrefix(certPath, systemCertPath) { |
| 717 | enforceSystemCert := ctx.Config().EnforceSystemCertificate() |
Colin Cross | 95f7b34 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 718 | allowed := ctx.Config().EnforceSystemCertificateAllowList() |
Jeongik Cha | c946414 | 2019-01-07 12:07:27 +0900 | [diff] [blame] | 719 | |
Colin Cross | 95f7b34 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 720 | if enforceSystemCert && !inList(m.Name(), allowed) { |
Jeongik Cha | c946414 | 2019-01-07 12:07:27 +0900 | [diff] [blame] | 721 | ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.") |
| 722 | } |
| 723 | } |
| 724 | } |
| 725 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 726 | return certificates |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 727 | } |
| 728 | |
Jooyung Han | 65cd0f0 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 729 | func (a *AndroidApp) InstallApkName() string { |
| 730 | return a.installApkName |
| 731 | } |
| 732 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 733 | func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) { |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 734 | var apkDeps android.Paths |
| 735 | |
Jeongik Cha | 538c0d0 | 2019-07-11 15:54:27 +0900 | [diff] [blame] | 736 | a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx) |
| 737 | a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex) |
| 738 | |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 739 | // Check if the install APK name needs to be overridden. |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 740 | a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name()) |
Jaewoong Jung | 9d22a91 | 2019-01-23 16:27:47 -0800 | [diff] [blame] | 741 | |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 742 | if ctx.ModuleName() == "framework-res" { |
| 743 | // framework-res.apk is installed as system/framework/framework-res.apk |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 744 | a.installDir = android.PathForModuleInstall(ctx, "framework") |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 745 | } else if a.Privileged() { |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 746 | a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName) |
| 747 | } else if ctx.InstallInTestcases() { |
Jaewoong Jung | 326a941 | 2019-11-21 10:41:00 -0800 | [diff] [blame] | 748 | a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch()) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 749 | } else { |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 750 | a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 751 | } |
Jaewoong Jung | 7dd4ae2 | 2019-09-27 17:13:15 -0700 | [diff] [blame] | 752 | a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir) |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 753 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 754 | a.noticeBuildActions(ctx) |
Jaewoong Jung | 9877279 | 2019-07-01 17:15:13 -0700 | [diff] [blame] | 755 | if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") { |
| 756 | a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput |
| 757 | } |
Jaewoong Jung | 5b425e2 | 2019-06-17 17:40:56 -0700 | [diff] [blame] | 758 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 759 | // Process all building blocks, from AAPT to certificates. |
| 760 | a.aaptBuildActions(ctx) |
| 761 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 762 | if a.usesLibrary.enforceUsesLibraries() { |
| 763 | manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile) |
| 764 | apkDeps = append(apkDeps, manifestCheckFile) |
| 765 | } |
| 766 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 767 | a.proguardBuildActions(ctx) |
| 768 | |
Colin Cross | 1e28e3c | 2020-06-02 20:09:13 -0700 | [diff] [blame] | 769 | a.linter.mergedManifest = a.aapt.mergedManifestFile |
| 770 | a.linter.manifest = a.aapt.manifestPath |
| 771 | a.linter.resources = a.aapt.resourceFiles |
Colin Cross | 1d11c87 | 2020-07-03 11:56:24 -0700 | [diff] [blame] | 772 | a.linter.buildModuleReportZip = ctx.Config().UnbundledBuild() |
Colin Cross | 1e28e3c | 2020-06-02 20:09:13 -0700 | [diff] [blame] | 773 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 774 | dexJarFile := a.dexBuildActions(ctx) |
| 775 | |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 776 | jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis)) |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 777 | jniJarFile := a.jniBuildActions(jniLibs, ctx) |
| 778 | |
| 779 | if ctx.Failed() { |
| 780 | return |
| 781 | } |
| 782 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 783 | certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx) |
| 784 | a.certificate = certificates[0] |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 785 | |
| 786 | // Build a final signed app package. |
Jaewoong Jung | 5a49881 | 2019-11-07 14:14:38 -0800 | [diff] [blame] | 787 | packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk") |
Songchun Fan | 688de9a | 2020-03-24 20:32:24 -0700 | [diff] [blame] | 788 | v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature) |
| 789 | var v4SignatureFile android.WritablePath = nil |
| 790 | if v4SigningRequested { |
| 791 | v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig") |
| 792 | } |
Liz Kammer | 70dd74d | 2020-05-07 13:24:05 -0700 | [diff] [blame] | 793 | var lineageFile android.Path |
| 794 | if lineage := String(a.overridableAppProperties.Lineage); lineage != "" { |
| 795 | lineageFile = android.PathForModuleSrc(ctx, lineage) |
| 796 | } |
| 797 | CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile) |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 798 | a.outputFile = packageFile |
Songchun Fan | 688de9a | 2020-03-24 20:32:24 -0700 | [diff] [blame] | 799 | if v4SigningRequested { |
| 800 | a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile) |
| 801 | } |
Colin Cross | 3bc7ffa | 2017-11-22 16:19:37 -0800 | [diff] [blame] | 802 | |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 803 | for _, split := range a.aapt.splits { |
| 804 | // Sign the split APKs |
Jaewoong Jung | 5a49881 | 2019-11-07 14:14:38 -0800 | [diff] [blame] | 805 | packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk") |
Songchun Fan | 688de9a | 2020-03-24 20:32:24 -0700 | [diff] [blame] | 806 | if v4SigningRequested { |
| 807 | v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig") |
| 808 | } |
Liz Kammer | 70dd74d | 2020-05-07 13:24:05 -0700 | [diff] [blame] | 809 | CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile) |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 810 | a.extraOutputFiles = append(a.extraOutputFiles, packageFile) |
Songchun Fan | 688de9a | 2020-03-24 20:32:24 -0700 | [diff] [blame] | 811 | if v4SigningRequested { |
| 812 | a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile) |
| 813 | } |
Colin Cross | e560c4a | 2019-03-19 16:03:11 -0700 | [diff] [blame] | 814 | } |
| 815 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 816 | // Build an app bundle. |
Colin Cross | f623721 | 2018-10-29 23:14:58 -0700 | [diff] [blame] | 817 | bundleFile := android.PathForModuleOut(ctx, "base.zip") |
| 818 | BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile) |
| 819 | a.bundleFile = bundleFile |
| 820 | |
Jaewoong Jung | 590b1ae | 2019-01-22 16:40:58 -0800 | [diff] [blame] | 821 | // Install the app package. |
Jiyong Park | 8ba50f9 | 2019-11-13 15:01:01 +0900 | [diff] [blame] | 822 | if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() { |
| 823 | ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile) |
| 824 | for _, extra := range a.extraOutputFiles { |
| 825 | ctx.InstallFile(a.installDir, extra.Base(), extra) |
| 826 | } |
Colin Cross | 5ab4e6d | 2017-11-22 16:20:45 -0800 | [diff] [blame] | 827 | } |
Artur Satayev | d9b503a | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 828 | |
| 829 | a.buildAppDependencyInfo(ctx) |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 830 | } |
| 831 | |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 832 | type appDepsInterface interface { |
| 833 | sdkVersion() sdkSpec |
| 834 | minSdkVersion() sdkSpec |
| 835 | RequiresStableAPIs(ctx android.BaseModuleContext) bool |
| 836 | } |
| 837 | |
| 838 | func collectAppDeps(ctx android.ModuleContext, app appDepsInterface, |
| 839 | shouldCollectRecursiveNativeDeps bool, |
Colin Cross | 1c93c29 | 2020-02-15 10:38:00 -0800 | [diff] [blame] | 840 | checkNativeSdkVersion bool) ([]jniLib, []Certificate) { |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 841 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 842 | var jniLibs []jniLib |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 843 | var certificates []Certificate |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 844 | seenModulePaths := make(map[string]bool) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 845 | |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 846 | if checkNativeSdkVersion { |
| 847 | checkNativeSdkVersion = app.sdkVersion().specified() && |
| 848 | app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx) |
| 849 | } |
| 850 | |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 851 | ctx.WalkDeps(func(module android.Module, parent android.Module) bool { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 852 | otherName := ctx.OtherModuleName(module) |
| 853 | tag := ctx.OtherModuleDependencyTag(module) |
| 854 | |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 855 | if IsJniDepTag(tag) || tag == cc.SharedDepTag { |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 856 | if dep, ok := module.(*cc.Module); ok { |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 857 | if dep.IsNdk() || dep.IsStubs() { |
| 858 | return false |
| 859 | } |
| 860 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 861 | lib := dep.OutputFile() |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 862 | path := lib.Path() |
| 863 | if seenModulePaths[path.String()] { |
| 864 | return false |
| 865 | } |
| 866 | seenModulePaths[path.String()] = true |
| 867 | |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 868 | if checkNativeSdkVersion && dep.SdkVersion() == "" { |
| 869 | ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not", |
| 870 | otherName) |
Colin Cross | 1c93c29 | 2020-02-15 10:38:00 -0800 | [diff] [blame] | 871 | } |
| 872 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 873 | if lib.Valid() { |
| 874 | jniLibs = append(jniLibs, jniLib{ |
Colin Cross | b32b712 | 2020-07-06 14:15:24 -0700 | [diff] [blame] | 875 | name: ctx.OtherModuleName(module), |
| 876 | path: path, |
| 877 | target: module.Target(), |
| 878 | coverageFile: dep.CoverageOutputFile(), |
| 879 | unstrippedFile: dep.UnstrippedOutputFile(), |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 880 | }) |
| 881 | } else { |
| 882 | ctx.ModuleErrorf("dependency %q missing output file", otherName) |
| 883 | } |
| 884 | } else { |
| 885 | ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 886 | } |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 887 | |
| 888 | return shouldCollectRecursiveNativeDeps |
| 889 | } |
| 890 | |
| 891 | if tag == certificateTag { |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 892 | if dep, ok := module.(*AndroidAppCertificate); ok { |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 893 | certificates = append(certificates, dep.Certificate) |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 894 | } else { |
| 895 | ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName) |
| 896 | } |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 897 | } |
Peter Collingbourne | ad84f97 | 2019-12-17 16:46:18 -0800 | [diff] [blame] | 898 | |
| 899 | return false |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 900 | }) |
| 901 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 902 | return jniLibs, certificates |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 903 | } |
| 904 | |
Artur Satayev | d9b503a | 2020-04-27 19:05:28 +0100 | [diff] [blame] | 905 | func (a *AndroidApp) walkPayloadDeps(ctx android.ModuleContext, |
| 906 | do func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool)) { |
| 907 | |
| 908 | ctx.WalkDeps(func(child, parent android.Module) bool { |
| 909 | isExternal := !a.DepIsInSameApex(ctx, child) |
| 910 | if am, ok := child.(android.ApexModule); ok { |
| 911 | do(ctx, parent, am, isExternal) |
| 912 | } |
| 913 | return !isExternal |
| 914 | }) |
| 915 | } |
| 916 | |
| 917 | func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) { |
| 918 | if ctx.Host() { |
| 919 | return |
| 920 | } |
| 921 | |
| 922 | depsInfo := android.DepNameToDepInfoMap{} |
| 923 | a.walkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) { |
| 924 | depName := to.Name() |
| 925 | if info, exist := depsInfo[depName]; exist { |
| 926 | info.From = append(info.From, from.Name()) |
| 927 | info.IsExternal = info.IsExternal && externalDep |
| 928 | depsInfo[depName] = info |
| 929 | } else { |
| 930 | toMinSdkVersion := "(no version)" |
| 931 | if m, ok := to.(interface{ MinSdkVersion() string }); ok { |
| 932 | if v := m.MinSdkVersion(); v != "" { |
| 933 | toMinSdkVersion = v |
| 934 | } |
| 935 | } |
| 936 | depsInfo[depName] = android.ApexModuleDepInfo{ |
| 937 | To: depName, |
| 938 | From: []string{from.Name()}, |
| 939 | IsExternal: externalDep, |
| 940 | MinSdkVersion: toMinSdkVersion, |
| 941 | } |
| 942 | } |
| 943 | }) |
| 944 | |
| 945 | a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo) |
| 946 | } |
| 947 | |
Artur Satayev | 2b4b7bb | 2020-04-28 14:57:42 +0100 | [diff] [blame] | 948 | func (a *AndroidApp) Updatable() bool { |
| 949 | return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable() |
| 950 | } |
| 951 | |
Colin Cross | 0ea8ba8 | 2019-06-06 14:33:29 -0700 | [diff] [blame] | 952 | func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string { |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 953 | certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName()) |
| 954 | if overridden { |
Jaewoong Jung | acb6db3 | 2019-02-28 16:22:30 +0000 | [diff] [blame] | 955 | return ":" + certificate |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 956 | } |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 957 | return String(a.overridableAppProperties.Certificate) |
Jaewoong Jung | 2ad817c | 2019-01-18 14:27:16 -0800 | [diff] [blame] | 958 | } |
| 959 | |
Jiyong Park | 0f80c18 | 2020-01-31 02:49:53 +0900 | [diff] [blame] | 960 | func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool { |
| 961 | if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) { |
| 962 | return true |
| 963 | } |
| 964 | return a.Library.DepIsInSameApex(ctx, dep) |
| 965 | } |
| 966 | |
Jiyong Park | b7c639e | 2019-08-19 14:56:02 +0900 | [diff] [blame] | 967 | // For OutputFileProducer interface |
| 968 | func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) { |
| 969 | switch tag { |
| 970 | case ".aapt.srcjar": |
| 971 | return []android.Path{a.aaptSrcJar}, nil |
Anton Hansson | 8fe023c | 2020-08-13 19:37:22 +0100 | [diff] [blame] | 972 | case ".export-package.apk": |
| 973 | return []android.Path{a.exportPackage}, nil |
Jiyong Park | b7c639e | 2019-08-19 14:56:02 +0900 | [diff] [blame] | 974 | } |
| 975 | return a.Library.OutputFiles(tag) |
| 976 | } |
| 977 | |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 978 | func (a *AndroidApp) Privileged() bool { |
| 979 | return Bool(a.appProperties.Privileged) |
| 980 | } |
| 981 | |
Jaewoong Jung | 37ca4a1 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 982 | func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool { |
Colin Cross | 72cabc6 | 2020-06-16 17:51:46 -0700 | [diff] [blame] | 983 | return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled() |
Jaewoong Jung | 37ca4a1 | 2020-03-26 14:01:48 -0700 | [diff] [blame] | 984 | } |
| 985 | |
| 986 | func (a *AndroidApp) PreventInstall() { |
| 987 | a.appProperties.PreventInstall = true |
| 988 | } |
| 989 | |
| 990 | func (a *AndroidApp) HideFromMake() { |
| 991 | a.appProperties.HideFromMake = true |
| 992 | } |
| 993 | |
| 994 | func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) { |
| 995 | a.appProperties.IsCoverageVariant = coverage |
| 996 | } |
| 997 | |
| 998 | var _ cc.Coverage = (*AndroidApp)(nil) |
| 999 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 1000 | // android_app compiles sources and Android resources into an Android application package `.apk` file. |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 1001 | func AndroidAppFactory() android.Module { |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 1002 | module := &AndroidApp{} |
| 1003 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 1004 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 66dbc0b | 2017-12-28 12:23:20 -0800 | [diff] [blame] | 1005 | module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true) |
| 1006 | |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1007 | module.Module.properties.Instrument = true |
Colin Cross | 9ae1b92 | 2018-06-26 17:59:05 -0700 | [diff] [blame] | 1008 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1009 | |
Colin Cross | 1c14b4e | 2020-06-15 16:09:53 -0700 | [diff] [blame] | 1010 | module.addHostAndDeviceProperties() |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 1011 | module.AddProperties( |
Colin Cross | a97c5d3 | 2018-03-28 14:58:31 -0700 | [diff] [blame] | 1012 | &module.aaptProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1013 | &module.appProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1014 | &module.overridableAppProperties, |
| 1015 | &module.usesLibrary.usesLibraryProperties) |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 1016 | |
Colin Cross | a9d8bee | 2018-10-02 13:59:46 -0700 | [diff] [blame] | 1017 | module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool { |
| 1018 | return class == android.Device && ctx.Config().DevicePrefer32BitApps() |
| 1019 | }) |
| 1020 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 1021 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1022 | android.InitDefaultableModule(module) |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1023 | android.InitOverridableModule(module, &module.appProperties.Overrides) |
Jiyong Park | 52cd06f | 2019-11-11 10:14:32 +0900 | [diff] [blame] | 1024 | android.InitApexModule(module) |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 1025 | |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 1026 | return module |
Colin Cross | 30e076a | 2015-04-13 13:58:27 -0700 | [diff] [blame] | 1027 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1028 | |
| 1029 | type appTestProperties struct { |
| 1030 | Instrumentation_for *string |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1031 | |
| 1032 | // if specified, the instrumentation target package name in the manifest is overwritten by it. |
| 1033 | Instrumentation_target_package *string |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1034 | } |
| 1035 | |
| 1036 | type AndroidTest struct { |
| 1037 | AndroidApp |
| 1038 | |
| 1039 | appTestProperties appTestProperties |
| 1040 | |
| 1041 | testProperties testProperties |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1042 | |
| 1043 | testConfig android.Path |
Colin Cross | d96ca35 | 2018-08-10 16:06:24 -0700 | [diff] [blame] | 1044 | data android.Paths |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1045 | } |
| 1046 | |
Jaewoong Jung | 0949f31 | 2019-09-11 10:25:18 -0700 | [diff] [blame] | 1047 | func (a *AndroidTest) InstallInTestcases() bool { |
| 1048 | return true |
| 1049 | } |
| 1050 | |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1051 | func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
easoncylee | ba60625 | 2020-04-30 14:57:06 +0800 | [diff] [blame] | 1052 | var configs []tradefed.Config |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1053 | if a.appTestProperties.Instrumentation_target_package != nil { |
| 1054 | a.additionalAaptFlags = append(a.additionalAaptFlags, |
| 1055 | "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package) |
| 1056 | } else if a.appTestProperties.Instrumentation_for != nil { |
| 1057 | // Check if the instrumentation target package is overridden. |
Jaewoong Jung | 4102e5d | 2019-02-27 16:26:28 -0800 | [diff] [blame] | 1058 | manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for) |
| 1059 | if overridden { |
| 1060 | a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName) |
| 1061 | } |
| 1062 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1063 | a.generateAndroidBuildActions(ctx) |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1064 | |
easoncylee | ba60625 | 2020-04-30 14:57:06 +0800 | [diff] [blame] | 1065 | for _, module := range a.testProperties.Test_mainline_modules { |
| 1066 | configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module}) |
| 1067 | } |
| 1068 | |
Jaewoong Jung | 3998234 | 2020-01-14 10:27:18 -0800 | [diff] [blame] | 1069 | testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config, |
easoncylee | ba60625 | 2020-04-30 14:57:06 +0800 | [diff] [blame] | 1070 | a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs) |
Jaewoong Jung | 3998234 | 2020-01-14 10:27:18 -0800 | [diff] [blame] | 1071 | a.testConfig = a.FixTestConfig(ctx, testConfig) |
Colin Cross | 8a49795 | 2019-03-05 22:25:09 -0800 | [diff] [blame] | 1072 | a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data) |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1073 | } |
| 1074 | |
Jaewoong Jung | 3998234 | 2020-01-14 10:27:18 -0800 | [diff] [blame] | 1075 | func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path { |
| 1076 | if testConfig == nil { |
| 1077 | return nil |
| 1078 | } |
| 1079 | |
| 1080 | fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml") |
| 1081 | rule := android.NewRuleBuilder() |
| 1082 | command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig) |
| 1083 | fixNeeded := false |
| 1084 | |
| 1085 | if ctx.ModuleName() != a.installApkName { |
| 1086 | fixNeeded = true |
| 1087 | command.FlagWithArg("--test-file-name ", a.installApkName+".apk") |
| 1088 | } |
| 1089 | |
| 1090 | if a.overridableAppProperties.Package_name != nil { |
| 1091 | fixNeeded = true |
| 1092 | command.FlagWithInput("--manifest ", a.manifestPath). |
| 1093 | FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name) |
| 1094 | } |
| 1095 | |
| 1096 | if fixNeeded { |
| 1097 | rule.Build(pctx, ctx, "fix_test_config", "fix test config") |
| 1098 | return fixedConfig |
| 1099 | } |
| 1100 | return testConfig |
| 1101 | } |
| 1102 | |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1103 | func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) { |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 1104 | a.AndroidApp.DepsMutator(ctx) |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1105 | } |
| 1106 | |
| 1107 | func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) { |
| 1108 | a.AndroidApp.OverridablePropertiesDepsMutator(ctx) |
Colin Cross | 4b964c0 | 2018-10-15 16:18:06 -0700 | [diff] [blame] | 1109 | if a.appTestProperties.Instrumentation_for != nil { |
| 1110 | // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac, |
| 1111 | // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so |
| 1112 | // use instrumentationForTag instead of libTag. |
| 1113 | ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for)) |
| 1114 | } |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1115 | } |
| 1116 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 1117 | // android_test compiles test sources and Android resources into an Android application package `.apk` file and |
| 1118 | // creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file. |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1119 | func AndroidTestFactory() android.Module { |
| 1120 | module := &AndroidTest{} |
| 1121 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 1122 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 5067db9 | 2018-09-17 16:46:35 -0700 | [diff] [blame] | 1123 | |
| 1124 | module.Module.properties.Instrument = true |
Colin Cross | 9ae1b92 | 2018-06-26 17:59:05 -0700 | [diff] [blame] | 1125 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 1126 | module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true) |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 1127 | module.appProperties.AlwaysPackageNativeLibs = true |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 1128 | module.Module.dexpreopter.isTest = true |
Colin Cross | 1e28e3c | 2020-06-02 20:09:13 -0700 | [diff] [blame] | 1129 | module.Module.linter.test = true |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1130 | |
Colin Cross | 1c14b4e | 2020-06-15 16:09:53 -0700 | [diff] [blame] | 1131 | module.addHostAndDeviceProperties() |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1132 | module.AddProperties( |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1133 | &module.aaptProperties, |
| 1134 | &module.appProperties, |
Dan Willemsen | f5531d2 | 2018-07-16 17:21:19 -0700 | [diff] [blame] | 1135 | &module.appTestProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1136 | &module.overridableAppProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1137 | &module.usesLibrary.usesLibraryProperties, |
Dan Willemsen | f5531d2 | 2018-07-16 17:21:19 -0700 | [diff] [blame] | 1138 | &module.testProperties) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1139 | |
Colin Cross | a4f0881 | 2018-10-02 22:03:40 -0700 | [diff] [blame] | 1140 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1141 | android.InitDefaultableModule(module) |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1142 | android.InitOverridableModule(module, &module.appProperties.Overrides) |
Colin Cross | ae5caf5 | 2018-05-22 11:11:52 -0700 | [diff] [blame] | 1143 | return module |
| 1144 | } |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1145 | |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1146 | type appTestHelperAppProperties struct { |
| 1147 | // list of compatibility suites (for example "cts", "vts") that the module should be |
| 1148 | // installed into. |
| 1149 | Test_suites []string `android:"arch_variant"` |
Dan Shi | 6ffaaa8 | 2019-09-26 11:41:36 -0700 | [diff] [blame] | 1150 | |
| 1151 | // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml |
| 1152 | // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true |
| 1153 | // explicitly. |
| 1154 | Auto_gen_config *bool |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1155 | } |
| 1156 | |
| 1157 | type AndroidTestHelperApp struct { |
| 1158 | AndroidApp |
| 1159 | |
| 1160 | appTestHelperAppProperties appTestHelperAppProperties |
| 1161 | } |
| 1162 | |
Jaewoong Jung | 326a941 | 2019-11-21 10:41:00 -0800 | [diff] [blame] | 1163 | func (a *AndroidTestHelperApp) InstallInTestcases() bool { |
| 1164 | return true |
| 1165 | } |
| 1166 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 1167 | // android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that |
| 1168 | // will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a |
| 1169 | // test. |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1170 | func AndroidTestHelperAppFactory() android.Module { |
| 1171 | module := &AndroidTestHelperApp{} |
| 1172 | |
Sasha Smundak | 2057f82 | 2019-04-16 17:16:58 -0700 | [diff] [blame] | 1173 | module.Module.deviceProperties.Optimize.EnabledByDefault = true |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1174 | |
| 1175 | module.Module.properties.Installable = proptools.BoolPtr(true) |
Colin Cross | e4246ab | 2019-02-05 21:55:21 -0800 | [diff] [blame] | 1176 | module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true) |
Colin Cross | 47fa9d3 | 2019-03-26 10:51:39 -0700 | [diff] [blame] | 1177 | module.appProperties.AlwaysPackageNativeLibs = true |
Colin Cross | 43f08db | 2018-11-12 10:13:39 -0800 | [diff] [blame] | 1178 | module.Module.dexpreopter.isTest = true |
Colin Cross | 1e28e3c | 2020-06-02 20:09:13 -0700 | [diff] [blame] | 1179 | module.Module.linter.test = true |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1180 | |
Colin Cross | 1c14b4e | 2020-06-15 16:09:53 -0700 | [diff] [blame] | 1181 | module.addHostAndDeviceProperties() |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1182 | module.AddProperties( |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1183 | &module.aaptProperties, |
| 1184 | &module.appProperties, |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1185 | &module.appTestHelperAppProperties, |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1186 | &module.overridableAppProperties, |
| 1187 | &module.usesLibrary.usesLibraryProperties) |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1188 | |
| 1189 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1190 | android.InitDefaultableModule(module) |
Anton Hansson | 3d2b6b4 | 2020-01-10 15:06:01 +0000 | [diff] [blame] | 1191 | android.InitApexModule(module) |
Colin Cross | 252fc6f | 2018-10-04 15:22:03 -0700 | [diff] [blame] | 1192 | return module |
| 1193 | } |
| 1194 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1195 | type AndroidAppCertificate struct { |
| 1196 | android.ModuleBase |
| 1197 | properties AndroidAppCertificateProperties |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 1198 | Certificate Certificate |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1199 | } |
| 1200 | |
| 1201 | type AndroidAppCertificateProperties struct { |
| 1202 | // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name. |
| 1203 | Certificate *string |
| 1204 | } |
| 1205 | |
Colin Cross | 1b16b0e | 2019-02-12 14:41:32 -0800 | [diff] [blame] | 1206 | // android_app_certificate modules can be referenced by the certificates property of android_app modules to select |
| 1207 | // the signing key. |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1208 | func AndroidAppCertificateFactory() android.Module { |
| 1209 | module := &AndroidAppCertificate{} |
| 1210 | module.AddProperties(&module.properties) |
| 1211 | android.InitAndroidModule(module) |
| 1212 | return module |
| 1213 | } |
| 1214 | |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1215 | func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 1216 | cert := String(c.properties.Certificate) |
Jiyong Park | c00cbd9 | 2018-10-30 21:20:05 +0900 | [diff] [blame] | 1217 | c.Certificate = Certificate{ |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 1218 | Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"), |
| 1219 | Key: android.PathForModuleSrc(ctx, cert+".pk8"), |
Colin Cross | bd01e2a | 2018-10-04 15:21:03 -0700 | [diff] [blame] | 1220 | } |
| 1221 | } |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1222 | |
| 1223 | type OverrideAndroidApp struct { |
| 1224 | android.ModuleBase |
| 1225 | android.OverrideModuleBase |
| 1226 | } |
| 1227 | |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 1228 | func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) { |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1229 | // All the overrides happen in the base module. |
| 1230 | // TODO(jungjw): Check the base module type. |
| 1231 | } |
| 1232 | |
| 1233 | // override_android_app is used to create an android_app module based on another android_app by overriding |
| 1234 | // some of its properties. |
| 1235 | func OverrideAndroidAppModuleFactory() android.Module { |
| 1236 | m := &OverrideAndroidApp{} |
| 1237 | m.AddProperties(&overridableAppProperties{}) |
| 1238 | |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 1239 | android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon) |
Jaewoong Jung | 525443a | 2019-02-28 15:35:54 -0800 | [diff] [blame] | 1240 | android.InitOverrideModule(m) |
| 1241 | return m |
| 1242 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1243 | |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1244 | type OverrideAndroidTest struct { |
| 1245 | android.ModuleBase |
| 1246 | android.OverrideModuleBase |
| 1247 | } |
| 1248 | |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 1249 | func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) { |
Jaewoong Jung | 26dedd3 | 2019-06-06 08:45:58 -0700 | [diff] [blame] | 1250 | // All the overrides happen in the base module. |
| 1251 | // TODO(jungjw): Check the base module type. |
| 1252 | } |
| 1253 | |
| 1254 | // override_android_test is used to create an android_app module based on another android_test by overriding |
| 1255 | // some of its properties. |
| 1256 | func OverrideAndroidTestModuleFactory() android.Module { |
| 1257 | m := &OverrideAndroidTest{} |
| 1258 | m.AddProperties(&overridableAppProperties{}) |
| 1259 | m.AddProperties(&appTestProperties{}) |
| 1260 | |
| 1261 | android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon) |
| 1262 | android.InitOverrideModule(m) |
| 1263 | return m |
| 1264 | } |
| 1265 | |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1266 | type OverrideRuntimeResourceOverlay struct { |
| 1267 | android.ModuleBase |
| 1268 | android.OverrideModuleBase |
| 1269 | } |
| 1270 | |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 1271 | func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(_ android.ModuleContext) { |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1272 | // All the overrides happen in the base module. |
| 1273 | // TODO(jungjw): Check the base module type. |
| 1274 | } |
| 1275 | |
| 1276 | // override_runtime_resource_overlay is used to create a module based on another |
| 1277 | // runtime_resource_overlay module by overriding some of its properties. |
| 1278 | func OverrideRuntimeResourceOverlayModuleFactory() android.Module { |
| 1279 | m := &OverrideRuntimeResourceOverlay{} |
| 1280 | m.AddProperties(&OverridableRuntimeResourceOverlayProperties{}) |
| 1281 | |
| 1282 | android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon) |
| 1283 | android.InitOverrideModule(m) |
| 1284 | return m |
| 1285 | } |
| 1286 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1287 | type AndroidAppImport struct { |
| 1288 | android.ModuleBase |
| 1289 | android.DefaultableModuleBase |
| 1290 | prebuilt android.Prebuilt |
| 1291 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1292 | properties AndroidAppImportProperties |
| 1293 | dpiVariants interface{} |
| 1294 | archVariants interface{} |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1295 | |
| 1296 | outputFile android.Path |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 1297 | certificate Certificate |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1298 | |
| 1299 | dexpreopter |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1300 | |
| 1301 | usesLibrary usesLibrary |
Jaewoong Jung | 8aae22e | 2019-07-17 10:21:49 -0700 | [diff] [blame] | 1302 | |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1303 | preprocessed bool |
| 1304 | |
Colin Cross | 70dda7e | 2019-10-01 22:05:35 -0700 | [diff] [blame] | 1305 | installPath android.InstallPath |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1306 | } |
| 1307 | |
| 1308 | type AndroidAppImportProperties struct { |
| 1309 | // A prebuilt apk to import |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1310 | Apk *string |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1311 | |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1312 | // The name of a certificate in the default certificate directory or an android_app_certificate |
| 1313 | // module name in the form ":module". Should be empty if presigned or default_dev_cert is set. |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1314 | Certificate *string |
| 1315 | |
| 1316 | // Set this flag to true if the prebuilt apk is already signed. The certificate property must not |
| 1317 | // be set for presigned modules. |
| 1318 | Presigned *bool |
| 1319 | |
Liz Kammer | 2bc57f6 | 2020-05-13 15:49:21 -0700 | [diff] [blame] | 1320 | // Name of the signing certificate lineage file. |
| 1321 | Lineage *string |
| 1322 | |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1323 | // Sign with the default system dev certificate. Must be used judiciously. Most imported apps |
| 1324 | // need to either specify a specific certificate or be presigned. |
| 1325 | Default_dev_cert *bool |
| 1326 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1327 | // Specifies that this app should be installed to the priv-app directory, |
| 1328 | // where the system will grant it additional privileges not available to |
| 1329 | // normal apps. |
| 1330 | Privileged *bool |
| 1331 | |
| 1332 | // Names of modules to be overridden. Listed modules can only be other binaries |
| 1333 | // (in Make or Soong). |
| 1334 | // This does not completely prevent installation of the overridden binaries, but if both |
| 1335 | // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed |
| 1336 | // from PRODUCT_PACKAGES. |
| 1337 | Overrides []string |
Jaewoong Jung | 8aae22e | 2019-07-17 10:21:49 -0700 | [diff] [blame] | 1338 | |
| 1339 | // Optional name for the installed app. If unspecified, it is derived from the module name. |
| 1340 | Filename *string |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1341 | } |
| 1342 | |
Martin Stjernholm | 6d41527 | 2020-01-31 17:10:36 +0000 | [diff] [blame] | 1343 | func (a *AndroidAppImport) IsInstallable() bool { |
| 1344 | return true |
| 1345 | } |
| 1346 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1347 | // Updates properties with variant-specific values. |
| 1348 | func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) { |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1349 | config := ctx.Config() |
| 1350 | |
| 1351 | dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants") |
| 1352 | // Try DPI variant matches in the reverse-priority order so that the highest priority match |
| 1353 | // overwrites everything else. |
| 1354 | // TODO(jungjw): Can we optimize this by making it priority order? |
| 1355 | for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1356 | MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i]) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1357 | } |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1358 | if config.ProductAAPTPreferredConfig() != "" { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1359 | MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig()) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1360 | } |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1361 | |
| 1362 | archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch") |
| 1363 | archType := ctx.Config().Targets[android.Android][0].Arch.ArchType |
| 1364 | MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name) |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1365 | } |
| 1366 | |
Colin Cross | 1184b64 | 2019-12-30 18:43:07 -0800 | [diff] [blame] | 1367 | func MergePropertiesFromVariant(ctx android.EarlyModuleContext, |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1368 | dst interface{}, variantGroup reflect.Value, variant string) { |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1369 | src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant)) |
| 1370 | if !src.IsValid() { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1371 | return |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1372 | } |
| 1373 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1374 | err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend) |
| 1375 | if err != nil { |
| 1376 | if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok { |
| 1377 | ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error()) |
| 1378 | } else { |
| 1379 | panic(err) |
| 1380 | } |
| 1381 | } |
Jaewoong Jung | a5e5abc | 2019-04-26 14:31:50 -0700 | [diff] [blame] | 1382 | } |
| 1383 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1384 | func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) { |
| 1385 | cert := android.SrcIsModule(String(a.properties.Certificate)) |
| 1386 | if cert != "" { |
| 1387 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 1388 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1389 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 1390 | a.usesLibrary.deps(ctx, true) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1391 | } |
| 1392 | |
| 1393 | func (a *AndroidAppImport) uncompressEmbeddedJniLibs( |
| 1394 | ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) { |
Jaewoong Jung | 7c5bd83 | 2020-01-13 09:55:39 -0800 | [diff] [blame] | 1395 | // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing |
| 1396 | // with them may invalidate pre-existing signature data. |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1397 | if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) { |
Jaewoong Jung | 7c5bd83 | 2020-01-13 09:55:39 -0800 | [diff] [blame] | 1398 | ctx.Build(pctx, android.BuildParams{ |
| 1399 | Rule: android.Cp, |
| 1400 | Output: outputPath, |
| 1401 | Input: inputPath, |
| 1402 | }) |
| 1403 | return |
| 1404 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1405 | rule := android.NewRuleBuilder() |
| 1406 | rule.Command(). |
| 1407 | Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath). |
Colin Cross | ee94d6a | 2019-07-08 17:08:34 -0700 | [diff] [blame] | 1408 | BuiltTool(ctx, "zip2zip"). |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1409 | FlagWithInput("-i ", inputPath). |
| 1410 | FlagWithOutput("-o ", outputPath). |
| 1411 | FlagWithArg("-0 ", "'lib/**/*.so'"). |
| 1412 | Textf(`; else cp -f %s %s; fi`, inputPath, outputPath) |
| 1413 | rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs") |
| 1414 | } |
| 1415 | |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1416 | // Returns whether this module should have the dex file stored uncompressed in the APK. |
| 1417 | func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool { |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1418 | if ctx.Config().UnbundledBuild() || a.preprocessed { |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1419 | return false |
| 1420 | } |
| 1421 | |
| 1422 | // Uncompress dex in APKs of privileged apps |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 1423 | if ctx.Config().UncompressPrivAppDex() && a.Privileged() { |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1424 | return true |
| 1425 | } |
| 1426 | |
| 1427 | return shouldUncompressDex(ctx, &a.dexpreopter) |
| 1428 | } |
| 1429 | |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 1430 | func (a *AndroidAppImport) uncompressDex( |
| 1431 | ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) { |
| 1432 | rule := android.NewRuleBuilder() |
| 1433 | rule.Command(). |
| 1434 | Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath). |
Colin Cross | ee94d6a | 2019-07-08 17:08:34 -0700 | [diff] [blame] | 1435 | BuiltTool(ctx, "zip2zip"). |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 1436 | FlagWithInput("-i ", inputPath). |
| 1437 | FlagWithOutput("-o ", outputPath). |
| 1438 | FlagWithArg("-0 ", "'classes*.dex'"). |
| 1439 | Textf(`; else cp -f %s %s; fi`, inputPath, outputPath) |
| 1440 | rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files") |
| 1441 | } |
| 1442 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1443 | func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1444 | a.generateAndroidBuildActions(ctx) |
| 1445 | } |
| 1446 | |
Jooyung Han | 65cd0f0 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1447 | func (a *AndroidAppImport) InstallApkName() string { |
| 1448 | return a.BaseModuleName() |
| 1449 | } |
| 1450 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1451 | func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) { |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1452 | numCertPropsSet := 0 |
| 1453 | if String(a.properties.Certificate) != "" { |
| 1454 | numCertPropsSet++ |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1455 | } |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1456 | if Bool(a.properties.Presigned) { |
| 1457 | numCertPropsSet++ |
| 1458 | } |
| 1459 | if Bool(a.properties.Default_dev_cert) { |
| 1460 | numCertPropsSet++ |
| 1461 | } |
| 1462 | if numCertPropsSet != 1 { |
| 1463 | ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set") |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1464 | } |
| 1465 | |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 1466 | _, certificates := collectAppDeps(ctx, a, false, false) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1467 | |
| 1468 | // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1469 | // TODO: LOCAL_PACKAGE_SPLITS |
| 1470 | |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1471 | srcApk := a.prebuilt.SingleSourcePath(ctx) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1472 | |
| 1473 | if a.usesLibrary.enforceUsesLibraries() { |
| 1474 | srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk) |
| 1475 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1476 | |
| 1477 | // TODO: Install or embed JNI libraries |
| 1478 | |
| 1479 | // Uncompress JNI libraries in the apk |
| 1480 | jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk") |
| 1481 | a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath) |
| 1482 | |
Kyeongkab.Nam | c499714 | 2019-11-22 11:38:16 +0900 | [diff] [blame] | 1483 | var installDir android.InstallPath |
| 1484 | if Bool(a.properties.Privileged) { |
| 1485 | installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName()) |
Jaewoong Jung | 7c5bd83 | 2020-01-13 09:55:39 -0800 | [diff] [blame] | 1486 | } else if ctx.InstallInTestcases() { |
| 1487 | installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch()) |
Kyeongkab.Nam | c499714 | 2019-11-22 11:38:16 +0900 | [diff] [blame] | 1488 | } else { |
| 1489 | installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName()) |
| 1490 | } |
| 1491 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1492 | a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk") |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1493 | a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned) |
Jaewoong Jung | acf18d7 | 2019-05-02 14:55:29 -0700 | [diff] [blame] | 1494 | a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1495 | |
| 1496 | a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries() |
| 1497 | a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs |
| 1498 | a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx) |
| 1499 | a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx) |
| 1500 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1501 | dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed) |
Jaewoong Jung | ea1bdb0 | 2019-05-09 14:36:34 -0700 | [diff] [blame] | 1502 | if a.dexpreopter.uncompressedDex { |
| 1503 | dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk") |
| 1504 | a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath) |
| 1505 | dexOutput = dexUncompressed |
| 1506 | } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1507 | |
Jooyung Han | 65cd0f0 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1508 | apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk") |
| 1509 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1510 | // TODO: Handle EXTERNAL |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1511 | |
| 1512 | // Sign or align the package if package has not been preprocessed |
| 1513 | if a.preprocessed { |
| 1514 | a.outputFile = srcApk |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 1515 | a.certificate = PresignedCertificate |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1516 | } else if !Bool(a.properties.Presigned) { |
Jaewoong Jung | 961d4fd | 2019-08-22 14:25:58 -0700 | [diff] [blame] | 1517 | // If the certificate property is empty at this point, default_dev_cert must be set to true. |
| 1518 | // Which makes processMainCert's behavior for the empty cert string WAI. |
| 1519 | certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1520 | if len(certificates) != 1 { |
| 1521 | ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates) |
| 1522 | } |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 1523 | a.certificate = certificates[0] |
Jooyung Han | 65cd0f0 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1524 | signed := android.PathForModuleOut(ctx, "signed", apkFilename) |
Liz Kammer | 2bc57f6 | 2020-05-13 15:49:21 -0700 | [diff] [blame] | 1525 | var lineageFile android.Path |
| 1526 | if lineage := String(a.properties.Lineage); lineage != "" { |
| 1527 | lineageFile = android.PathForModuleSrc(ctx, lineage) |
| 1528 | } |
| 1529 | SignAppPackage(ctx, signed, dexOutput, certificates, nil, lineageFile) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1530 | a.outputFile = signed |
| 1531 | } else { |
Jooyung Han | 65cd0f0 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1532 | alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1533 | TransformZipAlign(ctx, alignedApk, dexOutput) |
| 1534 | a.outputFile = alignedApk |
Sasha Smundak | c4f0ff1 | 2020-05-27 16:36:07 -0700 | [diff] [blame] | 1535 | a.certificate = PresignedCertificate |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1536 | } |
| 1537 | |
| 1538 | // TODO: Optionally compress the output apk. |
| 1539 | |
Jooyung Han | 65cd0f0 | 2020-03-23 20:21:11 +0900 | [diff] [blame] | 1540 | a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1541 | |
| 1542 | // TODO: androidmk converter jni libs |
| 1543 | } |
| 1544 | |
| 1545 | func (a *AndroidAppImport) Prebuilt() *android.Prebuilt { |
| 1546 | return &a.prebuilt |
| 1547 | } |
| 1548 | |
| 1549 | func (a *AndroidAppImport) Name() string { |
| 1550 | return a.prebuilt.Name(a.ModuleBase.Name()) |
| 1551 | } |
| 1552 | |
Dario Freni | cde2a03 | 2019-10-27 00:29:22 +0100 | [diff] [blame] | 1553 | func (a *AndroidAppImport) OutputFile() android.Path { |
| 1554 | return a.outputFile |
| 1555 | } |
| 1556 | |
Jiyong Park | 618922e | 2020-01-08 13:35:43 +0900 | [diff] [blame] | 1557 | func (a *AndroidAppImport) JacocoReportClassesFile() android.Path { |
| 1558 | return nil |
| 1559 | } |
| 1560 | |
Colin Cross | 503c1d0 | 2020-01-28 14:00:53 -0800 | [diff] [blame] | 1561 | func (a *AndroidAppImport) Certificate() Certificate { |
| 1562 | return a.certificate |
| 1563 | } |
| 1564 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1565 | var dpiVariantGroupType reflect.Type |
| 1566 | var archVariantGroupType reflect.Type |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1567 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1568 | func initAndroidAppImportVariantGroupTypes() { |
| 1569 | dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants") |
| 1570 | |
| 1571 | archNames := make([]string, len(android.ArchTypeList())) |
| 1572 | for i, archType := range android.ArchTypeList() { |
| 1573 | archNames[i] = archType.Name |
| 1574 | } |
| 1575 | archVariantGroupType = createVariantGroupType(archNames, "Arch") |
| 1576 | } |
| 1577 | |
| 1578 | // Populates all variant struct properties at creation time. |
| 1579 | func (a *AndroidAppImport) populateAllVariantStructs() { |
| 1580 | a.dpiVariants = reflect.New(dpiVariantGroupType).Interface() |
| 1581 | a.AddProperties(a.dpiVariants) |
| 1582 | |
| 1583 | a.archVariants = reflect.New(archVariantGroupType).Interface() |
| 1584 | a.AddProperties(a.archVariants) |
| 1585 | } |
| 1586 | |
Jiyong Park | f748731 | 2019-10-17 12:54:30 +0900 | [diff] [blame] | 1587 | func (a *AndroidAppImport) Privileged() bool { |
| 1588 | return Bool(a.properties.Privileged) |
| 1589 | } |
| 1590 | |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 1591 | func (a *AndroidAppImport) sdkVersion() sdkSpec { |
| 1592 | return sdkSpecFrom("") |
| 1593 | } |
| 1594 | |
| 1595 | func (a *AndroidAppImport) minSdkVersion() sdkSpec { |
| 1596 | return sdkSpecFrom("") |
| 1597 | } |
| 1598 | |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1599 | func createVariantGroupType(variants []string, variantGroupName string) reflect.Type { |
| 1600 | props := reflect.TypeOf((*AndroidAppImportProperties)(nil)) |
| 1601 | |
| 1602 | variantFields := make([]reflect.StructField, len(variants)) |
| 1603 | for i, variant := range variants { |
| 1604 | variantFields[i] = reflect.StructField{ |
| 1605 | Name: proptools.FieldNameForProperty(variant), |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1606 | Type: props, |
| 1607 | } |
| 1608 | } |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1609 | |
| 1610 | variantGroupStruct := reflect.StructOf(variantFields) |
| 1611 | return reflect.StructOf([]reflect.StructField{ |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1612 | { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1613 | Name: variantGroupName, |
| 1614 | Type: variantGroupStruct, |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1615 | }, |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1616 | }) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1617 | } |
| 1618 | |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1619 | // android_app_import imports a prebuilt apk with additional processing specified in the module. |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1620 | // DPI-specific apk source files can be specified using dpi_variants. Example: |
| 1621 | // |
| 1622 | // android_app_import { |
| 1623 | // name: "example_import", |
| 1624 | // apk: "prebuilts/example.apk", |
| 1625 | // dpi_variants: { |
| 1626 | // mdpi: { |
| 1627 | // apk: "prebuilts/example_mdpi.apk", |
| 1628 | // }, |
| 1629 | // xhdpi: { |
| 1630 | // apk: "prebuilts/example_xhdpi.apk", |
| 1631 | // }, |
| 1632 | // }, |
| 1633 | // certificate: "PRESIGNED", |
| 1634 | // } |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1635 | func AndroidAppImportFactory() android.Module { |
| 1636 | module := &AndroidAppImport{} |
| 1637 | module.AddProperties(&module.properties) |
| 1638 | module.AddProperties(&module.dexpreoptProperties) |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1639 | module.AddProperties(&module.usesLibrary.usesLibraryProperties) |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1640 | module.populateAllVariantStructs() |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1641 | android.AddLoadHook(module, func(ctx android.LoadHookContext) { |
Jaewoong Jung | 1ce9ac6 | 2019-08-13 14:11:33 -0700 | [diff] [blame] | 1642 | module.processVariants(ctx) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1643 | }) |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1644 | |
Jaewoong Jung | 0feed89 | 2020-05-26 20:10:08 -0700 | [diff] [blame] | 1645 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1646 | android.InitDefaultableModule(module) |
Jaewoong Jung | 3e18b19 | 2019-06-11 12:25:34 -0700 | [diff] [blame] | 1647 | android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk") |
Jaewoong Jung | ccbb393 | 2019-04-15 09:48:31 -0700 | [diff] [blame] | 1648 | |
| 1649 | return module |
| 1650 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1651 | |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1652 | type androidTestImportProperties struct { |
| 1653 | // Whether the prebuilt apk can be installed without additional processing. Default is false. |
| 1654 | Preprocessed *bool |
| 1655 | } |
| 1656 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1657 | type AndroidTestImport struct { |
| 1658 | AndroidAppImport |
| 1659 | |
| 1660 | testProperties testProperties |
| 1661 | |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1662 | testImportProperties androidTestImportProperties |
| 1663 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1664 | data android.Paths |
| 1665 | } |
| 1666 | |
| 1667 | func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1668 | a.preprocessed = Bool(a.testImportProperties.Preprocessed) |
| 1669 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1670 | a.generateAndroidBuildActions(ctx) |
| 1671 | |
| 1672 | a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data) |
| 1673 | } |
| 1674 | |
Jaewoong Jung | 7c5bd83 | 2020-01-13 09:55:39 -0800 | [diff] [blame] | 1675 | func (a *AndroidTestImport) InstallInTestcases() bool { |
| 1676 | return true |
| 1677 | } |
| 1678 | |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1679 | // android_test_import imports a prebuilt test apk with additional processing specified in the |
| 1680 | // module. DPI or arch variant configurations can be made as with android_app_import. |
| 1681 | func AndroidTestImportFactory() android.Module { |
| 1682 | module := &AndroidTestImport{} |
| 1683 | module.AddProperties(&module.properties) |
| 1684 | module.AddProperties(&module.dexpreoptProperties) |
| 1685 | module.AddProperties(&module.usesLibrary.usesLibraryProperties) |
| 1686 | module.AddProperties(&module.testProperties) |
Liz Kammer | 7e20dda | 2020-05-20 14:36:30 -0700 | [diff] [blame] | 1687 | module.AddProperties(&module.testImportProperties) |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1688 | module.populateAllVariantStructs() |
| 1689 | android.AddLoadHook(module, func(ctx android.LoadHookContext) { |
| 1690 | module.processVariants(ctx) |
| 1691 | }) |
| 1692 | |
Colin Cross | f30c453 | 2020-05-06 22:29:10 -0700 | [diff] [blame] | 1693 | module.dexpreopter.isTest = true |
| 1694 | |
Jaewoong Jung | a689ffe | 2020-05-01 15:50:08 -0700 | [diff] [blame] | 1695 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1696 | android.InitDefaultableModule(module) |
Jaewoong Jung | b28eb5f | 2019-08-27 15:01:50 -0700 | [diff] [blame] | 1697 | android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk") |
| 1698 | |
| 1699 | return module |
| 1700 | } |
| 1701 | |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1702 | type RuntimeResourceOverlay struct { |
| 1703 | android.ModuleBase |
| 1704 | android.DefaultableModuleBase |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1705 | android.OverridableModuleBase |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1706 | aapt |
| 1707 | |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1708 | properties RuntimeResourceOverlayProperties |
| 1709 | overridableProperties OverridableRuntimeResourceOverlayProperties |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1710 | |
Jaewoong Jung | 78ec5d8 | 2020-01-31 10:11:47 -0800 | [diff] [blame] | 1711 | certificate Certificate |
| 1712 | |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1713 | outputFile android.Path |
| 1714 | installDir android.InstallPath |
| 1715 | } |
| 1716 | |
| 1717 | type RuntimeResourceOverlayProperties struct { |
| 1718 | // the name of a certificate in the default certificate directory or an android_app_certificate |
| 1719 | // module name in the form ":module". |
| 1720 | Certificate *string |
| 1721 | |
Liz Kammer | 7fe241f | 2020-05-19 16:15:25 -0700 | [diff] [blame] | 1722 | // Name of the signing certificate lineage file. |
| 1723 | Lineage *string |
| 1724 | |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1725 | // optional theme name. If specified, the overlay package will be applied |
| 1726 | // only when the ro.boot.vendor.overlay.theme system property is set to the same value. |
| 1727 | Theme *string |
| 1728 | |
| 1729 | // if not blank, set to the version of the sdk to compile against. |
| 1730 | // Defaults to compiling against the current platform. |
| 1731 | Sdk_version *string |
| 1732 | |
| 1733 | // if not blank, set the minimum version of the sdk that the compiled artifacts will run against. |
| 1734 | // Defaults to sdk_version if not set. |
| 1735 | Min_sdk_version *string |
Jaewoong Jung | ca095d7 | 2020-04-09 16:15:30 -0700 | [diff] [blame] | 1736 | |
| 1737 | // list of android_library modules whose resources are extracted and linked against statically |
| 1738 | Static_libs []string |
| 1739 | |
| 1740 | // list of android_app modules whose resources are extracted and linked against |
| 1741 | Resource_libs []string |
Jaewoong Jung | bfc6ac0 | 2020-04-24 15:22:40 -0700 | [diff] [blame] | 1742 | |
| 1743 | // Names of modules to be overridden. Listed modules can only be other overlays |
| 1744 | // (in Make or Soong). |
| 1745 | // This does not completely prevent installation of the overridden overlays, but if both |
| 1746 | // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed |
| 1747 | // from PRODUCT_PACKAGES. |
| 1748 | Overrides []string |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1749 | } |
| 1750 | |
| 1751 | func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) { |
| 1752 | sdkDep := decodeSdkDep(ctx, sdkContext(r)) |
| 1753 | if sdkDep.hasFrameworkLibs() { |
| 1754 | r.aapt.deps(ctx, sdkDep) |
| 1755 | } |
| 1756 | |
| 1757 | cert := android.SrcIsModule(String(r.properties.Certificate)) |
| 1758 | if cert != "" { |
| 1759 | ctx.AddDependency(ctx.Module(), certificateTag, cert) |
| 1760 | } |
Jaewoong Jung | ca095d7 | 2020-04-09 16:15:30 -0700 | [diff] [blame] | 1761 | |
| 1762 | ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...) |
| 1763 | ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1764 | } |
| 1765 | |
| 1766 | func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
| 1767 | // Compile and link resources |
| 1768 | r.aapt.hasNoCode = true |
Jaewoong Jung | f0f747c | 2020-01-24 10:30:02 -0800 | [diff] [blame] | 1769 | // Do not remove resources without default values nor dedupe resource configurations with the same value |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1770 | aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"} |
| 1771 | // Allow the override of "package name" and "overlay target package name" |
| 1772 | manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName()) |
| 1773 | if overridden || r.overridableProperties.Package_name != nil { |
| 1774 | // The product override variable has a priority over the package_name property. |
| 1775 | if !overridden { |
| 1776 | manifestPackageName = *r.overridableProperties.Package_name |
| 1777 | } |
| 1778 | aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName) |
| 1779 | } |
| 1780 | if r.overridableProperties.Target_package_name != nil { |
| 1781 | aaptLinkFlags = append(aaptLinkFlags, |
| 1782 | "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name) |
| 1783 | } |
| 1784 | r.aapt.buildActions(ctx, r, aaptLinkFlags...) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1785 | |
| 1786 | // Sign the built package |
Colin Cross | eb03296 | 2020-05-13 11:05:02 -0700 | [diff] [blame] | 1787 | _, certificates := collectAppDeps(ctx, r, false, false) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1788 | certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx) |
| 1789 | signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk") |
Liz Kammer | 7fe241f | 2020-05-19 16:15:25 -0700 | [diff] [blame] | 1790 | var lineageFile android.Path |
| 1791 | if lineage := String(r.properties.Lineage); lineage != "" { |
| 1792 | lineageFile = android.PathForModuleSrc(ctx, lineage) |
| 1793 | } |
| 1794 | SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, nil, lineageFile) |
Jaewoong Jung | 78ec5d8 | 2020-01-31 10:11:47 -0800 | [diff] [blame] | 1795 | r.certificate = certificates[0] |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1796 | |
| 1797 | r.outputFile = signed |
| 1798 | r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme)) |
| 1799 | ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile) |
| 1800 | } |
| 1801 | |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 1802 | func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec { |
| 1803 | return sdkSpecFrom(String(r.properties.Sdk_version)) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1804 | } |
| 1805 | |
| 1806 | func (r *RuntimeResourceOverlay) systemModules() string { |
| 1807 | return "" |
| 1808 | } |
| 1809 | |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 1810 | func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec { |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1811 | if r.properties.Min_sdk_version != nil { |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 1812 | return sdkSpecFrom(*r.properties.Min_sdk_version) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1813 | } |
| 1814 | return r.sdkVersion() |
| 1815 | } |
| 1816 | |
Jiyong Park | 6a927c4 | 2020-01-21 02:03:43 +0900 | [diff] [blame] | 1817 | func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec { |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1818 | return r.sdkVersion() |
| 1819 | } |
| 1820 | |
| 1821 | // runtime_resource_overlay generates a resource-only apk file that can overlay application and |
| 1822 | // system resources at run time. |
| 1823 | func RuntimeResourceOverlayFactory() android.Module { |
| 1824 | module := &RuntimeResourceOverlay{} |
| 1825 | module.AddProperties( |
| 1826 | &module.properties, |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1827 | &module.aaptProperties, |
| 1828 | &module.overridableProperties) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1829 | |
Roshan Pius | b830796 | 2020-04-27 09:42:27 -0700 | [diff] [blame] | 1830 | android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) |
| 1831 | android.InitDefaultableModule(module) |
| 1832 | android.InitOverridableModule(module, &module.properties.Overrides) |
Jaewoong Jung | 9befb0c | 2020-01-18 10:33:43 -0800 | [diff] [blame] | 1833 | return module |
| 1834 | } |
| 1835 | |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1836 | type UsesLibraryProperties struct { |
| 1837 | // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file. |
| 1838 | Uses_libs []string |
| 1839 | |
| 1840 | // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with |
| 1841 | // required=false. |
| 1842 | Optional_uses_libs []string |
| 1843 | |
| 1844 | // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults |
| 1845 | // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future. |
| 1846 | Enforce_uses_libs *bool |
| 1847 | } |
| 1848 | |
| 1849 | // usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the |
| 1850 | // <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the |
| 1851 | // uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps |
| 1852 | // with knowledge of their shared libraries. |
| 1853 | type usesLibrary struct { |
| 1854 | usesLibraryProperties UsesLibraryProperties |
| 1855 | } |
| 1856 | |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 1857 | func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) { |
Colin Cross | 3245b2c | 2019-06-07 13:18:09 -0700 | [diff] [blame] | 1858 | if !ctx.Config().UnbundledBuild() { |
| 1859 | ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...) |
| 1860 | ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...) |
Paul Duffin | 250e619 | 2019-06-07 10:44:37 +0100 | [diff] [blame] | 1861 | // Only add these extra dependencies if the module depends on framework libs. This avoids |
| 1862 | // creating a cyclic dependency: |
| 1863 | // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res. |
| 1864 | if hasFrameworkLibs { |
Colin Cross | 3245b2c | 2019-06-07 13:18:09 -0700 | [diff] [blame] | 1865 | // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs |
| 1866 | // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each |
| 1867 | // library to dexpreopt. |
| 1868 | ctx.AddVariationDependencies(nil, usesLibTag, |
| 1869 | "org.apache.http.legacy", |
| 1870 | "android.hidl.base-V1.0-java", |
| 1871 | "android.hidl.manager-V1.0-java") |
| 1872 | } |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1873 | } |
| 1874 | } |
| 1875 | |
| 1876 | // presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the |
| 1877 | // build. |
| 1878 | func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string { |
| 1879 | optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries()) |
| 1880 | return optionalUsesLibs |
| 1881 | } |
| 1882 | |
| 1883 | // usesLibraryPaths returns a map of module names of shared library dependencies to the paths to their dex jars. |
| 1884 | func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) map[string]android.Path { |
| 1885 | usesLibPaths := make(map[string]android.Path) |
| 1886 | |
| 1887 | if !ctx.Config().UnbundledBuild() { |
| 1888 | ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) { |
| 1889 | if lib, ok := m.(Dependency); ok { |
| 1890 | if dexJar := lib.DexJar(); dexJar != nil { |
| 1891 | usesLibPaths[ctx.OtherModuleName(m)] = dexJar |
| 1892 | } else { |
| 1893 | ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must produce a dex jar, does it have installable: true?", |
| 1894 | ctx.OtherModuleName(m)) |
| 1895 | } |
| 1896 | } else if ctx.Config().AllowMissingDependencies() { |
| 1897 | ctx.AddMissingDependencies([]string{ctx.OtherModuleName(m)}) |
| 1898 | } else { |
| 1899 | ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", |
| 1900 | ctx.OtherModuleName(m)) |
| 1901 | } |
| 1902 | }) |
| 1903 | } |
| 1904 | |
| 1905 | return usesLibPaths |
| 1906 | } |
| 1907 | |
| 1908 | // enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs |
| 1909 | // properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true |
| 1910 | // unconditionally in the future. |
| 1911 | func (u *usesLibrary) enforceUsesLibraries() bool { |
| 1912 | defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 || |
| 1913 | len(u.usesLibraryProperties.Optional_uses_libs) > 0 |
| 1914 | return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs) |
| 1915 | } |
| 1916 | |
| 1917 | // verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified |
| 1918 | // in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest. |
| 1919 | func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path { |
| 1920 | outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml") |
| 1921 | |
| 1922 | rule := android.NewRuleBuilder() |
Colin Cross | ee94d6a | 2019-07-08 17:08:34 -0700 | [diff] [blame] | 1923 | cmd := rule.Command().BuiltTool(ctx, "manifest_check"). |
Colin Cross | 50ddcc4 | 2019-05-16 12:28:22 -0700 | [diff] [blame] | 1924 | Flag("--enforce-uses-libraries"). |
| 1925 | Input(manifest). |
| 1926 | FlagWithOutput("-o ", outputFile) |
| 1927 | |
| 1928 | for _, lib := range u.usesLibraryProperties.Uses_libs { |
| 1929 | cmd.FlagWithArg("--uses-library ", lib) |
| 1930 | } |
| 1931 | |
| 1932 | for _, lib := range u.usesLibraryProperties.Optional_uses_libs { |
| 1933 | cmd.FlagWithArg("--optional-uses-library ", lib) |
| 1934 | } |
| 1935 | |
| 1936 | rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>") |
| 1937 | |
| 1938 | return outputFile |
| 1939 | } |
| 1940 | |
| 1941 | // verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified |
| 1942 | // in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK. |
| 1943 | func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path { |
| 1944 | outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base()) |
| 1945 | |
| 1946 | rule := android.NewRuleBuilder() |
| 1947 | aapt := ctx.Config().HostToolPath(ctx, "aapt") |
| 1948 | rule.Command(). |
| 1949 | Textf("aapt_binary=%s", aapt.String()).Implicit(aapt). |
| 1950 | Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")). |
| 1951 | Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")). |
| 1952 | Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk) |
| 1953 | rule.Command().Text("cp -f").Input(apk).Output(outputFile) |
| 1954 | |
| 1955 | rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>") |
| 1956 | |
| 1957 | return outputFile |
| 1958 | } |