CONSOLE-4061: Update console operator to handle new custom logo API

- Update custom logo sync to come before console config and deployment syncs
- custom logo sync returns on failure, no need for "ok to mount" conditions when building console
  config and deployments
- Remove extra custom logo related args from deployment and console config sync functions. Use
  existing console operator config.
- Add SyncCustomLogos function to validate and sync configmaps defined by new API
- Update SyncCustomLogoConfigMap to remove bool return value
- Share UpdateCustomLogoSyncSource between SyncCustomLogos and SyncCustomLogoConfigMap
- Remove unused brand_custom_logo.go and brand_custom_logo_test.go files
- Update DefaultConfigMap func to handle new API
- Update config builder to convert old API to new, and sync either new API or converted old API to
  console config
- Update DefaultDeployment to create appropriate volumes depending on CustomLogoFile or Logos
- General code style updates
- Update unit and e2e tests

Author: TheRealJon

pkg/console/operator/sync_v400.go

@@ -114,6 +114,22 @@ func (co *consoleOperator) sync_v400(ctx context.Context, controllerContext fact
 		}
 	}
 
+	// TODO remove deprecated CustomLogoFile API
+	// TODO: why is this missing a toUpdate change?
+	customLogoError, customLogoErrReason := co.SyncCustomLogoConfigMap(updatedOperatorConfig)
+	// If the custom logo sync fails for any reason, we are degraded, not progressing.
+	// The sync loop may not settle, we are unable to honor it in current state.
+	statusHandler.AddConditions(status.HandleProgressingOrDegraded("CustomLogoSync", customLogoErrReason, customLogoError))
+	if customLogoError != nil {
+		return statusHandler.FlushAndReturn(customLogoError)
+	}
+
+	customLogosErr, customLogosErrReason := co.SyncCustomLogos(updatedOperatorConfig)
+	statusHandler.AddConditions(status.HandleProgressingOrDegraded("CustomLogosSync", customLogosErrReason, customLogosErr))
+	if customLogosErr != nil {
+		return statusHandler.FlushAndReturn(customLogosErr)
+	}
+
 	cm, cmChanged, cmErrReason, cmErr := co.SyncConfigMap(
 		ctx,
 		set.Operator,
@@ -146,15 +162,6 @@ func (co *consoleOperator) sync_v400(ctx context.Context, controllerContext fact
 		return statusHandler.FlushAndReturn(trustedCAErr)
 	}
 
-	// TODO: why is this missing a toUpdate change?
-	customLogoCanMount, customLogoErrReason, customLogoError := co.SyncCustomLogoConfigMap(ctx, updatedOperatorConfig)
-	// If the custom logo sync fails for any reason, we are degraded, not progressing.
-	// The sync loop may not settle, we are unable to honor it in current state.
-	statusHandler.AddConditions(status.HandleProgressingOrDegraded("CustomLogoSync", customLogoErrReason, customLogoError))
-	if customLogoError != nil {
-		return statusHandler.FlushAndReturn(customLogoError)
-	}
-
 	var oauthServingCertConfigMap *corev1.ConfigMap
 	switch authnConfig.Spec.Type {
 	// We don't disable auth since the internal OAuth server is not disabled even with auth type 'None'.
@@ -187,7 +194,6 @@ func (co *consoleOperator) sync_v400(ctx context.Context, controllerContext fact
 		sessionSecret,
 		set.Proxy,
 		set.Infrastructure,
-		customLogoCanMount,
 		controllerContext.Recorder(),
 	)
 	toUpdate = toUpdate || depChanged
@@ -291,7 +297,6 @@ func (co *consoleOperator) SyncDeployment(
 	sessionSecret *corev1.Secret,
 	proxyConfig *configv1.Proxy,
 	infrastructureConfig *configv1.Infrastructure,
-	canMountCustomLogo bool,
 	recorder events.Recorder,
 ) (consoleDeployment *appsv1.Deployment, changed bool, reason string, err error) {
 	updatedOperatorConfig := operatorConfig.DeepCopy()
@@ -306,7 +311,6 @@ func (co *consoleOperator) SyncDeployment(
 		sessionSecret,
 		proxyConfig,
 		infrastructureConfig,
-		canMountCustomLogo,
 	)
 	genChanged := operatorConfig.ObjectMeta.Generation != operatorConfig.Status.ObservedGeneration
 
@@ -554,16 +558,35 @@ func (co *consoleOperator) SyncTrustedCAConfigMap(ctx context.Context, operatorC
 	return actual, true, "", err
 }
 
-func (co *consoleOperator) SyncCustomLogoConfigMap(ctx context.Context, operatorConfig *operatorv1.Console) (okToMount bool, reason string, err error) {
-	// validate first, to avoid a broken volume mount & a crashlooping console
-	okToMount, reason, err = co.ValidateCustomLogo(ctx, operatorConfig)
-
-	if okToMount || configmapsub.IsRemoved(operatorConfig) {
-		if err := co.UpdateCustomLogoSyncSource(operatorConfig); err != nil {
-			return false, "FailedSyncSource", customerrors.NewCustomLogoError("custom logo sync source update error")
+func (co *consoleOperator) SyncCustomLogos(operatorConfig *operatorv1.Console) (error, string) {
+	var (
+		aggregatedError error
+		err             error
+		reason          string
+	)
+	for _, logo := range operatorConfig.Spec.Customization.Logos {
+		for _, theme := range logo.Themes {
+			logoToSync := theme.Source.ConfigMap
+			err, reason = co.UpdateCustomLogoSyncSource(logoToSync)
+			if err != nil {
+				if aggregatedError == nil {
+					aggregatedError = fmt.Errorf("One or more errors were encountered while syncing custom logos:\n  - %v, %s", logoToSync, err.Error())
+				} else {
+					aggregatedError = fmt.Errorf("%s\n  - %v, %s", aggregatedError.Error(), logoToSync, err.Error())
+				}
+			}
 		}
 	}
-	return okToMount, reason, err
+	if aggregatedError != nil {
+		return aggregatedError, reason
+	}
+	return nil, ""
+}
+
+// TODO remove deprecated CustomLogoFile API
+func (co *consoleOperator) SyncCustomLogoConfigMap(operatorConfig *operatorv1.Console) (error, string) {
+	var customLogoRef = operatorv1.ConfigMapFileReference(operatorConfig.Spec.Customization.CustomLogoFile)
+	return co.UpdateCustomLogoSyncSource(&customLogoRef)
 }
 
 func (co *consoleOperator) ValidateOAuthServingCertConfigMap(ctx context.Context) (oauthServingCert *corev1.ConfigMap, reason string, err error) {
@@ -587,39 +610,52 @@ func (co *consoleOperator) ValidateOAuthServingCertConfigMap(ctx context.Context
 // sync loop will run later.  Our operator is waiting to receive
 // the copied configmap into the console namespace for a future
 // sync loop to mount into the console deployment.
-func (c *consoleOperator) UpdateCustomLogoSyncSource(operatorConfig *operatorv1.Console) error {
+func (c *consoleOperator) UpdateCustomLogoSyncSource(cmRef *operatorv1.ConfigMapFileReference) (error, string) {
+	// validate first, to avoid a broken volume mount & a crashlooping console
+	err, reason := c.ValidateCustomLogo(cmRef)
+	if err != nil {
+		return err, reason
+	}
+
 	source := resourcesynccontroller.ResourceLocation{}
-	logoConfigMapName := operatorConfig.Spec.Customization.CustomLogoFile.Name
+	logoConfigMapName := cmRef.Name
 
 	if logoConfigMapName != "" {
 		source.Name = logoConfigMapName
 		source.Namespace = api.OpenShiftConfigNamespace
 	}
 	// if no custom logo provided, sync an empty source to delete
-	return c.resourceSyncer.SyncConfigMap(
-		resourcesynccontroller.ResourceLocation{Namespace: api.OpenShiftConsoleNamespace, Name: api.OpenShiftCustomLogoConfigMapName},
+	err = c.resourceSyncer.SyncConfigMap(
+		resourcesynccontroller.ResourceLocation{Namespace: api.OpenShiftConsoleNamespace, Name: cmRef.Name},
 		source,
 	)
+	if err != nil {
+		return err, "FailedResourceSync"
+	}
+
+	return nil, ""
 }
 
-func (co *consoleOperator) ValidateCustomLogo(ctx context.Context, operatorConfig *operatorv1.Console) (okToMount bool, reason string, err error) {
-	logoConfigMapName := operatorConfig.Spec.Customization.CustomLogoFile.Name
-	logoImageKey := operatorConfig.Spec.Customization.CustomLogoFile.Key
+func (co *consoleOperator) ValidateCustomLogo(logoFileRef *operatorv1.ConfigMapFileReference) (err error, reason string) {
+	logoConfigMapName := logoFileRef.Name
+	logoImageKey := logoFileRef.Key
 
-	if configmapsub.FileNameOrKeyInconsistentlySet(operatorConfig) {
+	if (len(logoConfigMapName) == 0) != (len(logoImageKey) == 0) {
 		klog.V(4).Infoln("custom logo filename or key have not been set")
-		return false, "KeyOrFilenameInvalid", customerrors.NewCustomLogoError("either custom logo filename or key have not been set")
+		return customerrors.NewCustomLogoError("either custom logo filename or key have not been set"), "KeyOrFilenameInvalid"
 	}
+
 	// fine if nothing set, but don't mount it
-	if configmapsub.FileNameNotSet(operatorConfig) {
+	if len(logoConfigMapName) == 0 {
 		klog.V(4).Infoln("no custom logo configured")
-		return false, "", nil
+		return nil, ""
 	}
+
 	logoConfigMap, err := co.configNSConfigMapLister.ConfigMaps(api.OpenShiftConfigNamespace).Get(logoConfigMapName)
 	// If we 404, the logo file may not have been created yet.
 	if err != nil {
-		klog.V(4).Infof("custom logo file %v not found", logoConfigMapName)
-		return false, "FailedGet", customerrors.NewCustomLogoError(fmt.Sprintf("custom logo file %v not found", logoConfigMapName))
+		klog.V(4).Infof("failed to get ConfigMap %v, %v", logoConfigMapName, err)
+		return customerrors.NewCustomLogoError(fmt.Sprintf("failed to get ConfigMap %v, %v", logoConfigMapName, err)), "FailedGet"
 	}
 
 	_, imageDataFound := logoConfigMap.BinaryData[logoImageKey]
@@ -628,11 +664,11 @@ func (co *consoleOperator) ValidateCustomLogo(ctx context.Context, operatorConfi
 	}
 	if !imageDataFound {
 		klog.V(4).Infoln("custom logo file exists but no image provided")
-		return false, "NoImageProvided", customerrors.NewCustomLogoError("custom logo file exists but no image provided")
+		return customerrors.NewCustomLogoError("custom logo file exists but no image provided"), "NoImageProvided"
 	}
 
-	klog.V(4).Infoln("custom logo ok to mount")
-	return true, "", nil
+	klog.V(4).Infof("custom logo %s ok to mount", logoConfigMapName)
+	return nil, ""
 }
 
 func (co *consoleOperator) GetAvailablePlugins(enabledPluginsNames []string) []*v1.ConsolePlugin {