feat: add sort func for controller errors

added sort func to help make testing easy by having a consistent output for a list of errors

Signed-off-by: ehila <ehila@redhat.com>

Author: eggfoobar

pkg/operator/configobserver/config_observer_controller.go

@@ -178,6 +178,9 @@ func (c ConfigObserver) sync(ctx context.Context, syncCtx factory.SyncContext) e
 	if err := c.updateObservedConfig(ctx, syncCtx, existingConfig, mergedObservedConfig); err != nil {
 		errs = []error{err}
 	}
+
+	v1helpers.SortErrorsInLexicalOrder(errs)
+
 	configError := v1helpers.NewMultiLineAggregate(errs)
 
 	// update failing condition

pkg/operator/v1helpers/helpers.go

@@ -399,6 +399,13 @@ func (agg aggregate) visit(f func(err error) bool) bool {
 	return false
 }
 
+// We sort errors to allow for consistent output for testing.
+func SortErrorsInLexicalOrder(errs []error) {
+	sort.SliceStable(errs, func(i, j int) bool {
+		return errs[i].Error() < errs[j].Error()
+	})
+}
+
 // MapToEnvVars converts a string-string map to a slice of corev1.EnvVar-s
 func MapToEnvVars(mapEnvVars map[string]string) []corev1.EnvVar {
 	if mapEnvVars == nil {