/
build.go
319 lines (283 loc) · 9.42 KB
/
build.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
// Copyright 2021 Upbound Inc
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package xpkg
import (
"bytes"
"context"
"io"
"os"
"strings"
"github.com/crossplane/crossplane-runtime/pkg/errors"
pkgmetav1 "github.com/crossplane/crossplane/apis/pkg/meta/v1"
"github.com/crossplane/crossplane/apis/pkg/v1beta1"
v1 "github.com/google/go-containerregistry/pkg/v1"
"github.com/google/go-containerregistry/pkg/v1/empty"
"github.com/google/go-containerregistry/pkg/v1/mutate"
"gopkg.in/yaml.v2"
crd "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/serializer/json"
"github.com/crossplane/crossplane-runtime/pkg/parser"
"github.com/upbound/up/internal/xpkg/parser/examples"
"github.com/upbound/up/internal/xpkg/parser/linter"
"github.com/upbound/up/internal/xpkg/scheme"
)
const (
errParserPackage = "failed to parse package"
errParserExample = "failed to parse examples"
errLintPackage = "failed to lint package"
errInitBackend = "failed to initialize package parsing backend"
errTarFromStream = "failed to build tarball from stream"
errLayerFromTar = "failed to convert tarball to image layer"
errDigestInvalid = "failed to get digest from image layer"
errBuildImage = "failed to build image from layers"
errConfigFile = "failed to get config file from image"
errMutateConfig = "failed to mutate config for image"
errBuildObjectScheme = "failed to build scheme for package encoder"
errParseAuth = "an auth extension was supplied but could not be parsed"
errAuthNotAnnotated = "an auth extension was supplied but but the " + ProviderConfigKind + " object could not be found"
authMetaAnno = "auth.upbound.io/group"
authObjectAnno = "auth.upbound.io/config"
ProviderConfigKind = "ProviderConfig"
)
// annotatedTeeReadCloser is a copy of io.TeeReader that implements
// parser.AnnotatedReadCloser. It returns a Reader that writes to w what it
// reads from r. All reads from r performed through it are matched with
// corresponding writes to w. There is no internal buffering - the write must
// complete before the read completes. Any error encountered while writing is
// reported as a read error. If the underlying reader is a
// parser.AnnotatedReadCloser the tee reader will invoke its Annotate function.
// Otherwise it will return nil. Closing is always a no-op.
func annotatedTeeReadCloser(r io.Reader, w io.Writer) *teeReader {
return &teeReader{r, w}
}
type teeReader struct {
r io.Reader
w io.Writer
}
func (t *teeReader) Read(p []byte) (n int, err error) {
n, err = t.r.Read(p)
if n > 0 {
if n, err := t.w.Write(p[:n]); err != nil {
return n, err
}
}
return
}
func (t *teeReader) Close() error {
return nil
}
func (t *teeReader) Annotate() any {
anno, ok := t.r.(parser.AnnotatedReadCloser)
if !ok {
return nil
}
return anno.Annotate()
}
// Builder defines an xpkg Builder.
type Builder struct {
pb parser.Backend
eb parser.Backend
ab parser.Backend
pp parser.Parser
ep *examples.Parser
}
// New returns a new Builder.
func New(pkg, ab, ex parser.Backend, pp parser.Parser, ep *examples.Parser) *Builder {
return &Builder{
pb: pkg,
ab: ab,
eb: ex,
pp: pp,
ep: ep,
}
}
type buildOpts struct {
base v1.Image
}
// A BuildOpt modifies how a package is built.
type BuildOpt func(*buildOpts)
// WithController sets the controller image that should serve as the base for
// the package.
func WithController(img v1.Image) BuildOpt {
return func(o *buildOpts) {
o.base = img
}
}
type AuthExtension struct {
Version string `yaml:"version"`
Discriminant string `yaml:"discriminant"`
Sources []struct {
Name string `yaml:"name"`
Docs string `yaml:"docs"`
AdditionalResources []struct {
Type string `yaml:"type"`
Ref string `yaml:"ref"`
} `yaml:"additionalResources"`
ShowFields []string `yaml:"showFields"`
} `yaml:"sources"`
}
// Build compiles a Crossplane package from an on-disk package.
func (b *Builder) Build(ctx context.Context, opts ...BuildOpt) (v1.Image, runtime.Object, error) { // nolint:gocyclo
bOpts := &buildOpts{
base: empty.Image,
}
for _, o := range opts {
o(bOpts)
}
// assume examples exist
examplesExist := true
// Get package YAML stream.
pkgReader, err := b.pb.Init(ctx)
if err != nil {
return nil, nil, errors.Wrap(err, errInitBackend)
}
defer func() { _ = pkgReader.Close() }()
// Get examples YAML stream.
exReader, err := b.eb.Init(ctx)
if err != nil && !os.IsNotExist(err) {
return nil, nil, errors.Wrap(err, errInitBackend)
}
defer func() { _ = exReader.Close() }()
// examples/ doesn't exist
if os.IsNotExist(err) {
examplesExist = false
}
pkg, err := b.pp.Parse(ctx, pkgReader)
if err != nil {
return nil, nil, errors.Wrap(err, errParserPackage)
}
metas := pkg.GetMeta()
if len(metas) != 1 {
return nil, nil, errors.New(errNotExactlyOneMeta)
}
// TODO(hasheddan): make linter selection logic configurable.
meta := metas[0]
var linter linter.Linter
switch meta.GetObjectKind().GroupVersionKind().Kind {
case pkgmetav1.ConfigurationKind:
linter = NewConfigurationLinter()
case v1beta1.FunctionKind:
linter = NewFunctionLinter()
case pkgmetav1.ProviderKind:
if b.ab != nil { // if we have an auth.yaml file
if p, ok := meta.(metav1.Object); ok {
if group, ok := p.GetAnnotations()[authMetaAnno]; ok {
// if we found an annotation auth.upbound.io/group then look for the object
// specified there like aws.upbound.io and annotate that with auth.upbound.io/config
// and embed the contents of the auth.yaml file
ar, err := b.ab.Init(ctx)
if err != nil {
return nil, nil, errors.Wrap(err, errParseAuth)
}
// validate the auth.yaml file
var auth AuthExtension
if err := yaml.NewDecoder(ar).Decode(&auth); err != nil {
return nil, nil, errors.Wrap(err, errParseAuth)
}
annotated := false
for x, o := range pkg.GetObjects() {
if c, ok := o.(*crd.CustomResourceDefinition); ok {
if c.Spec.Group == group && c.Spec.Names.Kind == ProviderConfigKind {
ab := new(bytes.Buffer)
if err := yaml.NewEncoder(ab).Encode(auth); err != nil {
return nil, nil, errors.Wrap(err, errParseAuth)
}
c.Annotations[authObjectAnno] = ab.String()
pkg.GetObjects()[x] = c
annotated = true
break
}
}
}
if !annotated {
return nil, nil, errors.New(errAuthNotAnnotated)
}
}
}
}
linter = NewProviderLinter()
}
if err := linter.Lint(pkg); err != nil {
return nil, nil, errors.Wrap(err, errLintPackage)
}
layers := make([]v1.Layer, 0)
cfgFile, err := bOpts.base.ConfigFile()
if err != nil {
return nil, nil, errors.Wrap(err, errConfigFile)
}
cfg := cfgFile.Config
cfg.Labels = make(map[string]string)
pkgBytes, err := encode(pkg)
if err != nil {
return nil, nil, errors.Wrap(err, errConfigFile)
}
pkgLayer, err := Layer(pkgBytes, StreamFile, PackageAnnotation, int64(pkgBytes.Len()), StreamFileMode, &cfg)
if err != nil {
return nil, nil, err
}
layers = append(layers, pkgLayer)
// examples exist, create the layer
if examplesExist {
exBuf := new(bytes.Buffer)
if _, err = b.ep.Parse(ctx, annotatedTeeReadCloser(exReader, exBuf)); err != nil {
return nil, nil, errors.Wrap(err, errParserExample)
}
exLayer, err := Layer(exBuf, XpkgExamplesFile, ExamplesAnnotation, int64(exBuf.Len()), StreamFileMode, &cfg)
if err != nil {
return nil, nil, err
}
layers = append(layers, exLayer)
}
for _, l := range layers {
bOpts.base, err = mutate.AppendLayers(bOpts.base, l)
if err != nil {
return nil, nil, errors.Wrap(err, errBuildImage)
}
}
bOpts.base, err = mutate.Config(bOpts.base, cfg)
if err != nil {
return nil, nil, errors.Wrap(err, errMutateConfig)
}
return bOpts.base, meta, nil
}
// encode encodes a package as a YAML stream. Does not check meta existence
// or quantity i.e. it should be linted first to ensure that it is valid.
func encode(pkg linter.Package) (*bytes.Buffer, error) {
pkgBuf := new(bytes.Buffer)
objScheme, err := scheme.BuildObjectScheme()
if err != nil {
return nil, errors.New(errBuildObjectScheme)
}
do := json.NewSerializerWithOptions(json.DefaultMetaFactory, objScheme, objScheme, json.SerializerOptions{Yaml: true})
pkgBuf.WriteString("---\n")
if err = do.Encode(pkg.GetMeta()[0], pkgBuf); err != nil {
return nil, errors.Wrap(err, errBuildObjectScheme)
}
pkgBuf.WriteString("---\n")
for _, o := range pkg.GetObjects() {
if err = do.Encode(o, pkgBuf); err != nil {
return nil, errors.Wrap(err, errBuildObjectScheme)
}
pkgBuf.WriteString("---\n")
}
return pkgBuf, nil
}
// SkipContains supplies a FilterFn that skips paths that contain the give pattern.
func SkipContains(pattern string) parser.FilterFn {
return func(path string, info os.FileInfo) (bool, error) {
return strings.Contains(path, pattern), nil
}
}