Merge pull request #309 from nullable-eth/auth-ext-build

combine xpkg auth ext anno during build

cmd/up/xpkg/build.go

@@ -16,6 +16,7 @@ package xpkg
 
 import (
 	"context"
+	"io"
 	"path/filepath"
 
 	"github.com/crossplane/crossplane-runtime/pkg/errors"
@@ -36,8 +37,6 @@ const (
 	errBuildPackage    = "failed to build package"
 	errImageDigest     = "failed to get package digest"
 	errCreatePackage   = "failed to create package file"
-
-	examplesDir = "examples/"
 )
 
 // AfterApply constructs and binds Upbound-specific context to any subcommands
@@ -56,6 +55,18 @@ func (c *buildCmd) AfterApply() error {
 		return err
 	}
 
+	var authBE parser.Backend
+	if ax, err := filepath.Abs(c.AuthExt); err == nil {
+		if axf, err := c.fs.Open(ax); err == nil {
+			defer func() { _ = axf.Close() }()
+			b, err := io.ReadAll(axf)
+			if err != nil {
+				return err
+			}
+			authBE = parser.NewEchoBackend(string(b))
+		}
+	}
+
 	pp, err := yaml.New()
 	if err != nil {
 		return err
@@ -68,8 +79,9 @@ func (c *buildCmd) AfterApply() error {
 			parser.FsFilters(
 				append(
 					buildFilters(root, c.Ignore),
-					xpkg.SkipContains(examplesDir))...),
+					xpkg.SkipContains(c.ExamplesRoot), xpkg.SkipContains(c.AuthExt))...),
 		),
+		authBE,
 		parser.NewFsBackend(
 			c.fs,
 			parser.FsDir(ex),
@@ -99,6 +111,7 @@ type buildCmd struct {
 	Controller   string   `help:"Controller image used as base for package."`
 	PackageRoot  string   `short:"f" help:"Path to package directory." default:"."`
 	ExamplesRoot string   `short:"e" help:"Path to package examples directory." default:"./examples"`
+	AuthExt      string   `short:"a" help:"Path to an authentication extension file." default:"auth.yaml"`
 	Ignore       []string `help:"Paths, specified relative to --package-root, to exclude from the package."`
 }
 

go.mod

@@ -30,6 +30,7 @@ require (
 	github.com/willabides/kongplete v0.3.0
 	golang.org/x/sync v0.0.0-20220601150217-0de741cfad7f
 	golang.org/x/term v0.0.0-20210927222741-03fcf44c2211
+	gopkg.in/yaml.v2 v2.4.0
 	gopkg.in/yaml.v3 v3.0.1
 	helm.sh/helm/v3 v3.9.0
 	k8s.io/api v0.24.3
@@ -217,7 +218,6 @@ require (
 	google.golang.org/protobuf v1.28.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/warnings.v0 v0.1.2 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 	k8s.io/apiserver v0.24.3 // indirect
 	k8s.io/cli-runtime v0.24.3 // indirect
 	k8s.io/component-base v0.24.3 // indirect

internal/xpkg/build.go

@@ -23,28 +23,39 @@ import (
 
 	"github.com/crossplane/crossplane-runtime/pkg/errors"
 	pkgmetav1 "github.com/crossplane/crossplane/apis/pkg/meta/v1"
+	v1alpha1 "github.com/crossplane/crossplane/apis/pkg/meta/v1alpha1"
 	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"
 	"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"
+	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
@@ -90,15 +101,17 @@ func (t *teeReader) Annotate() any {
 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, ex parser.Backend, pp parser.Parser, ep *examples.Parser) *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,
@@ -120,6 +133,20 @@ func WithController(img v1.Image) BuildOpt {
 	}
 }
 
+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{
@@ -149,9 +176,7 @@ func (b *Builder) Build(ctx context.Context, opts ...BuildOpt) (v1.Image, runtim
 		examplesExist = false
 	}
 
-	// Copy stream once to parse and once write to tarball.
-	pkgBuf := new(bytes.Buffer)
-	pkg, err := b.pp.Parse(ctx, annotatedTeeReadCloser(pkgReader, pkgBuf))
+	pkg, err := b.pp.Parse(ctx, pkgReader)
 	if err != nil {
 		return nil, nil, errors.Wrap(err, errParserPackage)
 	}
@@ -167,6 +192,43 @@ func (b *Builder) Build(ctx context.Context, opts ...BuildOpt) (v1.Image, runtim
 	if meta.GetObjectKind().GroupVersionKind().Kind == pkgmetav1.ConfigurationKind {
 		linter = NewConfigurationLinter()
 	} else {
+		if b.ab != nil { // if we have an auth.yaml file
+			if p, ok := meta.(*v1alpha1.Provider); ok {
+				// if has 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
+				if group, ok := p.ObjectMeta.Annotations[authMetaAnno]; ok {
+					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 {
@@ -182,7 +244,12 @@ func (b *Builder) Build(ctx context.Context, opts ...BuildOpt) (v1.Image, runtim
 	cfg := cfgFile.Config
 	cfg.Labels = make(map[string]string)
 
-	pkgLayer, err := Layer(pkgBuf, StreamFile, PackageAnnotation, int64(pkgBuf.Len()), &cfg)
+	pkgBytes, err := encode(pkg)
+	if err != nil {
+		return nil, nil, errors.Wrap(err, errConfigFile)
+	}
+
+	pkgLayer, err := Layer(pkgBytes, StreamFile, PackageAnnotation, int64(pkgBytes.Len()), &cfg)
 	if err != nil {
 		return nil, nil, err
 	}
@@ -217,6 +284,30 @@ func (b *Builder) Build(ctx context.Context, opts ...BuildOpt) (v1.Image, runtim
 	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) {

internal/xpkg/build_test.go

@@ -121,7 +121,7 @@ func TestBuild(t *testing.T) {
 
 	for name, tc := range cases {
 		t.Run(name, func(t *testing.T) {
-			builder := New(tc.args.be, tc.args.ex, tc.args.p, tc.args.e)
+			builder := New(tc.args.be, nil, tc.args.ex, tc.args.p, tc.args.e)
 
 			_, _, err := builder.Build(context.TODO())
 
@@ -251,7 +251,7 @@ func TestBuildExamples(t *testing.T) {
 				parser.FsFilters(defaultFilters...),
 			)
 
-			builder := New(pkgBe, pkgEx, pkgp, examples.New())
+			builder := New(pkgBe, nil, pkgEx, pkgp, examples.New())
 
 			img, _, err := builder.Build(context.TODO())