Files
sanderling/cmd/sanderling/doctor_test.go
T
pj 90224dfd06 Physical-device iOS support (#64) (#66)
* feat(companion): add appState, eraseText, pressKey runner handlers

The Go runner transport already calls these methods; the in-device runner
implemented them only latently. They become load-bearing on the device
path, where the hybrid's legacy-companion fallback is absent. Backward
compatible: the simulator hybrid never calls them.

* feat(ios): resolve physical devices from devicectl

ResolveDevice parses xcrun devicectl list devices into Device{Name,
HardwareUDID, CoreDeviceID}: the hardware UDID feeds xcodebuild/iproxy
and the CoreDevice id feeds devicectl install. Matches by name or either
id; errors list candidates on none/ambiguous. Fixes the stale sidecar
comment on ResolveTarget.

* feat(ioscompanion): runner-only device driver mode

NewDevice reuses Driver with d.companion set to the runner dialed over an
iproxy usbmux tunnel, hybrid=false, runnerClient=nil. The existing accessor
seams then route launch/snapshot/text/gesture to the runner with no new
DeviceDriver methods. Device seams swap clear-state to a devicectl
reinstall, container reset to a warn-once no-op, and paste grant to a no-op.
realSpawnDeviceRunner builds and signs the runner at run time via the App
Store Connect API key (no Xcode UI), caching on a source hash.

* test(ioscompanion): cover device wiring, routing, and shell-out argv

Seam-driven NewDevice wiring + gesture/text routing (asserting no keyboard
HID), devicectl/build/test/iproxy argv builders, xctestrun test-target dict
name parsing, signing-credential env checks, and source-hash cache keying.

* feat(testrun): route physical-device iOS runs to the device driver

Execute resolves a non-simulator iOS target through ios.ResolveDevice into
its hardware UDID and CoreDevice id; buildDriver constructs NewDevice via a
seam instead of rejecting the device. Generalizes the --ios-device and
--ios-app-path help to cover the device path; signing stays env-read, never
a flag.

* feat(doctor): device prereqs replace java/sidecar for ios-device

iosDeviceChecks now verifies devicectl, iproxy on PATH, a connected+paired
device (via ios.ConnectedDevices), and App Store Connect signing creds (via
ioscompanion.VerifyDeviceSigning). The retired JVM sidecar checks stay only
under android.

* feat(conformance): device backend uses iphoneos app and tunnel orphan checks

The device backend now builds via just ios-device, points --ios-app-path at
the Debug-iphoneos bundle, and reinstalls each run for clear-state. The G5
orphan scan replaces the retired sidecar.jar check with lingering iproxy and
device test-without-building sessions (destination platform=iOS,id=).

* feat(folio): device build linking the iosArm64 framework

project.yml selects the Kotlin framework slice by SDK (iosArm64 for
iphoneos, iosSimulatorArm64 for simulator) and links via -framework Shared
on the SDK-conditional search path. New ios-device/test-ios-device recipes
mirror ios/test-ios, signing the Debug-iphoneos build with the .env API key.

* docs(cli): document ios-device doctor checks and the device flags

The --ios-device flag now also selects a connected device; --ios-app-path
covers the device install; the doctor gains an ios-device platform whose
checks are devicectl, iproxy, a paired device, and signing credentials.
Corrects the --clear-data default to true.

* fix(ioscompanion): resolve signing key path to absolute

xcodebuild's -authenticationKeyPath requires an absolute path, but .env
files commonly carry a repo-relative one. Resolve it against the working
directory before the stat so a relative ASC_API_KEY_PATH still signs.

* fix(ioscompanion): re-enable signing for the device runner build

companion/project.yml disables code signing for the simulator build, so
the device build inherited it and produced an unsigned runner that the
device rejected at install (0xe8008018). build-for-testing now forces
CODE_SIGNING_ALLOWED/REQUIRED=YES so automatic provisioning signs it.

* fix(ioscompanion): key the device build cache on signing identity

The cache marker hashed only sources, so switching signing team or key
reused a runner signed with the stale identity, which the device rejects at
install (0xe8008018). Fold team + key id into the cache key so a signing
change forces a rebuild.

* docs(getting-started): document physical iOS device setup

Lists the iproxy requirement and the App Store Connect signing env vars
(SANDERLING_IOS_TEAM, ASC_API_*) a device run needs, plus the
test-ios-device recipe and the doctor check.

* feat(ios): native usbmux client and in-process tunnel forwarder

Talk to macOS usbmuxd directly instead of shelling out to iproxy, so the
device path depends on nothing beyond macOS + Xcode.

* refactor(ios): drive device tunnel via io.Closer seam

Replace the tunnelChild *exec.Cmd and spawnTunnel seam with a tunnel
io.Closer and startTunnel seam backed by the in-process usbmux forwarder.

* refactor(ios): remove iproxy spawn from device runner

* test(ios): cover tunnel close via io.Closer not child process

* feat(doctor): check usbmuxd socket instead of iproxy on PATH

* chore(conformance): drop iproxy orphan check; tunnel is in-process

* docs(ios): device tunnel uses native usbmux, nothing to install

* chore: gitignore the signing keys directory

* feat(folio): add Android launcher icon (black bg, white dot)

* feat(folio): add iOS app icon (black bg, white dot)

* feat(folio): add web favicon (black bg, white dot)

* docs(ioscompanion): fix stale const comments

* refactor(ioscompanion): inline single-use devicectl argv builders

* refactor(ioscompanion): inline xcodegenArgs, drop tautological argv tests

* refactor(ioscompanion): inline firstNonEmpty

* refactor(doctor): dedup usbmuxd socket path via ioscompanion seam

* test(doctor): trim redundant signing-check test

* refactor(ioscompanion): deliver COMPANION_PORT via TEST_RUNNER_ env

* fix(testrun): seam preflight so iOS routing tests pass on CI without xcrun
2026-06-09 18:38:52 +05:30

250 lines
7.4 KiB
Go

package main
import (
"bytes"
"context"
"errors"
"flag"
"io"
"strings"
"testing"
"github.com/priyanshujain/sanderling/internal/ios"
)
func TestRunDoctorChecks_AllPass(t *testing.T) {
var stdout bytes.Buffer
checks := []doctorCheck{
{Name: "always ok", Run: func(context.Context) error { return nil }},
{Name: "also ok", Run: func(context.Context) error { return nil }},
}
if err := runDoctorChecks(context.Background(), checks, &stdout); err != nil {
t.Fatalf("expected nil error, got %v", err)
}
output := stdout.String()
if !strings.Contains(output, "OK always ok") || !strings.Contains(output, "OK also ok") {
t.Errorf("expected OK lines, got: %s", output)
}
}
func TestRunDoctorChecks_ReportsFailures(t *testing.T) {
var stdout bytes.Buffer
checks := []doctorCheck{
{Name: "ok", Run: func(context.Context) error { return nil }},
{Name: "broken", Run: func(context.Context) error { return errors.New("boom") }},
}
err := runDoctorChecks(context.Background(), checks, &stdout)
if err == nil || !strings.Contains(err.Error(), "1 check(s) failed") {
t.Fatalf("expected failure summary, got %v", err)
}
output := stdout.String()
if !strings.Contains(output, "FAIL broken") {
t.Errorf("expected FAIL line, got: %s", output)
}
}
func TestParseJavaMajor_AcceptsModernFormat(t *testing.T) {
cases := []struct {
input string
major int
}{
{`openjdk version "17.0.10"` + "\n", 17},
{`openjdk version "21" 2023-09-19` + "\n", 21},
{`java version "25.0.2" 2026-01-20` + "\n", 25},
{`openjdk version "1.8.0_402"` + "\n", 8},
}
for _, testCase := range cases {
got, err := parseJavaMajor(testCase.input)
if err != nil {
t.Errorf("parseJavaMajor(%q): unexpected error %v", testCase.input, err)
continue
}
if got != testCase.major {
t.Errorf("parseJavaMajor(%q): got %d, want %d", testCase.input, got, testCase.major)
}
}
}
func TestParseJavaMajor_RejectsUnrecognized(t *testing.T) {
_, err := parseJavaMajor("not java output\n")
if err == nil {
t.Errorf("expected error for unrecognized output")
}
}
func TestCheckExecutableOnPath_FindsRealCommand(t *testing.T) {
check := checkExecutableOnPath("ls")
if err := check(context.Background()); err != nil {
t.Errorf("ls should be on PATH on macOS/linux, got %v", err)
}
}
func TestCheckExecutableOnPath_MissingCommand(t *testing.T) {
check := checkExecutableOnPath("definitely-not-a-real-command-xyz-123")
if err := check(context.Background()); err == nil {
t.Errorf("expected error for missing command")
}
}
func TestDoctorChecksFor_Web_OmitsJava(t *testing.T) {
for _, c := range doctorChecksFor("web") {
if strings.Contains(c.Name, "java") || strings.Contains(c.Name, "sidecar") || strings.Contains(c.Name, "adb") {
t.Errorf("web checks should not include %q", c.Name)
}
}
if len(doctorChecksFor("web")) == 0 {
t.Error("web checks empty")
}
}
func TestDoctorChecksFor_Android_IncludesADB(t *testing.T) {
checks := doctorChecksFor("android")
found := false
for _, c := range checks {
if strings.Contains(c.Name, "adb") {
found = true
}
}
if !found {
t.Errorf("android checks missing adb: %+v", checks)
}
}
func TestDoctorChecksFor_iOS_IncludesXcrun(t *testing.T) {
checks := doctorChecksFor("ios")
found := false
for _, c := range checks {
if strings.Contains(c.Name, "xcrun") {
found = true
}
}
if !found {
t.Errorf("ios checks missing xcrun: %+v", checks)
}
}
func TestDoctorChecksFor_All_IsUnion(t *testing.T) {
all := doctorChecksFor("all")
names := map[string]int{}
for _, c := range all {
names[c.Name]++
}
for _, name := range []string{"adb on PATH", "xcrun on PATH (ios simulator)", "headless chromium can launch"} {
if names[name] != 1 {
t.Errorf("expected %q in 'all' exactly once, got %d", name, names[name])
}
}
}
func TestDoctorChecksFor_iOSSimulator_OmitsJava(t *testing.T) {
for _, c := range doctorChecksFor("ios") {
if strings.Contains(c.Name, "java") || strings.Contains(c.Name, "sidecar") {
t.Errorf("ios simulator checks must omit %q; simulator runs need no JVM", c.Name)
}
}
}
func TestDoctorChecksFor_iOSDevice_CoversDevicePrereqs(t *testing.T) {
checks := doctorChecksFor("ios-device")
for _, c := range checks {
if strings.Contains(c.Name, "java") || strings.Contains(c.Name, "sidecar") {
t.Errorf("device checks must not include the retired %q", c.Name)
}
}
for _, want := range []string{"devicectl", "usbmuxd", "connected and paired", "signing credentials"} {
found := false
for _, c := range checks {
if strings.Contains(c.Name, want) {
found = true
}
}
if !found {
t.Errorf("ios-device checks missing %q: %+v", want, checks)
}
}
}
func TestCheckDeviceConnected(t *testing.T) {
original := doctorConnectedDevices
t.Cleanup(func() { doctorConnectedDevices = original })
doctorConnectedDevices = func(context.Context) ([]ios.Device, error) {
return []ios.Device{{Name: "iPhone"}}, nil
}
if err := checkDeviceConnected(context.Background()); err != nil {
t.Fatalf("a connected device must pass: %v", err)
}
doctorConnectedDevices = func(context.Context) ([]ios.Device, error) { return nil, nil }
if err := checkDeviceConnected(context.Background()); err == nil {
t.Fatal("no device must fail")
}
}
func TestCheckDeviceSigning_SurfacesSeamResult(t *testing.T) {
// checkDeviceSigning is a passthrough to the driver's credential check; the
// credential logic itself is covered by TestReadSigningCredentials* in the
// ioscompanion package. Here we only confirm the wiring through the seam.
original := doctorVerifySigning
t.Cleanup(func() { doctorVerifySigning = original })
doctorVerifySigning = func() error { return nil }
if err := checkDeviceSigning(context.Background()); err != nil {
t.Fatalf("a passing signing check must surface nil: %v", err)
}
doctorVerifySigning = func() error { return errors.New("missing credentials") }
if err := checkDeviceSigning(context.Background()); err == nil {
t.Fatal("a failing signing check must surface the error")
}
}
func TestDoctorChecksFor_UnknownPlatform(t *testing.T) {
if got := doctorChecksFor("fuchsia"); got != nil {
t.Errorf("expected nil for unknown platform, got %+v", got)
}
}
func TestParseDoctorArgs_DefaultAll(t *testing.T) {
options, err := parseDoctorArgs(nil, io.Discard)
if err != nil {
t.Fatal(err)
}
if options.platform != "all" {
t.Errorf("default platform: got %q, want all", options.platform)
}
}
func TestParseDoctorArgs_ExplicitPlatform(t *testing.T) {
for _, form := range [][]string{
{"--platform", "web"},
{"--platform=web"},
} {
options, err := parseDoctorArgs(form, io.Discard)
if err != nil {
t.Fatalf("%v: %v", form, err)
}
if options.platform != "web" {
t.Errorf("%v: got platform=%q, want web", form, options.platform)
}
}
}
func TestParseDoctorArgs_RejectsUnknown(t *testing.T) {
if _, err := parseDoctorArgs([]string{"--platform=fuchsia"}, io.Discard); err == nil {
t.Error("expected error for unsupported platform")
}
if _, err := parseDoctorArgs([]string{"--bogus"}, io.Discard); err == nil {
t.Error("expected error for unknown argument")
}
}
func TestParseDoctorArgs_HelpReturnsErrHelp(t *testing.T) {
if _, err := parseDoctorArgs([]string{"-h"}, io.Discard); !errors.Is(err, flag.ErrHelp) {
t.Errorf("expected flag.ErrHelp for -h, got %v", err)
}
if _, err := parseDoctorArgs([]string{"--help"}, io.Discard); !errors.Is(err, flag.ErrHelp) {
t.Errorf("expected flag.ErrHelp for --help, got %v", err)
}
}