fix(indexing): pick channel heads by semver

On index add in replaces mode, pick the highest bundle version in each
channel as its head; take the default channel from the highest bundle
version in the entire package.

Author: njhale

bundles/prometheus.0.14.0-beta/manifests/prometheusoperator.0.14.0.clusterserviceversion.yaml

@@ -154,7 +154,7 @@ spec:
                     cpu: 100m
                     memory: 50Mi
   maturity: alpha
-  version: 0.14.0
+  version: 0.14.0-beta
   customresourcedefinitions:
     owned:
     - name: prometheuses.monitoring.coreos.com

pkg/lib/bundle/validate.go

@@ -365,7 +365,7 @@ func (i imageValidator) ValidateBundleContent(manifestDir string) error {
 
 	// Validate the bundle object
 	if len(unstObjs) > 0 {
-		bundle := registry.NewBundle(csvName, "", nil, unstObjs...)
+		bundle := registry.NewBundle(csvName, &registry.Annotations{}, unstObjs...)
 		bundleValidator := validation.BundleValidator
 		results := bundleValidator.Validate(bundle)
 		if len(results) > 0 {

pkg/lib/validation/bundle_test.go

@@ -60,7 +60,7 @@ func TestValidateBundle(t *testing.T) {
 		}
 
 		// Validate the bundle object
-		bundle := registry.NewBundle("test", "", nil, unstObjs...)
+		bundle := registry.NewBundle("test", &registry.Annotations{}, unstObjs...)
 		results := BundleValidator.Validate(bundle)
 
 		if len(results) > 0 {

pkg/registry/bundle.go

@@ -1,6 +1,7 @@
 package registry
 
 import (
+	"encoding/json"
 	"fmt"
 	"strings"
 
@@ -41,33 +42,59 @@ type Bundle struct {
 	Package      string
 	Channels     []string
 	BundleImage  string
+	version      string
 	csv          *ClusterServiceVersion
 	v1beta1crds  []*apiextensionsv1beta1.CustomResourceDefinition
 	v1crds       []*apiextensionsv1.CustomResourceDefinition
 	Dependencies []*Dependency
 	Properties   []*Property
+	Annotations  *Annotations
 	cacheStale   bool
 }
 
-func NewBundle(name, pkgName string, channels []string, objs ...*unstructured.Unstructured) *Bundle {
-	bundle := &Bundle{Name: name, Package: pkgName, Channels: channels, cacheStale: false}
+func NewBundle(name string, annotations *Annotations, objs ...*unstructured.Unstructured) *Bundle {
+	bundle := &Bundle{
+		Name:        name,
+		Package:     annotations.PackageName,
+		Annotations: annotations,
+	}
 	for _, o := range objs {
 		bundle.Add(o)
 	}
+
+	if annotations == nil {
+		return bundle
+	}
+	bundle.Channels = strings.Split(annotations.Channels, ",")
+
 	return bundle
 }
 
-func NewBundleFromStrings(name, pkgName string, channels []string, objs []string) (*Bundle, error) {
+func NewBundleFromStrings(name, version, pkg, defaultChannel, channels, objs string) (*Bundle, error) {
+	objStrs, err := BundleStringToObjectStrings(objs)
+	if err != nil {
+		return nil, err
+	}
+
 	unstObjs := []*unstructured.Unstructured{}
-	for _, o := range objs {
+	for _, o := range objStrs {
 		dec := yaml.NewYAMLOrJSONDecoder(strings.NewReader(o), 10)
 		unst := &unstructured.Unstructured{}
 		if err := dec.Decode(unst); err != nil {
 			return nil, err
 		}
 		unstObjs = append(unstObjs, unst)
 	}
-	return NewBundle(name, pkgName, channels, unstObjs...), nil
+
+	annotations := &Annotations{
+		PackageName:        pkg,
+		Channels:           channels,
+		DefaultChannelName: defaultChannel,
+	}
+	bundle := NewBundle(name, annotations, unstObjs...)
+	bundle.version = version
+
+	return bundle, nil
 }
 
 func (b *Bundle) Size() int {
@@ -86,10 +113,20 @@ func (b *Bundle) ClusterServiceVersion() (*ClusterServiceVersion, error) {
 }
 
 func (b *Bundle) Version() (string, error) {
-	if err := b.cache(); err != nil {
+	if b.version != "" {
+		return b.version, nil
+	}
+
+	var err error
+	if err = b.cache(); err != nil {
 		return "", err
 	}
-	return b.csv.GetVersion()
+
+	if b.csv != nil {
+		b.version, err = b.csv.GetVersion()
+	}
+
+	return b.version, err
 }
 
 func (b *Bundle) SkipRange() (string, error) {
@@ -226,29 +263,33 @@ func (b *Bundle) AllProvidedAPIsInBundle() error {
 	return nil
 }
 
-func (b *Bundle) Serialize() (csvName, bundleImage string, csvBytes []byte, bundleBytes []byte, err error) {
+func (b *Bundle) Serialize() (csvName, bundleImage string, csvBytes []byte, bundleBytes []byte, annotationBytes []byte, err error) {
 	csvCount := 0
 	for _, obj := range b.Objects {
 		objBytes, err := runtime.Encode(unstructured.UnstructuredJSONScheme, obj)
 		if err != nil {
-			return "", "", nil, nil, err
+			return "", "", nil, nil, nil, err
 		}
 		bundleBytes = append(bundleBytes, objBytes...)
 
 		if obj.GroupVersionKind().Kind == "ClusterServiceVersion" {
 			csvName = obj.GetName()
 			csvBytes, err = runtime.Encode(unstructured.UnstructuredJSONScheme, obj)
 			if err != nil {
-				return "", "", nil, nil, err
+				return "", "", nil, nil, nil, err
 			}
 			csvCount += 1
 			if csvCount > 1 {
-				return "", "", nil, nil, fmt.Errorf("two csvs found in one bundle")
+				return "", "", nil, nil, nil, fmt.Errorf("two csvs found in one bundle")
 			}
 		}
 	}
 
-	return csvName, b.BundleImage, csvBytes, bundleBytes, nil
+	if b.Annotations != nil {
+		annotationBytes, err = json.Marshal(b.Annotations)
+	}
+
+	return csvName, b.BundleImage, csvBytes, bundleBytes, annotationBytes, nil
 }
 
 func (b *Bundle) Images() (map[string]struct{}, error) {

pkg/registry/bundle_test.go

@@ -2,14 +2,15 @@ package registry
 
 import (
 	"io/ioutil"
-	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
-	"k8s.io/apimachinery/pkg/runtime/serializer"
-	k8syaml "k8s.io/apimachinery/pkg/util/yaml"
 	"path/filepath"
 	"reflect"
 	"strings"
 	"testing"
 
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime/serializer"
+	k8syaml "k8s.io/apimachinery/pkg/util/yaml"
+
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	apiextensionsv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
 )
@@ -22,7 +23,10 @@ const (
 // The provided APIs and CRD objects in the created bundle are compared to those in a test manifest directory.
 func TestV1CRDsInBundle(t *testing.T) {
 	// create bundle from manifests that include a v1 CRD
-	bundle := NewBundle("test", "lib-bucket-provisioner", []string{"alpha"})
+	bundle := NewBundle("test", &Annotations{
+		PackageName: "lib-bucket-provisioner",
+		Channels:    "alpha",
+	})
 
 	// Read all files in manifests directory
 	items, err := ioutil.ReadDir(manifestDir)

pkg/registry/decode.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/util/yaml"
 )

pkg/registry/empty.go

@@ -108,6 +108,10 @@ func (EmptyQuery) GetBundlePathIfExists(ctx context.Context, csvName string) (bu
 	return "", errors.New("empty querier: cannot get bundle path for bundle")
 }
 
+func (EmptyQuery) ListRegistryBundles(ctx context.Context) ([]*Bundle, error) {
+	return nil, errors.New("empty querier: cannot list registry bundles")
+}
+
 var _ Query = &EmptyQuery{}
 
 func NewEmptyQuerier() *EmptyQuery {

pkg/registry/imageinput.go

@@ -115,6 +115,7 @@ func (i *ImageInput) getBundleFromManifests() error {
 	bundle.Dependencies = i.dependenciesFile.GetDependencies()
 
 	bundle.Name = csvName
+	bundle.Annotations = &i.AnnotationsFile.Annotations
 	bundle.Package = i.AnnotationsFile.Annotations.PackageName
 	bundle.Channels = strings.Split(i.AnnotationsFile.Annotations.Channels, ",")
 

pkg/registry/interface.go

@@ -59,6 +59,8 @@ type Query interface {
 	GetDependenciesForBundle(ctx context.Context, name, version, path string) (dependencies []*api.Dependency, err error)
 	// Get the bundle path if it exists
 	GetBundlePathIfExists(ctx context.Context, csvName string) (string, error)
+	// ListRegistryBundles returns a set of registry bundles.
+	ListRegistryBundles(ctx context.Context) ([]*Bundle, error)
 }
 
 //go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 . GraphLoader