-
Notifications
You must be signed in to change notification settings - Fork 738
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding the :baselineprofile module for Baseline and Startup Profiles …
…generating and benchmarking Signed-off-by: javernaut <[email protected]>
- Loading branch information
Showing
16 changed files
with
344 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| import com.android.build.api.dsl.ManagedVirtualDevice | ||
|
|
||
| plugins { | ||
| id 'com.android.test' | ||
| id 'org.jetbrains.kotlin.android' | ||
| id 'androidx.baselineprofile' | ||
| } | ||
|
|
||
| android { | ||
| namespace 'im.vector.app.baselineprofile' | ||
| compileSdk versions.compileSdk | ||
|
|
||
| compileOptions { | ||
| sourceCompatibility versions.sourceCompat | ||
| targetCompatibility versions.targetCompat | ||
| } | ||
|
|
||
| kotlinOptions { | ||
| jvmTarget = versions.jvmTarget | ||
| } | ||
|
|
||
| defaultConfig { | ||
| minSdk 28 | ||
| targetSdk versions.targetSdk | ||
|
|
||
| testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" | ||
| } | ||
|
|
||
| targetProjectPath = ":vector-app" | ||
|
|
||
| flavorDimensions += ["store"] | ||
| productFlavors { | ||
| gplay { dimension = "store" } | ||
| fdroid { dimension = "store" } | ||
| } | ||
|
|
||
| // This code creates the gradle managed device used to generate baseline profiles. | ||
| // To use GMD please invoke generation through the command line: | ||
| // ./gradlew :vector-app:generateBaselineProfile | ||
| testOptions.managedDevices.devices { | ||
| pixel6Api34(ManagedVirtualDevice) { | ||
| device = "Pixel 6" | ||
| apiLevel = versions.targetSdk | ||
| // Since play services are used for gplay build, using a google image | ||
| systemImageSource = "google" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // This is the configuration block for the Baseline Profile plugin. | ||
| // You can specify to run the generators on a managed devices or connected devices. | ||
| baselineProfile { | ||
| // Option 1: A Gradle Managed Device for profile generating | ||
| managedDevices += "pixel6Api34" | ||
| useConnectedDevices = false | ||
| // Option 2: For benchmarking the app with and without the profiles applied on a real device | ||
| // useConnectedDevices = true | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation libs.androidx.junit | ||
| implementation libs.androidx.testRunner | ||
| implementation libs.androidx.testUiAutomator | ||
| implementation libs.androidx.benchmarkMacroJunit | ||
| } | ||
|
|
||
| androidComponents { | ||
| onVariants(selector().all()) { v -> | ||
| def artifactsLoader = v.artifacts.getBuiltArtifactsLoader() | ||
| v.instrumentationRunnerArguments.put( | ||
| "targetAppId", | ||
| v.testedApks.map { artifactsLoader.load(it)?.applicationId } | ||
| ) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <manifest /> |
68 changes: 68 additions & 0 deletions
68
baselineprofile/src/main/java/im/vector/app/baselineprofile/BaselineProfileGenerator.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| package im.vector.app.baselineprofile | ||
|
|
||
| import androidx.benchmark.macro.junit4.BaselineProfileRule | ||
| import androidx.test.ext.junit.runners.AndroidJUnit4 | ||
| import androidx.test.filters.LargeTest | ||
| import androidx.test.platform.app.InstrumentationRegistry | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
|
|
||
| /** | ||
| * This test class generates a basic startup baseline profile for the target package. | ||
| * | ||
| * We recommend you start with this but add important user flows to the profile to improve their performance. | ||
| * Refer to the [baseline profile documentation](https://d.android.com/topic/performance/baselineprofiles) | ||
| * for more information. | ||
| * | ||
| * You can run the generator with the "Generate Baseline Profile" run configuration in Android Studio or | ||
| * the equivalent `generateBaselineProfile` gradle task: | ||
| * ``` | ||
| * ./gradlew :vector-app:generateReleaseBaselineProfile | ||
| * ``` | ||
| * The run configuration runs the Gradle task and applies filtering to run only the generators. | ||
| * | ||
| * Check [documentation](https://d.android.com/topic/performance/benchmarking/macrobenchmark-instrumentation-args) | ||
| * for more information about available instrumentation arguments. | ||
| * | ||
| * After you run the generator, you can verify the improvements running the [StartupBenchmarks] benchmark. | ||
| * | ||
| * When using this class to generate a baseline profile, only API 33+ or rooted API 28+ are supported. | ||
| * | ||
| * The minimum required version of androidx.benchmark to generate a baseline profile is 1.2.0. | ||
| **/ | ||
| @RunWith(AndroidJUnit4::class) | ||
| @LargeTest | ||
| class BaselineProfileGenerator { | ||
|
|
||
| @get:Rule | ||
| val rule = BaselineProfileRule() | ||
|
|
||
| @Test | ||
| fun generate() { | ||
| // The application id for the running build variant is read from the instrumentation arguments. | ||
| rule.collect( | ||
| packageName = InstrumentationRegistry.getArguments().getString("targetAppId") | ||
| ?: throw Exception("targetAppId not passed as instrumentation runner arg"), | ||
|
|
||
| // See: https://d.android.com/topic/performance/baselineprofiles/dex-layout-optimizations | ||
| includeInStartupProfile = true | ||
| ) { | ||
| // This block defines the app's critical user journey. Here we are interested in | ||
| // optimizing for app startup. But you can also navigate and scroll through your most important UI. | ||
|
|
||
| // Start default activity for your app | ||
| pressHome() | ||
| startActivityAndWait() | ||
|
|
||
| // TODO Write more interactions to optimize advanced journeys of your app. | ||
| // For example: | ||
| // 1. Wait until the content is asynchronously loaded | ||
| // 2. Scroll the feed content | ||
| // 3. Navigate to detail screen | ||
|
|
||
| // Check UiAutomator documentation for more information how to interact with the app. | ||
| // https://d.android.com/training/testing/other-components/ui-automator | ||
| } | ||
| } | ||
| } |
78 changes: 78 additions & 0 deletions
78
baselineprofile/src/main/java/im/vector/app/baselineprofile/StartupBenchmarks.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| package im.vector.app.baselineprofile | ||
|
|
||
| import androidx.benchmark.macro.BaselineProfileMode | ||
| import androidx.benchmark.macro.CompilationMode | ||
| import androidx.benchmark.macro.StartupMode | ||
| import androidx.benchmark.macro.StartupTimingMetric | ||
| import androidx.benchmark.macro.junit4.MacrobenchmarkRule | ||
| import androidx.test.ext.junit.runners.AndroidJUnit4 | ||
| import androidx.test.filters.LargeTest | ||
| import androidx.test.platform.app.InstrumentationRegistry | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
|
|
||
| /** | ||
| * This test class benchmarks the speed of app startup. | ||
| * Run this benchmark to verify how effective a Baseline Profile is. | ||
| * It does this by comparing [CompilationMode.None], which represents the app with no Baseline | ||
| * Profiles optimizations, and [CompilationMode.Partial], which uses Baseline Profiles. | ||
| * | ||
| * Run this benchmark to see startup measurements and captured system traces for verifying | ||
| * the effectiveness of your Baseline Profiles. You can run it directly from Android | ||
| * Studio as an instrumentation test, or run all benchmarks for a variant, for example benchmarkRelease, | ||
| * with this Gradle task: | ||
| * ``` | ||
| * ./gradlew :baselineprofile:connectedBenchmarkReleaseAndroidTest | ||
| * ``` | ||
| * | ||
| * You should run the benchmarks on a physical device, not an Android emulator, because the | ||
| * emulator doesn't represent real world performance and shares system resources with its host. | ||
| * | ||
| * For more information, see the [Macrobenchmark documentation](https://d.android.com/macrobenchmark#create-macrobenchmark) | ||
| * and the [instrumentation arguments documentation](https://d.android.com/topic/performance/benchmarking/macrobenchmark-instrumentation-args). | ||
| * | ||
| * Before starting the benchmarks from Android Studio's gutter, select the *BenchmarkRelease or release variants in Build Variants panel. | ||
| **/ | ||
| @RunWith(AndroidJUnit4::class) | ||
| @LargeTest | ||
| class StartupBenchmarks { | ||
|
|
||
| @get:Rule | ||
| val rule = MacrobenchmarkRule() | ||
|
|
||
| @Test | ||
| fun startupCompilationNone() = | ||
| benchmark(CompilationMode.None()) | ||
|
|
||
| @Test | ||
| fun startupCompilationBaselineProfiles() = | ||
| benchmark(CompilationMode.Partial(BaselineProfileMode.Require)) | ||
|
|
||
| private fun benchmark(compilationMode: CompilationMode) { | ||
| // The application id for the running build variant is read from the instrumentation arguments. | ||
| rule.measureRepeated( | ||
| packageName = InstrumentationRegistry.getArguments().getString("targetAppId") | ||
| ?: throw Exception("targetAppId not passed as instrumentation runner arg"), | ||
| metrics = listOf(StartupTimingMetric()), | ||
| compilationMode = compilationMode, | ||
| startupMode = StartupMode.COLD, | ||
| iterations = 10, | ||
| setupBlock = { | ||
| pressHome() | ||
| }, | ||
| measureBlock = { | ||
| startActivityAndWait() | ||
|
|
||
| // TODO Add interactions to wait for when your app is fully drawn. | ||
| // The app is fully drawn when Activity.reportFullyDrawn is called. | ||
| // For Jetpack Compose, you can use ReportDrawn, ReportDrawnWhen and ReportDrawnAfter | ||
| // from the AndroidX Activity library. | ||
|
|
||
| // Check the UiAutomator documentation for more information on how to | ||
| // interact with the app. | ||
| // https://d.android.com/training/testing/other-components/ui-automator | ||
| } | ||
| ) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.