-
Notifications
You must be signed in to change notification settings - Fork 8
/
binary.go
315 lines (258 loc) · 9.77 KB
/
binary.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
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package binary
import (
"context"
"fmt"
"io/fs"
"path/filepath"
specs "github.com/opencontainers/image-spec/specs-go/v1"
"namespacelabs.dev/foundation/internal/artifacts/oci"
"namespacelabs.dev/foundation/internal/artifacts/registry"
"namespacelabs.dev/foundation/internal/build"
"namespacelabs.dev/foundation/internal/build/assets"
"namespacelabs.dev/foundation/internal/build/multiplatform"
"namespacelabs.dev/foundation/internal/compute"
"namespacelabs.dev/foundation/internal/console"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/integrations/dockerfile"
"namespacelabs.dev/foundation/schema"
"namespacelabs.dev/foundation/schema/storage"
"namespacelabs.dev/foundation/std/cfg"
"namespacelabs.dev/foundation/std/pkggraph"
)
var (
UsePrebuilts = true // XXX make these a scoped configuration instead.
)
var BuildGo func(loc pkggraph.Location, _ *schema.ImageBuildPlan_GoBuild, unsafeCacheable bool) (build.Spec, error)
var BuildWeb func(pkggraph.Location) build.Spec
var BuildLLBGen func(schema.PackageName, *pkggraph.Module, build.Spec) build.Spec
var BuildAlpine func(pkggraph.Location, *schema.ImageBuildPlan_AlpineBuild) build.Spec
var BuildNix func(schema.PackageName, *pkggraph.Module, fs.FS) build.Spec
var BuildNodejs func(cfg.Context, pkggraph.Location, *schema.NodejsBuild, assets.AvailableBuildAssets, bool /* isFocus */) (build.Spec, error)
var BuildStaticFilesServer func(*schema.ImageBuildPlan_StaticFilesServer) build.Spec
var prebuiltsConfType = cfg.DefineConfigType[*Prebuilts]()
const LLBGenBinaryName = "llbgen"
type Prepared struct {
Name string
Plan build.Plan
Command []string
Args []string
Env []*schema.BinaryConfig_EnvEntry
WorkingDir string
}
type PreparedImage struct {
Name string
Image compute.Computable[oci.Image]
Command []string
}
type BuildImageOpts struct {
UsePrebuilts bool
// Whether the server build is triggered explicitly, e.g. as a parameter of `ns dev` and not as a dependant server.
// Builders may use this flag to listen to the FS changes and do hot restart, for example.
IsFocus bool
Platforms []specs.Platform
}
// Returns a Prepared.
func Plan(ctx context.Context, pkg *pkggraph.Package, binName string, env pkggraph.SealedContext, assets assets.AvailableBuildAssets, opts BuildImageOpts) (*Prepared, error) {
binary, err := pkg.LookupBinary(binName)
if err != nil {
return nil, err
}
return PlanBinary(ctx, env, env, pkg.Location, binary, assets, opts)
}
func PlanBinary(ctx context.Context, pl pkggraph.PackageLoader, env cfg.Context, loc pkggraph.Location, binary *schema.Binary, assets assets.AvailableBuildAssets, opts BuildImageOpts) (*Prepared, error) {
spec, err := planImage(ctx, pl, env, loc, binary, assets, opts)
if err != nil {
return nil, err
}
platforms := opts.Platforms
if spec.PlatformIndependent() {
platforms = nil
}
plan := build.Plan{
SourcePackage: loc.PackageName,
SourceLabel: fmt.Sprintf("Binary %s", loc.PackageName),
BuildKind: storage.Build_BINARY,
Spec: spec,
Workspace: loc.Module,
Platforms: platforms,
}
return &Prepared{
Name: loc.PackageName.String(),
Plan: plan,
Command: binary.Config.GetCommand(),
Args: binary.Config.GetArgs(),
Env: binary.Config.GetEnv(),
WorkingDir: binary.Config.GetWorkingDir(),
}, nil
}
func (p Prepared) Image(ctx context.Context, env pkggraph.SealedContext) (compute.Computable[oci.ResolvableImage], error) {
return multiplatform.PrepareMultiPlatformImage(ctx, env, p.Plan)
}
func PrebuiltImageID(ctx context.Context, loc pkggraph.Location, cfg cfg.Configuration) (*oci.ImageID, error) {
if !UsePrebuilts {
return nil, nil
}
prebuilts := loc.Module.Workspace.PrebuiltBinary
if conf, ok := prebuiltsConfType.CheckGet(cfg); ok {
prebuilts = append(prebuilts, conf.PrebuiltBinary...)
fmt.Fprintf(console.Debug(ctx), "Adding %d prebuilts from planning configuration.", len(conf.PrebuiltBinary))
}
var selected *oci.ImageID
for _, prebuilt := range prebuilts {
if prebuilt.PackageName == loc.PackageName.String() {
imgid := oci.ImageID{Repository: prebuilt.Repository, Digest: prebuilt.Digest}
if imgid.Repository == "" {
if loc.Module.Workspace.PrebuiltBaseRepository == "" {
break // Silently fail.
}
imgid.Repository = filepath.Join(loc.Module.Workspace.PrebuiltBaseRepository, prebuilt.PackageName)
}
if selected == nil {
selected = &imgid
continue
}
if imgid.Repository != selected.Repository {
return nil, fnerrors.NewWithLocation(loc, "conflicting repositories for prebuilt: %s vs %s", imgid.Repository, selected.Repository)
}
if imgid.Digest != selected.Digest {
return nil, fnerrors.NewWithLocation(loc, "conflicting digest for prebuilt: %s vs %s", imgid.Digest, selected.Digest)
}
}
}
return selected, nil
}
func planImage(ctx context.Context, pl pkggraph.PackageLoader, env cfg.Context, loc pkggraph.Location, bin *schema.Binary, assets assets.AvailableBuildAssets, opts BuildImageOpts) (build.Spec, error) {
// We prepare the build spec, as we need information, e.g. whether it's platform independent,
// if a prebuilt is specified.
spec, err := buildLayeredSpec(ctx, pl, env, loc, bin, assets, opts)
if err != nil {
return nil, err
}
if opts.UsePrebuilts {
imgid, err := PrebuiltImageID(ctx, loc, env.Configuration())
if err != nil {
return nil, err
}
if imgid != nil {
return build.PrebuiltPlan(*imgid, spec.PlatformIndependent(), build.PrebuiltResolveOpts()), nil
}
}
return spec, nil
}
func buildLayeredSpec(ctx context.Context, pl pkggraph.PackageLoader, env cfg.Context, loc pkggraph.Location, bin *schema.Binary, assets assets.AvailableBuildAssets, opts BuildImageOpts) (build.Spec, error) {
src := bin.BuildPlan
if src == nil || len(src.LayerBuildPlan) == 0 {
return nil, fnerrors.NewWithLocation(loc, "%s: don't know how to build, missing build plan", bin.Name)
}
if len(src.LayerBuildPlan) == 1 {
return buildSpec(ctx, pl, env, loc, bin, src.LayerBuildPlan[0], assets, opts)
}
specs := make([]build.Spec, len(src.LayerBuildPlan))
descriptions := make([]string, len(src.LayerBuildPlan))
platformIndependent := true
for k, plan := range src.LayerBuildPlan {
var err error
specs[k], err = buildSpec(ctx, pl, env, loc, bin, plan, assets, opts)
if err != nil {
return nil, err
}
if !specs[k].PlatformIndependent() {
platformIndependent = false
}
if plan.Description == "" {
descriptions[k] = fmt.Sprintf("plan#%d", k)
} else {
descriptions[k] = plan.Description
}
}
return MergeSpecs{Specs: specs, Descriptions: descriptions, platformIndependent: platformIndependent}, nil
}
func buildSpec(ctx context.Context, pl pkggraph.PackageLoader, env cfg.Context, loc pkggraph.Location, bin *schema.Binary, src *schema.ImageBuildPlan, assets assets.AvailableBuildAssets, opts BuildImageOpts) (build.Spec, error) {
if src == nil {
return nil, fnerrors.NewWithLocation(loc, "don't know how to build %q: no plan", bin.Name)
}
if imageId := src.ImageId; imageId != "" {
imgId, err := oci.ParseImageID(imageId)
if err != nil {
return nil, err
}
return build.PrebuiltPlan(imgId, false /* platformIndependent */, build.PrebuiltResolveOpts()), nil
}
if goPackage := src.GoPackage; goPackage != "" {
// Note, regardless of what config.command has been set to, we always build a
// binary named bin.Name.
return BuildGo(loc, &schema.ImageBuildPlan_GoBuild{
RelPath: goPackage,
BinaryName: bin.Name,
IsFocus: opts.IsFocus,
}, false)
}
if src.GoBuild != nil {
return BuildGo(loc, src.GoBuild, false)
}
if src.NodejsBuild != nil {
return BuildNodejs(env, loc, src.NodejsBuild, assets, opts.IsFocus)
}
if wb := src.WebBuild; wb != "" {
if wb != "." {
return nil, fnerrors.NewWithLocation(loc, "web_build: must be set to `.`")
}
return BuildWeb(loc), nil
}
if llb := src.LlbPlan; llb != nil {
spec, err := buildLayeredSpec(ctx, pl, env, loc, llb.OutputOf, assets, opts)
if err != nil {
return nil, err
}
return BuildLLBGen(loc.PackageName, loc.Module, spec), nil
}
if alpine := src.AlpineBuild; alpine != nil {
return BuildAlpine(loc, alpine), nil
}
if nix := src.NixFlake; nix != "" {
fsys, err := compute.GetValue(ctx, loc.Module.VersionedFS(loc.Rel(nix), false))
if err != nil {
return nil, fnerrors.AttachLocation(loc, err)
}
return BuildNix(loc.PackageName, loc.Module, fsys.FS()), nil
}
if dockerFile := src.Dockerfile; dockerFile != "" {
spec, err := dockerfile.Build(loc.Rel(), dockerFile, opts.IsFocus)
if err != nil {
return nil, fnerrors.AttachLocation(loc, err)
}
return spec, nil
}
if binRef := src.Binary; binRef != nil {
binPkg, binary, err := pkggraph.LoadBinary(ctx, pl, binRef)
if err != nil {
return nil, err
}
spec, err := planImage(ctx, pl, env, binPkg.Location, binary, assets, opts)
if err != nil {
return nil, err
}
return spec, nil
}
if src.StaticFilesServer != nil {
return BuildStaticFilesServer(src.StaticFilesServer), nil
}
if len(src.SnapshotFiles) > 0 {
return snapshotFiles{loc.Rel(), src.SnapshotFiles}, nil
}
return nil, fnerrors.NewWithLocation(loc, "don't know how to build binary image: `from` statement does not yield a build unit")
}
func EnsureImage(ctx context.Context, env pkggraph.SealedContext, prepared *Prepared) (oci.ImageID, error) {
img, err := prepared.Image(ctx, env)
if err != nil {
return oci.ImageID{}, err
}
name, err := registry.RawAllocateName(ctx, env.Configuration(), prepared.Name)
if err != nil {
return oci.ImageID{}, err
}
return compute.GetValue(ctx, oci.PublishResolvable(name, img))
}