runtime

type ContainerEvent struct {
	Timestamp   time.Time
	Type        string
	Action      string
	ActorID     string
	ActorName   string
	ActorFullID string
	Attributes  map[string]string
}

type ContainerLogOptions struct {
	// Tail limits the output to the last lines of the log; nil writes the whole log.
	Tail *int64
	// Follow keeps writing new log lines until the context ends.
	Follow bool
	// Timestamps prefixes every line with its timestamp.
	Timestamps bool
}

type ContainerLogWriter interface {
	// WriteContainerLogs writes the container's stdout and stderr to the given writers. A
	// container with a TTY has one combined stream, written to stdout.
	WriteContainerLogs(
		ctx context.Context,
		containerName string,
		opts ContainerLogOptions,
		stdout, stderr io.Writer,
	) error
}

type ContainerMount struct {
	Source      string
	Destination string
}

type ContainerRuntime interface {
	// Initializes the Container runtime struct
	Init(...RuntimeOption) error
	// Mgmt return management network configuration of a runtime
	Mgmt() *clabtypes.MgmtNet
	// Adds custom configuration items to the container runtime struct
	WithConfig(*RuntimeConfig)
	// Set the network management details (generated by the config.go)
	WithMgmtNet(*clabtypes.MgmtNet)
	// Instructs the runtime not to delete the mgmt network on destroy
	WithKeepMgmtNet()
	// CreateNet creates or inspects the management network and stores its resolved subnets.
	CreateNet(context.Context, ...NetworkCreateOptions) error
	// NetworkAddresses snapshots occupied addresses from networks whose pools
	// overlap the requested subnets. Disjoint networks must not be inspected.
	NetworkAddresses(context.Context, []netip.Prefix) ([]NetworkAddress, error)
	// Delete container (bridge) network
	DeleteNet(context.Context) error
	// Pull container image if not present
	PullImage(context.Context, string, clabtypes.PullPolicyValue) error
	// CreateContainer creates a container, but does not start it
	CreateContainer(context.Context, *clabtypes.NodeConfig) (string, error)
	// Start pre-created container by its name. Returns an extra interface that can be used to
	// receive signals
	// about the container life-cycle after it was created, e.g. for post-deploy tasks
	StartContainer(context.Context, string, Node) (any, error)
	// Stop running container by its name AND signal to use
	StopContainer(ctx context.Context, name string, stopSignal clabtypes.Signal) error
	// Pause a container identified by its name
	PauseContainer(context.Context, string) error
	// UnPause / resume a container identified by its name
	UnpauseContainer(context.Context, string) error
	// List all containers matching labels
	ListContainers(context.Context, []*clabtypes.GenericFilter) ([]GenericContainer, error)
	// Get a netns path using the name of a container
	GetNSPath(context.Context, string) (string, error)
	// LogNonRunningContainerOutput fetches recent stdout/stderr from a container that is not
	// running and logs it (best-effort; no-op on inspect failure). Used so deploy failures
	// surface root cause when link attach runs after a fast exit.
	LogNonRunningContainerOutput(ctx context.Context, containerName string)
	// Executes cmd on container identified with id and returns stdout, stderr bytes and an error
	Exec(ctx context.Context, cID string, execCmd *clabexec.ExecCmd) (*clabexec.ExecResult, error)
	// ExecNotWait executes cmd on container identified with id but doesn't wait for output nor
	// attaches stdout/err
	ExecNotWait(ctx context.Context, cID string, execCmd *clabexec.ExecCmd) error
	// Delete container by its name
	DeleteContainer(context.Context, string) error
	// Getter for runtime config options
	Config() RuntimeConfig
	GetName() string
	// GetHostsPath returns fs path to a file which is mounted as /etc/hosts into a given container
	GetHostsPath(context.Context, string) (string, error)
	// GetContainerStatus retrieves the ContainerStatus of the named container
	GetContainerStatus(ctx context.Context, cID string) ContainerStatus
	// IsHealthy returns true is the container is reported as being healthy, false otherwise
	IsHealthy(ctx context.Context, cID string) (bool, error)
	// Immediately write to the stdin of a container, returns error
	WriteToStdinNoWait(ctx context.Context, cID string, data []byte) error
	// CheckConnectivity returns an error if it cannot connect to the runtime, nil otherwise
	CheckConnection(ctx context.Context) error
	// GetRuntimeSocket returns the path to the control socket
	GetRuntimeSocket() (string, error)
	// GetCooCBindMounts returns the extra mounts a container running this runtime in
	// Container-outside-of-Container (CooC - General case – container uses host container
	// runtime) does need to function properly
	GetCooCBindMounts() clabtypes.Binds
	// StreamLogs returns a reader for the container's logs
	// The caller needs to close the returned ReadCloser.
	StreamLogs(ctx context.Context, containerName string) (io.ReadCloser, error)
	// StreamEvents streams runtime events that match provided options.
	StreamEvents(
		ctx context.Context,
		opts EventStreamOptions,
	) (<-chan ContainerEvent, <-chan error, error)
	// InspectImage returns detailed information about a container image
	InspectImage(ctx context.Context, imageName string) (*ImageInspect, error)
	// CopyToContainer copies the contents of the given host path into the named container's
	// destination path.
	// The path must be a file, and the the destination directory must exist inside the container
	CopyToContainer(ctx context.Context, cID string, dstPath string, srcPath string) error
	// SyncMgmtHostRoutes reconciles host routes to current management endpoints.
	SyncMgmtHostRoutes(context.Context) error
}

type ContainerStatus string

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

type EventStreamOptions struct {
	Labels map[string]string
}

type GenericContainer struct {
	Names           []string
	ID              string
	ShortID         string // trimmed ID for display purposes
	Image           string
	State           string
	Status          string
	Labels          map[string]string
	Pid             int
	NetworkName     string
	NetworkSettings GenericMgmtIPs
	Mounts          []ContainerMount
	Runtime         ContainerRuntime
	Ports           []*clabtypes.GenericPortBinding
	// Workload locates the node's Kubernetes workload; it is only set by lab runtimes.
	Workload *clabtypes.LabRuntimeWorkload `json:",omitempty"`
}

type GenericMgmtIPs struct {
	IPv4addr string
	IPv4pLen int
	IPv4Gw   string
	IPv6addr string
	IPv6pLen int
	IPv6Gw   string
}

type GraphDriver struct {
	Name string
	Data GraphDriverData
}

type GraphDriverData struct {
	UpperDir  string
	WorkDir   string
	MergedDir string
}

type ImageConfig struct {
	Labels map[string]string
}

type ImageInspect struct {
	ID          string
	Config      ImageConfig
	RootFS      RootFS
	GraphDriver GraphDriver
}

type Initializer func() ContainerRuntime

type MgmtBridgeResolver interface {
	// ResolveMgmtBridge sets the bridge of the bound management network when the
	// network exists and the bridge is not set yet. A missing network is not an error.
	ResolveMgmtBridge(context.Context) error
}

type MgmtNetBinder interface {
	// ForMgmtNet returns a copy of the runtime bound to the given management network
	ForMgmtNet(*clabtypes.MgmtNet) ContainerRuntime
}

type MgmtNetworkChecker interface {
	// MgmtNetworkExists reports whether the management network bound to the runtime
	// exists.
	MgmtNetworkExists(context.Context) (bool, error)
}

type NetworkAddress struct {
	NetworkName string
	ContainerID string
	Address     netip.Addr
}

type NetworkCreateOptions struct {
	StaticAddresses []netip.Addr
}

type Node interface {
	Config() *clabtypes.NodeConfig
	GetEndpoints() []clablinks.Endpoint
}

type RootFS struct {
	Type   string
	Layers []string
}

type RuntimeConfig struct {
	Timeout          time.Duration
	GracefulShutdown bool
	Debug            bool
	KeepMgmtNet      bool
	LabNamespace     string
	VerifyLinkParams *clablinks.VerifyLinkParams
}

type RuntimeOption func(ContainerRuntime)