debian-forge-composer/vendor/github.com/osbuild/images/pkg/manifest/pipeline.go

package manifest

import (
	"github.com/osbuild/images/pkg/artifact"
	"github.com/osbuild/images/pkg/container"
	"github.com/osbuild/images/pkg/osbuild"
	"github.com/osbuild/images/pkg/ostree"
	"github.com/osbuild/images/pkg/platform"
	"github.com/osbuild/images/pkg/rpmmd"
)

// Pipeline serializes to a series of stages that modify a file system tree
// when used as input to osbuild. Different Pipelines serialize to different
// sequences of stages depending on their type and configuration.
type Pipeline interface {

	// Name of the pipeline.
	Name() string

	// Checkpoint this pipeline when osbuild is called.
	Checkpoint()

	// Export this tree of this pipeline as an artifact when osbuild is called.
	Export() *artifact.Artifact

	// BuildPipeline returns a reference to the pipeline that creates the build
	// root for this pipeline. For build pipelines, it should return nil.
	BuildPipeline() *Build

	// Manifest returns a reference to the Manifest which this Pipeline belongs to.
	Manifest() *Manifest

	getCheckpoint() bool

	getExport() bool

	// getBuildPackages returns the list of packages required for the pipeline
	// at build time.
	getBuildPackages(Distro) []string
	// getPackageSetChain returns the list of package names to be required by
	// the pipeline. Each set should be depsolved sequentially to resolve
	// dependencies and full package specs. See the dnfjson package for more
	// details.
	getPackageSetChain(Distro) []rpmmd.PackageSet
	// getContainerSources returns the list of containers sources to be resolved and
	// embedded by the pipeline. Each source should be resolved to its full
	// Spec. See the container package for more details.
	getContainerSources() []container.SourceSpec
	// getOSTreeCommitSources returns the list of ostree commit sources to be
	// resolved and added to the pipeline. Each source should be resolved to
	// its full Spec. See the ostree package for more details.
	getOSTreeCommitSources() []ostree.SourceSpec

	serializeStart([]rpmmd.PackageSpec, []container.Spec, []ostree.CommitSpec)
	serializeEnd()
	serialize() osbuild.Pipeline

	// getPackageSpecs returns the list of specifications for packages that
	// will be installed to the pipeline tree.
	getPackageSpecs() []rpmmd.PackageSpec
	// getContainerSpecs returns the list of specifications for the containers
	// that will be installed to the pipeline tree.
	getContainerSpecs() []container.Spec
	// getOSTreeCommits returns the list of specifications for the commits
	// required by the pipeline.
	getOSTreeCommits() []ostree.CommitSpec
	// getInline returns the list of inlined data content that will be used to
	// embed files in the pipeline tree.
	getInline() []string
}

// A Base represents the core functionality shared between each of the pipeline
// implementations, and the Base struct must be embedded in each of them.
type Base struct {
	manifest   *Manifest
	name       string
	build      *Build
	checkpoint bool
	export     bool
}

// Name returns the name of the pipeline. The name must be unique for a given manifest.
// Pipeline names are used to refer to pipelines either as dependencies between pipelines
// or for exporting them.
func (p Base) Name() string {
	return p.name
}

func (p *Base) Checkpoint() {
	p.checkpoint = true
}

func (p Base) getCheckpoint() bool {
	return p.checkpoint
}

func (p *Base) Export() *artifact.Artifact {
	panic("can't export pipeline")
}

func (p Base) getExport() bool {
	return p.export
}

func (p Base) BuildPipeline() *Build {
	return p.build
}

func (p Base) Manifest() *Manifest {
	return p.manifest
}

func (p Base) getBuildPackages(Distro) []string {
	return []string{}
}

func (p Base) getPackageSetChain(Distro) []rpmmd.PackageSet {
	return nil
}

func (p Base) getContainerSources() []container.SourceSpec {
	return nil
}

func (p Base) getOSTreeCommitSources() []ostree.SourceSpec {
	return nil
}

func (p Base) getPackageSpecs() []rpmmd.PackageSpec {
	return []rpmmd.PackageSpec{}
}

func (p Base) getOSTreeCommits() []ostree.CommitSpec {
	return nil
}

func (p Base) getContainerSpecs() []container.Spec {
	return nil
}

func (p Base) getInline() []string {
	return []string{}
}

// NewBase returns a generic Pipeline object. The name is mandatory, immutable and must
// be unique among all the pipelines used in a manifest, which is currently not enforced.
// The build argument is a pipeline representing a build root in which the rest of the
// pipeline is built. In order to ensure reproducibility a build pipeline must always be
// provided, except for int he build pipeline itself. When a build pipeline is not provided
// the build host's filesystem is used as the build root. The runner specifies how to use this
// pipeline as a build pipeline, by naming the distro it contains. When the host system is used
// as a build root, then the necessary runner is autodetected.
func NewBase(m *Manifest, name string, build *Build) Base {
	p := Base{
		manifest: m,
		name:     name,
		build:    build,
	}
	if build != nil {
		if build.Base.manifest != m {
			panic("build pipeline from a different manifest")
		}
	}
	return p
}

// serializeStart must be called exactly once before each call
// to serialize().
func (p Base) serializeStart([]rpmmd.PackageSpec, []container.Spec, []ostree.CommitSpec) {
}

// serializeEnd must be called exactly once after each call to
// serialize().
func (p Base) serializeEnd() {
}

// Serialize turns a given pipeline into an osbuild.Pipeline object. This object is
// meant to be treated as opaque and not to be modified further outside of the pipeline
// package.
func (p Base) serialize() osbuild.Pipeline {
	pipeline := osbuild.Pipeline{
		Name: p.name,
	}
	if p.build != nil {
		pipeline.Build = "name:" + p.build.Name()
	}
	return pipeline
}

// TreePipeline is any pipeline that produces a directory tree.
type TreePipeline interface {
	Name() string
	Manifest() *Manifest
	BuildPipeline() *Build
	Platform() platform.Platform
}

// FilePipeline is any pipeline that produces a single file (typically an image file).
type FilePipeline interface {
	Pipeline
	Filename() string
	SetFilename(fname string)
}