environment

type Arch string

type Container interface {
	// Name is the name of the container runtime. e.g. docker, containerd
	Name() string
	// Provision provisions/installs the container runtime.
	// Should be idempotent.
	Provision(ctx context.Context) error
	// Start starts the container runtime.
	Start(ctx context.Context) error
	// Stop stops the container runtime.
	Stop(ctx context.Context) error
	// Teardown tears down/uninstall the container runtime.
	Teardown(ctx context.Context) error
	// Update the container runtime.
	Update(ctx context.Context) (bool, error)
	// Version returns the container runtime version.
	Version(ctx context.Context) string
	// Running returns if the container runtime is currently running.
	Running(ctx context.Context) bool

	Dependencies
}

type DataDisk struct {
	Dirs     []DiskDir // the directories to be mounted
	PreMount []string  // the scripts to run before mounting the directories
	FSType   string    // the filesystem type for the disk e.g. ext4
}

type Dependencies interface {
	// Dependencies are dependencies that must exist on the host.
	// TODO this may need to accommodate non-brew installable dependencies
	Dependencies() []string
}

type DiskDir struct {
	Name string
	Path string
}

type GuestActions interface {

	// Start starts up the VM
	Start(ctx context.Context, conf config.Config) error
	// Stop shuts down the VM
	Stop(ctx context.Context, force bool) error
	// Restart restarts the VM
	Restart(ctx context.Context) error
	// SSH performs an ssh connection to the VM
	SSH(workingDir string, args ...string) error
	// Created returns if the VM has been previously created.
	Created() bool
	// Running returns if the VM is currently running.
	Running(ctx context.Context) bool
	// Env retrieves environment variable in the VM.
	Env(string) (string, error)
	// Get retrieves a configuration in the VM.
	Get(key string) string
	// Set sets configuration in the VM.
	Set(key, value string) error
	// User returns the username of the user in the VM.
	User() (string, error)
	// Arch returns the architecture of the VM.
	Arch() Arch
	// contains filtered or unexported methods
}

type Host interface {
	HostActions
}

type HostActions interface {

	// WithEnv creates a new instance based on the current instance
	// with the specified environment variables.
	WithEnv(env ...string) HostActions
	// WithDir creates a new instance based on the current instance
	// with the working directory set to dir.
	WithDir(dir string) HostActions
	// Env retrieves environment variable on the host.
	Env(string) string
	// contains filtered or unexported methods
}

type NewContainerFunc func(host HostActions, guest GuestActions) Container

type VM interface {
	GuestActions
	Dependencies
	Host() HostActions
	Teardown(ctx context.Context) error
}