hostmaintenance

type Change struct {
	Name   string `json:"name"`
	Before string `json:"before"`
	After  string `json:"after"`
}

type Command struct {
	Name string
	Args []string
}

type Engine struct {
	Host Host
	// Progress receives rollout-style progress events. Nil discards them.
	Progress func(phase, status, message string, attrs map[string]string)
}

type FailureError struct{ Problem Problem }

type Host interface {
	// LookPath resolves an executable like exec.LookPath.
	LookPath(name string) (string, error)
	// ReadFile reads a file like os.ReadFile.
	ReadFile(path string) ([]byte, error)
	// Exists reports whether a path exists.
	Exists(path string) bool
	// LockHolder reports whether a process holds a POSIX write lock on path,
	// and its PID when known. A missing file is not locked.
	LockHolder(path string) (held bool, pid int, err error)
	// TryLock takes a POSIX write lock on path without waiting. A missing
	// file is created with createMode, or is an error when createMode is 0.
	// acquired is false when another process holds the lock. release drops
	// it; the kernel drops it when the process exits.
	TryLock(path string, createMode os.FileMode) (release func(), acquired bool, err error)
	// Processes lists every running process with its executable and argv.
	// A process that cannot be read for lack of permission is an error: an
	// incomplete list cannot rule a process out. Processes that exit while
	// they are read are skipped.
	Processes() ([]Process, error)
	// Executable is the absolute path of the running stackkit binary.
	Executable() (string, error)
	// Run executes a command. A nonzero exit is reported in Output.ExitCode
	// with a nil error; the error is for a command that could not run or a
	// context that ended.
	Run(ctx context.Context, command Command) (Output, error)
	// Now is the host clock.
	Now() time.Time
	// Sleep waits for d or until ctx ends.
	Sleep(ctx context.Context, d time.Duration) error
}

type LocalHost struct{}

type OSInfo struct {
	ID         string `json:"id"`
	VersionID  string `json:"version_id,omitempty"`
	PrettyName string `json:"pretty_name,omitempty"`
}

type Output struct {
	Stdout   string
	Stderr   string
	ExitCode int
}

type Package struct {
	Name     string `json:"name"`
	From     string `json:"from"`
	To       string `json:"to"`
	Security bool   `json:"security"`
}

type Problem struct {
	Code     string   `json:"code"`
	Message  string   `json:"message"`
	Guidance []string `json:"guidance,omitempty"`
}

type Process struct {
	PID  int
	Exe  string
	Args []string
}

type RefusalError struct{ Problem Problem }

type Result struct {
	SchemaVersion  string    `json:"schema_version"`
	Operation      string    `json:"operation"`
	ObservedAt     time.Time `json:"observed_at"`
	OS             *OSInfo   `json:"os,omitempty"`
	PackageManager string    `json:"package_manager,omitempty"`

	// Plan fields; apply repeats them from its re-simulation.
	PlanDigest    string    `json:"plan_digest,omitempty"`
	PendingCount  *int      `json:"pending_count,omitempty"`
	SecurityCount *int      `json:"security_count,omitempty"`
	Packages      []Package `json:"packages,omitempty"`
	Held          []Package `json:"held,omitempty"`
	KeptBack      []string  `json:"kept_back,omitempty"`
	HoldScope     string    `json:"hold_scope,omitempty"`
	RebootLikely  *bool     `json:"reboot_likely,omitempty"`
	DpkgProblems  []string  `json:"dpkg_problems,omitempty"`

	// Apply fields.
	Outcome                string    `json:"outcome,omitempty"`
	Unit                   string    `json:"unit,omitempty"`
	Changes                []Change  `json:"changes,omitempty"`
	RebootRequired         *bool     `json:"reboot_required,omitempty"`
	RebootRequiredPackages []string  `json:"reboot_required_packages,omitempty"`
	AutoMarksNotRestored   []string  `json:"auto_marks_not_restored,omitempty"`
	StartedAt              time.Time `json:"started_at,omitzero"`
	FinishedAt             time.Time `json:"finished_at,omitzero"`

	// Reboot fields.
	Scheduled    *bool     `json:"scheduled,omitempty"`
	BootIDBefore string    `json:"boot_id_before,omitempty"`
	ScheduledAt  time.Time `json:"scheduled_at,omitzero"`
	DelaySeconds int       `json:"delay_seconds,omitempty"`

	Refusal *Problem `json:"refusal,omitempty"`
	Failure *Problem `json:"failure,omitempty"`
}