sanderling/internal/testrun/preflight.go

package testrun

import (
	"context"
	"fmt"
	"os/exec"
)

// Preflight runs platform-specific host checks before sidecar/driver setup.
// On failure it returns a wrapped error pointing the user at the matching
// `sanderling doctor --platform=<p>` command. Web returns nil (no host
// prerequisites beyond a working chromium, which the driver will surface
// itself if missing).
func Preflight(ctx context.Context, platform string) error {
	check := preflightCheck
	return runPreflight(ctx, platform, check)
}

type preflightFunc func(name string) error

func preflightCheck(name string) error {
	if _, err := exec.LookPath(name); err != nil {
		return fmt.Errorf("%s not found on PATH: %w", name, err)
	}
	return nil
}

func runPreflight(ctx context.Context, platform string, check preflightFunc) error {
	if err := ctx.Err(); err != nil {
		return err
	}
	switch platform {
	case "web":
		return nil
	case "android":
		if err := check("adb"); err != nil {
			return preflightFailure("android", err)
		}
		if err := check("java"); err != nil {
			return preflightFailure("android", err)
		}
		return nil
	case "ios":
		// Simulator runs drive the native companion and need no JVM. The java
		// requirement is deferred to the physical-device path in buildDriver.
		if err := check("xcrun"); err != nil {
			return preflightFailure("ios", err)
		}
		return nil
	default:
		return fmt.Errorf("preflight: unknown platform %q", platform)
	}
}

// preflightDevice runs the extra host checks the JVM sidecar path needs once we
// know a run targets a physical iOS device. Android already requires java in
// the top-level Preflight, so this only matters for ios.
func preflightDevice(platform string) error {
	return runPreflightDevice(platform, preflightCheck)
}

func runPreflightDevice(platform string, check preflightFunc) error {
	if platform != "ios" {
		return nil
	}
	if err := check("java"); err != nil {
		// The doctor splits simulator and device checks: java lives under the
		// ios-device platform, so the hint must point there.
		return preflightFailure("ios-device", err)
	}
	return nil
}

func preflightFailure(platform string, cause error) error {
	return fmt.Errorf(
		"preflight: %w\nrun `sanderling doctor --platform=%s` for full host-readiness checks",
		cause, platform,
	)
}