types.go

package layers

import (
	"context"
	"io"

	"github.com/box-builder/box/builder/config"
	"github.com/box-builder/box/logger"
)

// Image needs a description
type Image interface {
	// SetContext sets the context for upcoming operations.
	SetContext(context.Context)

	// Flatten copies a tarred up series of files (passed in through the
	// io.Reader handle) to the image where they are untarred. The first argument
	// is the parent image to use.
	Flatten(string, int64, io.Reader) error

	// Tag the current layer. Takes a tag name as argument.
	Tag(string) error

	// CheckCache consults the cache to see if there are any items which fit it.
	CheckCache(string) (bool, error)

	// UseCache determines if the cache should be considered or not.
	UseCache(bool)

	// GetCache gets the current value of whether or not to use the cache
	GetCache() bool

	// ImageID returns the image identifier of the most recent layer.
	ImageID() string

	// Save saves an image to the provided filename.
	Save(string, string, string) error
}

// Layers needs a description
type Layers interface {
	// Pull an image. Takes a name and returns an image ID+error.
	Fetch(*config.Config, string) (string, error)

	// SetLayers sets the layers.
	SetLayers([]string)

	// AddImage adds layers to the layer list from a provided image, in order of
	// appearance. Any existing layers are skipped over, removing them from the list.
	AddImage(string) error

	// SetSkipLayers toggles whether or not to skip layers that are being built
	// next. Toggle again to re-enable layer recording. The final image will not
	// contain the skipped layers.
	SetSkipLayers(bool)

	// MakeImage makes the final image, skipping any layers as necessary. The
	// layers must be pre-recorded within the executor.
	// It returns an error condition, if any.
	MakeImage(config *config.Config) (string, error)

	// Look up an image identifier.
	Lookup(*config.Config, string) (string, error)

	// SetContext sets the context for subsequent calls.
	SetContext(ctx context.Context)
}

// ImageConfig sets the properties used to construct an
type ImageConfig struct {
	Layers   Layers
	UseCache bool
	Config   *config.Config
	Logger   *logger.Logger
}