executor

type Docker struct {
	Bin         string
	ProxyBinary string // a static linux ynf, run as the egress proxy
	ProxyImage  string // the image the proxy runs in; default alpine:3.20
}

type Executor interface {
	Name() string
	// Contained reports whether the executor confines the run (ADR-007).
	Contained() bool
	// Paths returns the worktree and run folder as the command sees them.
	Paths(j Job) (worktree, runDir string)
	Run(ctx context.Context, j Job) (Output, error)
}

type Inline struct {
	// User is the user runs run as; default ynh, the user an agent image is built for.
	User string
	// Chown changes a path's owner; nil is os.Lchown. For tests.
	Chown func(path string, uid, gid int) error
	// Credential sets the user a command runs as; nil runs it as that user. For tests.
	Credential func(c *exec.Cmd, uid, gid uint32)
}

type Job struct {
	Argv     []string
	Env      map[string]string
	Worktree string // host path, real (no symlinks)
	RunDir   string // host path for the run's files and caches
	Image    string
	Egress   []string
	Timeout  time.Duration
	// ImageUser keeps the image's own user and home: an agent image built by ynh keeps its
	// harness and vendor configuration under its user's home.
	ImageUser bool
	// Secrets reach the run by name only: docker reads each value from its own environment, so a
	// secret never appears in a command line or a process listing.
	Secrets map[string]string
	// Share are folders the run needs beside its own, if any; the inline executor hands them to the run user too.
	Share []string
	// Spool is the run's own spool folder on the host, when it has one (ynr ADR-004): the run
	// writes its telemetry there, as YNR_SPOOL. A docker run has this folder mounted at SpoolDir,
	// and nothing else of the spool; the inline executor hands it to the run user.
	Spool string
	// NoOTLP starts the run without the operator's OTEL_EXPORTER_OTLP_*: the collector is on, and
	// ynr serve ships to the operator's endpoint instead.
	NoOTLP bool
}

type Output struct {
	Exit   int
	Stdout []byte
	Stderr []byte
	Denied []string // hosts the egress proxy refused
}

type Process struct{}

type RunUser interface {
	// RunUID returns the user the run writes as and whether it is another than ynf's own, the
	// owner of the run's spool folder. An error means it could not be found out.
	RunUID(ctx context.Context, j Job) (uid uint32, other bool, err error)
}

type SpoolVolumes interface {
	SpoolVolume() bool
}