biome

type Biome interface {
	// Describe returns information about the execution environment.
	// The caller must not modify the returned Descriptor.
	Describe() *Descriptor

	// Dirs returns paths to special directories.
	// The caller must not modify the returned Dirs.
	Dirs() *Dirs

	// Run runs a program specified by the given invocation and waits for
	// it to complete. Run must not modify any fields in the Invocation or
	// retain them after Run returns.
	Run(ctx context.Context, invoke *Invocation) error

	// JoinPath joins any number of path elements into a single path.
	// The result is cleaned as if by path/filepath.Clean, however, if the
	// argument list is empty or all its elements are empty, JoinPath
	// returns an empty string.
	JoinPath(elem ...string) string

	// IsAbsPath reports whether the path is absolute.
	IsAbsPath(path string) bool
}

type BiomeCloser interface {
	Biome
	io.Closer
}

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

type ContainerOptions struct {
	// PackageDir is the path on the host where the package is located.
	// Must not be empty and the directory must exist.
	PackageDir string
	// HomeDir is the path on the host to use as the biome's home directory.
	// Must not be empty and the directory must exist.
	HomeDir string
	// TiniExe is a stream of TiniURL's contents. Must be non-nil.
	TiniExe io.Reader

	// PullOutput is where any `docker pull` progress output is sent to.
	// If nil, this output is discarded.
	PullOutput io.Writer
	// Definition optionally specifies details about the container to create.
	Definition *narwhal.ContainerDefinition
	// NetworkID is a Docker network ID to connect the container to, if not empty.
	NetworkID string
}

type Descriptor struct {
	OS   string
	Arch string
}

type Dirs struct {
	// Package is the absolute path of the package directory.
	// Biomes guarantee this directory exists.
	Package string

	// Home is the absolute path of the build HOME directory.
	// Biomes guarantee this directory exists.
	Home string

	// Tools is the absolute path of a directory where helper tools can be
	// installed. It is not shared with other biomes. It may have to be
	// created.
	Tools string
}

type EnvBiome struct {
	Biome
	Env Environment
}

type Environment struct {
	// Vars is a mapping of variables.
	Vars map[string]string
	// PrependPath is a list of paths to prepend to PATH.
	PrependPath []string
	// AppendPath is a list of paths to append to PATH.
	AppendPath []string
}

type ExecPrefix struct {
	Biome
	PrependArgv []string
}

type Fake struct {
	// Separator is the path separator character. If NUL, then slash '/' is used.
	Separator rune

	// Descriptor is the descriptor that will be returned by Describe.
	Descriptor Descriptor

	// DirsResult is what will be returned by Dirs.
	DirsResult Dirs

	// RunFunc is called to handle the Run method.
	RunFunc func(context.Context, *Invocation) error
}

type Invocation struct {
	// Argv is the argument list. Argv[0] is the name of the program to execute.
	Argv []string

	// Dir is the directory to execute the program in. Paths are resolved relative to
	// the package directory. If empty, then it will be executed in the package
	// directory. It is separated by the biome's path separator.
	Dir string

	// Env specifies additional environment variables to send to the program.
	// The biome may provide additional environment variables to the program, but
	// will not override the provided environment variables.
	Env Environment

	// Stdin specifies the program's standard input.
	// If Stdin is nil, the program reads from the null device.
	Stdin io.Reader

	// Interactive indicates whether the program will be surfaced to the user
	// interactively. This usually indicates that the program should be given
	// a pseudo-TTY as input.
	Interactive bool

	// Stdout and Stderr specify the program's standard output and error.
	// If either is nil, Run connects the corresponding file descriptor to the
	// null device.
	//
	// If Stdout and Stderr are the same writer, and have a type that can
	// be compared with ==, at most one goroutine at a time will call Write.
	Stdout io.Writer
	Stderr io.Writer
}

type Local struct {
	// PackageDir is the absolute path to a directory containing the source files
	// of the package.
	PackageDir string

	// HomeDir is the absolute path to a directory that should be used as HOME.
	// This directory may or may not exist. It SHOULD NOT be the user's actual
	// home directory. It's meant for storing configuration and intermediate files
	// that any build tools need.
	HomeDir string
}