Android/cleanup app release install (#4996)

vaslabs · web-flow · commit ee30b0afc5d8 · 2025-04-28T06:22:13.000+08:00
## Summary - **better organisation** between androidmodule and androidappmodule (separate properly what things are used in apps and things that are shared between lib building and app building) - R8 and D8 **dex generation** depending on build type settings - **Instrumented tests** now use the android application namespace and id and adding a "variant" indicator - introduced a lite version of **build type settings** with main motivation to control r8 and d8 but also serve as a scaffolding for build variants - **Android manifest** has less hardcoded parameters (uses-sdk and instrumentation tags are now generated) - Minor change into **testTask** to keep it consistent with the rest of modules(Task.Anon) and thus the test-report is now in `testForked.dest` ## R8 and Proguard Followed similar configuration style with gradle ![image](https://github.com/user-attachments/assets/c2c99135-6381-4c91-9ce2-ac5e666f5a33) Although there's still work to be done in that area, if minification is enabled, we use the R8 tool to generate the dex otherwise the d8 (which also uses proguard for now) . This needs further work and clarification as AGP seems to be using R8 by default when minification is enabled, otherwise d8 is used. Proguard default files are also fetched (as an opt-in setting) from the Android SDK directories ## Build settings I've introduced a first very minimal step for doing build variants, mainly out of necessity to manage R8 and D8 variations better, but this will be expanded once we need to fully support build variants. The settings so far concerned the R8 use case at hand and it's a case class that has the parameters to feed proguard files and flags into R8. ## R8 enhancements Extending the work from #4892 , I've made some usability enhancements and enriched the examples to demonstrate how instrumented tests can be used alongside R8 and release builds. I think R8 now can be fairly usable to generate minified and optimised release builds without getting in the middle of development (e.g. running tests and testing in the emulator) although more work needs to be done towards that area, but we'll follow up after we do more exploratory usability testing! ## Future work Following this work, we can move to complete the work on architecture samples by testing instrumented tests, unit tests and later on debug variants. The cleanup also reduced a lot of duplication between `AndroidAppModule` and `AndroidModule` so it will make our development efforts a bit easier to add more features! More discovery work will follow to align the instrumented test apk installation more in line with AGP
diff --git a/example/androidlib/java/1-hello-world/app/src/main/AndroidManifest.xml b/example/androidlib/java/1-hello-world/app/src/main/AndroidManifest.xml
@@ -1,5 +1,4 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
-    <uses-sdk android:minSdkVersion="9" android:targetSdkVersion="35"/>
     <application android:label="@string/app_name" android:theme="@android:style/Theme.Light.NoTitleBar" android:debuggable="true">
         <activity android:name=".MainActivity"
                 android:exported="true">
@@ -9,7 +8,4 @@
             </intent-filter>
         </activity>
     </application>
-    <instrumentation
-            android:name="androidx.test.runner.AndroidJUnitRunner"
-            android:targetPackage="com.helloworld.app" />
 </manifest>
diff --git a/example/androidlib/java/1-hello-world/build.mill b/example/androidlib/java/1-hello-world/build.mill
@@ -45,8 +45,6 @@ object app extends AndroidAppModule {
 
     def androidSdkModule = mill.define.ModuleRef(androidSdkModule0)
 
-    override def instrumentationPackage = "com.helloworld.app"
-
     /* TODO currently the dependency resolution ignores the platform type and kotlinx-coroutines-core has
      * conflicting classes with kotlinx-coroutines-core-jvm . Remove the exclusions once the dependency
      * resolution resolves conflicts between androidJvm and jvm platform types
@@ -141,7 +139,7 @@ object app extends AndroidAppModule {
 ]
 ...
 
-> cat out/app/it/testTask.dest/test-report.xml
+> cat out/app/it/testForked.dest/test-report.xml
 ...
 <?xml version='1.0' encoding='UTF-8'?>
 <testsuites tests="1" failures="0" errors="0" skipped="0" time="...">
diff --git a/example/androidlib/java/2-app-bundle/bundle/src/main/AndroidManifest.xml b/example/androidlib/java/2-app-bundle/bundle/src/main/AndroidManifest.xml
@@ -1,5 +1,4 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
-    <uses-sdk android:minSdkVersion="9" android:targetSdkVersion="35"/>
     <application android:label="@string/app_name" android:theme="@android:style/Theme.Light.NoTitleBar" android:debuggable="true">
         <activity android:name=".MainActivity"
                 android:exported="true">
diff --git a/example/androidlib/java/3-linting/app/src/main/AndroidManifest.xml b/example/androidlib/java/3-linting/app/src/main/AndroidManifest.xml
@@ -1,5 +1,4 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
-    <uses-sdk android:minSdkVersion="9" android:targetSdkVersion="35"/>
     <application android:label="@string/app_name" android:theme="@android:style/Theme.Light.NoTitleBar" android:debuggable="true">
         <activity android:name=".MainActivity"
                 android:exported="true">
diff --git a/example/androidlib/java/3-linting/build.mill b/example/androidlib/java/3-linting/build.mill
@@ -67,7 +67,7 @@ lint.xml
 src
 
 > cat out/app/androidLintRun.dest/report.txt # Display content of the linting report
-AndroidManifest.xml:3: ...Error: Avoid hardcoding the debug mode; leaving it out allows debug and release builds to automatically assign one [HardcodedDebugMode]
+AndroidManifest.xml:2: ...Error: Avoid hardcoding the debug mode; leaving it out allows debug and release builds to automatically assign one [HardcodedDebugMode]
 
 > sed -i.bak 's/ android:debuggable="true"//g' app/src/main/AndroidManifest.xml # Fix the HardcodedDebugMode warning issue from `AndroidManifest.xml`
 
@@ -91,7 +91,7 @@ AndroidManifest.xml:3: ...Error: Avoid hardcoding the debug mode; leaving it out
 > ./mill app.androidLintRun # Rerun it for new changes to reflect
 
 > cat out/app/androidLintRun.dest/report.txt # Output the changes in the report
-AndroidManifest.xml:3: ...Warning: Should explicitly set android:icon, there is no default [MissingApplicationIcon]
+AndroidManifest.xml:2: ...Warning: Should explicitly set android:icon, there is no default [MissingApplicationIcon]
 
 > sed -i.bak 's/severity="warning"/severity="ignore"/g' app/lint.xml # Revert the severity level of `MissingApplicationIcon`
 
diff --git a/example/androidlib/java/4-sum-lib-java/app/src/main/AndroidManifest.xml b/example/androidlib/java/4-sum-lib-java/app/src/main/AndroidManifest.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
-    <uses-sdk android:minSdkVersion="9" android:targetSdkVersion="35"/>
     <application android:label="Calculator" android:theme="@android:style/Theme.Light.NoTitleBar" android:debuggable="true">
         <activity android:name=".Main"
                 android:exported="true">
diff --git a/example/androidlib/java/4-sum-lib-java/build.mill b/example/androidlib/java/4-sum-lib-java/build.mill
@@ -28,6 +28,8 @@ object lib extends AndroidLibModule with PublishModule {
   def androidMinSdk = 19
   def androidCompileSdk = 35
 
+  def androidLibPackage = "com.example"
+
   def publishVersion = "0.0.1"
   def pomSettings = PomSettings(
     description = "sumlib",
diff --git a/example/androidlib/java/4-sum-lib-java/lib/src/main/AndroidManifest.xml b/example/androidlib/java/4-sum-lib-java/lib/src/main/AndroidManifest.xml
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example" android:versionCode="1" android:versionName="1.0">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
 
 </manifest>
diff --git a/example/androidlib/java/5-R8/app/src/main/AndroidManifest.xml b/example/androidlib/java/5-R8/app/src/main/AndroidManifest.xml
@@ -1,5 +1,4 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.helloworld.app" android:versionCode="1" android:versionName="1.0">
-    <uses-sdk android:minSdkVersion="9" android:targetSdkVersion="35"/>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
     <application android:label="@string/app_name" android:theme="@android:style/Theme.Light.NoTitleBar" android:debuggable="true">
         <activity android:name=".MainActivity"
                 android:exported="true">
@@ -9,7 +8,4 @@
             </intent-filter>
         </activity>
     </application>
-    <instrumentation
-            android:name="androidx.test.runner.AndroidJUnitRunner"
-            android:targetPackage="com.helloworld.app" />
 </manifest>
diff --git a/example/androidlib/java/5-R8/app/test-proguard-rules.pro b/example/androidlib/java/5-R8/app/test-proguard-rules.pro
@@ -9,6 +9,7 @@
 # Keep all annotation metadata (needed for reflection-based test frameworks)
 -keepattributes *Annotation*
 
+-keep class com.helloworld.app.** { *; }
 # Keep all Espresso framework classes and specifically ensure that the idling resources aren’t stripped
 -keep class androidx.test.espresso.** { *; }
 -keep class androidx.test.espresso.IdlingRegistry { *; }
diff --git a/example/androidlib/java/5-R8/build.mill b/example/androidlib/java/5-R8/build.mill
@@ -43,6 +43,15 @@ object app extends AndroidAppModule { // <2>
   def androidReleaseKeyStorePass: T[Option[String]] = Task { Some("MillBuildTool") }
 
   override def androidVirtualDeviceIdentifier: String = "java-test"
+  override def androidIsDebug: T[Boolean] = Task { false }
+
+  override def androidReleaseSettings: T[AndroidBuildTypeSettings] = Task {
+    super.androidReleaseSettings().withProguardLocalFiles(
+      Seq(
+        moduleDir / "proguard-rules.pro"
+      )
+    )
+  }
 
   // Unit tests for the application
   object test extends AndroidAppTests with TestModule.Junit4 {
@@ -54,7 +63,14 @@ object app extends AndroidAppModule { // <2>
   // Instrumented tests (runs on emulator)
   object it extends AndroidAppInstrumentedTests with AndroidTestModule.AndroidJUnit {
     def androidSdkModule = mill.define.ModuleRef(androidSdkModule0)
-    override def instrumentationPackage = "com.helloworld.app"
+
+    override def androidIsDebug: T[Boolean] = Task {
+      false
+    }
+
+    override def androidReleaseSettings: T[AndroidBuildTypeSettings] = Task {
+      AndroidBuildTypeSettings(isMinifyEnabled = false)
+    }
 
     /* TODO currently the dependency resolution ignores the platform type and kotlinx-coroutines-core has
      * conflicting classes with kotlinx-coroutines-core-jvm . Remove the exclusions once the dependency
@@ -80,25 +96,39 @@ object app extends AndroidAppModule { // <2>
 /** Usage
 
 > ./mill show app.androidApk
-".../out/app/androidApk.dest/app.apk"
 
 > ./mill show app.createAndroidVirtualDevice
 ...Name: java-test, DeviceId: medium_phone...
 
 > ./mill show app.startAndroidEmulator
 
-> ./mill show app.androidReleaseInstall
+> ./mill show app.androidInstall
 ...All files should be loaded. Notifying the device...
 
+> ./mill show app.it
+...
+[
+  "",
+  [
+    {
+      "fullyQualifiedName": "com.helloworld.app.ExampleInstrumentedTest.useAppContext",
+      "selector": "com.helloworld.app.ExampleInstrumentedTest.useAppContext",
+      "duration": ...,
+      "status": "Success"
+    }
+  ]
+]
+
+
 > ./mill show app.stopAndroidEmulator
 
 > ./mill show app.deleteAndroidVirtualDevice
 
 */
 
-// R8 will run automatically when you run the `androidReleaseInstall` task.
-// If you want to create the APK without R8, you can use the `androidApk` task to create the not-optimized APK. You can also
+// R8 will run automatically when you run the `androidInstall` task with androidIsDebug set to false.
+// If you want to create the APK without R8, you can set the androidReleaseSettings isMinifyEnabled to false. You can also
 // run the `andoidInstall` task that will automaticaly run the `androidApk` and also install it in the emulator.
-// The `androidReleaseInstall` task will install the optimized APK on the emulator.
+// The release settings used in `androidInstall` task will install the optimized APK on the emulator.
 // So first you need to create the emulator and start it.
 // After the emulator is started, you can run the `androidReleaseInstall` task and see the app in the emulator.
diff --git a/example/androidlib/kotlin/1-hello-kotlin/app/proguard-rules.pro b/example/androidlib/kotlin/1-hello-kotlin/app/proguard-rules.pro
@@ -13,12 +13,10 @@
 #   public *;
 #}
 
-# Uncomment this to preserve the line number information for
-# debugging stack traces.
-#-keepattributes SourceFile,LineNumberTable
+# Suppress warnings
+-ignorewarnings
 
-# If you keep the line number information, uncomment this to
-# hide the original source file name.
--renamesourcefileattribute SourceFilex
+# Keep all annotation metadata (needed for reflection-based test frameworks)
+-keepattributes *Annotation*
 
 -keep class com.helloworld.** { *; }
diff --git a/example/androidlib/kotlin/1-hello-kotlin/app/src/main/AndroidManifest.xml b/example/androidlib/kotlin/1-hello-kotlin/app/src/main/AndroidManifest.xml
@@ -1,5 +1,4 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
-    <uses-sdk android:minSdkVersion="9" android:targetSdkVersion="35"/>
     <application android:label="@string/app_name" android:theme="@android:style/Theme.Light.NoTitleBar" android:debuggable="true">
         <activity android:name=".MainActivity"
                 android:exported="true">
@@ -9,8 +8,4 @@
             </intent-filter>
         </activity>
     </application>
-    <!-- TODO this needs to be constructed by Mill's integration tests (android tests) -->
-    <instrumentation
-            android:name="androidx.test.runner.AndroidJUnitRunner"
-            android:targetPackage="com.helloworld.app" />
 </manifest>
diff --git a/example/androidlib/kotlin/1-hello-kotlin/app/test-proguard-rules.pro b/example/androidlib/kotlin/1-hello-kotlin/app/test-proguard-rules.pro
@@ -11,6 +11,7 @@
 
 # Keep all Espresso framework classes and specifically ensure that the idling resources aren’t stripped
 -keep class androidx.test.espresso.** { *; }
+-keep class androidx.test.** { *; }
 -keep class androidx.test.espresso.IdlingRegistry { *; }
 -keep class androidx.test.espresso.IdlingResource { *; }
 
diff --git a/example/androidlib/kotlin/1-hello-kotlin/build.mill b/example/androidlib/kotlin/1-hello-kotlin/build.mill
@@ -41,13 +41,36 @@ object app extends AndroidAppKotlinModule {
   override def androidVirtualDeviceIdentifier: String = "kotlin-test"
   override def androidEmulatorPort: String = "5556"
 
+  override def androidIsDebug: T[Boolean] = Task { false }
+
+  override def androidReleaseSettings: T[AndroidBuildTypeSettings] = Task {
+    super.androidReleaseSettings()
+      .withDefaultProguardFile("proguard-android.txt")
+      .withProguardLocalFiles(
+        Seq(
+          moduleDir / "proguard-rules.pro"
+        )
+      )
+  }
+
   object test extends AndroidAppKotlinTests with TestModule.Junit4 {
     def junit4Version = "4.13.2"
   }
 
   object it extends AndroidAppKotlinInstrumentedTests with AndroidTestModule.AndroidJUnit {
 
-    override def instrumentationPackage = "com.helloworld.app"
+    // TODO currently instrumented tests debug mode
+    // is coupled with the app debug mode. Fix so
+    // that instrumented tests can be built with debug
+    // configuration but the apk signature will match
+    // the app apk
+    override def androidIsDebug: T[Boolean] = Task {
+      false
+    }
+
+    override def androidReleaseSettings: T[AndroidBuildTypeSettings] = Task {
+      AndroidBuildTypeSettings(isMinifyEnabled = false)
+    }
 
     /* TODO currently the dependency resolution ignores the platform type and kotlinx-coroutines-core has
      * conflicting classes with kotlinx-coroutines-core-jvm . Remove the exclusions once the dependency
@@ -75,18 +98,6 @@ object app extends AndroidAppKotlinModule {
 > ./mill show app.androidApk
 ".../out/app/androidApk.dest/app.apk"
 
-> ./mill show app.createAndroidVirtualDevice
-...Name: kotlin-test, DeviceId: medium_phone...
-
-> ./mill show app.startAndroidEmulator
-
-> ./mill show app.androidReleaseInstall
-...All files should be loaded. Notifying the device...
-
-> ./mill show app.stopAndroidEmulator
-
-> ./mill show app.deleteAndroidVirtualDevice
-
 */
 
 // This command triggers the build process, which installs the Android Setup, compiles the kotlin
@@ -156,7 +167,7 @@ object app extends AndroidAppKotlinModule {
 ]
 ...
 
-> cat out/app/it/testTask.dest/test-report.xml
+> cat out/app/it/testForked.dest/test-report.xml
 ...
 <?xml version='1.0' encoding='UTF-8'?>
 <testsuites tests="1" failures="0" errors="0" skipped="0" time="...">
diff --git a/example/androidlib/kotlin/3-compose-screenshot-tests/app/src/main/AndroidManifest.xml b/example/androidlib/kotlin/3-compose-screenshot-tests/app/src/main/AndroidManifest.xml
@@ -1,8 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!--    Adopted from AGP screenshot test template, a sample can be found in-->
 <!--    https://github.com/vaslabs-ltd/android-screenshot-test-sample/blob/main/app/src/main/AndroidManifest.xml-->
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.example.screenshottest">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
     <application
         android:allowBackup="true"
diff --git a/example/androidlib/kotlin/4-sum-lib-kotlin/app/src/main/AndroidManifest.xml b/example/androidlib/kotlin/4-sum-lib-kotlin/app/src/main/AndroidManifest.xml
@@ -1,5 +1,4 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
-    <uses-sdk android:minSdkVersion="9" android:targetSdkVersion="35"/>
     <application android:label="@string/app_name" android:theme="@android:style/Theme.Light.NoTitleBar" android:debuggable="true">
         <activity android:name=".MainActivity"
                 android:exported="true">
diff --git a/example/androidlib/kotlin/4-sum-lib-kotlin/build.mill b/example/androidlib/kotlin/4-sum-lib-kotlin/build.mill
@@ -28,6 +28,8 @@ object lib extends AndroidLibKotlinModule with PublishModule {
   def androidCompileSdk = 35
   def kotlinVersion = "2.0.20"
 
+  def androidLibPackage = "com.example"
+
   def publishVersion = "0.0.1"
   def pomSettings = PomSettings(
     description = "sumlib",
diff --git a/example/androidlib/kotlin/4-sum-lib-kotlin/lib/src/main/AndroidManifest.xml b/example/androidlib/kotlin/4-sum-lib-kotlin/lib/src/main/AndroidManifest.xml
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example" android:versionCode="1" android:versionName="1.0">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">
 
 </manifest>
diff --git a/example/thirdparty/androidtodo/build.mill b/example/thirdparty/androidtodo/build.mill
@@ -111,10 +111,9 @@ object app extends AndroidAppKotlinModule with AndroidBuildConfig with AndroidHi
     )
   }
 
-  object androidTest extends AndroidAppKotlinInstrumentedTests with AndroidTestModule.AndroidJUnit {
-    override def instrumentationPackage = "com.example.android"
-
-  }
+  // TODO support instrumented tests on Hilt setups
+  object androidTest extends AndroidAppKotlinInstrumentedTests
+      with AndroidTestModule.AndroidJUnit {}
 
 }
 
diff --git a/libs/androidlib/src/mill/androidlib/AndroidAppKotlinModule.scala b/libs/androidlib/src/mill/androidlib/AndroidAppKotlinModule.scala
@@ -66,8 +66,6 @@ trait AndroidAppKotlinModule extends AndroidAppModule with AndroidKotlinModule {
 
     override def androidCompileSdk: T[Int] = outer.androidCompileSdk()
 
-    override def androidMergedManifest: T[PathRef] = outer.androidMergedManifest()
-
     override def androidSdkModule: ModuleRef[AndroidSdkModule] = outer.androidSdkModule
 
     // FIXME: avoid hardcoded version
diff --git a/libs/androidlib/src/mill/androidlib/AndroidAppModule.scala b/libs/androidlib/src/mill/androidlib/AndroidAppModule.scala
diff --git a/libs/androidlib/src/mill/androidlib/AndroidBuildTypeSettings.scala b/libs/androidlib/src/mill/androidlib/AndroidBuildTypeSettings.scala
diff --git a/libs/androidlib/src/mill/androidlib/AndroidLibModule.scala b/libs/androidlib/src/mill/androidlib/AndroidLibModule.scala
diff --git a/libs/androidlib/src/mill/androidlib/AndroidModule.scala b/libs/androidlib/src/mill/androidlib/AndroidModule.scala
diff --git a/libs/androidlib/src/mill/androidlib/AndroidModuleGeneratedDexVariants.scala b/libs/androidlib/src/mill/androidlib/AndroidModuleGeneratedDexVariants.scala
diff --git a/libs/androidlib/src/mill/androidlib/AndroidSdkModule.scala b/libs/androidlib/src/mill/androidlib/AndroidSdkModule.scala

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:versionCode="1" android:versionName="1.0">`
`2`		`- <uses-sdk android:minSdkVersion="9" android:targetSdkVersion="35"/>`
`3`	`2`	`<application android:label="@string/app_name" android:theme="@android:style/Theme.Light.NoTitleBar" android:debuggable="true">`
`4`	`3`	`<activity android:name=".MainActivity"`
`5`	`4`	`android:exported="true">`