You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
iceraven-browser/benchmark/src/main/java/org/mozilla/fenix/benchmark/BaselineProfilesStartupBenc...

71 lines
3.0 KiB
Kotlin

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package org.mozilla.fenix.benchmark
import android.os.Build
import androidx.annotation.RequiresApi
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 org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith
import org.mozilla.fenix.benchmark.utils.measureRepeatedDefault
/**
* 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.
*
* Before running make sure `autosignReleaseWithDebugKey=true` is present in local.properties.
*
* 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 that logs the benchmark metrics with links to the Perfetto traces,
*
* or using the gradle command:
*
* ```
* ./gradlew :benchmark:connectedBenchmarkAndroidTest -P android.testInstrumentationRunnerArguments.class=org.mozilla.fenix.benchmark.BaselineProfilesStartupBenchmark -P benchmarkTest
* ```
*
* The metric results will be in `benchmark/build/outputs/connected_android_test_additional_output` folder.
*
* Run the benchmarks on a physical device, not an 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).
**/
@RunWith(AndroidJUnit4::class)
@RequiresApi(Build.VERSION_CODES.N)
class BaselineProfilesStartupBenchmark {
@get:Rule
val benchmarkRule = MacrobenchmarkRule()
@Test
fun startupNone() = startupBenchmark(CompilationMode.None())
@Test
fun startupPartialWithBaselineProfiles() =
startupBenchmark(CompilationMode.Partial(baselineProfileMode = BaselineProfileMode.Require))
private fun startupBenchmark(compilationMode: CompilationMode) =
benchmarkRule.measureRepeatedDefault(
metrics = listOf(StartupTimingMetric()),
startupMode = StartupMode.COLD,
compilationMode = compilationMode,
setupBlock = {
pressHome()
},
) {
startActivityAndWait()
}
}