poc release bundle attribute in version property

Signed-off-by: grokspawn <[email protected]>

Author: grokspawn

alpha/declcfg/declcfg_to_model.go

@@ -147,6 +147,7 @@ func ConvertToModel(cfg DeclarativeConfig) (model.Model, error) {
 				mb.Objects = b.Objects
 				mb.PropertiesP = props
 				mb.Version = ver
+				mb.Release = props.Packages[0].Release
 			}
 		}
 		if !found {

alpha/declcfg/helpers_test.go

@@ -145,6 +145,16 @@ func withNoBundleData() func(*Bundle) {
 	}
 }
 
+func withReleaseVersion(packageName, version string, rel property.Release) func(*Bundle) {
+	return func(b *Bundle) {
+		for i, p := range b.Properties {
+			if p.Type == property.TypePackage {
+				b.Properties[i] = property.MustBuildPackageRelease(packageName, version, rel.Label, rel.Version.String())
+			}
+		}
+	}
+}
+
 func newTestBundle(packageName, version string, opts ...bundleOpt) Bundle {
 	csvJSON := fmt.Sprintf(`{"kind": "ClusterServiceVersion", "apiVersion": "operators.coreos.com/v1alpha1", "metadata":{"name":%q}}`, testBundleName(packageName, version))
 	b := Bundle{

alpha/model/model.go

@@ -3,6 +3,7 @@ package model
 import (
 	"errors"
 	"fmt"
+	"slices"
 	"sort"
 	"strings"
 
@@ -103,24 +104,24 @@ func (m *Package) Validate() error {
 }
 
 func (m *Package) validateUniqueBundleVersions() error {
-	versionsMap := map[string]semver.Version{}
+	versionsMap := map[string]string{}
 	bundlesWithVersion := map[string]sets.Set[string]{}
 	for _, ch := range m.Channels {
 		for _, b := range ch.Bundles {
-			versionsMap[b.Version.String()] = b.Version
-			if bundlesWithVersion[b.Version.String()] == nil {
-				bundlesWithVersion[b.Version.String()] = sets.New[string]()
+			versionsMap[b.VersionString()] = b.VersionString()
+			if bundlesWithVersion[b.VersionString()] == nil {
+				bundlesWithVersion[b.VersionString()] = sets.New[string]()
 			}
-			bundlesWithVersion[b.Version.String()].Insert(b.Name)
+			bundlesWithVersion[b.VersionString()].Insert(b.Name)
 		}
 	}
 
 	versionsSlice := maps.Values(versionsMap)
-	semver.Sort(versionsSlice)
+	slices.Sort(versionsSlice)
 
 	var errs []error
 	for _, v := range versionsSlice {
-		bundles := sets.List(bundlesWithVersion[v.String()])
+		bundles := sets.List(bundlesWithVersion[v])
 		if len(bundles) > 1 {
 			errs = append(errs, fmt.Errorf("{%s: [%s]}", v, strings.Join(bundles, ", ")))
 		}
@@ -327,6 +328,47 @@ type Bundle struct {
 	// These fields are used to compare bundles in a diff.
 	PropertiesP *property.Properties
 	Version     semver.Version
+	Release     property.Release
+}
+
+func (b *Bundle) VersionString() string {
+	if b.Release.Label != "" || (b.Release.Version.Major != 0 || b.Release.Version.Minor != 0 || b.Release.Version.Patch != 0) {
+		return strings.Join([]string{b.Version.String(), b.Release.String()}, "-")
+	} else {
+		return b.Version.String()
+	}
+}
+
+func (b *Bundle) normalizeName() string {
+	// if the bundle has release versioning, then the name must include this in standard form:
+	// <package-name>-<version>-<release label>-<release version>
+	// if no release versioning exists, then just return the bundle name
+	if b.Release.Label != "" || (b.Release.Version.Major != 0 || b.Release.Version.Minor != 0 || b.Release.Version.Patch != 0) {
+		return strings.Join([]string{b.Package.Name, b.Version.String(), b.Release.String()}, "-")
+	} else {
+		return b.Name
+	}
+}
+
+// order by release, if present
+//   - label first, if present;
+//   - then version, if present;
+//
+// then version
+func (b *Bundle) Compare(other *Bundle) int {
+	if b.Name == other.Name {
+		return 0
+	}
+	if b.Release.Label != other.Release.Label {
+		return strings.Compare(b.Release.Label, other.Release.Label)
+	}
+	if b.Release.Version.NE(other.Release.Version) {
+		return b.Release.Version.Compare(other.Release.Version)
+	}
+	if b.Version.NE(other.Version) {
+		return b.Version.Compare(other.Version)
+	}
+	return 0
 }
 
 func (b *Bundle) Validate() error {
@@ -335,6 +377,9 @@ func (b *Bundle) Validate() error {
 	if b.Name == "" {
 		result.subErrors = append(result.subErrors, errors.New("name must be set"))
 	}
+	if b.Name != b.normalizeName() {
+		result.subErrors = append(result.subErrors, fmt.Errorf("name %q does not match normalized name %q", b.Name, b.normalizeName()))
+	}
 	if b.Channel == nil {
 		result.subErrors = append(result.subErrors, errors.New("channel must be set"))
 	}

alpha/property/property.go

@@ -6,9 +6,11 @@ import (
 	"errors"
 	"fmt"
 	"reflect"
+	"strings"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+	"github.com/blang/semver/v4"
 	"github.com/operator-framework/api/pkg/operators/v1alpha1"
 )
 
@@ -35,9 +37,15 @@ func (p Property) String() string {
 	return fmt.Sprintf("type: %q, value: %q", p.Type, p.Value)
 }
 
+type Release struct {
+	Label   string         `json:"label"`
+	Version semver.Version `json:"version"`
+}
+
 type Package struct {
-	PackageName string `json:"packageName"`
-	Version     string `json:"version"`
+	PackageName string  `json:"packageName"`
+	Version     string  `json:"version"`
+	Release     Release `json:"release,omitzero"`
 }
 
 // NOTICE: The Channel properties are for internal use only.
@@ -247,6 +255,9 @@ func jsonMarshal(p interface{}) ([]byte, error) {
 func MustBuildPackage(name, version string) Property {
 	return MustBuild(&Package{PackageName: name, Version: version})
 }
+func MustBuildPackageRelease(name, version, relLabel, relVersion string) Property {
+	return MustBuild(&Package{PackageName: name, Version: version, Release: Release{Label: relLabel, Version: semver.MustParse(relVersion)}})
+}
 func MustBuildPackageRequired(name, versionRange string) Property {
 	return MustBuild(&PackageRequired{name, versionRange})
 }
@@ -286,3 +297,14 @@ func MustBuildCSVMetadata(csv v1alpha1.ClusterServiceVersion) Property {
 func MustBuildChannelPriority(name string, priority int) Property {
 	return MustBuild(&Channel{ChannelName: name, Priority: priority})
 }
+
+func (r *Release) String() string {
+	segments := []string{}
+	if r.Label != "" {
+		segments = append(segments, r.Label)
+	}
+	if r.Version.Major != 0 || r.Version.Minor != 0 || r.Version.Patch != 0 {
+		segments = append(segments, r.Version.String())
+	}
+	return strings.Join(segments, "-")
+}

alpha/property/property_test.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"testing"
 
+	"github.com/blang/semver/v4"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -132,12 +133,12 @@ func TestParse(t *testing.T) {
 			},
 			expectProps: &Properties{
 				Packages: []Package{
-					{"package1", "0.1.0"},
-					{"package2", "0.2.0"},
+					{PackageName: "package1", Version: "0.1.0"},
+					{PackageName: "package2", Version: "0.2.0"},
 				},
 				PackagesRequired: []PackageRequired{
-					{"package3", ">=1.0.0 <2.0.0-0"},
-					{"package4", ">=2.0.0 <3.0.0-0"},
+					{PackageName: "package3", VersionRange: ">=1.0.0 <2.0.0-0"},
+					{PackageName: "package4", VersionRange: ">=2.0.0 <3.0.0-0"},
 				},
 				GVKs: []GVK{
 					{"group", "Kind1", "v1"},
@@ -206,10 +207,16 @@ func TestBuild(t *testing.T) {
 	specs := []spec{
 		{
 			name:             "Success/Package",
-			input:            &Package{"name", "0.1.0"},
+			input:            &Package{PackageName: "name", Version: "0.1.0"},
 			assertion:        require.NoError,
 			expectedProperty: propPtr(MustBuildPackage("name", "0.1.0")),
 		},
+		{
+			name:             "Success/Package-ReleaseVersion",
+			input:            &Package{PackageName: "name", Version: "0.1.0", Release: Release{Label: "alpha-whatsit", Version: semver.MustParse("1.1.0-bluefoot")}},
+			assertion:        require.NoError,
+			expectedProperty: propPtr(MustBuildPackageRelease("name", "0.1.0", "alpha-whatsit", "1.1.0-bluefoot")),
+		},
 		{
 			name:             "Success/PackageRequired",
 			input:            &PackageRequired{"name", ">=0.1.0"},

pkg/cache/cache.go

@@ -367,6 +367,10 @@ func (c *cache) processPackage(ctx context.Context, reader io.Reader) (packageIn
 	if err != nil {
 		return nil, err
 	}
+
+	// TODO: for each input channel, adjust the entries to respect re-ordering by release attributes as required
+	// do so as FBC so that the routine may be made common, and re-used for OLMv1
+
 	pkgModel, err := declcfg.ConvertToModel(*pkgFbc)
 	if err != nil {
 		return nil, err