DockerCLI/vendor/github.com/moby/buildkit/client/llb/state.go

package llb

import (
	"context"

	"github.com/moby/buildkit/solver/pb"
	"github.com/moby/buildkit/util/system"
	digest "github.com/opencontainers/go-digest"
)

type StateOption func(State) State

type Output interface {
	ToInput() (*pb.Input, error)
	Vertex() Vertex
}

type Vertex interface {
	Validate() error
	Marshal() (digest.Digest, []byte, *OpMetadata, error)
	Output() Output
	Inputs() []Output
}

func NewState(o Output) State {
	s := State{
		out: o,
		ctx: context.Background(),
	}
	s = dir("/")(s)
	s = addEnv("PATH", system.DefaultPathEnv)(s)
	return s
}

type State struct {
	out Output
	ctx context.Context
}

func (s State) WithValue(k, v interface{}) State {
	return State{
		out: s.out,
		ctx: context.WithValue(s.ctx, k, v),
	}
}

func (s State) Value(k interface{}) interface{} {
	return s.ctx.Value(k)
}

func (s State) Marshal(md ...MetadataOpt) (*Definition, error) {
	def := &Definition{
		Metadata: make(map[digest.Digest]OpMetadata, 0),
	}
	if s.Output() == nil {
		return def, nil
	}
	def, err := marshal(s.Output().Vertex(), def, map[digest.Digest]struct{}{}, map[Vertex]struct{}{}, md)
	if err != nil {
		return def, err
	}
	inp, err := s.Output().ToInput()
	if err != nil {
		return def, err
	}
	proto := &pb.Op{Inputs: []*pb.Input{inp}}
	dt, err := proto.Marshal()
	if err != nil {
		return def, err
	}
	def.Def = append(def.Def, dt)
	return def, nil
}

func marshal(v Vertex, def *Definition, cache map[digest.Digest]struct{}, vertexCache map[Vertex]struct{}, md []MetadataOpt) (*Definition, error) {
	if _, ok := vertexCache[v]; ok {
		return def, nil
	}
	for _, inp := range v.Inputs() {
		var err error
		def, err = marshal(inp.Vertex(), def, cache, vertexCache, md)
		if err != nil {
			return def, err
		}
	}

	dgst, dt, opMeta, err := v.Marshal()
	if err != nil {
		return def, err
	}
	vertexCache[v] = struct{}{}
	if opMeta != nil {
		m := mergeMetadata(def.Metadata[dgst], *opMeta)
		for _, f := range md {
			f.SetMetadataOption(&m)
		}
		def.Metadata[dgst] = m
	}
	if _, ok := cache[dgst]; ok {
		return def, nil
	}
	def.Def = append(def.Def, dt)
	cache[dgst] = struct{}{}
	return def, nil
}

func (s State) Validate() error {
	return s.Output().Vertex().Validate()
}

func (s State) Output() Output {
	return s.out
}

func (s State) WithOutput(o Output) State {
	return State{
		out: o,
		ctx: s.ctx,
	}
}

func (s State) Run(ro ...RunOption) ExecState {
	ei := &ExecInfo{State: s}
	for _, o := range ro {
		o.SetRunOption(ei)
	}
	meta := Meta{
		Args:     getArgs(ei.State),
		Cwd:      getDir(ei.State),
		Env:      getEnv(ei.State),
		User:     getUser(ei.State),
		ProxyEnv: ei.ProxyEnv,
	}

	exec := NewExecOp(s.Output(), meta, ei.ReadonlyRootFS, ei.Metadata())
	for _, m := range ei.Mounts {
		exec.AddMount(m.Target, m.Source, m.Opts...)
	}

	return ExecState{
		State: s.WithOutput(exec.Output()),
		exec:  exec,
	}
}

func (s State) AddEnv(key, value string) State {
	return s.AddEnvf(key, value)
}

func (s State) AddEnvf(key, value string, v ...interface{}) State {
	return addEnvf(key, value, v...)(s)
}

func (s State) Dir(str string) State {
	return s.Dirf(str)
}
func (s State) Dirf(str string, v ...interface{}) State {
	return dirf(str, v...)(s)
}

func (s State) GetEnv(key string) (string, bool) {
	return getEnv(s).Get(key)
}

func (s State) GetDir() string {
	return getDir(s)
}

func (s State) GetArgs() []string {
	return getArgs(s)
}

func (s State) Reset(s2 State) State {
	return reset(s2)(s)
}

func (s State) User(v string) State {
	return user(v)(s)
}

func (s State) With(so ...StateOption) State {
	for _, o := range so {
		s = o(s)
	}
	return s
}

type output struct {
	vertex   Vertex
	getIndex func() (pb.OutputIndex, error)
	err      error
}

func (o *output) ToInput() (*pb.Input, error) {
	if o.err != nil {
		return nil, o.err
	}
	var index pb.OutputIndex
	if o.getIndex != nil {
		var err error
		index, err = o.getIndex()
		if err != nil {
			return nil, err
		}
	}
	dgst, _, _, err := o.vertex.Marshal()
	if err != nil {
		return nil, err
	}
	return &pb.Input{Digest: dgst, Index: index}, nil
}

func (o *output) Vertex() Vertex {
	return o.vertex
}

type MetadataOpt interface {
	SetMetadataOption(*OpMetadata)
	RunOption
	LocalOption
	HTTPOption
	ImageOption
	GitOption
}

type metadataOptFunc func(m *OpMetadata)

func (fn metadataOptFunc) SetMetadataOption(m *OpMetadata) {
	fn(m)
}

func (fn metadataOptFunc) SetRunOption(ei *ExecInfo) {
	ei.ApplyMetadata(fn)
}

func (fn metadataOptFunc) SetLocalOption(li *LocalInfo) {
	li.ApplyMetadata(fn)
}

func (fn metadataOptFunc) SetHTTPOption(hi *HTTPInfo) {
	hi.ApplyMetadata(fn)
}

func (fn metadataOptFunc) SetImageOption(ii *ImageInfo) {
	ii.ApplyMetadata(fn)
}

func (fn metadataOptFunc) SetGitOption(gi *GitInfo) {
	gi.ApplyMetadata(fn)
}

func mergeMetadata(m1, m2 OpMetadata) OpMetadata {
	if m2.IgnoreCache {
		m1.IgnoreCache = true
	}
	if len(m2.Description) > 0 {
		if m1.Description == nil {
			m1.Description = make(map[string]string)
		}
		for k, v := range m2.Description {
			m1.Description[k] = v
		}
	}
	if m2.ExportCache != nil {
		m1.ExportCache = m2.ExportCache
	}

	return m1
}

var IgnoreCache = metadataOptFunc(func(md *OpMetadata) {
	md.IgnoreCache = true
})

func WithDescription(m map[string]string) MetadataOpt {
	return metadataOptFunc(func(md *OpMetadata) {
		md.Description = m
	})
}

// WithExportCache forces results for this vertex to be exported with the cache
func WithExportCache() MetadataOpt {
	return metadataOptFunc(func(md *OpMetadata) {
		md.ExportCache = &pb.ExportCache{Value: true}
	})
}

// WithoutExportCache sets results for this vertex to be not exported with
// the cache
func WithoutExportCache() MetadataOpt {
	return metadataOptFunc(func(md *OpMetadata) {
		// ExportCache with value false means to disable exporting
		md.ExportCache = &pb.ExportCache{Value: false}
	})
}

// WithoutDefaultExportCache resets the cache export for the vertex to use
// the default defined by the build configuration.
func WithoutDefaultExportCache() MetadataOpt {
	return metadataOptFunc(func(md *OpMetadata) {
		// nil means no vertex based config has been set
		md.ExportCache = nil
	})
}

type opMetaWrapper struct {
	OpMetadata
}

func (mw *opMetaWrapper) ApplyMetadata(f func(m *OpMetadata)) {
	f(&mw.OpMetadata)
}

func (mw *opMetaWrapper) Metadata() OpMetadata {
	return mw.OpMetadata
}