forked from box-builder/box
/
types.go
75 lines (57 loc) · 2.12 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
package layers
import (
"context"
"io"
"github.com/erikh/box/builder/config"
"github.com/erikh/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(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
}