sandbox

type Backend interface {
	Create(ctx context.Context, opts CreateOpts) (*Instance, error)
	Get(ctx context.Context, name string) (*Instance, error)
	List(ctx context.Context) ([]Instance, error)
	Start(ctx context.Context, name string) error
	Stop(ctx context.Context, name string) error
	Delete(ctx context.Context, name string) error

	CreateSnapshot(ctx context.Context, name, label string) error
	ListSnapshots(ctx context.Context, name string) ([]Snapshot, error)
	DeleteSnapshot(ctx context.Context, name, label string) error
	RestoreSnapshot(ctx context.Context, name, label string) error
	CloneFrom(ctx context.Context, source, label, newName string) error

	Capabilities() Capabilities
	Close() error
}

type Capabilities struct {
	Snapshots     bool
	CloneFrom     bool
	EgressControl bool
}

type ConsoleOpts struct {
	Env       []string
	RemoteCmd []string
}

type CreateOpts struct {
	Name   string
	Image  string
	CPU    string
	Memory int64
	Bare   bool // create instance only, skip provisioning and SSH wait
}

type EgressMode string

type Exec interface {
	Run(ctx context.Context, name string, opts ExecOpts) (exitCode int, err error)
	Output(ctx context.Context, name string, cmd []string) ([]byte, error)
	Console(ctx context.Context, name string, opts ConsoleOpts) error
	Ready(ctx context.Context, name string, timeout time.Duration) error
}

type ExecOpts struct {
	Cmd    []string
	Env    []string
	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer
	Root   bool // run as root instead of the configured sandbox user
}

type Factory func(cfg map[string]string) (Sandbox, error)

type FileEntry struct {
	Path  string      `json:"path"`
	Size  int64       `json:"size"`
	Mode  os.FileMode `json:"mode"`
	IsDir bool        `json:"is_dir"`
}

type Files interface {
	// WriteFile writes content to path inside the sandbox with the given mode.
	// uid/gid set the resulting file's ownership; pass negative values to
	// leave the backend default (root for filesystem-API writes; the
	// configured exec user for SSH/exec-based writes).
	WriteFile(ctx context.Context, name, path string, content []byte, mode os.FileMode, uid, gid int) error
	ReadFile(ctx context.Context, name, path string, maxBytes int64) (content []byte, truncated bool, err error)
	ListFiles(ctx context.Context, name, path string, recursive bool) ([]FileEntry, error)
	DeleteFile(ctx context.Context, name, path string) error
}

type Instance struct {
	Name      string
	Status    Status
	Addresses []string
}

type NetworkPolicy interface {
	SetEgressMode(ctx context.Context, name string, mode EgressMode) error
	AllowDomain(ctx context.Context, name, domain string) error
	DenyDomain(ctx context.Context, name, domain string) error
	GetPolicy(ctx context.Context, name string) (*Policy, error)
}

type Policy struct {
	Mode    EgressMode
	Domains []string
}

type Sandbox interface {
	Backend
	Exec
	Files
	NetworkPolicy
}

type Snapshot struct {
	Label     string
	Size      int64
	CreatedAt time.Time
}

type Status string