mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-02 19:17:10 +00:00
* fix(cli): fall back to node_modules for @uatu/spec resolution
Drop the hard failure when the uatu source tree is not reachable from
the spec file. Users integrating uatu in their own app have @uatu/spec
installed via npm; esbuild now resolves it from node_modules.
* build(gradle): drop :sample-app include from root settings
The sample now has its own Gradle project in examples/sample-app/android.
* build(sample-app): vendor gradle wrapper
Users running the sample build the APK via ./gradlew from inside the
sample-app's own android/ directory, no repo-root wrapper required.
* build(sample-app): make gradle project standalone
Drop the project(':sdk-android') dependency in favor of the Maven
Central coordinate io.github.priyanshujain:sdk-android. The sample now
owns its settings.gradle.kts and gradle.properties, so it builds
without any pieces of the uatu source tree.
* chore(sample-app): declare @uatu/spec npm dependency
Mirrors what a downstream user would put in their own package.json.
Uses file: for pre-release development; becomes a normal semver pin
once @uatu/spec ships to npm.
* docs(sample-app): rewrite justfile and add README
Justfile drops repo_root; all recipes run against the local gradle
wrapper and uatu from PATH. README is scoped to what a user needs to
run the sample against their own device.
* docs(manual): update sample install steps to standalone layout
./gradlew :sample-app:installDebug no longer exists; the sample owns
its own wrapper under android/.
* feat(sdk): log when Uatu.start succeeds
Silent SDK start makes the "SDK didn't connect" failure mode
impossible to debug. One INFO line at start time is enough.
* fix(sidecar): launch via am start -W instead of monkey
monkey -p <pkg> -c LAUNCHER 1 is unreliable on API 36+: it reports no
error but silently fails to start the activity, so the SDK never runs
and the CLI times out on the SDK-accept handshake.
Resolve the launcher activity via `cmd package resolve-activity
--brief` and launch it with `am start -W -n`. -W makes the call block
until the activity is up, which also makes the subsequent SDK
accept timing deterministic.
* feat(cli): auto-resolve Android device; boot AVD if none connected
--avd becomes optional. Resolution order:
- use any already-connected adb device;
- else if --avd names an existing AVD, boot it and wait for boot;
- else if --avd is missing or names no AVD, error with a clear message.
Falls back to $ANDROID_HOME/emulator/emulator when the binary is not on
PATH, so a standard Android SDK install works without extra shell setup.
* docs(sample-app): AVD is optional; document both paths
just test runs against any connected device. If none, pass AVD=<name>
to have uatu boot the emulator for you.
* feat(cli): auto-discover Android SDK; auto-pick the lone AVD
adb and emulator are looked up via PATH, then $ANDROID_HOME,
$ANDROID_SDK_ROOT, ~/Library/Android/sdk, ~/Android/Sdk, and the
Homebrew cask path. The discovered platform-tools directory is
prepended to the sidecar's PATH so its adb subprocess calls work too.
When --avd isn't passed and no device is connected, the CLI picks the
sole local AVD and boots it. Multiple AVDs → error listing them.
* build(make): add `make install` that go-installs uatu onto PATH
Puts `uatu` into $GOBIN (or $GOPATH/bin) so the sample and any local
dev flow can call it without PATH= prefixes.
* docs(sample-app): zero-config just test; dotenv-load for persistence
Drop the expectation that users prefix commands with PATH=, ANDROID_HOME=,
or AVD=. `just test` now works as-is; optional knobs can be pinned in a
.env file alongside the justfile.
* fix(sample-app): auto-detect ANDROID_HOME for Gradle tasks
The Go CLI finds the SDK itself, but AGP still needs ANDROID_HOME to
resolve `sdk.dir`. The justfile now resolves it from env or canonical
install paths before invoking ./gradlew, so `just install` works out
of the box on a standard Android SDK setup.
* gitignore runs directory for sample app
255 lines
7.7 KiB
Go
255 lines
7.7 KiB
Go
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"math/rand/v2"
|
|
"net"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/priyanshujain/uatu/internal/agent"
|
|
"github.com/priyanshujain/uatu/internal/bundler"
|
|
"github.com/priyanshujain/uatu/internal/driver/maestro"
|
|
"github.com/priyanshujain/uatu/internal/runner"
|
|
"github.com/priyanshujain/uatu/internal/sidecar"
|
|
"github.com/priyanshujain/uatu/internal/trace"
|
|
"github.com/priyanshujain/uatu/internal/verifier"
|
|
)
|
|
|
|
const (
|
|
socketName = "uatu-agent"
|
|
sidecarStartupTimeout = 30 * time.Second
|
|
sdkAcceptTimeout = 60 * time.Second
|
|
)
|
|
|
|
func runTestPipeline(ctx context.Context, options testOptions, stdout io.Writer) error {
|
|
if options.platform == "android" {
|
|
if err := ensureDevice(ctx, options.avd, stdout); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
aliases := map[string]string{}
|
|
if specApiPath := resolveSpecAPIPath(options.spec); specApiPath != "" {
|
|
aliases["@uatu/spec"] = specApiPath
|
|
}
|
|
bundle, err := bundler.Bundle(bundler.Options{
|
|
EntryFile: options.spec,
|
|
Defines: map[string]string{
|
|
"UATU_TEST_PHONE": os.Getenv("UATU_TEST_PHONE"),
|
|
"UATU_TEST_OTP": os.Getenv("UATU_TEST_OTP"),
|
|
},
|
|
Aliases: aliases,
|
|
})
|
|
if err != nil {
|
|
return fmt.Errorf("bundle spec: %w", err)
|
|
}
|
|
fmt.Fprintf(stdout, "bundled spec: %d bytes (sha256=%s)\n", len(bundle.JavaScript), bundle.SHA256[:12])
|
|
|
|
sidecarDirectory := filepath.Join(os.TempDir(), "uatu-sidecar")
|
|
jarPath, err := sidecar.Extract(sidecarDirectory)
|
|
if err != nil {
|
|
return fmt.Errorf("extract sidecar: %w", err)
|
|
}
|
|
fmt.Fprintf(stdout, "sidecar JAR: %s (size=%d)\n", jarPath, sidecar.EmbeddedSize())
|
|
|
|
sidecarPort, err := pickFreePort()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
sidecarCommand := exec.CommandContext(ctx, "java", "-jar", jarPath,
|
|
"--port", strconv.Itoa(sidecarPort),
|
|
"--platform", options.platform,
|
|
)
|
|
sidecarCommand.Stdout = stdout
|
|
sidecarCommand.Stderr = stdout
|
|
sidecarCommand.Env = envWithAndroidPlatformTools(os.Environ())
|
|
if err := sidecarCommand.Start(); err != nil {
|
|
return fmt.Errorf("spawn sidecar: %w", err)
|
|
}
|
|
defer func() {
|
|
if sidecarCommand.Process != nil {
|
|
_ = sidecarCommand.Process.Kill()
|
|
}
|
|
}()
|
|
fmt.Fprintf(stdout, "sidecar pid=%d listening on 127.0.0.1:%d\n", sidecarCommand.Process.Pid, sidecarPort)
|
|
|
|
driverClient, err := maestro.Dial(fmt.Sprintf("127.0.0.1:%d", sidecarPort))
|
|
if err != nil {
|
|
return fmt.Errorf("dial sidecar: %w", err)
|
|
}
|
|
defer driverClient.Close()
|
|
healthCtx, healthCancel := context.WithTimeout(ctx, sidecarStartupTimeout)
|
|
if err := driverClient.WaitForHealth(healthCtx, 250*time.Millisecond); err != nil {
|
|
healthCancel()
|
|
return fmt.Errorf("sidecar health check: %w", err)
|
|
}
|
|
healthCancel()
|
|
fmt.Fprintln(stdout, "sidecar is healthy")
|
|
|
|
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
|
if err != nil {
|
|
return fmt.Errorf("agent listener: %w", err)
|
|
}
|
|
defer listener.Close()
|
|
agentPort := listener.Addr().(*net.TCPAddr).Port
|
|
|
|
if err := adbReverse(socketName, agentPort); err != nil {
|
|
return fmt.Errorf("adb reverse: %w", err)
|
|
}
|
|
defer func() {
|
|
if err := adbReverseRemove(socketName); err != nil {
|
|
fmt.Fprintf(stdout, "warning: adb reverse cleanup: %v\n", err)
|
|
}
|
|
}()
|
|
fmt.Fprintf(stdout, "forwarded localabstract:%s -> tcp:%d\n", socketName, agentPort)
|
|
|
|
agentServer := agent.NewServer(listener)
|
|
|
|
type acceptResult struct {
|
|
connection *agent.Conn
|
|
err error
|
|
}
|
|
acceptChannel := make(chan acceptResult, 1)
|
|
go func() {
|
|
acceptCtx, cancel := context.WithTimeout(ctx, sdkAcceptTimeout)
|
|
defer cancel()
|
|
connection, acceptErr := agentServer.Accept(acceptCtx)
|
|
acceptChannel <- acceptResult{connection: connection, err: acceptErr}
|
|
}()
|
|
|
|
if err := driverClient.Launch(ctx, options.bundleID, options.launcherActivity, false); err != nil {
|
|
return fmt.Errorf("launch app: %w", err)
|
|
}
|
|
fmt.Fprintf(stdout, "launched %s; waiting for SDK to connect (%.0fs timeout)\n", options.bundleID, sdkAcceptTimeout.Seconds())
|
|
|
|
result := <-acceptChannel
|
|
if result.err != nil {
|
|
return fmt.Errorf("accept SDK: %w", result.err)
|
|
}
|
|
connection := result.connection
|
|
defer connection.Close()
|
|
hello := connection.Hello()
|
|
fmt.Fprintf(stdout, "SDK connected: platform=%s app=%s sdk=%s\n", hello.Platform, hello.AppPackage, hello.Version)
|
|
|
|
seed := options.seed
|
|
if seed == 0 {
|
|
seed = time.Now().UnixNano()
|
|
}
|
|
verifierInstance, err := verifier.New(verifier.WithRand(rand.New(rand.NewPCG(uint64(seed), 0))))
|
|
if err != nil {
|
|
return fmt.Errorf("verifier: %w", err)
|
|
}
|
|
if err := verifierInstance.Load(string(bundle.JavaScript)); err != nil {
|
|
return fmt.Errorf("load spec: %w", err)
|
|
}
|
|
fmt.Fprintln(stdout, "spec loaded into verifier")
|
|
|
|
runDirectory := filepath.Join(options.output, time.Now().UTC().Format("20060102-150405"))
|
|
traceWriter, err := trace.NewWriter(runDirectory)
|
|
if err != nil {
|
|
return fmt.Errorf("trace writer: %w", err)
|
|
}
|
|
defer traceWriter.Close()
|
|
if err := traceWriter.WriteMeta(trace.Meta{
|
|
Seed: seed,
|
|
SpecPath: options.spec,
|
|
BundleSHA256: bundle.SHA256,
|
|
Platform: options.platform,
|
|
BundleID: options.bundleID,
|
|
StartedAt: time.Now().UTC(),
|
|
UatuVersion: "0.0.1",
|
|
}); err != nil {
|
|
return fmt.Errorf("trace meta: %w", err)
|
|
}
|
|
fmt.Fprintf(stdout, "trace dir: %s\n", runDirectory)
|
|
|
|
fmt.Fprintf(stdout, "running for %s (seed=%d)\n", options.duration, seed)
|
|
summary, err := runner.Run(ctx, runner.Options{
|
|
Duration: options.duration,
|
|
SnapshotTimeout: 5 * time.Second,
|
|
IdleTimeout: 1 * time.Second,
|
|
Connection: connection,
|
|
Driver: driverClient,
|
|
Verifier: verifierInstance,
|
|
TraceWriter: traceWriter,
|
|
})
|
|
|
|
terminateCtx, terminateCancel := context.WithTimeout(context.Background(), 5*time.Second)
|
|
_ = driverClient.Terminate(terminateCtx)
|
|
terminateCancel()
|
|
|
|
if err != nil {
|
|
return fmt.Errorf("runner: %w", err)
|
|
}
|
|
|
|
fmt.Fprintf(stdout, "\nrun complete: %d steps in %s\n", summary.Steps, summary.EndTime.Sub(summary.StartTime).Round(time.Millisecond))
|
|
if len(summary.Violations) == 0 {
|
|
fmt.Fprintln(stdout, "no violations.")
|
|
} else {
|
|
fmt.Fprintf(stdout, "%d violation record(s):\n", len(summary.Violations))
|
|
for _, violation := range summary.Violations {
|
|
fmt.Fprintf(stdout, " step %d: %v\n", violation.StepIndex, violation.Properties)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// resolveSpecAPIPath returns the path to pkg/spec-api/src/index.ts inside
|
|
// a uatu source checkout, searched upward from the spec file and the cwd.
|
|
// Returns "" when not found, in which case esbuild resolves @uatu/spec via
|
|
// node_modules the way a downstream user's project would.
|
|
func resolveSpecAPIPath(specPath string) string {
|
|
candidates := []string{}
|
|
if absoluteSpec, err := filepath.Abs(specPath); err == nil {
|
|
directory := filepath.Dir(absoluteSpec)
|
|
for {
|
|
candidates = append(candidates, filepath.Join(directory, "pkg/spec-api/src/index.ts"))
|
|
parent := filepath.Dir(directory)
|
|
if parent == directory {
|
|
break
|
|
}
|
|
directory = parent
|
|
}
|
|
}
|
|
if cwd, err := os.Getwd(); err == nil {
|
|
candidates = append(candidates, filepath.Join(cwd, "pkg/spec-api/src/index.ts"))
|
|
}
|
|
for _, candidate := range candidates {
|
|
if _, err := os.Stat(candidate); err == nil {
|
|
return candidate
|
|
}
|
|
}
|
|
return ""
|
|
}
|
|
|
|
func pickFreePort() (int, error) {
|
|
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
defer listener.Close()
|
|
return listener.Addr().(*net.TCPAddr).Port, nil
|
|
}
|
|
|
|
func adbReverse(socket string, port int) error {
|
|
adb, err := adbBinary()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
command := exec.Command(adb, "reverse", "localabstract:"+socket, fmt.Sprintf("tcp:%d", port))
|
|
return command.Run()
|
|
}
|
|
|
|
func adbReverseRemove(socket string) error {
|
|
adb, err := adbBinary()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return exec.Command(adb, "reverse", "--remove", "localabstract:"+socket).Run()
|
|
}
|