aboutsummaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorcirakg <cirakg@cirakg.xyz>2026-10-19 22:28:09 +0200
committercirakg <cirakg@cirakg.xyz>2026-10-19 22:28:09 +0200
commit2373b6f02ef027a423762d5d6349cd9e0f36090e (patch)
tree7509b0b1905d7c593074bba8ed4c94e30e437604 /tools
parent35042ff04ffc50e55ff59a385849442be4429d6b (diff)
test(ui): drive the simulator with a scripted flow and check every screen
tools/ui_flow.py clicks buttons and taps from the device files, waits for DIAG shown lines and compares 10 screens per watch with goldens on four test and three spot-check devices. Adds the fixture-wrap generator, UI logic tests and driver tests; the launcher opens apps from their glance. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'tools')
-rw-r--r--tools/budgets.json8
-rw-r--r--tools/gen_fixture_wrap.py73
-rw-r--r--tools/tests/test_gen_fixture_wrap.py33
-rw-r--r--tools/tests/test_ui_flow.py73
-rw-r--r--tools/ui_flow.py465
5 files changed, 648 insertions, 4 deletions
diff --git a/tools/budgets.json b/tools/budgets.json
index 93e9a2b..ba7432d 100644
--- a/tools/budgets.json
+++ b/tools/budgets.json
@@ -1,12 +1,12 @@
{
"_author": "cirakg & claude ai",
"_summary": "Simulator budgets checked by `make perf` and `make memtest` (README section 18).",
- "_about": "Simulator timings depend on your PC and include the JVM start of monkeydo, so perf budgets only catch big regressions; from M4 on they are set to about 2x the measured baseline. Memory is a hard limit: at most 70 % of the watch-app memory of the device.",
+ "_about": "Simulator timings depend on your PC. startup_ms (in-app, object creation to first full frame) measured 1-18 ms in M4; its budget leaves room for simulator jitter. first_frame_wall_ms includes the JVM start of monkeydo, loading the glance, the 2 s pause and the tap that opens the app (16-18 s in M4), so it only catches big regressions; set to about 2x. Memory is a hard limit: at most 70 % of the watch-app memory of the device.",
"perf": {
- "startup_ms": 3000,
- "first_frame_wall_ms": 15000
+ "startup_ms": 100,
+ "first_frame_wall_ms": 36000
},
"mem": {
- "mem_used_fraction": 0.70
+ "mem_used_fraction": 0.7
}
}
diff --git a/tools/gen_fixture_wrap.py b/tools/gen_fixture_wrap.py
new file mode 100644
index 0000000..c389fea
--- /dev/null
+++ b/tools/gen_fixture_wrap.py
@@ -0,0 +1,73 @@
+#!/usr/bin/env python3
+# Author: cirakg & claude ai
+# Summary: Compute the UI-test fixture's PIN wrap (fake PIN 123456) so the watch needn't run PBKDF2 at start-up.
+"""Print the fake PIN wrap that source/app/Fixtures.mc stores in the UI-test build.
+
+The wrap follows docs/SECURITY.md ("PIN wrap, version 1") with fixed, fake
+inputs: PIN 123456, salt 10..1f, IV 20..2f, master key 40..5f, 2000
+PBKDF2 iterations. Deriving the PIN key on the watch in one event trips the
+watchdog, and the UI tests need the store ready before the first screen, so
+the fixture stores this precomputed value instead. The app's own unlock code
+then checks it like any other wrap, which also cross-checks the format.
+
+Usage: gen_fixture_wrap.py (prints FIXTURE_WRAP and FIXTURE_MASTER_KEY in hex)
+"""
+
+from __future__ import annotations
+
+import hashlib
+import hmac
+import struct
+import subprocess
+
+PIN = b"123456"
+ITERATIONS = 2000
+SALT = bytes(range(0x10, 0x20))
+IV = bytes(range(0x20, 0x30))
+MASTER_KEY = bytes(range(0x40, 0x60))
+
+
+def hkdf(ikm: bytes, info: bytes, length: int = 32) -> bytes:
+ """HKDF-SHA256 with an empty salt (RFC 5869), as in source/crypto/Kdf.mc."""
+ prk = hmac.new(bytes(32), ikm, hashlib.sha256).digest()
+ out, block, counter = b"", b"", 1
+ while len(out) < length:
+ block = hmac.new(prk, block + info + bytes([counter]), hashlib.sha256).digest()
+ out += block
+ counter += 1
+ return out[:length]
+
+
+def aes_cbc_encrypt(key: bytes, iv: bytes, plaintext: bytes) -> bytes:
+ """AES-256-CBC with PKCS#7 padding, through openssl (not in the standard library)."""
+ result = subprocess.run(
+ ["openssl", "enc", "-aes-256-cbc", "-K", key.hex(), "-iv", iv.hex()],
+ input=plaintext,
+ capture_output=True,
+ check=True,
+ )
+ return result.stdout
+
+
+def sealed_box(enc_key: bytes, mac_key: bytes, aad: bytes, plaintext: bytes) -> bytes:
+ """source/crypto/SealedBox.mc: 0x01 | IV | ciphertext | HMAC tag."""
+ body = b"\x01" + IV + aes_cbc_encrypt(enc_key, IV, plaintext)
+ tag = hmac.new(mac_key, b"OTPW-REC-1" + struct.pack(">I", len(aad)) + aad + body, hashlib.sha256).digest()
+ return body + tag
+
+
+def fixture_wrap() -> bytes:
+ pin_key = hashlib.pbkdf2_hmac("sha256", PIN, SALT, ITERATIONS, 32)
+ enc_key, mac_key = hkdf(pin_key, b"OTPW enc v1"), hkdf(pin_key, b"OTPW mac v1")
+ count = struct.pack(">I", ITERATIONS)
+ aad = b"OTPW-WRAP-1" + SALT + count
+ return SALT + count + sealed_box(enc_key, mac_key, aad, MASTER_KEY)
+
+
+def main() -> None:
+ print("FIXTURE_WRAP =", fixture_wrap().hex())
+ print("FIXTURE_MASTER_KEY =", MASTER_KEY.hex())
+
+
+if __name__ == "__main__":
+ main()
diff --git a/tools/tests/test_gen_fixture_wrap.py b/tools/tests/test_gen_fixture_wrap.py
new file mode 100644
index 0000000..1c72e66
--- /dev/null
+++ b/tools/tests/test_gen_fixture_wrap.py
@@ -0,0 +1,33 @@
+# Author: cirakg & claude ai
+# Summary: Tests that the fixture PIN wrap generator matches the constants in source/app/Fixtures.mc and RFC 5869.
+from __future__ import annotations
+
+import re
+import shutil
+from pathlib import Path
+
+import gen_fixture_wrap
+import pytest
+
+ROOT = Path(__file__).resolve().parents[2]
+
+
+def fixture_constant(name: str) -> str:
+ text = (ROOT / "source" / "app" / "Fixtures.mc").read_text(encoding="utf-8")
+ match = re.search(rf'const {name} = "([0-9a-f]+)"', text)
+ assert match, f"{name} not found in Fixtures.mc"
+ return match.group(1)
+
+
+def test_hkdf_matches_rfc5869_case_3() -> None:
+ # RFC 5869 A.3: empty salt and info.
+ okm = gen_fixture_wrap.hkdf(bytes([0x0B] * 22), b"", 42)
+ assert okm.hex() == (
+ "8da4e775a563c18f715f802a063c5a31b8a11f5c5ee1879ec3454e5f3c738d2d9d201395faa4b61a96c8" # RFC 5869 A.3
+ )
+
+
+@pytest.mark.skipif(shutil.which("openssl") is None, reason="needs openssl for AES")
+def test_generated_wrap_matches_the_fixture() -> None:
+ assert gen_fixture_wrap.fixture_wrap().hex() == fixture_constant("FIXTURE_WRAP")
+ assert gen_fixture_wrap.MASTER_KEY.hex() == fixture_constant("FIXTURE_MASTER_KEY")
diff --git a/tools/tests/test_ui_flow.py b/tools/tests/test_ui_flow.py
new file mode 100644
index 0000000..7e0d336
--- /dev/null
+++ b/tools/tests/test_ui_flow.py
@@ -0,0 +1,73 @@
+# Author: cirakg & claude ai
+# Summary: Tests for the UI flow driver's pure parts: device key layout, JSON lookup and the app-log reader.
+from __future__ import annotations
+
+import json
+import threading
+import time
+from pathlib import Path
+
+import pytest
+import ui_flow
+
+
+def write_sim(tmp_path: Path, config: dict[str, object]) -> Path:
+ (tmp_path / "simulator.json").write_text(json.dumps(config), encoding="utf-8")
+ return tmp_path
+
+
+def test_load_keys_gives_button_centres(tmp_path: Path) -> None:
+ device = write_sim(
+ tmp_path,
+ {
+ "keys": [
+ {"id": "enter", "behavior": "onSelect", "location": {"x": 10, "y": 20, "width": 30, "height": 40}},
+ {
+ "id": "menu",
+ "behavior": "onMenu",
+ "isHold": True,
+ "location": {"x": 0, "y": 0, "width": 2, "height": 2},
+ },
+ {"id": "start", "location": {"x": 5, "y": 5, "width": 10, "height": 10}},
+ ]
+ },
+ )
+ keys = ui_flow.load_keys(device)
+ assert keys["enter"] == ui_flow.Key(25, 40, "onSelect", False)
+ assert keys["menu"].hold
+ assert keys["start"].behavior == ""
+
+
+def test_find_key_searches_nested_structures() -> None:
+ data = {"display": {"isTouch": True}, "glance": [{"contentArea": {"x": 1}}]}
+ assert ui_flow.find_key(data, "isTouch") is True
+ assert ui_flow.find_key(data, "contentArea") == {"x": 1}
+ assert ui_flow.find_key(data, "missing") is None
+
+
+def test_app_log_waits_only_for_lines_after_the_mark(tmp_path: Path) -> None:
+ log_path = tmp_path / "app.log"
+ log_path.write_text("DIAG shown list\n", encoding="utf-8")
+ log = ui_flow.AppLog(log_path)
+ assert log.wait_for(r"DIAG shown list\s*$", 1).group(0).startswith("DIAG shown list")
+ log.set_mark()
+
+ def append_later() -> None:
+ time.sleep(0.2)
+ with log_path.open("a", encoding="utf-8") as f:
+ f.write("DIAG shown otp\n")
+
+ writer = threading.Thread(target=append_later)
+ writer.start()
+ assert log.wait_for(r"DIAG shown otp", 3)
+ writer.join()
+ with pytest.raises(ui_flow.FlowError):
+ log.wait_for(r"DIAG shown list", 0.3) # only before the mark
+
+
+def test_app_log_latest_returns_the_last_match(tmp_path: Path) -> None:
+ log_path = tmp_path / "app.log"
+ log_path.write_text("DIAG list_focus y=10\nother\nDIAG list_focus y=42\n", encoding="utf-8")
+ match = ui_flow.AppLog(log_path).latest(r"DIAG list_focus y=(\d+)")
+ assert match is not None and match.group(1) == "42"
+ assert ui_flow.AppLog(tmp_path / "missing.log").latest("x") is None
diff --git a/tools/ui_flow.py b/tools/ui_flow.py
new file mode 100644
index 0000000..f43cf81
--- /dev/null
+++ b/tools/ui_flow.py
@@ -0,0 +1,465 @@
+#!/usr/bin/env python3
+# Author: cirakg & claude ai
+# Summary: Drive the app in the headless simulator with scripted input and check a screenshot of every screen.
+"""Scripted UI flow for the UI-test build (README 17.4).
+
+Usage (inside the dev container, with the simulator running and the
+UI-test build launched by docker/scripts/screenshots.sh):
+ ui_flow.py --device fr70 --device-dir DIR --log APP.log --window ID
+ --out build/screenshots/fr70 --golden test/golden/fr70 [--approve]
+
+Input goes to the simulator window with xdotool: clicks on the device
+drawing's buttons (positions from DIR/simulator.json) and taps and swipes on
+the screen. Watches without a button for an action use touch instead (Venu
+Sq 2 has no UP/DOWN and no select button).
+
+The app (UI-test build, source/util/TestMode.mc) starts with fake entries,
+the PIN 123456 and a frozen clock, and prints "DIAG shown <screen>" after
+drawing each screen, so every step waits for the screen it expects instead
+of sleeping. Menus are native Menu2 views that print nothing; for those the
+script waits a fixed time.
+
+The flow covers: the list, a TOTP entry, a HOTP entry and its next code, the
+PIN screen, a wrong PIN, a correct PIN opening a locked entry, auto-lock
+closing it, the menu, the About screen (watches with buttons; touch-only
+menus have no focus to move) and the lockout after 5 wrong PINs.
+Each screenshot is compared with test/golden/<device>/<screen>.png like
+sim_screenshot.py does (or saved there with --approve).
+
+Exit: 0 all screens match, 1 a screen differs or is missing a golden image,
+2 the flow failed (a screen didn't appear in time).
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import re
+import subprocess
+import sys
+import time
+from dataclasses import dataclass
+from pathlib import Path
+
+import sim_screenshot as shots
+
+EXIT_OK, EXIT_DIFFERENT, EXIT_FLOW = 0, 1, 2
+SCREEN_TIMEOUT_S = 20.0
+AUTO_LOCK_TIMEOUT_S = 25.0 # the UI-test build locks after 10 s without input
+MENU_SETTLE_S = 1.5 # Menu2 has no "shown" line
+SETTLE_S = 0.4 # after a "shown" line, before the screenshot
+CLICK_PAUSE_S = 0.25
+HOLD_S = 1.6 # long enough for a hold (menu) on every device
+FIXTURE_PIN = "123456" # source/app/Fixtures.mc
+WRONG_PIN = "000000"
+FAILURES_UNTIL_WAIT = 5 # source/storage/Lockout.mc: the 5th failure starts a delay
+SELECTOR_OK = 10 # source/ui/PinView.mc: selector positions 0-9, then OK
+
+
+class FlowError(Exception):
+ """The app didn't reach an expected screen."""
+
+
+@dataclass(frozen=True)
+class Key:
+ x: int
+ y: int
+ behavior: str
+ hold: bool
+
+
+def load_keys(device_dir: Path) -> dict[str, Key]:
+ """Button centres in device-drawing coordinates, by button id (enter, up, down, esc, menu)."""
+ sim = json.loads((device_dir / "simulator.json").read_text(encoding="utf-8"))
+ keys: dict[str, Key] = {}
+ for key in sim.get("keys", []):
+ loc = key["location"]
+ keys[str(key["id"])] = Key(
+ int(loc["x"]) + int(loc["width"]) // 2,
+ int(loc["y"]) + int(loc["height"]) // 2,
+ str(key.get("behavior", "")),
+ bool(key.get("isHold", False)),
+ )
+ return keys
+
+
+class AppLog:
+ """The app's console output, read as it grows."""
+
+ def __init__(self, path: Path) -> None:
+ self.path = path
+ self.mark = 0
+
+ def lines(self) -> list[str]:
+ try:
+ return self.path.read_text(encoding="utf-8", errors="replace").splitlines()
+ except OSError:
+ return []
+
+ def set_mark(self) -> None:
+ """Later waits only look at lines written after this point."""
+ self.mark = len(self.lines())
+
+ def wait_for(self, pattern: str, timeout: float) -> re.Match[str]:
+ regex = re.compile(pattern)
+ deadline = time.monotonic() + timeout
+ while time.monotonic() < deadline:
+ for line in self.lines()[self.mark :]:
+ match = regex.search(line)
+ if match:
+ return match
+ time.sleep(0.05)
+ raise FlowError(f"timed out after {timeout:.0f} s waiting for /{pattern}/")
+
+ def latest(self, pattern: str) -> re.Match[str] | None:
+ regex = re.compile(pattern)
+ found = None
+ for line in self.lines():
+ match = regex.search(line)
+ if match:
+ found = match
+ return found
+
+
+class Simulator:
+ """Input to and screenshots of the simulator window."""
+
+ def __init__(self, window: str, device_dir: Path, raw_dir: Path) -> None:
+ self.window = window
+ self.device_dir = device_dir
+ self.display = shots.load_display(device_dir)
+ self.keys = load_keys(device_dir)
+ self.raw_dir = raw_dir
+ self.offset = self._find_offset()
+
+ def capture(self, name: str) -> Path:
+ path = self.raw_dir / f"{name}-window.png"
+ path.parent.mkdir(parents=True, exist_ok=True)
+ subprocess.run(["import", "-window", self.window, str(path)], check=True)
+ return path
+
+ def _find_offset(self) -> tuple[int, int]:
+ raw = shots.open_image(self.capture("offset"))
+ device = shots.open_image(self.device_dir / self.display.image)
+ dx, dy, score = shots.find_offset(raw, shots.bezel_only(device, self.display))
+ if score > shots.MAX_BEZEL_DIFF:
+ raise FlowError(f"device drawing not found in the simulator window (difference {score:.1f})")
+ return dx, dy
+
+ def _xdotool(self, *args: str) -> None:
+ subprocess.run(["xdotool", *args], check=True)
+
+ def _move(self, wx: int, wy: int) -> None:
+ self._xdotool("mousemove", "--window", self.window, str(wx), str(wy))
+
+ def _to_window(self, dx: int, dy: int) -> tuple[int, int]:
+ """Device-drawing coordinates to window coordinates."""
+ return self.offset[0] + dx, self.offset[1] + dy
+
+ def has(self, key_id: str, behavior: str | None = None) -> bool:
+ key = self.keys.get(key_id)
+ return key is not None and (behavior is None or key.behavior == behavior)
+
+ def press(self, key_id: str, hold: bool = False) -> None:
+ key = self.keys[key_id]
+ self._move(*self._to_window(key.x, key.y))
+ if hold:
+ self._xdotool("mousedown", "1")
+ time.sleep(HOLD_S)
+ self._xdotool("mouseup", "1")
+ else:
+ self._xdotool("click", "1")
+ time.sleep(CLICK_PAUSE_S)
+
+ def tap(self, sx: int, sy: int) -> None:
+ """Tap at screen coordinates (0, 0 = top left of the watch screen)."""
+ self._move(*self._to_window(self.display.x + sx, self.display.y + sy))
+ self._xdotool("click", "1")
+ time.sleep(CLICK_PAUSE_S)
+
+ def long_press(self, sx: int, sy: int) -> None:
+ self._move(*self._to_window(self.display.x + sx, self.display.y + sy))
+ self._xdotool("mousedown", "1")
+ time.sleep(HOLD_S)
+ self._xdotool("mouseup", "1")
+ time.sleep(CLICK_PAUSE_S)
+
+ def swipe(self, sx0: int, sy0: int, sx1: int, sy1: int) -> None:
+ self._move(*self._to_window(self.display.x + sx0, self.display.y + sy0))
+ self._xdotool("mousedown", "1")
+ steps = 8
+ for i in range(1, steps + 1):
+ x = sx0 + (sx1 - sx0) * i // steps
+ y = sy0 + (sy1 - sy0) * i // steps
+ self._move(*self._to_window(self.display.x + x, self.display.y + y))
+ time.sleep(0.02)
+ self._xdotool("mouseup", "1")
+ time.sleep(CLICK_PAUSE_S * 2)
+
+
+class Flow:
+ """The abstract actions of README 13.4, mapped to this device's buttons or touch screen."""
+
+ def __init__(self, sim: Simulator, log: AppLog, out: Path, golden: Path, approve: bool) -> None:
+ self.sim = sim
+ self.log = log
+ self.out = out
+ self.golden = golden
+ self.approve = approve
+ self.results: dict[str, int] = {}
+ self.selector = 0 # the PIN digit selector's position (button-only watches)
+ touch = log.wait_for(r"DIAG device touch=(\d)", SCREEN_TIMEOUT_S)
+ self.touch = touch.group(1) == "1"
+
+ # -- navigation ---------------------------------------------------------
+
+ def _w(self) -> int:
+ return self.sim.display.width
+
+ def _h(self) -> int:
+ return self.sim.display.height
+
+ def next(self) -> None:
+ if self.sim.has("down"):
+ self.sim.press("down")
+ else:
+ self.sim.swipe(self._w() // 2, self._h() * 3 // 4, self._w() // 2, self._h() // 4)
+
+ def back(self) -> None:
+ self.sim.press("esc")
+
+ def menu(self) -> None:
+ """Hold MENU, or long-press the screen on watches without one (Venu X1)."""
+ if self.sim.has("menu"):
+ self.sim.press("menu", hold=True)
+ else:
+ self.sim.long_press(self._w() // 2, self._h() // 2)
+
+ def open_focused_row(self) -> None:
+ if self.sim.has("enter", "onSelect"):
+ self.sim.press("enter")
+ return
+ focus = self.log.latest(r"DIAG list_focus y=(\d+)")
+ if focus is None:
+ raise FlowError("the list didn't report its focused row")
+ self.sim.tap(self._w() // 2, int(focus.group(1)))
+
+ def select(self) -> None:
+ """START, or a tap in the middle of the screen."""
+ if self.sim.has("enter", "onSelect"):
+ self.sim.press("enter")
+ else:
+ self.sim.tap(self._w() // 2, self._h() // 2)
+
+ def enter_pin(self, pin: str) -> None:
+ if self.touch:
+ keys = self.log.latest(r"DIAG pin_keys (\S+)")
+ if keys is None:
+ raise FlowError("the PIN screen didn't report its keypad")
+ centres = {}
+ for item in keys.group(1).split(";"):
+ value, xy = item.split("=")
+ x, y = xy.split(",")
+ centres[int(value)] = (int(x), int(y))
+ for digit in pin:
+ self.sim.tap(*centres[int(digit)])
+ self.sim.tap(*centres[-2]) # OK
+ return
+ for position in [int(d) for d in pin] + [SELECTOR_OK]:
+ steps = (position - self.selector) % (SELECTOR_OK + 1)
+ for _ in range(steps):
+ self.sim.press("down")
+ self.selector = position
+ self.sim.press("enter")
+
+ # -- checking -----------------------------------------------------------
+
+ def expect(self, screen: str, timeout: float = SCREEN_TIMEOUT_S) -> None:
+ self.log.wait_for(rf"DIAG shown {re.escape(screen)}\s*$", timeout)
+ time.sleep(SETTLE_S)
+
+ def opened_pin_screen(self) -> None:
+ """A new PIN screen starts with its selector at 0."""
+ self.selector = 0
+
+ def act(self) -> None:
+ """Call before an input whose result `expect` should wait for."""
+ self.log.set_mark()
+
+ def shot(self, name: str) -> None:
+ raw = self.sim.capture(name)
+ out = self.out / f"{name}.png"
+ label = f"{self.sim.device_dir.name}/{name}"
+ try:
+ screen = shots.extract_screen(raw, self.sim.device_dir, out)
+ except shots.ScreenshotError as err:
+ print(f"[{label}] {err}")
+ self.results[name] = EXIT_DIFFERENT
+ return
+ golden = self.golden / f"{name}.png"
+ if self.approve:
+ shots.save_png(screen, golden, f"Approved simulator screen '{name}' of {self.sim.device_dir.name}")
+ print(f"[{label}] approved as {golden}")
+ self.results[name] = EXIT_OK
+ return
+ self.results[name] = shots.check_golden(screen, label, out, golden)
+
+
+def flow_entries(f: Flow) -> None:
+ """The list, a TOTP entry, a HOTP entry and its next code."""
+ f.expect("list")
+ f.shot("list")
+ f.act()
+ f.open_focused_row() # GitHub, TOTP
+ f.expect("otp")
+ f.shot("otp")
+ f.act()
+ f.back()
+ f.expect("list")
+ for _ in range(3): # Google, Bank, VPN
+ f.next()
+ f.act()
+ f.open_focused_row() # VPN, HOTP
+ f.expect("otp_hotp")
+ f.shot("otp_hotp")
+ f.act()
+ f.select() # next HOTP code
+ f.expect("otp_hotp")
+ f.shot("otp_hotp_next")
+ f.act()
+ f.back()
+ f.expect("list")
+
+
+def flow_locked_entry(f: Flow) -> None:
+ """Bank is locked: PIN screen, a wrong PIN, the right PIN, then auto-lock."""
+ for _ in range(6): # wrap around to Bank (index 2 of 7)
+ f.next()
+ f.act()
+ f.open_focused_row()
+ f.expect("pin")
+ f.opened_pin_screen()
+ f.shot("pin")
+ f.act()
+ f.enter_pin(WRONG_PIN)
+ f.expect("pin_error")
+ f.shot("pin_error")
+ f.act()
+ f.enter_pin(FIXTURE_PIN)
+ f.expect("otp")
+ f.shot("otp_locked")
+ # Auto-lock closes the locked entry.
+ f.act()
+ f.expect("list", AUTO_LOCK_TIMEOUT_S)
+
+
+def flow_menu(f: Flow) -> None:
+ """The menu, and About on watches whose menu has a focus to move."""
+ f.menu()
+ time.sleep(MENU_SETTLE_S)
+ f.shot("menu")
+ f.act()
+ if f.sim.has("down"):
+ # Locked with a PIN: Change PIN, Reset PIN, Settings results, Entry
+ # IDs, Clock status, About.
+ for _ in range(5):
+ f.next()
+ time.sleep(MENU_SETTLE_S)
+ f.act()
+ f.select()
+ f.expect("about")
+ f.shot("about")
+ f.act()
+ # Touch-only watches show the menu as a freely scrolling list without
+ # focus, so there is no reliable "select About"; just close it.
+ f.back()
+ f.expect("list")
+
+
+def flow_lockout(f: Flow) -> None:
+ """Five wrong PINs start the 30 s wait."""
+ f.act()
+ f.open_focused_row()
+ f.expect("pin")
+ f.opened_pin_screen()
+ for attempt in range(1, FAILURES_UNTIL_WAIT + 1):
+ f.act()
+ f.enter_pin(WRONG_PIN)
+ f.expect("pin_wait" if attempt == FAILURES_UNTIL_WAIT else "pin_error")
+ f.shot("pin_wait")
+
+
+def run_flow(f: Flow) -> None:
+ """The scripted session; see the module docstring."""
+ flow_entries(f)
+ flow_locked_entry(f)
+ flow_menu(f)
+ flow_lockout(f)
+
+
+def find_key(data: object, key: str) -> object:
+ """The first value stored under `key` anywhere in a JSON structure, or None."""
+ if isinstance(data, dict):
+ if key in data:
+ return data[key]
+ data = list(data.values())
+ if isinstance(data, list):
+ for item in data:
+ found = find_key(item, key)
+ if found is not None:
+ return found
+ return None
+
+
+def open_from_glance(window: str, device_dir: Path, raw_dir: Path) -> None:
+ """Open the full app from its glance, as found in the simulator: a tap on
+ it on touch screens; on button-only watches DOWN (which selects the
+ glance) and then START. START alone does nothing in either case."""
+ sim = Simulator(window, device_dir, raw_dir)
+ config = json.loads((device_dir / "simulator.json").read_text(encoding="utf-8"))
+ area = find_key(config.get("glance", {}), "contentArea")
+ if find_key(config, "isTouch") is True and isinstance(area, dict):
+ sim.tap(int(area["x"]) + int(area["width"]) // 2, int(area["y"]) + int(area["height"]) // 2)
+ else:
+ sim.press("down")
+ time.sleep(1.0)
+ sim.press("enter")
+
+
+def main(argv: list[str] | None = None) -> int:
+ parser = argparse.ArgumentParser(description="Scripted UI flow with screenshot checks.")
+ parser.add_argument("--device-dir", type=Path, required=True)
+ parser.add_argument("--window", required=True, help="X window id of the simulator")
+ parser.add_argument("--out", type=Path, required=True, help="directory for the screenshots")
+ parser.add_argument("--log", type=Path, help="the app's console log (monkeydo output)")
+ parser.add_argument("--golden", type=Path, help="directory of the approved images")
+ parser.add_argument("--approve", action="store_true")
+ parser.add_argument("--open-from-glance", action="store_true", help="only open the app from its glance")
+ args = parser.parse_args(argv)
+ name = args.device_dir.name
+ if args.open_from_glance:
+ try:
+ open_from_glance(args.window, args.device_dir, args.out / "raw")
+ except (FlowError, subprocess.CalledProcessError, OSError) as err:
+ print(f"[{name}] could not open the app from its glance: {err}")
+ return EXIT_FLOW
+ return EXIT_OK
+ if args.log is None or args.golden is None:
+ parser.error("--log and --golden are required for the flow")
+ try:
+ sim = Simulator(args.window, args.device_dir, args.out / "raw")
+ flow = Flow(sim, AppLog(args.log), args.out, args.golden, args.approve)
+ run_flow(flow)
+ except (FlowError, subprocess.CalledProcessError, OSError) as err:
+ print(f"[{name}] UI flow failed: {err}")
+ return EXIT_FLOW
+ failed = sorted(screen for screen, code in flow.results.items() if code != EXIT_OK)
+ if failed:
+ print(f"[{name}] {len(failed)} of {len(flow.results)} screens need attention: {', '.join(failed)}")
+ return EXIT_DIFFERENT
+ print(f"[{name}] all {len(flow.results)} screens match")
+ return EXIT_OK
+
+
+if __name__ == "__main__":
+ sys.exit(main())