cockpitrun

type ExportDependencies ¶

type ExportDependencies struct {
	// LoadRecord reads this machine's daemon record for a projects root.
	LoadRecord func(root string) (daemon.State, bool, error)
	// Alive reports whether a process id is a running process. On macOS it asks
	// launchd (`launchctl print`, which changes nothing), so a daemon started in
	// the foreground by hand is reported as not running there.
	Alive func(int) bool
	// ProcessStart observes when a process started, to tell the daemon the record
	// was written for from a process that Now holds its recycled id. It reads
	// /proc on Linux and reports false elsewhere.
	ProcessStart func(int) (time.Time, bool)
	// Client is the HTTP Client for the daemon's loopback listener.
	Client func() *http.Client
	Now    func() time.Time
}

ExportDependencies is everything `wb cockpit export` touches. It deliberately has no seam that starts a daemon, mints a login code or opens a browser (cockpit-views#req:cockpit-export-verb): the verb reads the daemon record and makes anonymous loopback reads, and tests prove that no start path is reachable from it (a structural test of this struct and a call-graph test of this file).

func DefaultExportDependencies() ExportDependencies

type ExportFailure ¶

type ExportFailure string

ExportFailure is one of the three typed reasons the verb reports on stdout with exit code 1, or empty for none. It is its code and nothing else: no error text of a dependency, no path and no response body reaches an operator or a pipe.

type ExportRequest ¶

type ExportRequest struct {
	Root        string
	MetricsOnly bool
}

type ExportResult ¶

type ExportResult struct {
	Body    []byte
	Drops   cockpitfleet.ExportDrops
	Failure ExportFailure
}

func Export(ctx context.Context, deps ExportDependencies, request ExportRequest) ExportResult

type LocalRequest ¶

type LocalRequest struct {
	Root, Listen string
	Mint         bool
}

type LocalService ¶

type LocalService struct {
	// contains filtered or unexported fields
}

func NewLocalService(deps daemonruntime.Dependencies, login LoginOperation) LocalService

func (service LocalService) Local(ctx context.Context, request LocalRequest) (LocalSession, error)

type LocalSession ¶

type LocalSession struct {
	Listen  string
	Warning string
	Code    string
	Path    string
	Key     string
}

LocalSession is what a local invocation learns from the daemon: its listen address, a non-fatal warning from the start-or-reuse path, and, when one was requested, the login code, the path it is redeemed at and the session key of the session the code starts (cockpit#req:session-key).

type LoginOperation ¶

type LoginOperation func(context.Context, *http.Client) (cockpit.LoginCode, string, error)