refactor: rename project uatu -> sanderling (#24)

* refactor: rename Go module path uatu -> sanderling

Module path github.com/priyanshujain/uatu -> github.com/priyanshujain/sanderling,
including all imports and the proto go_package option. Generated .pb.go files
rewritten in-place; safe to regenerate with protoc later.

* chore(proto): regenerate driverpb after module path rename

The previous sed-based module rename corrupted the embedded descriptor
byte lengths. buf generate rewrites them cleanly.

* refactor: rename CLI binary uatu -> sanderling

Updates Makefile target + UATU_BIN var, .goreleaser project/build IDs,
.gitignore comment, and all user-facing strings in the CLI help text,
error messages, and tests. Binary is now bin/sanderling.

* refactor(sdk): rename Kotlin package dev.uatu.sdk -> dev.sanderling.sdk

Moves sdk/android/src/{main,test}/kotlin/dev/uatu -> dev/sanderling and
rewrites package declarations, imports, and the Gradle namespace. Class
names (Uatu, UatuRuntime) are renamed in a follow-up commit.

* refactor(sidecar): rename Kotlin package dev.uatu.sidecar -> dev.sanderling.sidecar

Moves sidecar/src/{main,test}/kotlin/dev/uatu -> dev/sanderling and
rewrites package declarations, imports, and the application mainClass.

* refactor: rename Uatu API surface -> Sanderling

- Kotlin: Uatu -> Sanderling, UatuRuntime -> SanderlingRuntime (+ files).
- JS host binding: globalThis.__uatu__ -> __sanderling__ (Go verifier,
  spec-api, tests).
- TS interface: UatuRuntime -> SanderlingRuntime; internal tags
  __uatuFormula / __uatuActionGenerator -> __sanderling* variants.
- Go trace: UatuVersion field + uatu_version JSON tag renamed.
- Socket naming: uatu-agent / uatu-agent-reader -> sanderling-agent*.
- Sample app, docs, inline-JS test strings updated to match.

* refactor(examples): rename examples/folio/uatu -> examples/folio/sanderling

Renames the example spec directory; updates justfile paths + gitignore
entries accordingly. Package.json name/description and @uatu/spec
dependency are renamed in the npm + docs commits.

* chore(build): rename gradle property + rootProject.name uatu -> sanderling

- Renames the uatu.version gradle property and all its -P references in
  Makefile, build.gradle.kts files, and .github/workflows/release.yml.
- settings.gradle.kts rootProject.name = "sanderling".
- Renames .env.local.example header + release-cli workflow job name.

* refactor(proto): rename proto package uatu.driver.v1 -> sanderling.driver.v1

Updates the proto package and java_package, regenerates driver.pb.go +
driver_grpc.pb.go, rewrites Kotlin imports and the gRPC ServiceName
assertion in driver_test.go.

* refactor: rename npm package @uatu/spec -> @sanderling/spec

Renames package name in pkg/spec-api/package.json + lockfile, all
consumer imports (examples/folio spec, testdata, verifier tests), the
esbuild alias in cmd/sanderling/test_run.go, and related doc references.

* docs: rename uatu -> sanderling in README, docs, and URLs

- README + docs/{manual,development}/*: narrative + GitHub + Pages URLs.
- POM + npm package.json repo/homepage/bugs URLs.
- .gitignore + embed_stub + Makefile-comment references updated to
  'make sanderling'.
- Minor narrative comments in cmd/sanderling/test_run.go and
  internal/inspect/server.go.

* refactor: rename remaining internal uatu strings -> sanderling

- SANDERLING_TEST_PHONE/OTP env vars (cmd + bundler tests).
- sanderling-sidecar runtime tmp dir + extracted JAR filename.
- Inspect web UI: @sanderling/inspect-web package, title, theme
  localStorage key, RunList empty-state copy, uatu_version TS field.
- Sample app storage key sanderling.ledger.v1.
- Test data: sanderling_test AVD name + com.example.sanderling_test.
- Release docs tarball name template.
This commit is contained in:
pj authored and GitHub committed 2026-04-21 11:57:49 +07:00
1 parent 13bb2feb82
commit 8ccf95c1cf
111 files changed
+514 -514

No files matched your search

+6 -6
View File
@@ -1,19 +1,19 @@
# @uatu/spec
# @sanderling/spec
TypeScript spec API for [uatu](https://github.com/priyanshujain/uatu), a property-based UI fuzzer for mobile apps.
TypeScript spec API for [sanderling](https://github.com/priyanshujain/sanderling), a property-based UI fuzzer for mobile apps.
Spec authors write specs in TypeScript that describe what an app should *always* do (safety invariants), generate weighted actions to exercise the app, and extract structured state from the accessibility tree. The `uatu` CLI picks up the spec and drives the app under test.
Spec authors write specs in TypeScript that describe what an app should *always* do (safety invariants), generate weighted actions to exercise the app, and extract structured state from the accessibility tree. The `sanderling` CLI picks up the spec and drives the app under test.
## Install
```sh
npm install --save-dev @uatu/spec
npm install --save-dev @sanderling/spec
```
## Usage
```ts
import { extract, always, actions, Tap, weighted } from "@uatu/spec";
import { extract, always, actions, Tap, weighted } from "@sanderling/spec";
export const spec = {
extract: extract((tree) => ({
@@ -32,7 +32,7 @@ export const spec = {
## Version compatibility
`@uatu/spec` is released in lockstep with the uatu CLI. Pin the same major/minor version as your installed `uatu` binary.
`@sanderling/spec` is released in lockstep with the sanderling CLI. Pin the same major/minor version as your installed `sanderling` binary.
## License
+2 -2
View File
@@ -1,11 +1,11 @@
{
"name": "@uatu/spec",
"name": "@sanderling/spec",
"version": "0.0.0-dev",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@uatu/spec",
"name": "@sanderling/spec",
"version": "0.0.0-dev",
"license": "Apache-2.0",
"devDependencies": {
+5 -5
View File
@@ -1,7 +1,7 @@
{
"name": "@uatu/spec",
"name": "@sanderling/spec",
"version": "0.0.0-dev",
"description": "TypeScript spec API for uatu, a property-based UI fuzzer for mobile apps.",
"description": "TypeScript spec API for sanderling, a property-based UI fuzzer for mobile apps.",
"type": "module",
"types": "./dist/index.d.ts",
"main": "./dist/index.js",
@@ -21,12 +21,12 @@
],
"repository": {
"type": "git",
"url": "git+https://github.com/priyanshujain/uatu.git",
"url": "git+https://github.com/priyanshujain/sanderling.git",
"directory": "pkg/spec-api"
},
"homepage": "https://github.com/priyanshujain/uatu",
"homepage": "https://github.com/priyanshujain/sanderling",
"bugs": {
"url": "https://github.com/priyanshujain/uatu/issues"
"url": "https://github.com/priyanshujain/sanderling/issues"
},
"license": "Apache-2.0",
"author": "Priyanshu Jain",
+9 -9
View File
@@ -14,26 +14,26 @@ import type {
} from "./types.ts";
export function actions(generator: () => Action[]): ActionGenerator {
return globalThis.__uatu__.actions(generator);
return globalThis.__sanderling__.actions(generator);
}
export function weighted(...entries: WeightedEntry[]): ActionGenerator {
return globalThis.__uatu__.weighted(...entries);
return globalThis.__sanderling__.weighted(...entries);
}
export function from<T>(items: readonly T[]): Sampler<T> {
return globalThis.__uatu__.from(items);
return globalThis.__sanderling__.from(items);
}
export function Tap(parameters: { on: string | AccessibilityElement }): TapAction {
return globalThis.__uatu__.tap(parameters);
return globalThis.__sanderling__.tap(parameters);
}
export function InputText(parameters: {
into: string | AccessibilityElement;
text: string;
}): InputTextAction {
return globalThis.__uatu__.inputText(parameters);
return globalThis.__sanderling__.inputText(parameters);
}
export function Swipe(parameters: {
@@ -41,21 +41,21 @@ export function Swipe(parameters: {
to: Point | AccessibilityElement;
durationMillis?: number;
}): SwipeAction {
return globalThis.__uatu__.swipe(parameters);
return globalThis.__sanderling__.swipe(parameters);
}
export function PressKey(parameters: { key: Key }): PressKeyAction {
return globalThis.__uatu__.pressKey(parameters);
return globalThis.__sanderling__.pressKey(parameters);
}
export function Wait(parameters: { durationMillis: number }): WaitAction {
return globalThis.__uatu__.wait(parameters);
return globalThis.__sanderling__.wait(parameters);
}
function builtinGenerator(name: "taps" | "swipes" | "waitOnce" | "pressKeys"): ActionGenerator {
return new Proxy({} as ActionGenerator, {
get(_target, property) {
const runtime = globalThis.__uatu__[name] as unknown as Record<
const runtime = globalThis.__sanderling__[name] as unknown as Record<
string | symbol,
unknown
>;
+1 -1
View File
@@ -4,7 +4,7 @@ import type { Formula } from "../types.ts";
const exceptionCount = extract<number>((state) => state.exceptions.length);
// Fails when the SDK captured an uncaught throwable or a Uatu.reportError
// Fails when the SDK captured an uncaught throwable or a Sanderling.reportError
// call surfaced one during the run.
export const noUncaughtExceptions: Formula = always(
() => exceptionCount.current === 0,
+1 -1
View File
@@ -1,5 +1,5 @@
import type { Extracted, State } from "./types.ts";
export function extract<T>(getter: (state: State) => T): Extracted<T> {
return globalThis.__uatu__.extract(getter);
return globalThis.__sanderling__.extract(getter);
}
+1 -1
View File
@@ -17,7 +17,7 @@ export type {
State,
SwipeAction,
TapAction,
UatuRuntime,
SanderlingRuntime,
WaitAction,
WeightedEntry,
} from "./types.ts";
+4 -4
View File
@@ -1,20 +1,20 @@
import type { EventuallyFormula, Formula } from "./types.ts";
export function always(predicateOrFormula: (() => boolean) | Formula): Formula {
return globalThis.__uatu__.always(predicateOrFormula);
return globalThis.__sanderling__.always(predicateOrFormula);
}
export function now(predicate: () => boolean): Formula {
return globalThis.__uatu__.now(predicate);
return globalThis.__sanderling__.now(predicate);
}
export function next(predicate: () => boolean): Formula {
return globalThis.__uatu__.next(predicate);
return globalThis.__sanderling__.next(predicate);
}
// An unbounded `eventually` never forces a violation within a finite run —
// prefer `.within(n, unit)` when you want the verifier to fail a property
// that stalls.
export function eventually(predicate: () => boolean): EventuallyFormula {
return globalThis.__uatu__.eventually(predicate);
return globalThis.__sanderling__.eventually(predicate);
}
+4 -4
View File
@@ -78,12 +78,12 @@ export type Key =
| "right";
export interface ActionGenerator {
readonly __uatuActionGenerator: true;
readonly __sanderlingActionGenerator: true;
generate(): Action[];
}
export interface Formula {
readonly __uatuFormula: true;
readonly __sanderlingFormula: true;
implies(other: Formula): Formula;
or(other: Formula): Formula;
and(other: Formula): Formula;
@@ -98,7 +98,7 @@ export interface Sampler<T> {
generate(): T;
}
export interface UatuRuntime {
export interface SanderlingRuntime {
extract: <T>(getter: (state: State) => T) => Extracted<T>;
always: (predicateOrFormula: (() => boolean) | Formula) => Formula;
now: (predicate: () => boolean) => Formula;
@@ -129,5 +129,5 @@ export type WeightedEntry = readonly [number, ActionGenerator];
declare global {
// eslint-disable-next-line no-var
var __uatu__: UatuRuntime;
var __sanderling__: SanderlingRuntime;
}
+18 -18
View File
@@ -29,11 +29,11 @@ import type {
Formula,
Sampler,
State,
UatuRuntime,
SanderlingRuntime,
WeightedEntry,
} from "../src/types.ts";
interface RecordedRuntime extends UatuRuntime {
interface RecordedRuntime extends SanderlingRuntime {
extracts: Array<(state: State) => unknown>;
alwaysArgs: Array<(() => boolean) | Formula>;
nowPredicates: Array<() => boolean>;
@@ -51,7 +51,7 @@ interface RecordedRuntime extends UatuRuntime {
function makeChainableFormula(record: RecordedRuntime): Formula {
const formula: Formula = {
__uatuFormula: true,
__sanderlingFormula: true,
implies(other: Formula): Formula {
record.impliesCalls++;
void other;
@@ -125,11 +125,11 @@ function installFakeRuntime(): RecordedRuntime {
},
actions: (generator: () => Action[]): ActionGenerator => {
calls.actionGenerators.push(generator);
return { __uatuActionGenerator: true, generate: generator };
return { __sanderlingActionGenerator: true, generate: generator };
},
weighted: (...entries: WeightedEntry[]): ActionGenerator => {
calls.weightedCalls.push(entries);
return { __uatuActionGenerator: true, generate: () => [] };
return { __sanderlingActionGenerator: true, generate: () => [] };
},
from: <T>(items: readonly T[]): Sampler<T> => {
calls.fromCalls.push(items as unknown[]);
@@ -145,13 +145,13 @@ function installFakeRuntime(): RecordedRuntime {
}),
pressKey: ({ key }) => ({ kind: "PressKey", key }),
wait: ({ durationMillis }) => ({ kind: "Wait", durationMillis }),
taps: { __uatuActionGenerator: true, generate: () => [] },
swipes: { __uatuActionGenerator: true, generate: () => [] },
waitOnce: { __uatuActionGenerator: true, generate: () => [] },
pressKeys: { __uatuActionGenerator: true, generate: () => [] },
} satisfies UatuRuntime;
taps: { __sanderlingActionGenerator: true, generate: () => [] },
swipes: { __sanderlingActionGenerator: true, generate: () => [] },
waitOnce: { __sanderlingActionGenerator: true, generate: () => [] },
pressKeys: { __sanderlingActionGenerator: true, generate: () => [] },
} satisfies SanderlingRuntime;
const recorded = Object.assign(runtime, calls) as RecordedRuntime;
globalThis.__uatu__ = recorded;
globalThis.__sanderling__ = recorded;
return recorded;
}
@@ -168,7 +168,7 @@ test("always wraps a predicate into a formula via the runtime", () => {
const predicate = () => true;
const formula = always(predicate);
assert.equal(runtime.alwaysArgs[0], predicate);
assert.equal(formula.__uatuFormula, true);
assert.equal(formula.__sanderlingFormula, true);
});
test("always accepts a formula handle", () => {
@@ -176,7 +176,7 @@ test("always accepts a formula handle", () => {
const inner = now(() => true);
const wrapped = always(inner);
assert.equal(runtime.alwaysArgs.at(-1), inner);
assert.equal(wrapped.__uatuFormula, true);
assert.equal(wrapped.__sanderlingFormula, true);
});
test("now/next/eventually forward predicates", () => {
@@ -257,7 +257,7 @@ test("actions wraps a generator into the runtime's ActionGenerator", () => {
const generator = () => [Tap({ on: "id:x" })];
const wrapped = actions(generator);
assert.equal(runtime.actionGenerators[0], generator);
assert.equal(wrapped.__uatuActionGenerator, true);
assert.equal(wrapped.__sanderlingActionGenerator, true);
});
test("weighted forwards weighted entries to the runtime", () => {
@@ -279,8 +279,8 @@ test("from forwards items to the runtime", () => {
test("default generators proxy through to the runtime", () => {
installFakeRuntime();
assert.equal(taps.__uatuActionGenerator, true);
assert.equal(swipes.__uatuActionGenerator, true);
assert.equal(waitOnce.__uatuActionGenerator, true);
assert.equal(pressKey.__uatuActionGenerator, true);
assert.equal(taps.__sanderlingActionGenerator, true);
assert.equal(swipes.__sanderlingActionGenerator, true);
assert.equal(waitOnce.__sanderlingActionGenerator, true);
assert.equal(pressKey.__sanderlingActionGenerator, true);
});
+16 -16
View File
@@ -9,11 +9,11 @@ import type {
Formula,
Sampler,
State,
UatuRuntime,
SanderlingRuntime,
WeightedEntry,
} from "../src/types.ts";
interface RecordedRuntime extends UatuRuntime {
interface RecordedRuntime extends SanderlingRuntime {
currentState: State;
extractors: Array<(state: State) => unknown>;
alwaysArgs: Array<(() => boolean) | Formula>;
@@ -43,17 +43,17 @@ function installRuntime(initialState: State): RecordedRuntime {
if (typeof predicateOrFormula === "function") {
lastPredicate = predicateOrFormula;
}
return { __uatuFormula: true } as Formula;
return { __sanderlingFormula: true } as Formula;
},
now: () => ({ __uatuFormula: true } as Formula),
next: () => ({ __uatuFormula: true } as Formula),
eventually: () => ({ __uatuFormula: true } as EventuallyFormula),
now: () => ({ __sanderlingFormula: true } as Formula),
next: () => ({ __sanderlingFormula: true } as Formula),
eventually: () => ({ __sanderlingFormula: true } as EventuallyFormula),
actions: (generator: () => Action[]): ActionGenerator => ({
__uatuActionGenerator: true,
__sanderlingActionGenerator: true,
generate: generator,
}),
weighted: (..._entries: WeightedEntry[]): ActionGenerator => ({
__uatuActionGenerator: true,
__sanderlingActionGenerator: true,
generate: () => [],
}),
from: <T>(_items: readonly T[]): Sampler<T> => ({ generate: () => _items[0] as T }),
@@ -62,11 +62,11 @@ function installRuntime(initialState: State): RecordedRuntime {
swipe: (p) => ({ kind: "Swipe", from: p.from, to: p.to, durationMillis: p.durationMillis }),
pressKey: ({ key }) => ({ kind: "PressKey", key }),
wait: ({ durationMillis }) => ({ kind: "Wait", durationMillis }),
taps: { __uatuActionGenerator: true, generate: () => [] } as ActionGenerator,
swipes: { __uatuActionGenerator: true, generate: () => [] } as ActionGenerator,
waitOnce: { __uatuActionGenerator: true, generate: () => [] } as ActionGenerator,
pressKeys: { __uatuActionGenerator: true, generate: () => [] } as ActionGenerator,
} satisfies UatuRuntime;
taps: { __sanderlingActionGenerator: true, generate: () => [] } as ActionGenerator,
swipes: { __sanderlingActionGenerator: true, generate: () => [] } as ActionGenerator,
waitOnce: { __sanderlingActionGenerator: true, generate: () => [] } as ActionGenerator,
pressKeys: { __sanderlingActionGenerator: true, generate: () => [] } as ActionGenerator,
} satisfies SanderlingRuntime;
const state = { currentState: initialState };
const recorded = Object.assign(runtime, {
@@ -77,7 +77,7 @@ function installRuntime(initialState: State): RecordedRuntime {
return lastPredicate;
},
}) as unknown as RecordedRuntime;
globalThis.__uatu__ = recorded;
globalThis.__sanderling__ = recorded;
// Re-bind state ref so subsequent extract() calls read the up-to-date state.
Object.defineProperty(recorded, "currentState", {
get() {
@@ -105,6 +105,6 @@ test("defaults bundle exports formulas tagged as LTL properties", async () => {
logs: [{ unixMillis: 1, level: "W", tag: "X", message: "warn" }],
});
const defaults = await import("../src/defaults/properties.ts");
assert.equal(defaults.noUncaughtExceptions.__uatuFormula, true);
assert.equal(defaults.noLogcatErrors.__uatuFormula, true);
assert.equal(defaults.noUncaughtExceptions.__sanderlingFormula, true);
assert.equal(defaults.noLogcatErrors.__sanderlingFormula, true);
});