fbc: promote package-level metdata from olm.csv.metadata to olm.package blob

Signed-off-by: Joe Lanford <[email protected]>

Author: joelanford

alpha/action/migrations/003_promote_package_metadata.go

@@ -0,0 +1,109 @@
+package migrations
+
+import (
+	"encoding/json"
+
+	"github.com/Masterminds/semver/v3"
+
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
+
+	"github.com/operator-framework/operator-registry/alpha/declcfg"
+	"github.com/operator-framework/operator-registry/alpha/property"
+)
+
+func promotePackageMetadata(cfg *declcfg.DeclarativeConfig) error {
+	metadataByPackage := map[string]promotedMetadata{}
+	for i := range cfg.Bundles {
+		b := &cfg.Bundles[i]
+
+		csvMetadata, csvMetadataIdx, err := getCsvMetadata(b)
+		if err != nil {
+			return err
+		}
+		if csvMetadata == nil {
+			continue
+		}
+
+		cur, ok := metadataByPackage[b.Package]
+		if !ok || compareRegistryV1Semver(cur.version, b.Version) < 0 {
+			metadataByPackage[b.Package] = promotedCSVMetadata(b.Version, csvMetadata)
+		}
+
+		csvMetadata.DisplayName = ""
+		delete(csvMetadata.Annotations, "description")
+		csvMetadata.Provider = v1alpha1.AppLink{}
+		csvMetadata.Maintainers = nil
+		csvMetadata.Links = nil
+		csvMetadata.Keywords = nil
+
+		newCSVMetadata, err := json.Marshal(csvMetadata)
+		if err != nil {
+			return err
+		}
+		b.Properties[csvMetadataIdx] = property.Property{
+			Type:  property.TypeCSVMetadata,
+			Value: newCSVMetadata,
+		}
+	}
+
+	for i := range cfg.Packages {
+		pkg := &cfg.Packages[i]
+		metadata, ok := metadataByPackage[pkg.Name]
+		if !ok {
+			continue
+		}
+		pkg.DisplayName = metadata.displayName
+		pkg.ShortDescription = metadata.shortDescription
+		pkg.Provider = metadata.provider
+		pkg.Maintainers = metadata.maintainers
+		pkg.Links = metadata.links
+		pkg.Keywords = metadata.keywords
+	}
+	return nil
+}
+
+func getCsvMetadata(b *declcfg.Bundle) (*property.CSVMetadata, int, error) {
+	for i, p := range b.Properties {
+		if p.Type != property.TypeCSVMetadata {
+			continue
+		}
+		var csvMetadata property.CSVMetadata
+		if err := json.Unmarshal(p.Value, &csvMetadata); err != nil {
+			return nil, -1, err
+		}
+		return &csvMetadata, i, nil
+	}
+	return nil, -1, nil
+}
+
+func compareRegistryV1Semver(a, b *semver.Version) int {
+	if v := a.Compare(b); v != 0 {
+		return v
+	}
+	aPre := semver.New(0, 0, 0, a.Metadata(), "")
+	bPre := semver.New(0, 0, 0, b.Metadata(), "")
+	return aPre.Compare(bPre)
+}
+
+type promotedMetadata struct {
+	version *semver.Version
+
+	displayName      string
+	shortDescription string
+	provider         v1alpha1.AppLink
+	maintainers      []v1alpha1.Maintainer
+	links            []v1alpha1.AppLink
+	keywords         []string
+}
+
+func promotedCSVMetadata(version *semver.Version, metadata *property.CSVMetadata) promotedMetadata {
+	return promotedMetadata{
+		version:          version,
+		displayName:      metadata.DisplayName,
+		shortDescription: metadata.Annotations["description"],
+		provider:         metadata.Provider,
+		maintainers:      metadata.Maintainers,
+		links:            metadata.Links,
+		keywords:         metadata.Keywords,
+	}
+}

alpha/action/migrations/migrations.go

@@ -56,6 +56,7 @@ var allMigrations = []Migration{
 	newMigration("bundle-object-to-csv-metadata", `migrates bundles' "olm.bundle.object" to "olm.csv.metadata"`, bundleObjectToCSVMetadata),
 	newMigration("split-icon", `split package icon out into separate "olm.icon" blob`, splitIcon),
 	newMigration("promote-bundle-version", `promote bundle version into first-class bundle field, remove olm.package properties`, promoteBundleVersion),
+	newMigration("promote-package-metadata", `promote package metadata from "olm.csv.metadata" properties to "olm.package" blob`, promotePackageMetadata),
 }
 
 func NewMigrations(name string) (*Migrations, error) {

alpha/declcfg/declcfg.go

@@ -11,6 +11,8 @@ import (
 	utilerrors "k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/apimachinery/pkg/util/sets"
 
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
+
 	"github.com/operator-framework/operator-registry/alpha/property"
 	prettyunmarshaler "github.com/operator-framework/operator-registry/pkg/prettyunmarshaler"
 )
@@ -36,12 +38,12 @@ type Package struct {
 	Schema string `json:"schema"`
 	Name   string `json:"name"`
 
-	//DisplayName      string                `json:"displayName,omitempty"`
-	//ShortDescription string                `json:"shortDescription,omitempty"`
-	//Provider         v1alpha1.AppLink      `json:"provider,omitempty"`
-	//Maintainers      []v1alpha1.Maintainer `json:"maintainers,omitempty"`
-	//Links            []v1alpha1.AppLink    `json:"links,omitempty"`
-	//Keywords         []string              `json:"keywords,omitempty"`
+	DisplayName      string                `json:"displayName,omitempty"`
+	ShortDescription string                `json:"shortDescription,omitempty"`
+	Provider         v1alpha1.AppLink      `json:"provider,omitempty"`
+	Maintainers      []v1alpha1.Maintainer `json:"maintainers,omitempty"`
+	Links            []v1alpha1.AppLink    `json:"links,omitempty"`
+	Keywords         []string              `json:"keywords,omitempty"`
 
 	DefaultChannel string              `json:"defaultChannel"`
 	Description    string              `json:"description,omitempty"`

alpha/declcfg/declcfg_to_model.go

@@ -32,12 +32,12 @@ func ConvertToModel(cfg DeclarativeConfig) (model.Model, error) {
 			Description: p.Description,
 			Channels:    map[string]*model.Channel{},
 
-			//DisplayName:      p.DisplayName,
-			//ShortDescription: p.ShortDescription,
-			//Provider:         p.Provider,
-			//Maintainers:      p.Maintainers,
-			//Links:            p.Links,
-			//Keywords:         p.Keywords,
+			DisplayName:      p.DisplayName,
+			ShortDescription: p.ShortDescription,
+			Provider:         p.Provider,
+			Maintainers:      p.Maintainers,
+			Links:            p.Links,
+			Keywords:         p.Keywords,
 		}
 		if p.Icon != nil {
 			mpkg.Icon = &model.Icon{

alpha/model/model.go

@@ -3,6 +3,7 @@ package model
 import (
 	"errors"
 	"fmt"
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
 	"sort"
 	"strings"
 
@@ -52,12 +53,12 @@ type Package struct {
 	Channels       map[string]*Channel
 	Deprecation    *Deprecation
 
-	//DisplayName      string
-	//ShortDescription string
-	//Provider         v1alpha1.AppLink
-	//Maintainers      []v1alpha1.Maintainer
-	//Links            []v1alpha1.AppLink
-	//Keywords         []string
+	DisplayName      string
+	ShortDescription string
+	Provider         v1alpha1.AppLink
+	Maintainers      []v1alpha1.Maintainer
+	Links            []v1alpha1.AppLink
+	Keywords         []string
 }
 
 func (m *Package) Validate() error {

pkg/api/model_to_api.go

@@ -30,7 +30,7 @@ func ConvertModelBundleToAPIBundle(b model.Bundle) (*Bundle, error) {
 				MediaType: b.Package.Icon.MediaType,
 			}}
 		}
-		csv := csvMetadataToCsv(props.CSVMetadatas[0])
+		csv := bundleToCSV(b)
 		csv.Name = b.Name
 		csv.Spec.Icon = icons
 		csv.Spec.InstallStrategy = v1alpha1.NamedInstallStrategy{
@@ -101,7 +101,28 @@ func parseProperties(in []property.Property) (*property.Properties, error) {
 	return props, nil
 }
 
-func csvMetadataToCsv(m property.CSVMetadata) v1alpha1.ClusterServiceVersion {
+func bundleToCSV(b model.Bundle) v1alpha1.ClusterServiceVersion {
+	p := b.Package
+	m := b.PropertiesP.CSVMetadatas[0]
+
+	if m.DisplayName == "" {
+		m.DisplayName = p.DisplayName
+	}
+	if _, ok := m.Annotations["description"]; !ok {
+		m.Annotations["description"] = p.ShortDescription
+	}
+	if m.Provider.Name == "" && m.Provider.URL == "" {
+		m.Provider = p.Provider
+	}
+	if m.Maintainers == nil {
+		m.Maintainers = p.Maintainers
+	}
+	if m.Links == nil {
+		m.Links = p.Links
+	}
+	if m.Keywords == nil {
+		m.Keywords = p.Keywords
+	}
 	return v1alpha1.ClusterServiceVersion{
 		TypeMeta: metav1.TypeMeta{
 			Kind:       operators.ClusterServiceVersionKind,