fleet

type Config struct {
	Client    *http.Client
	Endpoint  url.URL
	SSHTunnel SSHTunnel

	// Logger provides an initialised logger.
	Logger logging.Logger
}

type DummyConfig struct {
	Logger logging.Logger
}

type DummyFleet struct {
	Config DummyConfig
	Units  map[string]UnitStatus
	Mutex  sync.Mutex
}

type Fleet interface {
	// Submit schedules a unit on the configured fleet cluster. This is done by
	// setting the unit's target state to loaded.
	Submit(ctx context.Context, name, content string) error

	// Start starts a unit on the configured fleet cluster. This is done by
	// setting the unit's target state to launched.
	Start(ctx context.Context, name string) error

	// Stop stops a unit on the configured fleet cluster. This is done by
	// setting the unit's target state to loaded.
	Stop(ctx context.Context, name string) error

	// Destroy delets a unit on the configured fleet cluster. This is done by
	// setting the unit's target state to inactive.
	Destroy(ctx context.Context, name string) error

	// GetStatus fetches the current status of a unit. If the unit cannot be
	// found, an error that you can identify using IsUnitNotFound is returned.
	GetStatus(ctx context.Context, name string) (UnitStatus, error)

	// GetStatusWithMatcher returns a []UnitStatus, with an element for
	// each unit where the given matcher returns true.
	GetStatusWithMatcher(func(string) bool) ([]UnitStatus, error)
}

type MachineStatus struct {
	// ID represents the machines fleet agent ID where the related unit is
	// running on.
	ID string

	// IP represents the machines IP where the related unit is running on.
	IP net.IP

	// SystemdActive represents the unit's systemd active state.
	SystemdActive string

	// SystemdSub represents the unit's systemd sub state.
	SystemdSub string

	// UnitHash represents a unique token to identify the content of the unitfile.
	UnitHash string
}

type SSHTunnel interface {
	http.RoundTripper

	// IsActive determines whether the tunnel should be used. This is decided by
	// the given tunnel configuration. In case this is empty, the SSH tunnel is
	// not active.
	IsActive() bool
}

type SSHTunnelConfig struct {
	Endpoint              url.URL
	KnownHostsFile        string
	Logger                logging.Logger
	StrictHostKeyChecking bool
	Tunnel                string
	Timeout               time.Duration
	Username              string
}

type UnitStatus struct {
	// Current represents the current status within the fleet cluster.
	Current string

	// Desired represents the desired status within the fleet cluster.
	Desired string

	// Machine represents the status within a machine. For normal units that are
	// scheduled on only one machine there will be one MachineStatus returned.
	// For global units that are scheduled on multiple machines there will be
	// multiple MachineStatus returned. If a unit is not yet scheduled to any
	// machine, this will be empty.
	Machine []MachineStatus

	// Name represents the unit file name.
	Name string

	// Slice represents the slice ID. E.g. 1, or foo, or 5., etc..
	SliceID string
}