resolve channel collisions by a preferred channel type, where they are otherwise identical (#1095)

* minorly-kludgy approach, but functional

Signed-off-by: Jordan Keister <[email protected]>

* review comments

Signed-off-by: Jordan Keister <[email protected]>

* retool flag checks and defaulting

Signed-off-by: Jordan Keister <[email protected]>

* more review updates

Signed-off-by: Jordan Keister <[email protected]>

---------

Signed-off-by: Jordan Keister <[email protected]>

Author: grokspawn

alpha/template/composite/builder_test.go

@@ -435,7 +435,7 @@ func TestSemverBuilder(t *testing.T) {
 				defer file.Close()
 				fileData, err := io.ReadAll(file)
 				require.NoError(t, err)
-				require.Equal(t, string(fileData), semverBuiltFbcYaml)
+				require.Equal(t, semverBuiltFbcYaml, string(fileData))
 			},
 			validateAssertions: func(t *testing.T, validateErr error) {
 				require.NoError(t, validateErr)
@@ -466,7 +466,7 @@ func TestSemverBuilder(t *testing.T) {
 				defer file.Close()
 				fileData, err := io.ReadAll(file)
 				require.NoError(t, err)
-				require.Equal(t, string(fileData), semverBuiltFbcJson)
+				require.Equal(t, semverBuiltFbcJson, string(fileData))
 			},
 			validateAssertions: func(t *testing.T, validateErr error) {
 				require.NoError(t, validateErr)
@@ -565,8 +565,8 @@ func TestSemverBuilder(t *testing.T) {
 			buildAssertions: func(t *testing.T, dir string, buildErr error) {
 				require.Error(t, buildErr)
 				require.Equal(t,
-					buildErr.Error(),
-					"semver template configuration is invalid: semver template config must have a non-empty output (templateDefinition.config.output)")
+					"semver template configuration is invalid: semver template config must have a non-empty output (templateDefinition.config.output)",
+					buildErr.Error())
 			},
 		},
 		{
@@ -584,8 +584,9 @@ func TestSemverBuilder(t *testing.T) {
 			buildAssertions: func(t *testing.T, dir string, buildErr error) {
 				require.Error(t, buildErr)
 				require.Equal(t,
+					"semver template configuration is invalid: semver template config must have a non-empty input (templateDefinition.config.input),semver template config must have a non-empty output (templateDefinition.config.output)",
 					buildErr.Error(),
-					"semver template configuration is invalid: semver template config must have a non-empty input (templateDefinition.config.input),semver template config must have a non-empty output (templateDefinition.config.output)")
+				)
 			},
 		},
 	}
@@ -638,7 +639,7 @@ Stable:
 `
 
 const semverBuiltFbcYaml = `---
-defaultChannel: stable-v0
+defaultChannel: stable-v0.0
 name: webhook-operator
 schema: olm.package
 ---
@@ -694,7 +695,7 @@ schema: olm.bundle
 const semverBuiltFbcJson = `{
     "schema": "olm.package",
     "name": "webhook-operator",
-    "defaultChannel": "stable-v0"
+    "defaultChannel": "stable-v0.0"
 }
 {
     "schema": "olm.channel",

alpha/template/semver/semver.go

@@ -75,17 +75,42 @@ func readFile(reader io.Reader) (*semverTemplate, error) {
 		return nil, err
 	}
 
-	// default behavior is to generate only minor channels
-	sv := semverTemplate{
-		GenerateMajorChannels: false,
-		GenerateMinorChannels: true,
-	}
+	sv := semverTemplate{}
 	if err := yaml.UnmarshalStrict(data, &sv); err != nil {
 		return nil, err
 	}
+
 	if sv.Schema != schema {
 		return nil, fmt.Errorf("readFile: input file has unknown schema, should be %q", schema)
 	}
+
+	// if no generate option is selected, default to GenerateMinorChannels
+	if !sv.GenerateMajorChannels && !sv.GenerateMinorChannels {
+		sv.GenerateMinorChannels = true
+	}
+
+	// for default channel preference,
+	// if un-set, default to align to the selected generate option
+	// if set, error out if we mismatch the two
+	switch sv.DefaultChannelTypePreference {
+	case defaultStreamType:
+		if sv.GenerateMinorChannels {
+			sv.DefaultChannelTypePreference = minorStreamType
+		} else if sv.GenerateMajorChannels {
+			sv.DefaultChannelTypePreference = majorStreamType
+		}
+	case minorStreamType:
+		if !sv.GenerateMinorChannels {
+			return nil, fmt.Errorf("schema attribute mismatch: DefaultChannelTypePreference set to 'minor' doesn't make sense if not generating minor-version channels")
+		}
+	case majorStreamType:
+		if !sv.GenerateMajorChannels {
+			return nil, fmt.Errorf("schema attribute mismatch: DefaultChannelTypePreference set to 'major' doesn't make sense if not generating major-version channels")
+		}
+	default:
+		return nil, fmt.Errorf("unknown DefaultChannelTypePreference: %q\nValid values are 'major' or 'minor'", sv.DefaultChannelTypePreference)
+	}
+
 	return &sv, nil
 }
 
@@ -241,8 +266,8 @@ func (sv *semverTemplate) generateChannels(semverChannels *bundleVersions) []dec
 
 					unlinkedChannels[cName] = ch
 
-					hwcCandidate := highwaterChannel{archetype: archetype, version: bundles[bundleName], name: cName}
-					if hwcCandidate.gt(&hwc) {
+					hwcCandidate := highwaterChannel{archetype: archetype, kind: cKey, version: bundles[bundleName], name: cName}
+					if hwcCandidate.gt(&hwc, sv.DefaultChannelTypePreference) {
 						hwc = hwcCandidate
 					}
 				}
@@ -420,3 +445,31 @@ func stripBuildMetadata(v semver.Version) string {
 	v.Build = nil
 	return v.String()
 }
+
+// prefer (in descending order of preference):
+// - higher-rank archetype,
+// - semver version,
+// - a channel type matching the set preference, or
+// - a 'better' (higher value) channel type
+func (h *highwaterChannel) gt(ih *highwaterChannel, pref streamType) bool {
+	if channelPriorities[h.archetype] != channelPriorities[ih.archetype] {
+		return channelPriorities[h.archetype] > channelPriorities[ih.archetype]
+	}
+	if h.version.NE(ih.version) {
+		return h.version.GT(ih.version)
+	}
+	if h.kind != ih.kind {
+		if h.kind == pref {
+			return true
+		}
+		if ih.kind == pref {
+			return false
+		}
+		return h.kind.gt((*ih).kind)
+	}
+	return false
+}
+
+func (t streamType) gt(in streamType) bool {
+	return streamTypePriorities[t] > streamTypePriorities[in]
+}