Enhance diff logic to set a new defaultChannel by adding a priority property to a channel (#969)

* Added the channel Priority feature
* Added comments for the internal usage of Channel properties

Signed-off-by: Oskar Pawica <[email protected]>

Signed-off-by: Oskar Pawica <[email protected]>
Co-authored-by: Oskar Pawica <[email protected]>
Upstream-repository: operator-registry
Upstream-commit: 208775f5a9bf02804646751ef9c7cf48d7902e9b

Author: 2 people

staging/operator-registry/alpha/declcfg/declcfg_to_model.go

@@ -56,6 +56,10 @@ func ConvertToModel(cfg DeclarativeConfig) (model.Model, error) {
 			Package: mpkg,
 			Name:    c.Name,
 			Bundles: map[string]*model.Bundle{},
+			// NOTICE: The field Properties of the type Channel is for internal use only.
+			//   DO NOT use it for any public-facing functionalities.
+			//   This API is in alpha stage and it is subject to change.
+			Properties: c.Properties,
 		}
 
 		cde := sets.NewString()

staging/operator-registry/alpha/declcfg/model_to_declcfg.go

@@ -64,6 +64,10 @@ func traverseModelChannels(mpkg model.Package) ([]Channel, []Bundle) {
 			Name:    ch.Name,
 			Package: ch.Package.Name,
 			Entries: []ChannelEntry{},
+			// NOTICE: The field Properties of the type Channel is for internal use only.
+			//   DO NOT use it for any public-facing functionalities.
+			//   This API is in alpha stage and it is subject to change.
+			Properties: ch.Properties,
 		}
 
 		for _, chb := range ch.Bundles {

staging/operator-registry/alpha/model/model.go

@@ -134,6 +134,10 @@ type Channel struct {
 	Package *Package
 	Name    string
 	Bundles map[string]*Bundle
+	// NOTICE: The field Properties of the type Channel is for internal use only.
+	//   DO NOT use it for any public-facing functionalities.
+	//   This API is in alpha stage and it is subject to change.
+	Properties []property.Property
 }
 
 // TODO(joelanford): This function determines the channel head by finding the bundle that has 0

staging/operator-registry/alpha/property/property.go

@@ -39,6 +39,15 @@ type Package struct {
 	Version     string `json:"version"`
 }
 
+// NOTICE: The Channel properties are for internal use only.
+//   DO NOT use it for any public-facing functionalities.
+//   This API is in alpha stage and it is subject to change.
+type Channel struct {
+	ChannelName string `json:"channelName"`
+	//Priority    string `json:"priority"`
+	Priority int `json:"priority"`
+}
+
 type PackageRequired struct {
 	PackageName  string `json:"packageName"`
 	VersionRange string `json:"versionRange"`
@@ -118,6 +127,7 @@ type Properties struct {
 	GVKs             []GVK             `hash:"set"`
 	GVKsRequired     []GVKRequired     `hash:"set"`
 	BundleObjects    []BundleObject    `hash:"set"`
+	Channels         []Channel         `hash:"set"`
 
 	Others []Property `hash:"set"`
 }
@@ -128,6 +138,7 @@ const (
 	TypeGVK             = "olm.gvk"
 	TypeGVKRequired     = "olm.gvk.required"
 	TypeBundleObject    = "olm.bundle.object"
+	TypeChannel         = "olm.channel"
 )
 
 func Parse(in []Property) (*Properties, error) {
@@ -164,6 +175,15 @@ func Parse(in []Property) (*Properties, error) {
 				return nil, ParseError{Idx: i, Typ: prop.Type, Err: err}
 			}
 			out.BundleObjects = append(out.BundleObjects, p)
+		// NOTICE: The Channel properties are for internal use only.
+		//   DO NOT use it for any public-facing functionalities.
+		//   This API is in alpha stage and it is subject to change.
+		case TypeChannel:
+			var p Channel
+			if err := json.Unmarshal(prop.Value, &p); err != nil {
+				return nil, ParseError{Idx: i, Typ: prop.Type, Err: err}
+			}
+			out.Channels = append(out.Channels, p)
 		default:
 			var p json.RawMessage
 			if err := json.Unmarshal(prop.Value, &p); err != nil {
@@ -265,3 +285,10 @@ func MustBuildBundleObjectRef(ref string) Property {
 func MustBuildBundleObjectData(data []byte) Property {
 	return MustBuild(&BundleObject{File: File{data: data}})
 }
+
+// NOTICE: The Channel properties are for internal use only.
+//   DO NOT use it for any public-facing functionalities.
+//   This API is in alpha stage and it is subject to change.
+func MustBuildChannelPriority(name string, priority int) Property {
+	return MustBuild(&Channel{ChannelName: name, Priority: priority})
+}

staging/operator-registry/alpha/property/scheme.go

@@ -12,6 +12,10 @@ func init() {
 		reflect.TypeOf(&GVK{}):             TypeGVK,
 		reflect.TypeOf(&GVKRequired{}):     TypeGVKRequired,
 		reflect.TypeOf(&BundleObject{}):    TypeBundleObject,
+		// NOTICE: The Channel properties are for internal use only.
+		//   DO NOT use it for any public-facing functionalities.
+		//   This API is in alpha stage and it is subject to change.
+		reflect.TypeOf(&Channel{}): TypeChannel,
 	}
 }