Repository navigation
Expand file tree
/
Copy pathclient.go
More file actions
169 lines (141 loc) · 5.45 KB
/
Copy pathclient.go
File metadata and controls
169 lines (141 loc) · 5.45 KB
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
package pack
import (
"context"
"os"
"path/filepath"
"github.com/buildpacks/imgutil"
dockerClient "github.com/docker/docker/client"
"github.com/google/go-containerregistry/pkg/authn"
"github.com/pkg/errors"
pubcfg "github.com/buildpacks/pack/config"
"github.com/buildpacks/pack/internal/blob"
"github.com/buildpacks/pack/internal/build"
"github.com/buildpacks/pack/internal/config"
"github.com/buildpacks/pack/internal/image"
"github.com/buildpacks/pack/logging"
)
//go:generate mockgen -package testmocks -destination testmocks/mock_docker_client.go github.com/docker/docker/client CommonAPIClient
//go:generate mockgen -package testmocks -destination testmocks/mock_image_fetcher.go github.com/buildpacks/pack ImageFetcher
// ImageFetcher is an interface representing the ability to fetch local and images.
type ImageFetcher interface {
// Fetch fetches an image by resolving it both remotely and locally depending on provided parameters.
// The pull behavior is dictated by the pullPolicy, which can have the following behavior
// - PullNever: try to use the daemon to return a `local.Image`.
// - PullIfNotPResent: try look to use the daemon to return a `local.Image`, if none is found fetch a remote image.
// - PullAlways: it will only try to fetch a remote image.
//
// These PullPolicies that these interact with the daemon argument.
// PullIfNotPresent and daemon = false, gives us the same behavior as PullAlways.
// There is a single invalid configuration, PullNever and daemon = false, this will always fail.
Fetch(ctx context.Context, name string, daemon bool, pullPolicy pubcfg.PullPolicy) (imgutil.Image, error)
}
//go:generate mockgen -package testmocks -destination testmocks/mock_downloader.go github.com/buildpacks/pack Downloader
// Downloader is an interface for collecting both remote and local assets.
type Downloader interface {
// Download collects both local and remote assets and provides a blob object
// used to read asset contents.
Download(ctx context.Context, pathOrURI string) (blob.Blob, error)
}
//go:generate mockgen -package testmocks -destination testmocks/mock_image_factory.go github.com/buildpacks/pack ImageFactory
// ImageFactory is an interface representing the ability to create a new OCI image.
type ImageFactory interface {
// NewImage initializes an image object with required settings so that it
// can be written either locally or to a registry.
NewImage(repoName string, local bool) (imgutil.Image, error)
}
// Client is an orchestration object, it contains all parameters needed to
// build an app image using Cloud Native Buildpacks.
// All settings on this object should be changed through ClientOption functions.
type Client struct {
logger logging.Logger
imageFetcher ImageFetcher
downloader Downloader
lifecycleExecutor LifecycleExecutor
docker dockerClient.CommonAPIClient
imageFactory ImageFactory
experimental bool
}
// ClientOption is a type of function that mutate settings on the client.
// Values in these functions are set through currying.
type ClientOption func(c *Client)
// WithLogger supply your own logger.
func WithLogger(l logging.Logger) ClientOption {
return func(c *Client) {
c.logger = l
}
}
// WithImageFactory supply your own image factory.
func WithImageFactory(f ImageFactory) ClientOption {
return func(c *Client) {
c.imageFactory = f
}
}
// WithFetcher supply your own Fetcher.
// A Fetcher retrieves both local and remote images to make them available.
func WithFetcher(f ImageFetcher) ClientOption {
return func(c *Client) {
c.imageFetcher = f
}
}
// WithDownloader supply your own downloader.
// A Downloader is used to gather buildpacks from both remote urls, or local sources.
func WithDownloader(d Downloader) ClientOption {
return func(c *Client) {
c.downloader = d
}
}
// Deprecated: use WithDownloader instead.
//
// WithCacheDir supply your own cache directory.
func WithCacheDir(path string) ClientOption {
return func(c *Client) {
c.downloader = blob.NewDownloader(c.logger, path)
}
}
// WithDockerClient supply your own docker client.
func WithDockerClient(docker dockerClient.CommonAPIClient) ClientOption {
return func(c *Client) {
c.docker = docker
}
}
// WithExperimental sets whether experimental features should be enabled.
func WithExperimental(experimental bool) ClientOption {
return func(c *Client) {
c.experimental = experimental
}
}
// NewClient allocates and returns a Client configured with the specified options.
func NewClient(opts ...ClientOption) (*Client, error) {
var client Client
for _, opt := range opts {
opt(&client)
}
if client.logger == nil {
client.logger = logging.New(os.Stderr)
}
if client.docker == nil {
var err error
client.docker, err = dockerClient.NewClientWithOpts(
dockerClient.FromEnv,
dockerClient.WithVersion("1.38"),
)
if err != nil {
return nil, errors.Wrap(err, "creating docker client")
}
}
if client.downloader == nil {
packHome, err := config.PackHome()
if err != nil {
return nil, errors.Wrap(err, "getting pack home")
}
client.downloader = blob.NewDownloader(client.logger, filepath.Join(packHome, "download-cache"))
}
if client.imageFetcher == nil {
client.imageFetcher = image.NewFetcher(client.logger, client.docker)
}
if client.imageFactory == nil {
client.imageFactory = image.NewFactory(client.docker, authn.DefaultKeychain)
}
client.lifecycleExecutor = build.NewLifecycleExecutor(client.logger, client.docker)
return &client, nil
}