-
Notifications
You must be signed in to change notification settings - Fork 64
/
fetch.go
456 lines (396 loc) · 12.4 KB
/
fetch.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
// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors.
// Licensed under the BSD-3-Clause License (the "License").
// You may not use this file except in compliance with the License.
package fetch
import (
"context"
"errors"
"fmt"
"os"
"github.com/MakeNowJust/heredoc"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"kraftkit.sh/cmdfactory"
"kraftkit.sh/config"
"kraftkit.sh/exec"
"kraftkit.sh/iostreams"
"kraftkit.sh/machine/platform"
"kraftkit.sh/pack"
"kraftkit.sh/unikraft"
"kraftkit.sh/log"
"kraftkit.sh/make"
"kraftkit.sh/packmanager"
"kraftkit.sh/tui/paraprogress"
"kraftkit.sh/unikraft/app"
"kraftkit.sh/unikraft/target"
"kraftkit.sh/tui/processtree"
)
type Fetch struct {
Architecture string `long:"arch" short:"m" usage:"Filter the creation of the build by architecture of known targets"`
Kraftfile string `long:"kraftfile" short:"K" usage:"Set an alternative path of the Kraftfile"`
NoCache bool `long:"no-cache" usage:"Do not use the cache when pulling dependencies"`
NoConfigure bool `long:"no-configure" usage:"Do not run Unikraft's configure step before building"`
NoPull bool `long:"no-pull" usage:"Do not pull the dependencies of the project"`
Platform string `long:"plat" short:"p" usage:"Filter the creation of the build by platform of known targets"`
Target string `long:"target" short:"t" usage:"Build a particular known target"`
project app.Application
workdir string
}
func New() *cobra.Command {
cmd, err := cmdfactory.New(&Fetch{}, cobra.Command{
Short: "Fetch Unikraft unikernel dependencies",
Use: "fetch [FLAGS] [DIR]",
Args: cmdfactory.MaxDirArgs(1),
Long: heredoc.Docf(`
Fetch the dependencies of a unikernel.
The default behaviour of kraft fetch is to download the dependencies
of a unikernel.
`),
Example: heredoc.Doc(`
# Fetch the current project (cwd)
$ kraft fetch
# Fetch a project at a given path
$ kraft fetch path/to/app`),
Annotations: map[string]string{
cmdfactory.AnnotationHelpGroup: "build",
},
})
if err != nil {
panic(err)
}
return cmd
}
func (opts *Fetch) Pre(cmd *cobra.Command, args []string) error {
ctx, err := packmanager.WithDefaultUmbrellaManagerInContext(cmd.Context())
if err != nil {
return err
}
cmd.SetContext(ctx)
if len(args) == 0 {
opts.workdir, err = os.Getwd()
if err != nil {
return err
}
} else {
opts.workdir = args[0]
}
popts := []app.ProjectOption{
app.WithProjectWorkdir(opts.workdir),
}
if len(opts.Kraftfile) > 0 {
popts = append(popts, app.WithProjectKraftfile(opts.Kraftfile))
} else {
popts = append(popts, app.WithProjectDefaultKraftfiles())
}
// Initialize at least the configuration options for a project
opts.project, err = app.NewProjectFromOptions(ctx, popts...)
if err != nil && errors.Is(err, app.ErrNoKraftfile) {
return fmt.Errorf("cannot build project directory without a Kraftfile")
} else if err != nil {
return fmt.Errorf("could not initialize project directory: %w", err)
}
opts.Platform = platform.PlatformByName(opts.Platform).String()
return nil
}
func (opts *Fetch) pull(ctx context.Context, project app.Application, workdir string, norender bool, nameWidth int) error {
var missingPacks []pack.Package
var processes []*paraprogress.Process
var searches []*processtree.ProcessTreeItem
parallel := !config.G[config.KraftKit](ctx).NoParallel
auths := config.G[config.KraftKit](ctx).Auth
// FIXME: This is a temporary workaround for incorporating multiple processes in
// a command. After calling processtree the original output writer is lost
// so writing will no longer work. To fix this we temporarily save it
// beforehand.
// A proper fix would ensure in the tui package that this writer is
// preserved. Thankfully, this is the only place where it manifests right
// now.
oldOut := iostreams.G(ctx).Out
defer func() {
iostreams.G(ctx).Out = oldOut
}()
if _, err := opts.project.Components(ctx); err != nil && opts.project.Template().Name() != "" {
var packages []pack.Package
search := processtree.NewProcessTreeItem(
fmt.Sprintf("finding %s",
unikraft.TypeNameVersion(opts.project.Template()),
), "",
func(ctx context.Context) error {
packages, err = packmanager.G(ctx).Catalog(ctx,
packmanager.WithName(opts.project.Template().Name()),
packmanager.WithTypes(unikraft.ComponentTypeApp),
packmanager.WithVersion(opts.project.Template().Version()),
packmanager.WithCache(!opts.NoCache),
packmanager.WithAuthConfig(config.G[config.KraftKit](ctx).Auth),
)
if err != nil {
return err
}
if len(packages) == 0 {
return fmt.Errorf("could not find: %s",
unikraft.TypeNameVersion(opts.project.Template()),
)
} else if len(packages) > 1 {
return fmt.Errorf("too many options for %s",
unikraft.TypeNameVersion(opts.project.Template()),
)
}
return nil
},
)
treemodel, err := processtree.NewProcessTree(
ctx,
[]processtree.ProcessTreeOption{
processtree.IsParallel(parallel),
processtree.WithRenderer(norender),
processtree.WithFailFast(true),
},
search,
)
if err != nil {
return err
}
if err := treemodel.Start(); err != nil {
return fmt.Errorf("could not complete search: %v", err)
}
proc := paraprogress.NewProcess(
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(packages[0]),
),
func(ctx context.Context, w func(progress float64)) error {
return packages[0].Pull(
ctx,
pack.WithPullProgressFunc(w),
pack.WithPullWorkdir(workdir),
// pack.WithPullChecksum(!opts.NoChecksum),
pack.WithPullCache(!opts.NoCache),
)
},
)
processes = append(processes, proc)
paramodel, err := paraprogress.NewParaProgress(
ctx,
processes,
paraprogress.IsParallel(parallel),
paraprogress.WithRenderer(norender),
paraprogress.WithFailFast(true),
paraprogress.WithNameWidth(nameWidth),
)
if err != nil {
return err
}
if err := paramodel.Start(); err != nil {
return fmt.Errorf("could not pull all components: %v", err)
}
}
if opts.project.Template().Name() != "" {
templateWorkdir, err := unikraft.PlaceComponent(workdir, opts.project.Template().Type(), opts.project.Template().Name())
if err != nil {
return err
}
popts := []app.ProjectOption{
app.WithProjectWorkdir(workdir),
}
if len(opts.Kraftfile) > 0 {
popts = append(popts, app.WithProjectKraftfile(templateWorkdir))
} else {
popts = append(popts, app.WithProjectDefaultKraftfiles())
}
templateProject, err := app.NewProjectFromOptions(ctx, popts...)
if err != nil {
return err
}
opts.project, err = templateProject.MergeTemplate(ctx, project)
if err != nil {
return err
}
}
// Overwrite template with user options
components, err := opts.project.Components(ctx)
if err != nil {
return err
}
for _, component := range components {
// Skip "finding" the component if path is the same as the source (which
// means that the source code is already available as it is a directory on
// disk. In this scenario, the developer is likely hacking the particular
// microlibrary/component.
if component.Path() == component.Source() {
continue
}
component := component // loop closure
auths := auths
if f, err := os.Stat(component.Source()); err == nil && f.IsDir() {
continue
}
searches = append(searches, processtree.NewProcessTreeItem(
fmt.Sprintf("finding %s",
unikraft.TypeNameVersion(component),
), "",
func(ctx context.Context) error {
p, err := packmanager.G(ctx).Catalog(ctx,
packmanager.WithName(component.Name()),
packmanager.WithTypes(component.Type()),
packmanager.WithVersion(component.Version()),
packmanager.WithSource(component.Source()),
packmanager.WithCache(!opts.NoCache),
packmanager.WithAuthConfig(auths),
)
if err != nil {
return err
}
if len(p) == 0 {
return fmt.Errorf("could not find: %s",
unikraft.TypeNameVersion(component),
)
} else if len(p) > 1 {
return fmt.Errorf("too many options for %s",
unikraft.TypeNameVersion(component),
)
}
missingPacks = append(missingPacks, p...)
return nil
},
))
}
if len(searches) > 0 {
treemodel, err := processtree.NewProcessTree(
ctx,
[]processtree.ProcessTreeOption{
processtree.IsParallel(parallel),
processtree.WithRenderer(norender),
processtree.WithFailFast(true),
},
searches...,
)
if err != nil {
return err
}
if err := treemodel.Start(); err != nil {
return fmt.Errorf("could not complete search: %v", err)
}
}
if len(missingPacks) > 0 {
for _, p := range missingPacks {
p := p // loop closure
auths := auths
processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("pulling %s",
unikraft.TypeNameVersion(p),
),
func(ctx context.Context, w func(progress float64)) error {
return p.Pull(
ctx,
pack.WithPullProgressFunc(w),
pack.WithPullWorkdir(workdir),
// pack.WithPullChecksum(!opts.NoChecksum),
pack.WithPullCache(!opts.NoCache),
pack.WithPullAuthConfig(auths),
)
},
))
}
paramodel, err := paraprogress.NewParaProgress(
ctx,
processes,
paraprogress.IsParallel(parallel),
paraprogress.WithRenderer(norender),
paraprogress.WithFailFast(true),
paraprogress.WithNameWidth(nameWidth),
)
if err != nil {
return err
}
if err := paramodel.Start(); err != nil {
return fmt.Errorf("could not pull all components: %v", err)
}
}
return nil
}
func (opts *Fetch) Run(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
// Filter project targets by any provided CLI options
selected := opts.project.Targets()
if len(selected) == 0 {
return fmt.Errorf("no targets selected to fetch")
}
norender := log.LoggerTypeFromString(config.G[config.KraftKit](ctx).Log.Type) != log.FANCY
nameWidth := -1
// Calculate the width of the longest process name so that we can align the
// two independent processtrees if we are using "render" mode (aka the fancy
// mode is enabled).
if !norender {
// The longest word is "configuring" (which is 11 characters long), plus
// additional space characters (2 characters), brackets (2 characters) the
// name of the project and the target/plat string (which is variable in
// length).
for _, targ := range selected {
if newLen := len(targ.Name()) + len(target.TargetPlatArchName(targ)) + 15; newLen > nameWidth {
nameWidth = newLen
}
}
}
if !opts.NoPull {
if err := opts.pull(ctx, opts.project, opts.workdir, norender, nameWidth); err != nil {
return err
}
}
processes := []*paraprogress.Process{}
for _, targ := range selected {
// See: https://github.com/golang/go/wiki/CommonMistakes#using-reference-to-loop-iterator-variable
targ := targ
if !opts.NoConfigure {
processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("configuring %s (%s)", targ.Name(), target.TargetPlatArchName(targ)),
func(ctx context.Context, w func(progress float64)) error {
return opts.project.Configure(
ctx,
targ, // Target-specific options
nil, // No extra configuration options
make.WithProgressFunc(w),
make.WithSilent(true),
make.WithExecOptions(
exec.WithStdin(iostreams.G(ctx).In),
exec.WithStdout(log.G(ctx).Writer()),
exec.WithStderr(log.G(ctx).WriterLevel(logrus.ErrorLevel)),
),
)
},
))
}
processes = append(processes, paraprogress.NewProcess(
fmt.Sprintf("fetching %s (%s)", targ.Name(), target.TargetPlatArchName(targ)),
func(ctx context.Context, w func(progress float64)) error {
err := opts.project.Fetch(
ctx,
targ, // Target-specific options
make.WithExecOptions(
exec.WithStdout(log.G(ctx).Writer()),
exec.WithStderr(log.G(ctx).WriterLevel(logrus.WarnLevel)),
),
)
if err != nil {
return fmt.Errorf("fetch failed: %w", err)
}
return nil
},
))
}
paramodel, err := paraprogress.NewParaProgress(
ctx,
processes,
// Disable parallelization as:
// - The first process may be pulling the container image, which is
// necessary for the subsequent build steps;
// - The Unikraft build system can re-use compiled files from previous
// compilations (if the architecture does not change).
paraprogress.IsParallel(false),
paraprogress.WithRenderer(norender),
paraprogress.WithFailFast(true),
)
if err != nil {
return err
}
return paramodel.Start()
}