BaselineProfileRule

Artifact: androidx.benchmark:benchmark-macro-junit4

Added in 1.1.0

Kotlin |Java

@RequiresApi(value = 28)
public final class BaselineProfileRule implements TestRule

A TestRule that collects Baseline Profiles to be embedded in your APK.

These rules are used at install time to partially pre-compile your application code.

BaselineProfileRule is only supported on Android 13 (API 33) and above, or if using a rooted device, Android P (API 28) and above.

Note that you can specify a filterPredicate to filter captured rules, for example, if you're generating rules for a library, and don't want to record profiles from outside that library.

See the Baseline Profile Guide for more information on creating Baseline Profiles.

import androidx.benchmark.macro.junit4.BaselineProfileRule
import androidx.test.ext.junit.runners.AndroidJUnit4

@RunWith(AndroidJUnit4::class)
class AppBaselineProfileGenerator {
    @get:Rule val baselineProfileRule = BaselineProfileRule()

    @Test
    fun startup() =
        baselineProfileRule.collect(packageName = "com.example.my.application.id") {
            pressHome()
            // This block defines the scenario for which profiles are captured.
            // Here we are interested in optimizing for app startup, but you
            // could also navigate and scroll through your most important UI.
            startActivityAndWait()
        }
}

import androidx.benchmark.macro.junit4.BaselineProfileRule
import androidx.test.ext.junit.runners.AndroidJUnit4

@RunWith(AndroidJUnit4::class)
class LibraryBaselineProfileGenerator {
    @get:Rule val baselineProfileRule = BaselineProfileRule()

    @Test
    fun libraryStartupRules() =
        baselineProfileRule.collect(
            packageName = "com.example.my.application.id",
            filterPredicate = {
                // Only capture rules in the library's package, excluding test app code
                // Rules are prefixed by tag characters, followed by JVM method signature,
                // e.g. `HSPLcom/mylibrary/LibraryClass;-><init>()V`, where `L`
                // signifies the start of the package/class, and '/' is divider instead of '.'
                val libPackagePrefix = "com.mylibrary"
                it.contains("^.*L${libPackagePrefix.replace(".", "/")}".toRegex())
            }
        ) {
            startActivityAndWait()
        }
}

Summary

Public constructors
`BaselineProfileRule()`

Public methods
`@NonNull Statement`	`apply(@NonNull Statement base, @NonNull Description description)`
`final void`	`collect( @NonNull String packageName, int maxIterations, int stableIterations, String outputFilePrefix, boolean includeInStartupProfile, boolean strictStability, @NonNull Function1<@NonNull String, @NonNull Boolean> filterPredicate, @ExtensionFunctionType @NonNull Function1<@NonNull MacrobenchmarkScope, Unit> profileBlock )` Collects baseline profiles for a critical user journey, while ensuring that the generated profiles are stable for a minimum of `stableIterations`.
`final @NonNull BaselineProfileResult`	`collectWithResults( @NonNull String packageName, int maxIterations, int stableIterations, String outputFilePrefix, boolean includeInStartupProfile, boolean strictStability, @NonNull Function1<@NonNull String, @NonNull Boolean> filterPredicate, @ExtensionFunctionType @NonNull Function1<@NonNull MacrobenchmarkScope, Unit> profileBlock )` Collects baseline profiles for a critical user journey, while ensuring that the generated profiles are stable for a minimum of `stableIterations`.

Public constructors