-
Notifications
You must be signed in to change notification settings - Fork 103
/
detector.go
569 lines (502 loc) · 16 KB
/
detector.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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
package phase
import (
"fmt"
"os"
"sync"
apexlog "github.com/apex/log"
"github.com/apex/log/handlers/memory"
"github.com/pkg/errors"
"github.com/buildpacks/lifecycle/api"
"github.com/buildpacks/lifecycle/buildpack"
"github.com/buildpacks/lifecycle/env"
"github.com/buildpacks/lifecycle/internal/encoding"
"github.com/buildpacks/lifecycle/internal/fsutil"
"github.com/buildpacks/lifecycle/log"
"github.com/buildpacks/lifecycle/platform"
"github.com/buildpacks/lifecycle/platform/files"
)
const (
CodeDetectPass = 0
CodeDetectFail = 100
)
var (
ErrFailedDetection = errors.New("no buildpacks participating")
ErrBuildpack = errors.New("buildpack(s) failed with err")
)
// DetectResolver given a group of buildpacks (and optional image extensions)
// processes the outputs of each `./bin/detect` to determine if the group is viable -
// that is, whether all non-optional buildpacks passed detection and a valid Build Plan can be resolved
// from each "requires" and "provides" expressed by each group element.
//
//go:generate mockgen -package testmock -destination testmock/detect_resolver.go github.com/buildpacks/lifecycle/phase DetectResolver
type DetectResolver interface {
Resolve(done []buildpack.GroupElement, detectRuns *sync.Map) ([]buildpack.GroupElement, []files.BuildPlanEntry, error)
}
type Detector struct {
AppDir string
BuildConfigDir string
DirStore DirStore
Executor buildpack.DetectExecutor
HasExtensions bool
Logger log.LoggerHandlerWithLevel
Order buildpack.Order
PlatformDir string
Resolver DetectResolver
Runs *sync.Map
AnalyzeMD files.Analyzed
PlatformAPI *api.Version
// If detect fails, we want to print debug statements as info level.
// memHandler holds all log entries; we'll iterate through them at the end of detect,
// providing them to the detector's logger according to the desired log level.
memHandler *memory.Handler
}
// NewDetector constructs a new Detector by initializing services and reading the provided analyzed and order files.
func (f *HermeticFactory) NewDetector(inputs platform.LifecycleInputs, logger log.LoggerHandlerWithLevel) (*Detector, error) {
memHandler := memory.New()
detector := &Detector{
AppDir: inputs.AppDir,
BuildConfigDir: inputs.BuildConfigDir,
DirStore: f.dirStore,
Executor: &buildpack.DefaultDetectExecutor{},
Logger: logger,
PlatformDir: inputs.PlatformDir,
Resolver: NewDefaultDetectResolver(&apexlog.Logger{Handler: memHandler}),
Runs: &sync.Map{},
memHandler: memHandler,
PlatformAPI: f.platformAPI,
}
var err error
if detector.AnalyzeMD, err = f.configHandler.ReadAnalyzed(inputs.AnalyzedPath, logger); err != nil {
return nil, err
}
if detector.Order, detector.HasExtensions, err = f.getOrder(inputs.OrderPath, logger); err != nil {
return nil, err
}
return detector, nil
}
func (d *Detector) Detect() (buildpack.Group, files.Plan, error) {
defer log.NewMeasurement("Detector", d.Logger)()
group, plan, detectErr := d.DetectOrder(d.Order)
for _, e := range d.memHandler.Entries {
if detectErr != nil || e.Level >= d.Logger.LogLevel() {
if err := d.Logger.HandleLog(e); err != nil {
return buildpack.Group{}, files.Plan{}, fmt.Errorf("failed to handle log entry: %w", err)
}
}
}
return group, plan, detectErr
}
func (d *Detector) DetectOrder(order buildpack.Order) (buildpack.Group, files.Plan, error) {
detected, planEntries, err := d.detectOrder(order, nil, nil, false, &sync.WaitGroup{})
if err == ErrBuildpack {
err = buildpack.NewError(err, buildpack.ErrTypeBuildpack)
} else if err == ErrFailedDetection {
err = buildpack.NewError(err, buildpack.ErrTypeFailedDetection)
}
return buildpack.Group{Group: filter(detected, buildpack.KindBuildpack), GroupExtensions: filter(detected, buildpack.KindExtension)},
files.Plan{Entries: planEntries},
err
}
func filter(group []buildpack.GroupElement, kind string) []buildpack.GroupElement {
var out []buildpack.GroupElement
for _, el := range group {
if el.Kind() == kind {
out = append(out, el.NoExtension().NoOpt())
}
}
return out
}
func (d *Detector) detectOrder(order buildpack.Order, done, next []buildpack.GroupElement, optional bool, wg *sync.WaitGroup) ([]buildpack.GroupElement, []files.BuildPlanEntry, error) {
ngroup := buildpack.Group{Group: next}
buildpackErr := false
for _, group := range order {
// FIXME: double-check slice safety here
found, plan, err := d.detectGroup(group.Append(ngroup), done, wg)
if err == ErrBuildpack {
buildpackErr = true
}
if err == ErrFailedDetection || err == ErrBuildpack {
wg = &sync.WaitGroup{}
continue
}
return found, plan, err
}
if optional {
return d.detectGroup(ngroup, done, wg)
}
if buildpackErr {
return nil, nil, ErrBuildpack
}
return nil, nil, ErrFailedDetection
}
func (d *Detector) detectGroup(group buildpack.Group, done []buildpack.GroupElement, wg *sync.WaitGroup) ([]buildpack.GroupElement, []files.BuildPlanEntry, error) {
// used below to mark each item as "done" by appending it to the done list
markDone := func(groupEl buildpack.GroupElement, descriptor buildpack.Descriptor) {
done = append(done, groupEl.WithAPI(descriptor.API()).WithHomepage(descriptor.Homepage()))
}
runImageTargetInfo := d.AnalyzeMD.RunImageTarget()
for i, groupEl := range group.Group {
// Continue if element has already been processed.
if hasIDForKind(done, groupEl.Kind(), groupEl.ID) {
continue
}
// Resolve order if element is the order for extensions.
if groupEl.IsExtensionsOrder() {
return d.detectOrder(groupEl.OrderExtensions, done, group.Group[i+1:], true, wg)
}
// Lookup element in store (the "store" is the directory where all the buildpacks are).
var (
descriptor buildpack.Descriptor
err error
)
if groupEl.Kind() == buildpack.KindBuildpack {
bpDescriptor, err := d.DirStore.LookupBp(groupEl.ID, groupEl.Version)
if err != nil {
return nil, nil, err
}
// Resolve order if element is a composite buildpack.
if order := bpDescriptor.Order; len(order) > 0 {
// FIXME: double-check slice safety here
// FIXME: cyclical references lead to infinite recursion
return d.detectOrder(order, done, group.Group[i+1:], groupEl.Optional, wg)
}
descriptor = bpDescriptor // Standardize the type so below we don't have to care whether it is an extension.
} else {
descriptor, err = d.DirStore.LookupExt(groupEl.ID, groupEl.Version)
if err != nil {
return nil, nil, err
}
}
// Check target compatibility.
if d.PlatformAPI.AtLeast("0.12") {
var targetMatch bool
if len(descriptor.TargetsList()) == 0 {
// This is actually just for tests. In practice, the lifecycle will infer a target with at least an OS
// when targets are missing from buildpack.toml.
targetMatch = true
} else {
for _, target := range descriptor.TargetsList() {
d.Logger.Debugf("Checking for match against descriptor: %s", target)
if platform.TargetSatisfiedForBuild(&fsutil.Detect{}, &runImageTargetInfo, target, d.Logger) {
targetMatch = true
break
}
}
}
if !targetMatch && !groupEl.Optional {
markDone(groupEl, descriptor)
d.Runs.Store(
keyFor(groupEl),
buildpack.DetectOutputs{
Code: -1,
Err: fmt.Errorf(
"unable to satisfy target os/arch constraints; run image: %s, buildpack: %s",
encoding.ToJSONMaybe(runImageTargetInfo),
encoding.ToJSONMaybe(descriptor.TargetsList()),
),
})
continue
}
}
markDone(groupEl, descriptor)
// Run detect if element is a component buildpack or an extension.
wg.Add(1)
key := keyFor(groupEl)
go func(key string, descriptor buildpack.Descriptor) {
if _, ok := d.Runs.Load(key); !ok {
inputs := buildpack.DetectInputs{
AppDir: d.AppDir,
BuildConfigDir: d.BuildConfigDir,
PlatformDir: d.PlatformDir,
Env: env.NewBuildEnv(os.Environ()),
TargetEnv: platform.EnvVarsFor(&fsutil.Detect{}, runImageTargetInfo, d.Logger),
}
d.Runs.Store(key, d.Executor.Detect(descriptor, inputs, d.Logger)) // this is where we finally invoke bin/detect
}
wg.Done()
}(key, descriptor)
}
wg.Wait()
return d.Resolver.Resolve(done, d.Runs)
}
func hasIDForKind(els []buildpack.GroupElement, kind string, id string) bool {
for _, el := range els {
if el.Kind() == kind && el.ID == id {
return true
}
}
return false
}
func keyFor(groupEl buildpack.GroupElement) string {
return fmt.Sprintf("%s %s", groupEl.Kind(), groupEl.String())
}
type DefaultDetectResolver struct {
Logger log.Logger
}
func NewDefaultDetectResolver(logger log.Logger) *DefaultDetectResolver {
return &DefaultDetectResolver{Logger: logger}
}
// Resolve aggregates the detect output for a group of buildpacks and tries to resolve a build plan for the group.
// If any required buildpack in the group failed detection or a build plan cannot be resolved, it returns an error.
func (r *DefaultDetectResolver) Resolve(done []buildpack.GroupElement, detectRuns *sync.Map) ([]buildpack.GroupElement, []files.BuildPlanEntry, error) {
var groupRuns []buildpack.DetectOutputs
for _, el := range done {
key := keyFor(el) // FIXME: ensure the Detector and Resolver always use the same key
t, ok := detectRuns.Load(key)
if !ok {
return nil, nil, errors.Errorf("missing detection of '%s'", key)
}
run := t.(buildpack.DetectOutputs)
outputLogf := r.Logger.Debugf
switch run.Code {
case CodeDetectPass, CodeDetectFail:
// nop
default:
outputLogf = r.Logger.Infof
}
if len(run.Output) > 0 {
outputLogf("======== Output: %s ========", el)
outputLogf(string(run.Output))
}
if run.Err != nil {
outputLogf("======== Error: %s ========", el)
outputLogf(run.Err.Error())
}
groupRuns = append(groupRuns, run)
}
r.Logger.Debugf("======== Results ========")
results := detectResults{}
detected := true
anyBuildpacksDetected := false
buildpackErr := false
for i, el := range done {
run := groupRuns[i]
switch run.Code {
case CodeDetectPass:
r.Logger.Debugf("pass: %s", el)
results = append(results, detectResult{el, run})
if !el.Extension {
anyBuildpacksDetected = true
}
case CodeDetectFail:
if el.Optional {
r.Logger.Debugf("skip: %s", el)
} else {
r.Logger.Debugf("fail: %s", el)
}
detected = detected && el.Optional
case -1:
r.Logger.Infof("err: %s", el)
buildpackErr = true
detected = detected && el.Optional
default:
r.Logger.Infof("err: %s (%d)", el, run.Code)
buildpackErr = true
detected = detected && el.Optional
}
}
if !detected {
if buildpackErr {
return nil, nil, ErrBuildpack
}
return nil, nil, ErrFailedDetection
} else if !anyBuildpacksDetected {
r.Logger.Debugf("fail: no viable buildpacks in group")
return nil, nil, ErrFailedDetection
}
i := 0
deps, trial, err := results.runTrials(func(trial detectTrial) (depMap, detectTrial, error) {
i++
return r.runTrial(i, trial)
})
if err != nil {
return nil, nil, err
}
if len(done) != len(trial) {
r.Logger.Infof("%d of %d buildpacks participating", len(trial), len(done))
}
maxLength := 0
for _, t := range trial {
l := len(t.ID)
if l > maxLength {
maxLength = l
}
}
f := fmt.Sprintf("%%-%ds %%s", maxLength)
for _, t := range trial {
r.Logger.Infof(f, t.ID, t.Version)
}
var found []buildpack.GroupElement
for _, r := range trial {
found = append(found, r.GroupElement.NoOpt())
}
var plan []files.BuildPlanEntry
for _, dep := range deps {
plan = append(plan, dep.BuildPlanEntry.NoOpt())
}
return found, plan, nil
}
func (r *DefaultDetectResolver) runTrial(i int, trial detectTrial) (depMap, detectTrial, error) {
r.Logger.Debugf("Resolving plan... (try #%d)", i)
var deps depMap
retry := true
for retry {
retry = false
deps = newDepMap(trial)
if err := deps.eachUnmetRequire(func(name string, el buildpack.GroupElement) error {
retry = true
if !el.Optional {
r.Logger.Debugf("fail: %s requires %s", el, name)
return ErrFailedDetection
}
r.Logger.Debugf("skip: %s requires %s", el, name)
trial = trial.remove(el)
return nil
}); err != nil {
return nil, nil, err
}
if err := deps.eachUnmetProvide(func(name string, el buildpack.GroupElement) error {
retry = true
if !el.Optional {
r.Logger.Debugf("fail: %s provides unused %s", el, name)
return ErrFailedDetection
}
r.Logger.Debugf("skip: %s provides unused %s", el, name)
trial = trial.remove(el)
return nil
}); err != nil {
return nil, nil, err
}
}
if len(trial) == 0 {
r.Logger.Debugf("fail: no viable buildpacks in group")
return nil, nil, ErrFailedDetection
}
return deps, trial, nil
}
type detectResult struct {
buildpack.GroupElement
buildpack.DetectOutputs
}
func (r *detectResult) options() []detectOption {
var out []detectOption
for i, sections := range append([]buildpack.PlanSections{r.PlanSections}, r.Or...) {
el := r.GroupElement
el.Optional = el.Optional && i == len(r.Or)
out = append(out, detectOption{el, sections})
}
return out
}
type detectResults []detectResult
type trialFunc func(detectTrial) (depMap, detectTrial, error)
func (rs detectResults) runTrials(f trialFunc) (depMap, detectTrial, error) {
return rs.runTrialsFrom(nil, f)
}
func (rs detectResults) runTrialsFrom(prefix detectTrial, f trialFunc) (depMap, detectTrial, error) {
if len(rs) == 0 {
deps, trial, err := f(prefix)
return deps, trial, err
}
var lastErr error
for _, option := range rs[0].options() {
deps, trial, err := rs[1:].runTrialsFrom(append(prefix, option), f)
if err == nil {
return deps, trial, nil
}
lastErr = err
}
return nil, nil, lastErr
}
type detectOption struct {
buildpack.GroupElement
buildpack.PlanSections
}
type detectTrial []detectOption
func (ts detectTrial) remove(el buildpack.GroupElement) detectTrial {
var out detectTrial
for _, t := range ts {
if !t.GroupElement.Equals(el) {
out = append(out, t)
}
}
return out
}
type depEntry struct {
files.BuildPlanEntry
earlyRequires []buildpack.GroupElement
extraProvides []buildpack.GroupElement
}
type depMap map[string]depEntry
func newDepMap(trial detectTrial) depMap {
m := depMap{}
for _, option := range trial {
for _, p := range option.Provides {
m.provide(option.GroupElement, p)
}
for _, r := range option.Requires {
m.require(option.GroupElement, r)
}
}
return m
}
func (m depMap) provide(el buildpack.GroupElement, provide buildpack.Provide) {
entry := m[provide.Name]
entry.extraProvides = append(entry.extraProvides, el)
m[provide.Name] = entry
}
func (m depMap) require(el buildpack.GroupElement, require buildpack.Require) {
entry := m[require.Name]
entry.Providers = append(entry.Providers, entry.extraProvides...)
entry.extraProvides = nil
if len(entry.Providers) == 0 {
entry.earlyRequires = append(entry.earlyRequires, el)
} else {
entry.Requires = append(entry.Requires, require)
}
m[require.Name] = entry
}
func (m depMap) eachUnmetProvide(f func(name string, el buildpack.GroupElement) error) error {
for name, entry := range m {
if len(entry.extraProvides) != 0 {
for _, bp := range entry.extraProvides {
if err := f(name, bp); err != nil {
return err
}
}
}
}
return nil
}
func (m depMap) eachUnmetRequire(f func(name string, el buildpack.GroupElement) error) error {
for name, entry := range m {
if len(entry.earlyRequires) != 0 {
for _, el := range entry.earlyRequires {
if err := f(name, el); err != nil {
return err
}
}
}
}
return nil
}
func PrependExtensions(orderBp buildpack.Order, orderExt buildpack.Order) buildpack.Order {
if len(orderExt) == 0 {
return orderBp
}
// fill in values for extensions order
for i, group := range orderExt {
for j := range group.Group {
group.Group[j].Extension = true
group.Group[j].Optional = true
}
orderExt[i] = group
}
var newOrder buildpack.Order
extGroupEl := buildpack.GroupElement{OrderExtensions: orderExt}
for _, group := range orderBp {
newOrder = append(newOrder, buildpack.Group{
Group: append([]buildpack.GroupElement{extGroupEl}, group.Group...),
})
}
return newOrder
}