fbc: promote bundle version from property to first-class field

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

Author: joelanford

alpha/action/migrations/002_promote_bundle_version.go

@@ -0,0 +1,44 @@
+package migrations
+
+import (
+	"encoding/json"
+	"slices"
+
+	"github.com/Masterminds/semver/v3"
+
+	"github.com/operator-framework/operator-registry/alpha/declcfg"
+	"github.com/operator-framework/operator-registry/alpha/property"
+)
+
+func promoteBundleVersion(cfg *declcfg.DeclarativeConfig) error {
+	promoteVersion := func(b *declcfg.Bundle) error {
+		// Promote the version from the olm.package property to the bundle field.
+		for _, p := range b.Properties {
+			if p.Type != property.TypePackage {
+				continue
+			}
+			var pkg property.Package
+			if err := json.Unmarshal(p.Value, &pkg); err != nil {
+				return err
+			}
+			version, err := semver.StrictNewVersion(pkg.Version)
+			if err != nil {
+				return err
+			}
+			b.Version = version
+		}
+
+		// Delete the olm.package properties
+		b.Properties = slices.DeleteFunc(b.Properties, func(p property.Property) bool {
+			return p.Type == property.TypePackage
+		})
+		return nil
+	}
+
+	for i := range cfg.Bundles {
+		if err := promoteVersion(&cfg.Bundles[i]); err != nil {
+			return err
+		}
+	}
+	return nil
+}

alpha/action/migrations/migrations.go

@@ -55,6 +55,7 @@ var allMigrations = []Migration{
 	newMigration(NoMigrations, "do nothing", func(_ *declcfg.DeclarativeConfig) error { return nil }),
 	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),
 }
 
 func NewMigrations(name string) (*Migrations, error) {

alpha/declcfg/declcfg.go

@@ -6,6 +6,7 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/Masterminds/semver/v3"
 	"golang.org/x/text/cases"
 	utilerrors "k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/apimachinery/pkg/util/sets"
@@ -90,8 +91,9 @@ type ChannelEntry struct {
 //     evaluation in bundlesEqual().
 type Bundle struct {
 	Schema        string              `json:"schema"`
-	Name          string              `json:"name,omitempty"`
-	Package       string              `json:"package,omitempty"`
+	Name          string              `json:"name"`
+	Package       string              `json:"package"`
+	Version       *semver.Version     `json:"version,omitempty"`
 	Image         string              `json:"image"`
 	Properties    []property.Property `json:"properties,omitempty" hash:"set"`
 	RelatedImages []RelatedImage      `json:"relatedImages,omitempty" hash:"set"`

alpha/declcfg/declcfg_to_model.go

@@ -140,16 +140,18 @@ func ConvertToModel(cfg DeclarativeConfig) (model.Model, error) {
 			return nil, fmt.Errorf("parse properties for bundle %q: %v", b.Name, err)
 		}
 
-		if len(props.Packages) != 1 {
-			return nil, fmt.Errorf("package %q bundle %q must have exactly 1 %q property, found %d", b.Package, b.Name, property.TypePackage, len(props.Packages))
-		}
-
-		if b.Package != props.Packages[0].PackageName {
-			return nil, fmt.Errorf("package %q does not match %q property %q", b.Package, property.TypePackage, props.Packages[0].PackageName)
+		var rawVersion string
+		if b.Version != nil {
+			rawVersion = b.Version.String()
+		} else if len(props.Packages) == 1 {
+			if b.Package != props.Packages[0].PackageName {
+				return nil, fmt.Errorf("package %q does not match %q property %q", b.Package, property.TypePackage, props.Packages[0].PackageName)
+			}
+			rawVersion = props.Packages[0].Version
+		} else {
+			return nil, fmt.Errorf("package %q bundle %q requires either version being set or exactly one property with type %q", b.Package, b.Name, props.Packages[0].PackageName)
 		}
 
-		// Parse version from the package property.
-		rawVersion := props.Packages[0].Version
 		ver, err := semver.Parse(rawVersion)
 		if err != nil {
 			return nil, fmt.Errorf("error parsing bundle %q version %q: %v", b.Name, rawVersion, err)

alpha/model/model.go

@@ -338,6 +338,7 @@ type Bundle struct {
 	Package       *Package
 	Channel       *Channel
 	Name          string
+	Version       semver.Version
 	Image         string
 	Replaces      string
 	Skips         []string
@@ -354,7 +355,6 @@ type Bundle struct {
 
 	// These fields are used to compare bundles in a diff.
 	PropertiesP *property.Properties
-	Version     semver.Version
 }
 
 func (b *Bundle) Validate() error {
@@ -372,7 +372,7 @@ func (b *Bundle) Validate() error {
 	if b.Channel != nil && b.Package != nil && b.Package != b.Channel.Package {
 		result.subErrors = append(result.subErrors, errors.New("package does not match channel's package"))
 	}
-	props, err := property.Parse(b.Properties)
+	_, err := property.Parse(b.Properties)
 	if err != nil {
 		result.subErrors = append(result.subErrors, err)
 	}
@@ -391,8 +391,8 @@ func (b *Bundle) Validate() error {
 	//	}
 	//}
 
-	if props != nil && len(props.Packages) != 1 {
-		result.subErrors = append(result.subErrors, fmt.Errorf("must be exactly one property with type %q", property.TypePackage))
+	if b.Version.String() == "0.0.0" {
+		result.subErrors = append(result.subErrors, errors.New("version must be set"))
 	}
 
 	if b.Image == "" && len(b.Objects) == 0 {

go.mod

@@ -5,6 +5,7 @@ go 1.23.3
 toolchain go1.23.6
 
 require (
+	github.com/Masterminds/semver/v3 v3.3.1
 	github.com/akrylysov/pogreb v0.10.2
 	github.com/blang/semver/v4 v4.0.0
 	github.com/containerd/containerd v1.7.27

go.sum

@@ -14,6 +14,8 @@ github.com/BurntSushi/toml v1.5.0 h1:W5quZX/G/csjUnuI8SUYlsHs9M38FC7znL0lIO+DvMg
 github.com/BurntSushi/toml v1.5.0/go.mod h1:ukJfTF/6rtPPRCnwkur4qwRxa8vTRFBF0uk2lLoLwho=
 github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ=
 github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE=
+github.com/Masterminds/semver/v3 v3.3.1 h1:QtNSWtVZ3nBfk8mAOu/B6v7FMJ+NHTIgUPi7rj+4nv4=
+github.com/Masterminds/semver/v3 v3.3.1/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM=
 github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY=
 github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=
 github.com/Microsoft/hcsshim v0.12.9 h1:2zJy5KA+l0loz1HzEGqyNnjd3fyZA31ZBCGKacp6lLg=

pkg/api/model_to_api.go

@@ -64,17 +64,22 @@ func ConvertModelBundleToAPIBundle(b model.Bundle) (*Bundle, error) {
 	if err != nil {
 		return nil, fmt.Errorf("convert model properties to api dependencies: %v", err)
 	}
+
+	properties := b.Properties
+	if len(props.Packages) == 0 {
+		properties = append(properties, property.MustBuildPackage(b.Package.Name, b.Version.String()))
+	}
 	return &Bundle{
 		CsvName:      b.Name,
 		PackageName:  b.Package.Name,
 		ChannelName:  b.Channel.Name,
 		BundlePath:   b.Image,
 		ProvidedApis: gvksProvidedtoAPIGVKs(props.GVKs),
 		RequiredApis: gvksRequirestoAPIGVKs(props.GVKsRequired),
-		Version:      props.Packages[0].Version,
+		Version:      b.Version.String(),
 		SkipRange:    b.SkipRange,
 		Dependencies: apiDeps,
-		Properties:   convertModelPropertiesToAPIProperties(b.Properties),
+		Properties:   convertModelPropertiesToAPIProperties(properties),
 		Replaces:     b.Replaces,
 		Skips:        b.Skips,
 		CsvJson:      csvJSON,
@@ -89,10 +94,6 @@ func parseProperties(in []property.Property) (*property.Properties, error) {
 		return nil, err
 	}
 
-	if len(props.Packages) != 1 {
-		return nil, fmt.Errorf("expected exactly 1 property of type %q, found %d", property.TypePackage, len(props.Packages))
-	}
-
 	if len(props.CSVMetadatas) > 1 {
 		return nil, fmt.Errorf("expected at most 1 property of type %q, found %d", property.TypeCSVMetadata, len(props.CSVMetadatas))
 	}