Android test contract

The app owns the journey

An AASG capture is not a replacement for your test stack. Compose tests, Espresso, UI Automator, and your test fixtures continue to own navigation and app state, synchronization, locale/theme behavior, and deciding precisely when a frame is ready.

AASG sets up the requested capture variant, runs the configured test, and collects only the declared AndroidX Test Storage output. It never reads app-private files.

Write output through AndroidX Test Storage

Use PlatformTestStorageRegistry for every artifact. Keep paths deterministic and relative to the configured additional-output tree:

PlatformTestStorageRegistry.getInstance()
  .openOutputFile(CaptureOutputPaths.video("onboarding", "en", "light"))
  .use { output -> recorder.writeTo(output.fileDescriptor) }

The testkit path builders follow AASG’s inferred source convention. AASG looks for the fresh output of each capture variant under aasg/screenshots, aasg/videos, or aasg/json within that tree. It rejects missing or stale output.

System settings AASG may manage

For captures that request it, AASG temporarily switches Android navigation between gestural and three-button modes. For video captures it can also control Android’s Show taps setting. Capture defaults can also declare Android prerequisites before each variant: runtime permissions, roles, and named Android settings. This is a narrow exception to the app-owned state boundary: AASG only applies declared prerequisites and restores their original state after the run. Defaults that cannot be applied or restored are reported as run warnings rather than changing the capture result.

Choose show_taps: false when a video pipeline uses gesture_overlay; otherwise both native Android circles and rendered gesture cues would appear.

Record gesture metadata without a second automation layer

aasg-testkit records a timeline around test actions you already perform. Start it after the app-owned screen recorder begins, then write JSON sidecar metadata through AndroidX Test Storage. The helper does not navigate the app.

GestureTimeline(
  media = "onboarding-light.mp4",
  width = 1080,
  height = 2400,
  output = output,
  synchronize = { composeRule.waitForIdle() },
).start().use { journey ->
  journey.tap(GesturePoint(540, 1800)) {
    composeRule.onNodeWithTag("continue").performClick()
  }
}

See Semantic metadata for the sidecar contract and Rendering pipelines for gesture_overlay.