forked from buildpacks/pack
/
create_builder.go
414 lines (349 loc) · 13.1 KB
/
create_builder.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
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
package pack
import (
"context"
"fmt"
"io/ioutil"
"github.com/YousefHaggyHeroku/pack/config"
"github.com/YousefHaggyHeroku/pack/logging"
"github.com/Masterminds/semver"
"github.com/buildpacks/imgutil"
"github.com/buildpacks/imgutil/remote"
"github.com/google/go-containerregistry/pkg/authn"
"github.com/pkg/errors"
pubbldr "github.com/YousefHaggyHeroku/pack/builder"
"github.com/YousefHaggyHeroku/pack/buildpack"
"github.com/YousefHaggyHeroku/pack/internal/blob"
"github.com/YousefHaggyHeroku/pack/internal/builder"
"github.com/YousefHaggyHeroku/pack/internal/buildpackage"
"github.com/YousefHaggyHeroku/pack/internal/dist"
"github.com/YousefHaggyHeroku/pack/internal/image"
"github.com/YousefHaggyHeroku/pack/internal/layer"
"github.com/YousefHaggyHeroku/pack/internal/style"
)
// CreateBuilderOptions is a configuration object used to change the behavior of
// CreateBuilder.
type CreateBuilderOptions struct {
// Name of the builder.
BuilderName string
// Configuration that defines the functionality a builder provides.
Config pubbldr.Config
// Skip building image locally, directly publish to a registry.
// Requires BuilderName to be a valid registry location.
Publish bool
// Buildpack registry name. Defines where all registry buildpacks will be pulled from.
Registry string
// Strategy for updating images before a build.
PullPolicy config.PullPolicy
}
// CreateBuilder creates and saves a builder image to a registry with the provided options.
// If any configuration is invalid, it will error and exit without creating any images.
func (c *Client) CreateBuilder(ctx context.Context, opts CreateBuilderOptions) error {
if err := c.validateConfig(ctx, opts); err != nil {
return err
}
bldr, err := c.createBaseBuilder(ctx, opts)
if err != nil {
return errors.Wrap(err, "failed to create builder")
}
if err := c.addBuildpacksToBuilder(ctx, opts, bldr); err != nil {
return errors.Wrap(err, "failed to add buildpacks to builder")
}
bldr.SetOrder(opts.Config.Order)
bldr.SetStack(opts.Config.Stack)
return bldr.Save(c.logger, builder.CreatorMetadata{Version: Version})
}
func (c *Client) validateConfig(ctx context.Context, opts CreateBuilderOptions) error {
if err := pubbldr.ValidateConfig(opts.Config); err != nil {
return errors.Wrap(err, "invalid builder config")
}
if err := c.validateRunImageConfig(ctx, opts); err != nil {
return errors.Wrap(err, "invalid run image config")
}
return nil
}
func (c *Client) validateRunImageConfig(ctx context.Context, opts CreateBuilderOptions) error {
var runImages []imgutil.Image
for _, i := range append([]string{opts.Config.Stack.RunImage}, opts.Config.Stack.RunImageMirrors...) {
if !opts.Publish {
img, err := c.imageFetcher.Fetch(ctx, i, true, opts.PullPolicy)
if err != nil {
if errors.Cause(err) != image.ErrNotFound {
return errors.Wrap(err, "failed to fetch image")
}
} else {
runImages = append(runImages, img)
continue
}
}
img, err := c.imageFetcher.Fetch(ctx, i, false, opts.PullPolicy)
if err != nil {
if errors.Cause(err) != image.ErrNotFound {
return errors.Wrap(err, "failed to fetch image")
}
c.logger.Warnf("run image %s is not accessible", style.Symbol(i))
} else {
runImages = append(runImages, img)
}
}
for _, img := range runImages {
stackID, err := img.Label("io.buildpacks.stack.id")
if err != nil {
return errors.Wrap(err, "failed to label image")
}
if stackID != opts.Config.Stack.ID {
return fmt.Errorf(
"stack %s from builder config is incompatible with stack %s from run image %s",
style.Symbol(opts.Config.Stack.ID),
style.Symbol(stackID),
style.Symbol(img.Name()),
)
}
}
return nil
}
func (c *Client) createBaseBuilder(ctx context.Context, opts CreateBuilderOptions) (*builder.Builder, error) {
baseImage, err := c.imageFetcher.Fetch(ctx, opts.Config.Stack.BuildImage, !opts.Publish, opts.PullPolicy)
if err != nil {
return nil, errors.Wrap(err, "fetch build image")
}
c.logger.Debugf("Creating builder %s from build-image %s", style.Symbol(opts.BuilderName), style.Symbol(baseImage.Name()))
bldr, err := builder.New(baseImage, opts.BuilderName)
if err != nil {
return nil, errors.Wrap(err, "invalid build-image")
}
os, err := baseImage.OS()
if err != nil {
return nil, errors.Wrap(err, "lookup image OS")
}
if os == "windows" && !c.experimental {
return nil, NewExperimentError("Windows containers support is currently experimental.")
}
bldr.SetDescription(opts.Config.Description)
if bldr.StackID != opts.Config.Stack.ID {
return nil, fmt.Errorf(
"stack %s from builder config is incompatible with stack %s from build image",
style.Symbol(opts.Config.Stack.ID),
style.Symbol(bldr.StackID),
)
}
lifecycle, err := c.fetchLifecycle(ctx, opts.Config.Lifecycle, os)
if err != nil {
return nil, errors.Wrap(err, "fetch lifecycle")
}
bldr.SetLifecycle(lifecycle)
return bldr, nil
}
func (c *Client) fetchLifecycle(ctx context.Context, config pubbldr.LifecycleConfig, os string) (builder.Lifecycle, error) {
if config.Version != "" && config.URI != "" {
return nil, errors.Errorf(
"%s can only declare %s or %s, not both",
style.Symbol("lifecycle"), style.Symbol("version"), style.Symbol("uri"),
)
}
var uri string
switch {
case config.Version != "":
v, err := semver.NewVersion(config.Version)
if err != nil {
return nil, errors.Wrapf(err, "%s must be a valid semver", style.Symbol("lifecycle.version"))
}
uri = uriFromLifecycleVersion(*v, os)
case config.URI != "":
uri = config.URI
default:
uri = uriFromLifecycleVersion(*semver.MustParse(builder.DefaultLifecycleVersion), os)
}
b, err := c.downloader.Download(ctx, uri)
if err != nil {
return nil, errors.Wrap(err, "downloading lifecycle")
}
lifecycle, err := builder.NewLifecycle(b)
if err != nil {
return nil, errors.Wrap(err, "invalid lifecycle")
}
return lifecycle, nil
}
// TODO: Specific error message
func DownloadBuildpack(buildpackURI string, registryName string, logger logging.Logger) (dist.Buildpack, []dist.Buildpack, error) {
locatorType, err := buildpack.GetLocatorType(buildpackURI, []dist.BuildpackInfo{})
if err != nil {
return nil, nil, err
}
var mainBP dist.Buildpack
var depBPs []dist.Buildpack
switch locatorType {
case buildpack.PackageLocator:
imageName := buildpack.ParsePackageLocator(buildpackURI)
pkg, err := remote.NewImage(imageName, authn.DefaultKeychain, remote.FromBaseImage(imageName))
if err != nil {
return nil, nil, err
}
mainBP, depBPs, err = buildpackage.ExtractBuildpacks(pkg)
case buildpack.RegistryLocator:
registry, err := (*Client)(nil).getRegistry(logger, registryName)
if err != nil {
return nil, nil, errors.Wrapf(err, "invalid registry '%s'", registryName)
}
registryBp, err := registry.LocateBuildpack(buildpackURI)
if err != nil {
return nil, nil, errors.Wrapf(err, "locating in registry %s", style.Symbol(buildpackURI))
}
pkg, err := remote.NewImage(registryBp.Address, authn.DefaultKeychain, remote.FromBaseImage(registryBp.Address))
mainBP, depBPs, err = buildpackage.ExtractBuildpacks(pkg)
if err != nil {
return nil, nil, errors.Wrapf(err, "extracting from registry %s", style.Symbol(buildpackURI))
}
case buildpack.URILocator:
err := ensureBPSupport(buildpackURI)
if err != nil {
return nil, nil, err
}
cacheDir, err := ioutil.TempDir("", "cache")
downloader := blob.NewDownloader(logging.New(ioutil.Discard), cacheDir)
blob, err := downloader.Download(context.TODO(), buildpackURI)
if err != nil {
return nil, nil, errors.Wrapf(err, "downloading buildpack from %s", style.Symbol(buildpackURI))
}
isOCILayout, err := buildpackage.IsOCILayoutBlob(blob)
if err != nil {
return nil, nil, errors.Wrap(err, "inspecting buildpack blob")
}
if isOCILayout {
mainBP, depBPs, err = buildpackage.BuildpacksFromOCILayoutBlob(blob)
if err != nil {
return nil, nil, errors.Wrapf(err, "extracting buildpacks from %s", style.Symbol(buildpackURI))
}
} else {
//TODO: Understand this, imageOs probably shouldn't always be linux :P
imageOS := "linux"
layerWriterFactory, err := layer.NewWriterFactory(imageOS)
if err != nil {
return nil, nil, errors.Wrapf(err, "get tar writer factory for imageOS %s", imageOS)
}
mainBP, err = dist.BuildpackFromRootBlob(blob, layerWriterFactory)
if err != nil {
return nil, nil, errors.Wrapf(err, "creating buildpack from %s", style.Symbol(buildpackURI))
}
}
default:
return nil, nil, fmt.Errorf("error reading %s: invalid locator: %s", buildpackURI, locatorType)
}
return mainBP, depBPs, nil
}
func (c *Client) addBuildpacksToBuilder(ctx context.Context, opts CreateBuilderOptions, bldr *builder.Builder) error {
for _, b := range opts.Config.Buildpacks {
c.logger.Debugf("Looking up buildpack %s", style.Symbol(b.FullName()))
var err error
var locatorType buildpack.LocatorType
if b.URI == "" && b.ImageName != "" {
c.logger.Warn("The 'image' key is deprecated. Use 'uri=\"docker://...\"' instead.")
b.URI = b.ImageName
locatorType = buildpack.PackageLocator
} else {
locatorType, err = buildpack.GetLocatorType(b.URI, []dist.BuildpackInfo{})
if err != nil {
return err
}
}
var mainBP dist.Buildpack
var depBPs []dist.Buildpack
switch locatorType {
case buildpack.PackageLocator:
imageName := buildpack.ParsePackageLocator(b.URI)
c.logger.Debugf("Downloading buildpack from image: %s", style.Symbol(imageName))
mainBP, depBPs, err = extractPackagedBuildpacks(ctx, imageName, c.imageFetcher, opts.Publish, opts.PullPolicy)
if err != nil {
return err
}
case buildpack.RegistryLocator:
c.logger.Debugf("Downloading buildpack from registry: %s", style.Symbol(b.URI))
registryCache, err := c.getRegistry(c.logger, opts.Registry)
if err != nil {
return errors.Wrapf(err, "invalid registry '%s'", opts.Registry)
}
registryBp, err := registryCache.LocateBuildpack(b.URI)
if err != nil {
return errors.Wrapf(err, "locating in registry %s", style.Symbol(b.URI))
}
mainBP, depBPs, err = extractPackagedBuildpacks(ctx, registryBp.Address, c.imageFetcher, opts.Publish, opts.PullPolicy)
if err != nil {
return errors.Wrapf(err, "extracting from registry %s", style.Symbol(b.URI))
}
case buildpack.URILocator:
c.logger.Debugf("Downloading buildpack from URI: %s", style.Symbol(b.URI))
err := ensureBPSupport(b.URI)
if err != nil {
return err
}
blob, err := c.downloader.Download(ctx, b.URI)
if err != nil {
return errors.Wrapf(err, "downloading buildpack from %s", style.Symbol(b.URI))
}
isOCILayout, err := buildpackage.IsOCILayoutBlob(blob)
if err != nil {
return errors.Wrap(err, "inspecting buildpack blob")
}
if isOCILayout {
mainBP, depBPs, err = buildpackage.BuildpacksFromOCILayoutBlob(blob)
if err != nil {
return errors.Wrapf(err, "extracting buildpacks from %s", style.Symbol(b.ID))
}
} else {
imageOS, err := bldr.Image().OS()
if err != nil {
return errors.Wrap(err, "getting image OS")
}
layerWriterFactory, err := layer.NewWriterFactory(imageOS)
if err != nil {
return errors.Wrapf(err, "get tar writer factory for image %s", style.Symbol(bldr.Name()))
}
mainBP, err = dist.BuildpackFromRootBlob(blob, layerWriterFactory)
if err != nil {
return errors.Wrapf(err, "creating buildpack from %s", style.Symbol(b.URI))
}
}
default:
return fmt.Errorf("error reading %s: invalid locator: %s", b.URI, locatorType)
}
err = validateBuildpack(mainBP, b.URI, b.ID, b.Version)
if err != nil {
return errors.Wrap(err, "invalid buildpack")
}
bpDesc := mainBP.Descriptor()
for _, deprecatedAPI := range bldr.LifecycleDescriptor().APIs.Buildpack.Deprecated {
if deprecatedAPI.Equal(bpDesc.API) {
c.logger.Warnf("Buildpack %s is using deprecated Buildpacks API version %s", style.Symbol(bpDesc.Info.FullName()), style.Symbol(bpDesc.API.String()))
break
}
}
for _, bp := range append([]dist.Buildpack{mainBP}, depBPs...) {
bldr.AddBuildpack(bp)
}
}
return nil
}
func validateBuildpack(bp dist.Buildpack, source, expectedID, expectedBPVersion string) error {
if expectedID != "" && bp.Descriptor().Info.ID != expectedID {
return fmt.Errorf(
"buildpack from URI %s has ID %s which does not match ID %s from builder config",
style.Symbol(source),
style.Symbol(bp.Descriptor().Info.ID),
style.Symbol(expectedID),
)
}
if expectedBPVersion != "" && bp.Descriptor().Info.Version != expectedBPVersion {
return fmt.Errorf(
"buildpack from URI %s has version %s which does not match version %s from builder config",
style.Symbol(source),
style.Symbol(bp.Descriptor().Info.Version),
style.Symbol(expectedBPVersion),
)
}
return nil
}
func uriFromLifecycleVersion(version semver.Version, os string) string {
if os == "windows" {
return fmt.Sprintf("https://github.com/buildpacks/lifecycle/releases/download/v%s/lifecycle-v%s+windows.x86-64.tgz", version.String(), version.String())
}
return fmt.Sprintf("https://github.com/buildpacks/lifecycle/releases/download/v%s/lifecycle-v%s+linux.x86-64.tgz", version.String(), version.String())
}