Files
sanderling/internal/ios/ios_test.go
T
pj 406b7516b3 iOS simulator driver: Go-native companion-backed backend (#62)
* perf(ios): use prebuilt XCTest runner to cut startup

* chore(ioscompanion): add companion asset prepare script

* feat(ioscompanion): embed and extract simulator companion bundle

* test(ioscompanion): cover companion stub and embedded extraction

* docs: add third party notices for vendored companion

* chore: ignore vendored companion bundle artifact

* build(proto): pin simulator companion proto v1.1.8

* build(proto): add dedicated buf module and gen template for pinned proto

* build(proto): exclude pinned companion proto from root buf workspace

* feat(ioscompanion): commit generated companion gRPC stubs

* feat(ioscompanion): map flat companion describe dump to TreeNode JSON

* test(ioscompanion): add hierarchy-map golden and unit tests

* feat(ioscompanion): port screen-settle stability polling to Go

* test(ioscompanion): cover settle transitional, hash, streak, and cap rules

* feat(ioscompanion): add USB HID keymap module

* test(ioscompanion): cover keymap branches and paste-chord constants

* build: embed companion assets via withcompanion tag

* feat(ioscompanion): add transport companion interface

* feat(ioscompanion): add HID event wrapper and builders

* feat(ioscompanion): wire gRPC companion client and Dial

* test(ioscompanion): cover HID builders and unit conversions

* test(ioscompanion): cover Dial, process-state mapping, and install archive

* test(ioscompanion): add gated simulator integration smoke test

* feat(ioscompanion): text input and gesture HID composition with pasteboard fallback

* test(ioscompanion): cover input composers, paste dialog loop, and pure helpers

* feat(ioscompanion): add Describe to companion transport

* feat(ioscompanion): implement DeviceDriver with companion supervision

* test(ioscompanion): unit tests with fake companion transport

* test(ioscompanion): gated companion smoke test

* feat(ios): add ResolveTarget for simulator vs physical-device routing

* feat(testrun): route iOS simulators through the native companion driver

* refactor(testrun): defer the java preflight check to the physical-device path

* feat(cli): add --ios-app-path flag

* feat(doctor): split iOS checks into simulator and physical-device paths

* test(folio): add gate-analyzer fixtures for G1-G5

* feat(folio): add iOS conformance gate script

* chore(folio): wire gates recipe, app path, and ignore gate output

* style: gofmt struct alignment drift

* fix(doctor): probe simctl via xcrun instead of PATH lookup

* fix(ioscompanion): spawn companion under driver-lifetime context

* test(ioscompanion): prove companion child outlives startup context

* fix(ioscompanion): chunk install payload under companion message cap

* test(ioscompanion): cover install payload chunking

* fix(ioscompanion): reinstall via simctl and sanitize companion env

* fix(ioscompanion): wait out unresolved accessibility values after launch

* perf(ioscompanion): paste long text for atomic landing

* test(ioscompanion): cover paste threshold, retry flow, and sentinel detection

* fix(ioscompanion): treat unresolved bridge values as transitional, never as content

* fix(ioscompanion): accept masked secure-field values as paste landing

* test(ioscompanion): cover sentinel mapping and masked-field landing

* fix(ioscompanion): atomic erase and single-send paste to prevent doubling

* test(ioscompanion): cover atomic erase, single chord, unverifiable field

* fix(ioscompanion): verify paste on a time budget that outlasts the bridge blackout

* test(ioscompanion): cover bridge-blackout paste verification

* fix(ioscompanion): drop unresolved-value settle gate that never let empty-field screens settle

* refactor(ioscompanion): name the empty-editable-field sentinel for what it is

* perf(ioscompanion): tighten settle streak for the fast companion transport

* feat(ioscompanion): pre-grant pasteboard access so unicode input skips the OS prompt

* refactor(ioscompanion): drop paste warm-up now that the grant suppresses the prompt

* test(ioscompanion): cover pasteboard grant on launch, drop warm-up tests

* fix(ioscompanion): retry describe past transient collapsed accessibility dumps

* test(ioscompanion): cover collapsed-dump detection

* perf(ioscompanion): split raw and retrying describe so settle does not double-wait collapses

* perf(ioscompanion): tighten settle now that collapses are handled separately

* fix(ioscompanion): replace field content on input so blackout-skipped erase cannot accumulate text

* test(ioscompanion): cover replace-on-input and TextReplacer capability

* refactor(ioscompanion): neutralize HID events behind the transport seam

* feat(companion): add simulator runner project skeleton

* feat(companion): serve accessibility snapshots over the wire protocol

* feat(companion): synthesize timestamped touch gestures

* feat(companion): type text with replace semantics

* feat(companion): serve the wire protocol from a parked runner

* feat(ioscompanion): add TextEditor capability and unavailable sentinel to the transport seam

* feat(ioscompanion): route text input through a text-editing companion when available

* fix(companion): bind listener by port and source screen size from snapshot

* feat(ioscompanion): add runner companion JSON transport

* test(ioscompanion): cover runner transport protocol mapping

* fix(companion): synthesize gestures synchronously to avoid the async completion crash

* fix(companion): type on the main thread and recover from focus assertions

* fix(companion): keep serving after an automation failure

* refactor(companion): tidy snapshot serialization

* fix(companion): honor sequential tap gaps and survive synthesis exceptions

* feat(ioscompanion): expose native typing with an explicit replace flag

* chore(companion): add runner asset prepare script

* feat(ioscompanion): embed and extract the runner test bundle

* test(ioscompanion): cover runner asset extraction

* build(ioscompanion): commit runner asset archive

* feat(ioscompanion): pair the legacy companion with the in-simulator runner

* test(ioscompanion): cover hybrid routing, paste-grant skip, and port binding

* fix(ioscompanion): reconnect after interrupted runner calls instead of restarting

* fix(ioscompanion): route hybrid lifecycle through the runner and harden restarts

* feat(companion): launch and terminate apps through the automation session

* build(ioscompanion): refresh runner asset with session lifecycle

* fix(ioscompanion): classify connection deadline expiry as caller budget

* fix(companion): capture snapshots on the main thread inside the catch bridge

* build(ioscompanion): refresh runner asset with main-thread snapshots

* perf(ioscompanion): count read spans toward settle and capture snapshots concurrently

* feat(ioscompanion): make the hybrid simulator companion the default

* test(folio): cover runner-session orphans in the gate harness

* test(ioscompanion): pin the child-lifetime test to the legacy path

* fix(ioscompanion): keep mappable text on one HID stream and verify unicode clears

* fix(ioscompanion): pause the clear chord so selection applies before the delete

* fix(companion): prune the keyboard subtree from snapshots

* build(ioscompanion): refresh runner asset without keyboard elements

* fix(ioscompanion): capture the screenshot transport before a recovery can reassign it

* fix(companion): pin the runner listener to loopback

* fix(companion): size the replace delete prefix to cover any focused field

* build(ioscompanion): refresh runner asset with loopback bind and replace fix

* fix(cli): cancel the run context on SIGINT so spawned children are reaped

* fix(testrun): point the device java preflight hint at the ios-device doctor

* fix(folio): word-bound the G2 ERROR scan and drop the dead objc allowlist glob

* test(ioscompanion): cover stopProcess, restart, and failed bring-up supervision

* chore: add test-companion target for the withcompanion-tagged suite

* chore(ioscompanion): stop tracking the runner archive build artifact

* build: produce the runner archive from source like the companion bundle

* refactor(conformance): move the gate harness out of examples/folio

* chore(folio): drop the gate harness wiring from the example app
2026-06-08 19:10:54 +05:30

343 lines
11 KiB
Go

package ios
import (
"bytes"
"context"
"errors"
"strings"
"testing"
"time"
)
const simctlJSON = `{
"devices": {
"com.apple.CoreSimulator.SimRuntime.iOS-17-0": [
{"udid": "ipad-udid", "state": "Shutdown", "name": "iPad Pro", "isAvailable": true},
{"udid": "iphone15-udid", "state": "Booted", "name": "iPhone 15", "isAvailable": true},
{"udid": "broken-udid", "state": "Shutdown", "name": "iPhone 14", "isAvailable": false}
],
"com.apple.CoreSimulator.SimRuntime.iOS-16-4": [
{"udid": "watch-udid", "state": "Shutdown", "name": "Apple Watch", "isAvailable": true}
]
}
}`
func TestParseBootedDevice(t *testing.T) {
cases := []struct {
name string
input string
wantUDID string
wantNil bool
}{
{"picks booted entry", simctlJSON, "iphone15-udid", false},
{"none booted", `{"devices":{"r":[{"udid":"a","state":"Shutdown","name":"x","isAvailable":true}]}}`, "", true},
{"empty list", `{"devices":{}}`, "", true},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
got, err := parseBootedDevice([]byte(tc.input))
if err != nil {
t.Fatal(err)
}
if tc.wantNil {
if got != nil {
t.Fatalf("want nil, got %+v", got)
}
return
}
if got == nil || got.UDID != tc.wantUDID {
t.Fatalf("got %+v, want UDID %q", got, tc.wantUDID)
}
})
}
}
func TestParseBootedDevice_InvalidJSON(t *testing.T) {
if _, err := parseBootedDevice([]byte("not json")); err == nil {
t.Fatal("expected error on malformed JSON")
}
}
func TestParseAvailableDevices_DropsUnavailable(t *testing.T) {
got, err := parseAvailableDevices([]byte(simctlJSON))
if err != nil {
t.Fatal(err)
}
for _, d := range got {
if !d.IsAvailable {
t.Fatalf("unavailable device leaked through: %+v", d)
}
if d.UDID == "broken-udid" {
t.Fatalf("isAvailable=false device must not be selectable")
}
}
if len(got) != 3 {
t.Fatalf("got %d available across runtimes, want 3", len(got))
}
}
func TestPickSimulator(t *testing.T) {
cases := []struct {
name string
query string
available []simDevice
wantUDID string // "" with wantErr means error expected
wantErr bool
}{
{
name: "by name",
query: "iPhone 15",
available: []simDevice{{UDID: "aaa", Name: "iPad Pro", IsAvailable: true}, {UDID: "bbb", Name: "iPhone 15", IsAvailable: true}},
wantUDID: "bbb",
},
{
name: "by udid",
query: "aaa",
available: []simDevice{{UDID: "aaa", Name: "iPad Pro", IsAvailable: true}, {UDID: "bbb", Name: "iPhone 14", IsAvailable: true}},
wantUDID: "aaa",
},
{
name: "unknown name errors",
query: "Pixel 7",
available: []simDevice{{UDID: "aaa", Name: "iPad Pro", IsAvailable: true}},
wantErr: true,
},
{
name: "empty query prefers iPhone",
query: "",
available: []simDevice{{UDID: "aaa", Name: "iPad mini", IsAvailable: true}, {UDID: "bbb", Name: "iPhone 16", IsAvailable: true}, {UDID: "ccc", Name: "Apple Watch", IsAvailable: true}},
wantUDID: "bbb",
},
{
name: "empty query falls back to first",
query: "",
available: []simDevice{{UDID: "aaa", Name: "iPad Air", IsAvailable: true}, {UDID: "bbb", Name: "Apple TV", IsAvailable: true}},
wantUDID: "aaa",
},
{
name: "empty list errors",
query: "",
wantErr: true,
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
got, err := pickSimulator(tc.query, tc.available)
if tc.wantErr {
if err == nil {
t.Fatalf("expected error for query %q", tc.query)
}
return
}
if err != nil {
t.Fatal(err)
}
if got.UDID != tc.wantUDID {
t.Errorf("got %q, want %q", got.UDID, tc.wantUDID)
}
})
}
}
func TestBootedUDID_CanceledContextReturnsEmpty(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
cancel()
udid := BootedUDID(ctx)
if udid != "" {
t.Errorf("expected empty UDID on canceled context, got %q", udid)
}
}
func swapSeams(t *testing.T) {
t.Helper()
origBoot, origWait := boot, waitForBoot
t.Cleanup(func() { boot, waitForBoot = origBoot, origWait })
}
func TestEnsureSimulator_UsesBootedSimulator(t *testing.T) {
swapSeams(t)
origListBooted, origListAvailable := listBooted, listAvailable
t.Cleanup(func() { listBooted, listAvailable = origListBooted, origListAvailable })
listBooted = func(context.Context) (*simDevice, error) {
return &simDevice{UDID: "iphone15-udid", Name: "iPhone 15"}, nil
}
availableCalled := false
listAvailable = func(context.Context) ([]simDevice, error) {
availableCalled = true
return nil, nil
}
boot = func(context.Context, string) error {
t.Fatal("must not boot when a simulator is already booted")
return nil
}
var out bytes.Buffer
if err := EnsureSimulator(context.Background(), "", &out); err != nil {
t.Fatal(err)
}
if availableCalled {
t.Error("should short-circuit without listing available simulators")
}
if !bytes.Contains(out.Bytes(), []byte("iphone15-udid")) {
t.Errorf("expected booted UDID in output, got %q", out.String())
}
}
func TestEnsureSimulator_BootsPickedSimulator(t *testing.T) {
swapSeams(t)
origListBooted, origListAvailable := listBooted, listAvailable
t.Cleanup(func() { listBooted, listAvailable = origListBooted, origListAvailable })
listBooted = func(context.Context) (*simDevice, error) { return nil, nil }
listAvailable = func(context.Context) ([]simDevice, error) {
return []simDevice{
{UDID: "ipad-udid", Name: "iPad Pro", IsAvailable: true},
{UDID: "iphone15-udid", Name: "iPhone 15", IsAvailable: true},
}, nil
}
var bootedUDID string
boot = func(_ context.Context, udid string) error { bootedUDID = udid; return nil }
waitForBoot = func(context.Context, string, time.Duration) error { return nil }
if err := EnsureSimulator(context.Background(), "", new(bytes.Buffer)); err != nil {
t.Fatal(err)
}
if bootedUDID != "iphone15-udid" {
t.Errorf("booted %q, want iphone15-udid (iPhone preference)", bootedUDID)
}
}
func swapResolveSeams(t *testing.T) {
t.Helper()
origBootedAll, origAvailable := listBootedAll, listAvailable
t.Cleanup(func() { listBootedAll, listAvailable = origBootedAll, origAvailable })
}
func TestResolveTarget_ExplicitMatchesBootedSimulator(t *testing.T) {
swapResolveSeams(t)
listBootedAll = func(context.Context) ([]simDevice, error) {
return []simDevice{{UDID: "booted-udid", Name: "iPhone 15", State: "Booted", IsAvailable: true}}, nil
}
listAvailable = func(context.Context) ([]simDevice, error) {
t.Fatal("should not list available when a booted simulator matches")
return nil, nil
}
udid, isSimulator, err := ResolveTarget(context.Background(), "iPhone 15")
if err != nil {
t.Fatal(err)
}
if udid != "booted-udid" || !isSimulator {
t.Errorf("got (%q, %v), want (booted-udid, true)", udid, isSimulator)
}
}
func TestResolveTarget_ExplicitMatchesAvailableByUDID(t *testing.T) {
swapResolveSeams(t)
listBootedAll = func(context.Context) ([]simDevice, error) { return nil, nil }
listAvailable = func(context.Context) ([]simDevice, error) {
return []simDevice{{UDID: "shutdown-udid", Name: "iPhone 16", IsAvailable: true}}, nil
}
udid, isSimulator, err := ResolveTarget(context.Background(), "shutdown-udid")
if err != nil {
t.Fatal(err)
}
if udid != "shutdown-udid" || !isSimulator {
t.Errorf("got (%q, %v), want (shutdown-udid, true)", udid, isSimulator)
}
}
func TestResolveTarget_UnknownQueryResolvesAsPhysicalDevice(t *testing.T) {
swapResolveSeams(t)
listBootedAll = func(context.Context) ([]simDevice, error) { return nil, nil }
listAvailable = func(context.Context) ([]simDevice, error) {
return []simDevice{{UDID: "sim-udid", Name: "iPhone 16", IsAvailable: true}}, nil
}
udid, isSimulator, err := ResolveTarget(context.Background(), "00008110-physical-device-udid")
if err != nil {
t.Fatal(err)
}
if udid != "00008110-physical-device-udid" || isSimulator {
t.Errorf("got (%q, %v), want (00008110-physical-device-udid, false)", udid, isSimulator)
}
}
func TestResolveTarget_NoQuerySingleBooted(t *testing.T) {
swapResolveSeams(t)
listBootedAll = func(context.Context) ([]simDevice, error) {
return []simDevice{{UDID: "only-booted", Name: "iPhone 15", State: "Booted", IsAvailable: true}}, nil
}
udid, isSimulator, err := ResolveTarget(context.Background(), "")
if err != nil {
t.Fatal(err)
}
if udid != "only-booted" || !isSimulator {
t.Errorf("got (%q, %v), want (only-booted, true)", udid, isSimulator)
}
}
func TestResolveTarget_NoQueryZeroBootedErrors(t *testing.T) {
swapResolveSeams(t)
listBootedAll = func(context.Context) ([]simDevice, error) { return nil, nil }
_, _, err := ResolveTarget(context.Background(), "")
if err == nil {
t.Fatal("expected error when no simulator is booted")
}
}
func TestResolveTarget_NoQueryMultipleBootedErrors(t *testing.T) {
swapResolveSeams(t)
listBootedAll = func(context.Context) ([]simDevice, error) {
return []simDevice{
{UDID: "udid-a", Name: "iPhone 15", State: "Booted", IsAvailable: true},
{UDID: "udid-b", Name: "iPad Pro", State: "Booted", IsAvailable: true},
}, nil
}
_, _, err := ResolveTarget(context.Background(), "")
if err == nil {
t.Fatal("expected ambiguity error for multiple booted simulators")
}
message := err.Error()
for _, want := range []string{"--ios-device", "iPhone 15", "udid-a", "iPad Pro", "udid-b"} {
if !strings.Contains(message, want) {
t.Errorf("ambiguity error missing %q: %v", want, message)
}
}
}
func TestResolveTarget_BootedListError(t *testing.T) {
swapResolveSeams(t)
listBootedAll = func(context.Context) ([]simDevice, error) { return nil, errors.New("xcrun blew up") }
if _, _, err := ResolveTarget(context.Background(), ""); err == nil {
t.Fatal("expected booted-list error to propagate")
}
}
func TestParseBootedDevices_CollectsAllBooted(t *testing.T) {
got, err := parseBootedDevices([]byte(`{"devices":{"r":[
{"udid":"a","state":"Booted","name":"iPhone 15","isAvailable":true},
{"udid":"b","state":"Shutdown","name":"iPad","isAvailable":true},
{"udid":"c","state":"Booted","name":"iPhone 16","isAvailable":true}
]}}`))
if err != nil {
t.Fatal(err)
}
if len(got) != 2 {
t.Fatalf("got %d booted, want 2", len(got))
}
}
func TestEnsureSimulator_BootedListError(t *testing.T) {
origListBooted := listBooted
t.Cleanup(func() { listBooted = origListBooted })
listBooted = func(context.Context) (*simDevice, error) { return nil, errors.New("xcrun blew up") }
err := EnsureSimulator(context.Background(), "", new(bytes.Buffer))
if err == nil {
t.Fatal("expected error to propagate")
}
if !strings.Contains(err.Error(), "xcrun blew up") {
t.Errorf("error should wrap cause, got %v", err)
}
}