Merge pull request #259 from android/unify-benchmarks-in-single-module

Unifying benchmarks in a single module

Author: Murat Yener

.github/workflows/macrobenchmark.yml

@@ -56,5 +56,10 @@ jobs:
       - name: Build Macrobenchmark Sample
         run: >
           ./gradlew assemble \
-            -x :baselineProfile:pixel6Api31NonMinifiedReleaseAndroidTest \
-            -x :baselineProfile:collectNonMinifiedReleaseBaselineProfile
+            -x :macrobenchmark:pixel6Api31NonMinifiedReleaseAndroidTest \
+            -x :macrobenchmark:collectNonMinifiedReleaseBaselineProfile \
+            -Pandroidx.benchmark.enabledRules=BaselineProfile \
+            -Pandroid.testoptions.manageddevices.emulator.gpu="swiftshader_indirect" \
+            -Pandroid.experimental.testOptions.managedDevices.setupTimeoutMinutes=180 \
+            -Pandroid.experimental.androidTest.numManagedDeviceShards=1 \
+            -Pandroid.experimental.testOptions.managedDevices.maxConcurrentDevices=1

MacrobenchmarkSample/app/build.gradle.kts

@@ -103,5 +103,5 @@ dependencies {
     implementation(libs.viewmodel)
     androidTestImplementation(libs.benchmark.junit)
 
-    baselineProfile(project(":baselineProfile"))
+    baselineProfile(project(":macrobenchmark"))
 }

MacrobenchmarkSample/baseBenchmarks/.gitignore

@@ -1,8 +1,26 @@
+/*
+ * Copyright 2023 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import com.android.build.api.dsl.ManagedVirtualDevice
 
 plugins {
+    id("kotlin-android")
     alias(libs.plugins.test)
     alias(libs.plugins.kotlin)
+    alias(libs.plugins.baselineprofile)
 }
 
 // [START macrobenchmark_setup_android]
@@ -12,19 +30,22 @@ android {
     namespace = "com.example.macrobenchmark"
 
     defaultConfig {
-        minSdk = 23 // Minimum supported version for macrobenchmark
+        // Minimum supported version for Baseline Profiles.
+        // On lower APIs, apps are fully AOT compile, therefore Baseline Profiles aren't needed.
+        minSdk = 24
         targetSdk = 34
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
     }
 
     targetProjectPath = ":app"
 
     compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_11
-        targetCompatibility = JavaVersion.VERSION_11
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
     }
+
     kotlinOptions {
-        jvmTarget = JavaVersion.VERSION_11.toString()
+        jvmTarget = JavaVersion.VERSION_17.toString()
     }
 
     testOptions.managedDevices.devices {
@@ -54,8 +75,18 @@ android {
 }
 // [END macrobenchmark_setup_android]
 
+baselineProfile {
+
+    // This specifies the managed devices to use that you run the tests on. The default
+    // is none.
+    managedDevices += "pixel6Api31"
+
+    // This enables using connected devices to generate profiles. The default is true.
+    // When using connected devices, they must be rooted or API 33 and higher.
+    useConnectedDevices = false
+}
+
 dependencies {
-    implementation(project(":baseBenchmarks"))
     implementation(libs.benchmark.junit)
     implementation(libs.androidx.junit)
     implementation(libs.espresso)

MacrobenchmarkSample/baseBenchmarks/build.gradle.kts

@@ -1,5 +1,6 @@
-<?xml version="1.0" encoding="utf-8"?><!--
-  ~ Copyright 2022 The Android Open Source Project
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ Copyright 2023 The Android Open Source Project
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -15,8 +16,9 @@
   -->
 
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
-
     <!-- Requesting legacy storage is needed to be able to write to additionalTestOutputDir on API 29 -->
     <application android:requestLegacyExternalStorage="true" />
-
-</manifest>
+    <queries>
+        <package android:name="com.example.macrobenchmark.target" />
+    </queries>
+</manifest>