mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-03 11:37:09 +00:00
pj
8be26fbf8b
The previous snippet referenced `state.ax.find` inside an actions() body where state is not in scope, and shadowed the imported actions helper with an export of the same name.
44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
# @sanderling/spec
|
|
|
|
TypeScript spec API for [sanderling](https://github.com/priyanshujain/sanderling), a property-based UI fuzzer for mobile and web apps.
|
|
|
|
Spec authors write properties (what the app must always or eventually do), extractors (structured state from the UI), and action generators (what sanderling is allowed to do). The `sanderling` CLI evaluates the spec in a loop against a running app.
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install --save-dev @sanderling/spec
|
|
```
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { extract, always, eventually, actions, weighted, taps, swipes, InputText, Tap } from "@sanderling/spec";
|
|
|
|
const loggedIn = extract((s) => !!s.ax.find("id:home-tab-bar"));
|
|
const balance = extract<number>((s) => (s.snapshots.balance as number) ?? 0);
|
|
const emailField = extract((s) => s.ax.find("id:email-field"));
|
|
const submitButton = extract((s) => s.ax.find("id:sign-in-button"));
|
|
|
|
export const properties = {
|
|
balanceNeverNegative: always(() => balance.current >= 0),
|
|
loginSucceeds: eventually(() => loggedIn.current).within(30, "seconds"),
|
|
};
|
|
|
|
const doLogin = actions(() => {
|
|
if (loggedIn.current) return [];
|
|
const email = emailField.current;
|
|
const submit = submitButton.current;
|
|
if (!email || !submit) return [];
|
|
return [InputText({ into: email, text: "[email protected]" }), Tap({ on: submit })];
|
|
});
|
|
|
|
export const actionsRoot = weighted(
|
|
[50, doLogin],
|
|
[10, taps],
|
|
[2, swipes],
|
|
);
|
|
```
|
|
|
|
Works identically across Android, iOS, and web targets.
|