mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-02 19:17:10 +00:00
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
This commit is contained in:
97 files changed
+22104
-83
No files matched your search
@@ -0,0 +1,140 @@
|
||||
// Package runnerassets embeds the in-simulator runner test bundle and its
|
||||
// xctestrun, and extracts them to disk at runtime.
|
||||
package runnerassets
|
||||
|
||||
import (
|
||||
"archive/tar"
|
||||
"bytes"
|
||||
"compress/gzip"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// xctestrunName is the file name the staged test root uses for the runner's
|
||||
// xctestrun. The driver substitutes the port placeholder in this file before
|
||||
// launching, so it must not be renamed.
|
||||
const xctestrunName = "runner.xctestrun"
|
||||
|
||||
// EmbeddedSize returns the size in bytes of the embedded runner archive.
|
||||
func EmbeddedSize() int { return len(embeddedArchive) }
|
||||
|
||||
// EmbeddedSHA256 returns the hex-encoded SHA-256 of the embedded archive.
|
||||
func EmbeddedSHA256() string {
|
||||
sum := sha256.Sum256(embeddedArchive)
|
||||
return hex.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
// Extract unpacks the embedded runner archive into dir, preserving the test
|
||||
// root layout and any symlinks. A .sha256 marker next to the extracted tree
|
||||
// gates re-extraction: if it already matches, no rewrite happens. Returns the
|
||||
// absolute path to the extracted runner.xctestrun.
|
||||
func Extract(dir string) (string, error) {
|
||||
if len(embeddedArchive) == 0 {
|
||||
return "", errors.New("runner: binary built without -tags withcompanion; rebuild with `make sanderling`")
|
||||
}
|
||||
if err := os.MkdirAll(dir, 0o755); err != nil {
|
||||
return "", fmt.Errorf("mkdir %s: %w", dir, err)
|
||||
}
|
||||
|
||||
xctestrunPath, err := filepath.Abs(filepath.Join(dir, xctestrunName))
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
checksumPath := filepath.Join(dir, "runner.sha256")
|
||||
checksum := EmbeddedSHA256()
|
||||
|
||||
if existing, err := os.ReadFile(checksumPath); err == nil && string(existing) == checksum {
|
||||
if _, err := os.Stat(xctestrunPath); err == nil {
|
||||
return xctestrunPath, nil
|
||||
}
|
||||
}
|
||||
|
||||
if err := unpack(dir); err != nil {
|
||||
return "", err
|
||||
}
|
||||
if _, err := os.Stat(xctestrunPath); err != nil {
|
||||
return "", fmt.Errorf("runner: xctestrun missing after extraction: %w", err)
|
||||
}
|
||||
if err := os.WriteFile(checksumPath, []byte(checksum), 0o644); err != nil {
|
||||
return "", fmt.Errorf("write checksum: %w", err)
|
||||
}
|
||||
return xctestrunPath, nil
|
||||
}
|
||||
|
||||
func unpack(dir string) error {
|
||||
gzipReader, err := gzip.NewReader(bytes.NewReader(embeddedArchive))
|
||||
if err != nil {
|
||||
return fmt.Errorf("open runner archive: %w", err)
|
||||
}
|
||||
defer gzipReader.Close()
|
||||
|
||||
tarReader := tar.NewReader(gzipReader)
|
||||
for {
|
||||
header, err := tarReader.Next()
|
||||
if err == io.EOF {
|
||||
return nil
|
||||
}
|
||||
if err != nil {
|
||||
return fmt.Errorf("read runner archive: %w", err)
|
||||
}
|
||||
|
||||
if strings.HasPrefix(filepath.Base(header.Name), "._") {
|
||||
continue
|
||||
}
|
||||
|
||||
target, err := safeJoin(dir, header.Name)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
switch header.Typeflag {
|
||||
case tar.TypeDir:
|
||||
if err := os.MkdirAll(target, 0o755); err != nil {
|
||||
return err
|
||||
}
|
||||
case tar.TypeSymlink:
|
||||
if err := os.MkdirAll(filepath.Dir(target), 0o755); err != nil {
|
||||
return err
|
||||
}
|
||||
os.Remove(target)
|
||||
if err := os.Symlink(header.Linkname, target); err != nil {
|
||||
return err
|
||||
}
|
||||
case tar.TypeReg:
|
||||
if err := writeFile(target, tarReader, os.FileMode(header.Mode)); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func writeFile(path string, src io.Reader, mode os.FileMode) error {
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||
return err
|
||||
}
|
||||
file, err := os.OpenFile(path, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, mode)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if _, err := io.Copy(file, src); err != nil {
|
||||
file.Close()
|
||||
return err
|
||||
}
|
||||
return file.Close()
|
||||
}
|
||||
|
||||
// safeJoin rejects archive entries that would escape dir.
|
||||
func safeJoin(dir, name string) (string, error) {
|
||||
target := filepath.Join(dir, name)
|
||||
relative, err := filepath.Rel(dir, target)
|
||||
if err != nil || relative == ".." || strings.HasPrefix(relative, ".."+string(os.PathSeparator)) {
|
||||
return "", fmt.Errorf("archive entry escapes destination: %s", name)
|
||||
}
|
||||
return target, nil
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
//go:build withcompanion
|
||||
|
||||
package runnerassets
|
||||
|
||||
import _ "embed"
|
||||
|
||||
//go:embed assets/runner-1.0.0.tar.gz
|
||||
var embeddedArchive []byte
|
||||
|
||||
// IsPlaceholder reports whether the binary was built without the real runner
|
||||
// archive embedded. -tags withcompanion builds always return false.
|
||||
func IsPlaceholder() bool { return false }
|
||||
@@ -0,0 +1,10 @@
|
||||
//go:build !withcompanion
|
||||
|
||||
package runnerassets
|
||||
|
||||
var embeddedArchive []byte
|
||||
|
||||
// IsPlaceholder reports whether the binary was built without the real runner
|
||||
// archive embedded. Build with `make sanderling` (which passes
|
||||
// -tags withcompanion) to embed the real runner test bundle.
|
||||
func IsPlaceholder() bool { return true }
|
||||
@@ -0,0 +1,27 @@
|
||||
//go:build !withcompanion
|
||||
|
||||
package runnerassets
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestStubBuild_IsPlaceholder(t *testing.T) {
|
||||
if !IsPlaceholder() {
|
||||
t.Error("default build (no -tags withcompanion) must report a placeholder")
|
||||
}
|
||||
if EmbeddedSize() != 0 {
|
||||
t.Errorf("placeholder build must embed no archive, got %d bytes", EmbeddedSize())
|
||||
}
|
||||
}
|
||||
|
||||
func TestStubBuild_ExtractErrors(t *testing.T) {
|
||||
_, err := Extract(t.TempDir())
|
||||
if err == nil {
|
||||
t.Fatal("Extract must fail when no archive is embedded")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "withcompanion") {
|
||||
t.Errorf("error should tell the user to rebuild with -tags withcompanion, got %v", err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,143 @@
|
||||
//go:build withcompanion
|
||||
|
||||
package runnerassets
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestEmbeddedNonZero(t *testing.T) {
|
||||
if EmbeddedSize() == 0 {
|
||||
t.Errorf("expected embedded runner archive to be non-empty")
|
||||
}
|
||||
if IsPlaceholder() {
|
||||
t.Errorf("withcompanion build should not be a placeholder")
|
||||
}
|
||||
}
|
||||
|
||||
func TestEmbeddedSHA256Matches(t *testing.T) {
|
||||
sum := sha256.Sum256(embeddedArchive)
|
||||
if hex.EncodeToString(sum[:]) != EmbeddedSHA256() {
|
||||
t.Errorf("EmbeddedSHA256 does not match a fresh hash of the archive")
|
||||
}
|
||||
}
|
||||
|
||||
func TestExtract_WritesXctestrunAndChecksum(t *testing.T) {
|
||||
directory := t.TempDir()
|
||||
path, err := Extract(directory)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
expected, err := filepath.Abs(filepath.Join(directory, xctestrunName))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if path != expected {
|
||||
t.Errorf("unexpected xctestrun path: got %s want %s", path, expected)
|
||||
}
|
||||
|
||||
contents, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !strings.Contains(string(contents), "__COMPANION_PORT__") {
|
||||
t.Errorf("extracted xctestrun is missing the __COMPANION_PORT__ placeholder")
|
||||
}
|
||||
|
||||
checksum, err := os.ReadFile(filepath.Join(directory, "runner.sha256"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if string(checksum) != EmbeddedSHA256() {
|
||||
t.Errorf("checksum file content wrong: %q", checksum)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExtract_Layout(t *testing.T) {
|
||||
directory := t.TempDir()
|
||||
if _, err := Extract(directory); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
runnerApp := filepath.Join(directory, "Debug-iphonesimulator", "CompanionRunnerUITests-Runner.app")
|
||||
if stat, err := os.Stat(runnerApp); err != nil || !stat.IsDir() {
|
||||
t.Fatalf("runner app directory missing: %v", err)
|
||||
}
|
||||
|
||||
binary := filepath.Join(runnerApp, "CompanionRunnerUITests-Runner")
|
||||
if _, err := os.Stat(binary); err != nil {
|
||||
t.Errorf("runner app binary missing: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExtract_SymlinksResolve(t *testing.T) {
|
||||
directory := t.TempDir()
|
||||
if _, err := Extract(directory); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Simulator bundles are flat, so the runner app may contain no symlinks at
|
||||
// all. Any symlink that is present must resolve to a real target, proving
|
||||
// the unpack path restores links rather than copying broken stubs.
|
||||
root := filepath.Join(directory, "Debug-iphonesimulator")
|
||||
err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if info.Mode()&os.ModeSymlink != 0 {
|
||||
if _, statErr := os.Stat(path); statErr != nil {
|
||||
t.Errorf("symlink %s does not resolve: %v", path, statErr)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExtract_ReusesWhenChecksumMatches(t *testing.T) {
|
||||
directory := t.TempDir()
|
||||
xctestrunPath, err := Extract(directory)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
sentinel := []byte("SENTINEL-do-not-rewrite")
|
||||
if err := os.WriteFile(xctestrunPath, sentinel, 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if _, err := Extract(directory); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
after, err := os.ReadFile(xctestrunPath)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if string(after) != string(sentinel) {
|
||||
t.Errorf("second extract rewrote the xctestrun; reuse branch should have skipped extraction")
|
||||
}
|
||||
}
|
||||
|
||||
func TestExtract_RewritesIfChecksumMissing(t *testing.T) {
|
||||
directory := t.TempDir()
|
||||
if _, err := Extract(directory); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
checksumPath := filepath.Join(directory, "runner.sha256")
|
||||
if err := os.Remove(checksumPath); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := Extract(directory); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := os.Stat(checksumPath); err != nil {
|
||||
t.Errorf("checksum should have been rewritten: %v", err)
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user