pj/sanderling

0 Fork 0

mirror of https://github.com/priyanshujain/sanderling.git synced 2026-10-02 19:17:10 +00:00

Files

T

pj d0578dbaaa fix(runner): warn on malformed screen snapshot (#13 )

* fix(runner): warn on malformed screen snapshot

screenFromSnapshot swallowed json.Unmarshal errors, so a non-string
screen value silently became "" in the step log and trace while the
verifier still saw the raw JSON. Return the error and warn at the
call site, matching the hierarchy warning pattern.

* docs: clarify --avd is optional for uatu test

The CLI accepts --avd as an empty-string default (cmd/uatu/main.go:49)
and only requires it when no device is connected and multiple AVDs
exist (cmd/uatu/android_env.go:63). Docs and examples that showed it
as required or always-passed were misleading.

2026-04-18 17:14:31 +07:00

1.6 KiB

Raw Blame History

title

title
Getting started

Getting started

Install the CLI, link the SDK into your debug build, run a spec.

Prerequisites

An Android emulator with API level 30 or newer.
The app under test built as a debug variant with the uatu Android SDK linked in.
adb on your PATH.

Run uatu doctor to check the host environment.

Install

CLI

macOS arm64:

curl -L https://github.com/priyanshujain/uatu/releases/latest/download/uatu_<version>_darwin_arm64.tar.gz | tar xz
./uatu version

Linux amd64:

curl -L https://github.com/priyanshujain/uatu/releases/latest/download/uatu_<version>_linux_amd64.tar.gz | tar xz
./uatu version

Pre-built for darwin/arm64, darwin/amd64, linux/amd64, linux/arm64.

Spec package (npm)

npm install --save-dev @uatu/spec

Android SDK (Maven Central)

dependencies {
    implementation("io.github.priyanshujain:sdk-android:<version>")
}

Your first run

The repo ships a working sample at examples/sample-app. From that directory:

npm install
(cd android && ./gradlew installDebug)
uatu test \
  --spec spec.ts \
  --bundle-id dev.uatu.sample \
  --platform android \
  --duration 2m

Pass --avd <name> only when no device is connected and you have multiple AVDs; otherwise uatu uses the connected device or boots the single AVD it finds.

When the run ends, the trace lands in runs/<timestamp>/:

runs/2026-04-18T12-34-56/
├── trace.jsonl
├── screenshots/
└── meta.json

Open the screenshots directory to scrub visually, or read trace.jsonl step by step.

Next: writing specs.

1.6 KiB Raw Blame History