/
image.go
436 lines (357 loc) · 12.9 KB
/
image.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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
package image
import (
"context"
"fmt"
"strings"
"github.com/gookit/color"
"github.com/werf/logboek"
"github.com/werf/logboek/pkg/style"
"github.com/werf/logboek/pkg/types"
"github.com/werf/werf/pkg/build/stage"
"github.com/werf/werf/pkg/config"
"github.com/werf/werf/pkg/container_backend"
"github.com/werf/werf/pkg/docker_registry"
"github.com/werf/werf/pkg/dockerfile"
"github.com/werf/werf/pkg/giterminism_manager"
"github.com/werf/werf/pkg/image"
"github.com/werf/werf/pkg/logging"
"github.com/werf/werf/pkg/storage/manager"
)
type BaseImageType string
const (
ImageFromRegistryAsBaseImage BaseImageType = "ImageFromRegistryAsBaseImage"
StageAsBaseImage BaseImageType = "StageAsBaseImage"
NoBaseImage BaseImageType = "NoBaseImage"
)
type CommonImageOptions struct {
Conveyor Conveyor
GiterminismManager giterminism_manager.Interface
ContainerBackend container_backend.ContainerBackend
StorageManager manager.StorageManagerInterface
ProjectDir string
ProjectName string
ContainerWerfDir string
TmpDir string
ForceTargetPlatformLogging bool
}
type ImageOptions struct {
CommonImageOptions
IsArtifact, IsDockerfileImage, IsDockerfileTargetStage bool
DockerfileImageConfig *config.ImageFromDockerfile
BaseImageReference string
BaseImageName string
FetchLatestBaseImage bool
DockerfileExpanderFactory dockerfile.ExpanderFactory
}
func NewImage(ctx context.Context, targetPlatform, name string, baseImageType BaseImageType, opts ImageOptions) (*Image, error) {
switch baseImageType {
case NoBaseImage, ImageFromRegistryAsBaseImage, StageAsBaseImage:
default:
panic(fmt.Sprintf("unknown opts.BaseImageType %q", baseImageType))
}
if targetPlatform == "" {
panic("assertion: targetPlatform cannot be empty")
}
i := &Image{
Name: name,
CommonImageOptions: opts.CommonImageOptions,
IsArtifact: opts.IsArtifact,
IsDockerfileImage: opts.IsDockerfileImage,
IsDockerfileTargetStage: opts.IsDockerfileTargetStage,
DockerfileImageConfig: opts.DockerfileImageConfig,
TargetPlatform: targetPlatform,
baseImageType: baseImageType,
baseImageReference: opts.BaseImageReference,
baseImageName: opts.BaseImageName,
dockerfileExpanderFactory: opts.DockerfileExpanderFactory,
}
if opts.FetchLatestBaseImage {
if _, err := i.getFromBaseImageIdFromRegistry(ctx, i.baseImageReference); err != nil {
return nil, fmt.Errorf("error fetching base image id from registry: %w", err)
}
}
return i, nil
}
type Image struct {
CommonImageOptions
IsArtifact bool
IsDockerfileImage bool
IsDockerfileTargetStage bool
Name string
DockerfileImageConfig *config.ImageFromDockerfile
TargetPlatform string
stages []stage.Interface
lastNonEmptyStage stage.Interface
contentDigest string
rebuilt bool
baseImageType BaseImageType
baseImageReference string
baseImageName string
dockerfileExpanderFactory dockerfile.ExpanderFactory
baseImageRepoId string
baseStageImage *stage.StageImage
stageAsBaseImage stage.Interface
}
func (i *Image) LogName() string {
return logging.ImageLogName(i.Name, i.IsArtifact)
}
func (i *Image) LogDetailedName() string {
var targetPlatformForLog string
if i.ForceTargetPlatformLogging || i.TargetPlatform != i.ContainerBackend.GetRuntimePlatform() {
targetPlatformForLog = i.TargetPlatform
}
return logging.ImageLogProcessName(i.Name, i.IsArtifact, targetPlatformForLog)
}
func (i *Image) LogProcessStyle() color.Style {
return ImageLogProcessStyle(i.IsArtifact)
}
func (i *Image) LogTagStyle() color.Style {
return ImageLogTagStyle(i.IsArtifact)
}
func ImageLogProcessStyle(isArtifact bool) color.Style {
return imageDefaultStyle(isArtifact)
}
func ImageLogTagStyle(isArtifact bool) color.Style {
return imageDefaultStyle(isArtifact)
}
func imageDefaultStyle(isArtifact bool) color.Style {
var colors []color.Color
if isArtifact {
colors = []color.Color{color.FgCyan, color.Bold}
} else {
colors = []color.Color{color.FgYellow, color.Bold}
}
return color.New(colors...)
}
func (i *Image) SetStages(stages []stage.Interface) {
i.stages = stages
}
func (i *Image) GetStages() []stage.Interface {
return i.stages
}
func (i *Image) SetLastNonEmptyStage(stg stage.Interface) {
i.lastNonEmptyStage = stg
}
func (i *Image) GetLastNonEmptyStage() stage.Interface {
return i.lastNonEmptyStage
}
func (i *Image) SetContentDigest(digest string) {
i.contentDigest = digest
}
func (i *Image) GetContentDigest() string {
return i.contentDigest
}
func (i *Image) GetStage(name stage.StageName) stage.Interface {
for _, s := range i.stages {
if s.Name() == name {
return s
}
}
return nil
}
func (i *Image) GetStageID() string {
return i.GetLastNonEmptyStage().GetStageImage().Image.GetStageDescription().Info.Tag
}
func (i *Image) UsesBuildContext() bool {
for _, stg := range i.GetStages() {
if stg.UsesBuildContext() {
return true
}
}
return false
}
func (i *Image) GetName() string {
return i.Name
}
func (i *Image) GetLogName() string {
return i.LogName()
}
func (i *Image) SetRebuilt(rebuilt bool) {
i.rebuilt = rebuilt
}
func (i *Image) GetRebuilt() bool {
return i.rebuilt
}
func (i *Image) ExpandDependencies(ctx context.Context, baseEnv map[string]string) error {
for _, stg := range i.stages {
if err := stg.ExpandDependencies(ctx, i.Conveyor, baseEnv); err != nil {
return fmt.Errorf("unable to expand dependencies for stage %q: %w", stg.Name(), err)
}
}
return nil
}
func isUnsupportedMediaTypeError(err error) bool {
return err != nil && strings.Contains(err.Error(), "unsupported MediaType")
}
func (i *Image) SetupBaseImage(ctx context.Context, storageManager manager.StorageManagerInterface, storageOpts manager.StorageOptions) error {
switch i.baseImageType {
case StageAsBaseImage:
i.stageAsBaseImage = i.Conveyor.GetImage(i.TargetPlatform, i.baseImageName).GetLastNonEmptyStage()
i.baseImageReference = i.stageAsBaseImage.GetStageImage().Image.Name()
i.baseStageImage = i.stageAsBaseImage.GetStageImage()
case ImageFromRegistryAsBaseImage:
if i.IsDockerfileImage && i.dockerfileExpanderFactory != nil {
dependenciesArgs := stage.ResolveDependenciesArgs(i.TargetPlatform, i.DockerfileImageConfig.Dependencies, i.Conveyor)
ref, err := i.dockerfileExpanderFactory.GetExpander(dockerfile.ExpandOptions{SkipUnsetEnv: false}).ProcessWordWithMap(i.baseImageReference, dependenciesArgs)
if err != nil {
return fmt.Errorf("unable to expand dockerfile base image reference %q: %w", i.baseImageReference, err)
}
i.baseImageReference = ref
}
i.baseStageImage = i.Conveyor.GetOrCreateStageImage(i.baseImageReference, nil, nil, i)
if i.IsDockerfileImage && i.DockerfileImageConfig.Staged {
var info *image.Info
if i.baseImageReference != "scratch" {
var err error
info, err = storageManager.GetImageInfo(ctx, i.baseImageReference, storageOpts)
if isUnsupportedMediaTypeError(err) {
if err := logboek.Context(ctx).Default().LogProcess("Pulling base image %s", i.baseStageImage.Image.Name()).
Options(func(options types.LogProcessOptionsInterface) {
options.Style(style.Highlight())
}).
DoError(func() error {
return i.ContainerBackend.PullImageFromRegistry(ctx, i.baseStageImage.Image)
}); err != nil {
return err
}
info, err = storageManager.GetImageInfo(ctx, i.baseImageReference, storageOpts)
if err != nil {
return fmt.Errorf("unable to get base image %q manifest: %w", i.baseImageReference, err)
}
} else if err != nil {
return fmt.Errorf("unable to get base image %q manifest: %w", i.baseImageReference, err)
}
} else {
info = &image.Info{
Name: i.baseImageReference,
Env: nil,
}
}
i.baseStageImage.Image.SetStageDescription(&image.StageDescription{
StageID: nil, // this is not a stage actually, TODO
Info: info,
})
// for _, expression := range info.OnBuild {
// fmt.Printf(">> %q\n", expression)
// }
}
case NoBaseImage:
default:
panic(fmt.Sprintf("unknown base image type %q", i.baseImageType))
}
if i.IsDockerfileImage && i.DockerfileImageConfig.Staged {
switch i.baseImageType {
case StageAsBaseImage, ImageFromRegistryAsBaseImage:
if err := i.ExpandDependencies(ctx, EnvToMap(i.baseStageImage.Image.GetStageDescription().Info.Env)); err != nil {
return err
}
}
}
return nil
}
// TODO(staged-dockerfile): this is only for compatibility with stapel-builder logic, and this should be unified with new staged-dockerfile logic
func (i *Image) GetBaseStageImage() *stage.StageImage {
return i.baseStageImage
}
func (i *Image) GetBaseImageReference() string {
return i.baseImageReference
}
func (i *Image) FetchBaseImage(ctx context.Context) error {
switch i.baseImageType {
case ImageFromRegistryAsBaseImage:
if i.baseStageImage.Image.Name() == "scratch" {
return nil
}
// TODO: Refactor, move manifest fetching into SetupBaseImage, only pull image in FetchBaseImage method
if info, err := i.ContainerBackend.GetImageInfo(ctx, i.baseStageImage.Image.Name(), container_backend.GetImageInfoOpts{}); err != nil {
return fmt.Errorf("unable to inspect local image %s: %w", i.baseStageImage.Image.Name(), err)
} else if info != nil {
// TODO: do not use container_backend.LegacyStageImage for base image
i.baseStageImage.Image.SetStageDescription(&image.StageDescription{
StageID: nil, // this is not a stage actually, TODO
Info: info,
})
baseImageRepoId, err := i.getFromBaseImageIdFromRegistry(ctx, i.baseStageImage.Image.Name())
if baseImageRepoId == info.ID || (err != nil && !isUnsupportedMediaTypeError(err)) {
if err != nil {
logboek.Context(ctx).Warn().LogF("WARNING: cannot get base image id (%s): %s\n", i.baseStageImage.Image.Name(), err)
logboek.Context(ctx).Warn().LogF("WARNING: using existing image %s without pull\n", i.baseStageImage.Image.Name())
logboek.Context(ctx).Warn().LogOptionalLn()
}
return nil
}
}
if err := logboek.Context(ctx).Default().LogProcess("Pulling base image %s", i.baseStageImage.Image.Name()).
Options(func(options types.LogProcessOptionsInterface) {
options.Style(style.Highlight())
}).
DoError(func() error {
return i.ContainerBackend.PullImageFromRegistry(ctx, i.baseStageImage.Image)
}); err != nil {
return err
}
info, err := i.ContainerBackend.GetImageInfo(ctx, i.baseStageImage.Image.Name(), container_backend.GetImageInfoOpts{})
if err != nil {
return fmt.Errorf("unable to inspect local image %s: %w", i.baseStageImage.Image.Name(), err)
}
if info == nil {
return fmt.Errorf("unable to inspect local image %s after successful pull: image is not exists", i.baseStageImage.Image.Name())
}
i.baseStageImage.Image.SetStageDescription(&image.StageDescription{
StageID: nil, // this is not a stage actually, TODO
Info: info,
})
return nil
case StageAsBaseImage:
return i.StorageManager.FetchStage(ctx, i.ContainerBackend, i.stageAsBaseImage)
case NoBaseImage:
return nil
default:
panic(fmt.Sprintf("unknown base image type %q", i.baseImageType))
}
}
func (i *Image) getFromBaseImageIdFromRegistry(ctx context.Context, reference string) (string, error) {
i.Conveyor.GetServiceRWMutex("baseImagesRepoIdsCache" + reference).Lock()
defer i.Conveyor.GetServiceRWMutex("baseImagesRepoIdsCache" + reference).Unlock()
switch {
case i.baseImageRepoId != "":
return i.baseImageRepoId, nil
case i.Conveyor.IsBaseImagesRepoIdsCacheExist(reference):
i.baseImageRepoId = i.Conveyor.GetBaseImagesRepoIdsCache(reference)
return i.baseImageRepoId, nil
case i.Conveyor.IsBaseImagesRepoErrCacheExist(reference):
return "", i.Conveyor.GetBaseImagesRepoErrCache(reference)
}
var fetchedBaseRepoImage *image.Info
processMsg := fmt.Sprintf("Trying to get from base image id from registry (%s)", reference)
if err := logboek.Context(ctx).Info().LogProcessInline(processMsg).DoError(func() error {
var fetchImageIdErr error
fetchedBaseRepoImage, fetchImageIdErr = docker_registry.API().GetRepoImage(ctx, reference)
if fetchImageIdErr != nil {
i.Conveyor.SetBaseImagesRepoErrCache(reference, fetchImageIdErr)
return fmt.Errorf("can not get base image id from registry (%s): %w", reference, fetchImageIdErr)
}
return nil
}); err != nil {
return "", err
}
i.baseImageRepoId = fetchedBaseRepoImage.ID
i.Conveyor.SetBaseImagesRepoIdsCache(reference, i.baseImageRepoId)
return i.baseImageRepoId, nil
}
func EnvToMap(env []string) map[string]string {
res := make(map[string]string)
for _, kv := range env {
k, v := parseKeyValue(kv)
res[k] = v
}
return res
}
func parseKeyValue(env string) (string, string) {
parts := strings.SplitN(env, "=", 2)
v := ""
if len(parts) > 1 {
v = parts[1]
}
return parts[0], v
}