core

type Action struct {

	// Name is required for all actions. It's the name of the action's output.
	// The name shouldn't include version of the package and should represents
	// its content (e.g. cpython3, curl, ninja), NOT the action taken place
	// (e.g. build_cpython3, build_curl, build_ninja).
	// This name doesn't need to be unique and won't be used for deduplication,
	// but may be used as the placeholder for the path to the package during
	// transformation.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Metadata contains metadata information which won't affect the result of the
	// output. It can be used by package manager for cache/store packages and
	// helping users to identify its content.
	Metadata *Action_Metadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Dependencies which PackageManager will ensure being available prior to the
	// execution of this Action.
	// TODO: Maybe move dependencies into specs?
	Deps []*Action `protobuf:"bytes,3,rep,name=deps,proto3" json:"deps,omitempty"`
	// Spec is the action spec describing what action we want to perform.
	// It can be extended using extension for domain-specific use cases.
	// See cipkg/base/actions.ActionProcessor for additional details.
	//
	// Types that are assignable to Spec:
	//
	//	*Action_Command
	//	*Action_Url
	//	*Action_Copy
	//	*Action_Cipd
	//	*Action_Extension
	Spec isAction_Spec `protobuf_oneof:"spec"`
	// contains filtered or unexported fields
}

type ActionCIPDExport struct {

	// Ensure_file is the serialized text ensure file for cipd.
	EnsureFile string `protobuf:"bytes,1,opt,name=ensure_file,json=ensureFile,proto3" json:"ensure_file,omitempty"`
	// Env is the extra environment variables passed to the cipd process.
	Env []string `protobuf:"bytes,2,rep,name=env,proto3" json:"env,omitempty"`
	// contains filtered or unexported fields
}

type ActionCommand struct {
	Args []string `protobuf:"bytes,1,rep,name=args,proto3" json:"args,omitempty"`
	Env  []string `protobuf:"bytes,2,rep,name=env,proto3" json:"env,omitempty"`
	// contains filtered or unexported fields
}

type ActionFilesCopy struct {

	// Files are the destination-source pairs which is the relative path
	// source files should be copied to.
	Files map[string]*ActionFilesCopy_Source `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

type ActionFilesCopy_Source struct {
	Mode uint32 `protobuf:"varint,1,opt,name=mode,proto3" json:"mode,omitempty"`
	// Types that are assignable to Content:
	//
	//	*ActionFilesCopy_Source_Raw
	//	*ActionFilesCopy_Source_Local_
	//	*ActionFilesCopy_Source_Embed_
	//	*ActionFilesCopy_Source_Output_
	Content isActionFilesCopy_Source_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

type ActionFilesCopy_Source_Embed struct {

	// Ref is the reference to the embed.FS.
	Ref string `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// Path is the relative path to the file inside the embedded filesystem.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

type ActionFilesCopy_Source_Embed_ struct {
	// Embed refers to the embedded file in the go binary.
	Embed *ActionFilesCopy_Source_Embed `protobuf:"bytes,4,opt,name=embed,proto3,oneof"`
}

type ActionFilesCopy_Source_Local struct {

	// Path is the local filesystem absolute path to the file.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Version is the version string for the file.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Follow_symlinks, if set to true, will follow all the symlinks in the
	// directories while copying.
	FollowSymlinks bool `protobuf:"varint,3,opt,name=follow_symlinks,json=followSymlinks,proto3" json:"follow_symlinks,omitempty"`
	// contains filtered or unexported fields
}

type ActionFilesCopy_Source_Local_ struct {
	// Local refers to the local file.
	Local *ActionFilesCopy_Source_Local `protobuf:"bytes,3,opt,name=local,proto3,oneof"`
}

type ActionFilesCopy_Source_Output struct {

	// Name is the output action's Metadata.Name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Path is the relative path to the file inside the output.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

type ActionFilesCopy_Source_Output_ struct {
	// Output refers to the output file from other derivations.
	Output *ActionFilesCopy_Source_Output `protobuf:"bytes,5,opt,name=output,proto3,oneof"`
}

type ActionFilesCopy_Source_Raw struct {
	// Raw contains the literal content of the file.
	Raw []byte `protobuf:"bytes,2,opt,name=raw,proto3,oneof"`
}

type ActionURLFetch struct {

	// HTTP(s) url for the remote resource.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// HashAlgorithm is the hash function used to calculate hash value.
	HashAlgorithm HashAlgorithm `protobuf:"varint,2,opt,name=hash_algorithm,json=hashAlgorithm,proto3,enum=HashAlgorithm" json:"hash_algorithm,omitempty"`
	// HashValue is the lower-case text representation for the hex value of the
	// hash sum.
	HashValue string `protobuf:"bytes,3,opt,name=hash_value,json=hashValue,proto3" json:"hash_value,omitempty"`
	// contains filtered or unexported fields
}

type Action_Cipd struct {
	Cipd *ActionCIPDExport `protobuf:"bytes,7,opt,name=cipd,proto3,oneof"`
}

type Action_Command struct {
	Command *ActionCommand `protobuf:"bytes,4,opt,name=command,proto3,oneof"`
}

type Action_Copy struct {
	Copy *ActionFilesCopy `protobuf:"bytes,6,opt,name=copy,proto3,oneof"`
}

type Action_Extension struct {
	Extension *anypb.Any `protobuf:"bytes,99,opt,name=extension,proto3,oneof"`
}

type Action_Metadata struct {

	// Dependencies which PackageManager will ensure being available prior to
	// the use of this Action's output.
	RuntimeDeps []*Action                `protobuf:"bytes,1,rep,name=runtime_deps,json=runtimeDeps,proto3" json:"runtime_deps,omitempty"`
	Cipd        *Action_Metadata_CIPD    `protobuf:"bytes,2,opt,name=cipd,proto3" json:"cipd,omitempty"`
	Luciexe     *Action_Metadata_LUCIExe `protobuf:"bytes,3,opt,name=luciexe,proto3" json:"luciexe,omitempty"`
	// context_info can be used to indicate what this action related to - this
	// can help e.g. differentiate action with same content but comes from
	// different generator.
	ContextInfo string `protobuf:"bytes,4,opt,name=context_info,json=contextInfo,proto3" json:"context_info,omitempty"`
	// contains filtered or unexported fields
}

type Action_Metadata_CIPD struct {

	// Name is the cipd package name for the Action's output.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Version is the cipd version tag for action's output.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

type Action_Metadata_LUCIExe struct {

	// step_name is the name of this action when it's being executed under
	// luciexe framework.
	StepName string `protobuf:"bytes,1,opt,name=step_name,json=stepName,proto3" json:"step_name,omitempty"`
	// contains filtered or unexported fields
}

type Action_Url struct {
	Url *ActionURLFetch `protobuf:"bytes,5,opt,name=url,proto3,oneof"`
}

type Derivation struct {

	// Name is the name of the derivation's output and serves ONLY as an
	// indicator of its output.
	// The name shouldn't include version of the package and should represents
	// its content (e.g. cpython3, curl, ninja), NOT the action taken place
	// (e.g. build_cpython3, build_curl, build_ninja).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Platform is a textual description of the platform in which this Derivation
	// should be performed, and serves ONLY as an indicator of implicit
	// environmental contamination of the output of the derivation.
	// Actions should relies on cipkg/base/actions.ActionProcessor to populate
	// this field appropriately.
	Platform string `protobuf:"bytes,2,opt,name=platform,proto3" json:"platform,omitempty"`
	// Args are the `argv` vector of the derivation when executed.
	Args []string `protobuf:"bytes,3,rep,name=args,proto3" json:"args,omitempty"`
	// Env includes all the environment variables for the execution isolated from
	// host.
	// NOTE: ${out} is not included here but will be presented in the environment
	// during execution.
	Env []string `protobuf:"bytes,4,rep,name=env,proto3" json:"env,omitempty"`
	// Inputs are ids of all packages referred by this derivation.
	// It depends on the package manager to ensure packages represented by the
	// derivation IDs will be available before execution.
	// Ideally derivation should only be able to access derivations listed in the
	// inputs. Executor may lock down the runtime environment to prevent the
	// derivation from accessing any resource other than those listed in the
	// future.
	Inputs []string `protobuf:"bytes,5,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// fixed_output, if set, represents the content of the output. ID will be
	// generated based on fixed_output exclusively.
	// WARNING: Using fixed_output means shifting away the responsibility for
	// detecting any change from derivation. This should be rarely touched and
	// most of its use cases have a builtin implementation to take care of the
	// generated fixed_output value. Any use of it outside the builtin modules
	// are strongly discouraged. YOU HAVE BEEN WARNED.
	FixedOutput string `protobuf:"bytes,6,opt,name=fixed_output,json=fixedOutput,proto3" json:"fixed_output,omitempty"`
	// contains filtered or unexported fields
}

type HashAlgorithm int32

type PackageHandler interface {
	// OutputDirectory() returns the output directory.
	OutputDirectory() string

	// LoggingDirectory() returns the logging directory.
	LoggingDirectory() string

	// Build(buildFunc) makes packages available in the storage.
	// It's responsible for:
	// - Hold exclusive lock to the package during the build.
	// - Ensure build only happens once unless the package is removed.
	// - Check the remote cache server (if possible).
	// - Set up the build environment (e.g. create output directory).
	// - Mark package available if build function successfully returns.
	// Calling build function is expected to trigger the actual build iff package
	// isn't available yet.
	Build(builder func() error) error

	// TryRemove() may remove the package only if there is no reference to it.
	TryRemove() (ok bool, err error)

	// Reference the package to prevent it from being removed while in use.
	// IncRef() updates the last access time of the package as well.
	// IncRef() only succeeds if the package is available.
	// Otherwise ErrPackageNotExist will be returned.
	IncRef() error
	DecRef() error
}

type PackageManager interface {
	// Get(id) returns the handler for the package.
	Get(id string) PackageHandler
}