Order branches and commits where loaded, remove marshal overrides

Author: deepsm007

pkg/api/secretbootstrap/secretboostrap.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 	"reflect"
+	"sort"
 	"strings"
 
 	"github.com/getlantern/deepcopy"
@@ -61,6 +62,41 @@ type SecretConfig struct {
 	To   []SecretContext        `json:"to"`
 }
 
+// orderSecretConfig sorts the SecretConfig data structures for deterministic ordering
+func (s *SecretConfig) orderSecretConfig() {
+	// Sort From map keys and DockerConfigJSONData slices
+	sortedFrom := make(map[string]ItemContext)
+	keys := make([]string, 0, len(s.From))
+	for k := range s.From {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+
+	for _, k := range keys {
+		itemCtx := s.From[k]
+		// Sort DockerConfigJSONData slice
+		dockerData := make([]DockerConfigJSONData, len(itemCtx.DockerConfigJSONData))
+		copy(dockerData, itemCtx.DockerConfigJSONData)
+		sort.Slice(dockerData, func(i, j int) bool {
+			if dockerData[i].RegistryURL != dockerData[j].RegistryURL {
+				return dockerData[i].RegistryURL < dockerData[j].RegistryURL
+			}
+			if dockerData[i].Item != dockerData[j].Item {
+				return dockerData[i].Item < dockerData[j].Item
+			}
+			return dockerData[i].AuthField < dockerData[j].AuthField
+		})
+
+		sortedFrom[k] = ItemContext{
+			Item:                 itemCtx.Item,
+			Field:                itemCtx.Field,
+			DockerConfigJSONData: dockerData,
+			Base64Decode:         itemCtx.Base64Decode,
+		}
+	}
+	s.From = sortedFrom
+}
+
 // LoadConfigFromFile renders a Config object loaded from the given file
 func LoadConfigFromFile(file string, config *Config) error {
 	bytes, err := gzip.ReadFileMaybeGZIP(file)
@@ -79,6 +115,56 @@ func SaveConfigToFile(file string, config *Config) error {
 	return os.WriteFile(file, bytes, 0644)
 }
 
+// orderConfig sorts the Config data structures for deterministic ordering
+func (c *Config) orderConfig() {
+	// Sort ClusterGroups map keys
+	sortedClusterGroups := make(map[string][]string)
+	clusterGroupKeys := make([]string, 0, len(c.ClusterGroups))
+	for k := range c.ClusterGroups {
+		clusterGroupKeys = append(clusterGroupKeys, k)
+	}
+	sort.Strings(clusterGroupKeys)
+	for _, k := range clusterGroupKeys {
+		clusters := make([]string, len(c.ClusterGroups[k]))
+		copy(clusters, c.ClusterGroups[k])
+		sort.Strings(clusters)
+		sortedClusterGroups[k] = clusters
+	}
+	c.ClusterGroups = sortedClusterGroups
+
+	// Sort Secrets slice
+	sort.Slice(c.Secrets, func(i, j int) bool {
+		// Sort by first To entry's Cluster, then Namespace, then Name
+		// This groups secrets by cluster, making the output more organized
+		if len(c.Secrets[i].To) == 0 && len(c.Secrets[j].To) == 0 {
+			return false
+		}
+		if len(c.Secrets[i].To) == 0 {
+			return true
+		}
+		if len(c.Secrets[j].To) == 0 {
+			return false
+		}
+		toI := c.Secrets[i].To[0]
+		toJ := c.Secrets[j].To[0]
+		if toI.Cluster != toJ.Cluster {
+			return toI.Cluster < toJ.Cluster
+		}
+		if toI.Namespace != toJ.Namespace {
+			return toI.Namespace < toJ.Namespace
+		}
+		return toI.Name < toJ.Name
+	})
+
+	// Sort UserSecretsTargetClusters
+	sort.Strings(c.UserSecretsTargetClusters)
+
+	// Order each SecretConfig
+	for i := range c.Secrets {
+		c.Secrets[i].orderSecretConfig()
+	}
+}
+
 // Config is what we version in our repository
 type Config struct {
 	VaultDPTPPrefix           string              `json:"vault_dptp_prefix,omitempty"`
@@ -237,6 +323,9 @@ func (c *Config) resolve() error {
 
 	}
 
+	// Order the config data structures for deterministic output
+	c.orderConfig()
+
 	return utilerrors.NewAggregate(errs)
 }
 

pkg/clusterinit/onboard/manifestgenerator.go

@@ -127,6 +127,17 @@ func (w *manifestGeneratorStep) marshalManifests(manifests []interface{}, patche
 			return nil, err
 		}
 
+		// Fix YAML scalar style for monitoring config: change trailing newline handling
+		// yaml.v2 doesn't support controlling scalar style, so we post-process it.
+		// We change "config.yaml: |-" (literal block scalar that strips trailing newline) to
+		// "config.yaml: |" (literal block scalar that preserves trailing newline).
+		// This is safe and targeted: only runs for the cluster-monitoring-config ConfigMap.
+		if kind, ok := manifestMap["kind"].(string); ok && kind == "ConfigMap" {
+			if name, ok := manifestMap["metadata"].(map[string]interface{})["name"].(string); ok && name == "cluster-monitoring-config" {
+				manifestBytesPatched = bytes.ReplaceAll(manifestBytesPatched, []byte("config.yaml: |-"), []byte("config.yaml: |"))
+			}
+		}
+
 		manifestsBytes = append(manifestsBytes, manifestBytesPatched)
 	}
 

pkg/image-graph-generator/images.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"regexp"
+	"sort"
 
 	"github.com/sirupsen/logrus"
 
@@ -84,6 +85,16 @@ func (o *Operator) UpdateImage(image api.ProjectDirectoryImageBuildStepConfigura
 		}
 	}
 
+	// Sort Parents by Name for deterministic ordering
+	sort.Slice(imageRef.Parents, func(i, j int) bool {
+		return imageRef.Parents[i].Name < imageRef.Parents[j].Name
+	})
+
+	// Sort Branches by ID for deterministic ordering
+	sort.Slice(imageRef.Branches, func(i, j int) bool {
+		return imageRef.Branches[i].ID < imageRef.Branches[j].ID
+	})
+
 	if id, ok := o.images[imageName]; ok {
 		if err := o.updateImageRef(imageRef, id); err != nil {
 			return err
@@ -113,13 +124,26 @@ func (o *Operator) addImageRef(image *ImageRef) error {
 	}
 
 	if len(image.Branches) > 0 {
+		// Sort Branches by ID for deterministic ordering
+		sortedBranches := make([]BranchRef, len(image.Branches))
+		copy(sortedBranches, image.Branches)
+		sort.Slice(sortedBranches, func(i, j int) bool {
+			return sortedBranches[i].ID < sortedBranches[j].ID
+		})
 		input["branches"] = map[string]interface{}{
-			"id": image.Branches[0].ID,
+			"id": sortedBranches[0].ID,
 		}
 	}
 
+	// Sort Parents by Name for deterministic ordering
+	sortedParents := make([]ImageRef, len(image.Parents))
+	copy(sortedParents, image.Parents)
+	sort.Slice(sortedParents, func(i, j int) bool {
+		return sortedParents[i].Name < sortedParents[j].Name
+	})
+
 	var parents []interface{}
-	for _, parent := range image.Parents {
+	for _, parent := range sortedParents {
 		p := map[string]interface{}{
 			"name":           parent.Name,
 			"imageStreamRef": parent.ImageStreamRef,
@@ -177,13 +201,24 @@ func (o *Operator) updateImageRef(newImage *ImageRef, id string) error {
 		patch["source"] = newImage.Source
 	}
 	if len(newImage.Branches) > 0 {
+		// Sort Branches by ID for deterministic ordering
+		sort.Slice(newImage.Branches, func(i, j int) bool {
+			return newImage.Branches[i].ID < newImage.Branches[j].ID
+		})
 		patch["branches"] = map[string]interface{}{
 			"id": newImage.Branches[0].ID,
 		}
 	}
 
+	// Sort Parents by Name for deterministic ordering
+	sortedParents := make([]ImageRef, len(newImage.Parents))
+	copy(sortedParents, newImage.Parents)
+	sort.Slice(sortedParents, func(i, j int) bool {
+		return sortedParents[i].Name < sortedParents[j].Name
+	})
+
 	var parents []interface{}
-	for _, parent := range newImage.Parents {
+	for _, parent := range sortedParents {
 		p := map[string]interface{}{
 			"name":           parent.Name,
 			"imageStreamRef": parent.ImageStreamRef,

pkg/image-graph-generator/manifests.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"sort"
 	"strings"
 
 	corev1 "k8s.io/api/core/v1"
@@ -157,6 +158,11 @@ func (o *Operator) AddManifestImages() error {
 			}
 		}
 
+		// Sort Parents by Name for deterministic ordering
+		sort.Slice(imageRef.Parents, func(i, j int) bool {
+			return imageRef.Parents[i].Name < imageRef.Parents[j].Name
+		})
+
 		if id, ok := o.images[name]; !ok {
 			if err := o.addImageRef(imageRef); err != nil {
 				return err

test/integration/cluster-init/update-build99/expected/clusters/build-clusters/build99/openshift-monitoring/cluster-monitoring-config.yaml

@@ -6,7 +6,7 @@
 
 apiVersion: v1
 data:
-  config.yaml: |-
+  config.yaml: |
     alertmanagerMain:
       nodeSelector:
         node-role.kubernetes.io/infra: ""