actions

type ActionProcessor ¶

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

ActionProcessor processes and transforms actions into packages.

func NewActionProcessor() *ActionProcessor

func (ap *ActionProcessor) Process(buildPlat string, pm core.PackageManager, a *core.Action) (Package, error)

type Executor ¶

type Executor[M proto.Message] func(ctx context.Context, msg M, out string) error

Executor is the type of the Executor for action spec M. When the function is invoked, the action associated with the message spec should be executed. `out` is the output path for the artifacts generated by the executor.

type Package ¶

type Package struct {
	Handler core.PackageHandler

	DerivationID string
	Derivation   *core.Derivation

	BuildDependencies   []Package
	RuntimeDependencies []Package

	ActionID string
	Action   *core.Action
}

Package represents a high-level package including: - A storage handler for the package. - The transformed derivation and its unique id. - All its dependencies. - The action responsible for the package's content. All dependencies will be available duing build time (e.g for testing) but only runtime dependencies will be ensured to be available at runtime. Potentially we can cache or reuse package to avoid transform the same action multiple times if performance is to be considered.

type ReadLinkFS ¶

type ReadLinkFS interface {
	fs.FS

	// ReadLink returns the destination of the named symbolic link.
	// Link destinations will always be slash-separated paths.
	// NOTE: Although in the standard library the link destination is guaranteed
	// to be a path inside FS. We may return host destination for our use cases.
	ReadLink(name string) (string, error)
}

ReadLinkFS is the interface implemented by a file system that supports symbolic links. TODO(fancl): Replace it with https://github.com/golang/go/issues/49580

type ReexecRegistry ¶

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

ReexecRegistry is the registry for actions that requires implemented in the binary itself.

By default, NewReexecRegistry registers the following Reexec Executors:

• core.ActionURLFetch
• core.ActionFilesCopy
• core.ActionCIPDExport

In order for a binary to work with reexec actions, you must call the .Intercept() function very early in your program's `main()`. This will intercept the invocation of this program and divert execution control to the registered Executor.

Programs may register additional Executors in this registry using SetExecutor or MustSetExecutor functions from this package.

func NewReexecRegistry() *ReexecRegistry

func (r *ReexecRegistry) Intercept(ctx context.Context)

type Transformer ¶

type Transformer[M proto.Message] func(M, []Package) (*core.Derivation, error)

Transformer is the function transforms an action specification to a derivation.