fix golangci reported issues

Signed-off-by: Martin Schuppert <mschuppert@redhat.com>

Author: stuggi

controllers/glance_common.go

@@ -14,10 +14,12 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package controllers implements the glance-operator Kubernetes controllers.
 package controllers
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"time"
 
@@ -43,10 +45,15 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
+// Common static errors for glance controllers
+var (
+	ErrNetworkAttachmentConfig = errors.New("not all pods have interfaces with ips as configured in NetworkAttachments")
+)
+
 // fields to index to reconcile when change
 const (
 	passwordSecretField     = ".spec.secret"
-	caBundleSecretNameField = ".spec.tls.caBundleSecretName"
+	caBundleSecretNameField = ".spec.tls.caBundleSecretName" // #nosec G101
 	tlsAPIInternalField     = ".spec.tls.api.internal.secretName"
 	tlsAPIPublicField       = ".spec.tls.api.public.secretName"
 	topologyField           = ".spec.topologyRef.Name"
@@ -279,7 +286,7 @@ func GetPvcListWithLabel(
 	pvcList, err := h.GetKClient().CoreV1().PersistentVolumeClaims(namespace).List(ctx, metav1.ListOptions{LabelSelector: labelSelectorString})
 
 	if err != nil {
-		err = fmt.Errorf("Error listing PVC for labels: %v - %w", labelSelectorMap, err)
+		err = fmt.Errorf("error listing PVC for labels: %v - %w", labelSelectorMap, err)
 		return nil, err
 	}
 	return pvcList, nil

controllers/glance_controller.go

@@ -107,7 +107,7 @@ func (r *GlanceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res
 
 	// Fetch the Glance instance
 	instance := &glancev1.Glance{}
-	err := r.Client.Get(ctx, req.NamespacedName, instance)
+	err := r.Get(ctx, req.NamespacedName, instance)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			// Request object not found, could have been deleted after reconcile request.
@@ -244,7 +244,7 @@ func (r *GlanceReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manage
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(context.Background(), glances, listOpts...); err != nil {
+		if err := r.List(context.Background(), glances, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve Glance CRs %w")
 			return nil
 		}
@@ -274,7 +274,7 @@ func (r *GlanceReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manage
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(context.Background(), glances, listOpts...); err != nil {
+		if err := r.List(context.Background(), glances, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve Glance CRs %v")
 			return nil
 		}
@@ -795,8 +795,8 @@ func (r *GlanceReconciler) apiDeployment(
 	// want to override "external" with "single" in case APIType == "single":
 	// in this case we only deploy the External instance and skip the internal
 	// one
-	var internal string = glancev1.APIInternal
-	var external string = glancev1.APIExternal
+	var internal = glancev1.APIInternal
+	var external = glancev1.APIExternal
 	var wsgi bool
 
 	// We deploy:
@@ -959,8 +959,8 @@ func (r *GlanceReconciler) apiDeploymentCreateOrUpdate(
 		MemcachedInstance:     instance.Spec.MemcachedInstance,
 	}
 
-	if apiSpec.GlanceAPITemplate.NodeSelector == nil {
-		apiSpec.GlanceAPITemplate.NodeSelector = instance.Spec.NodeSelector
+	if apiSpec.NodeSelector == nil {
+		apiSpec.NodeSelector = instance.Spec.NodeSelector
 	}
 
 	// Inherit the ImageCacheSize from the top level if not specified
@@ -969,20 +969,20 @@ func (r *GlanceReconciler) apiDeploymentCreateOrUpdate(
 	}
 
 	// Inherit the values required for PVC creation from the top-level CR
-	if apiSpec.GlanceAPITemplate.Storage.StorageRequest == "" {
-		apiSpec.GlanceAPITemplate.Storage.StorageRequest = instance.Spec.Storage.StorageRequest
+	if apiSpec.Storage.StorageRequest == "" {
+		apiSpec.Storage.StorageRequest = instance.Spec.Storage.StorageRequest
 	}
-	if apiSpec.GlanceAPITemplate.Storage.StorageClass == "" {
-		apiSpec.GlanceAPITemplate.Storage.StorageClass = instance.Spec.Storage.StorageClass
+	if apiSpec.Storage.StorageClass == "" {
+		apiSpec.Storage.StorageClass = instance.Spec.Storage.StorageClass
 	}
-	if !apiSpec.GlanceAPITemplate.Storage.External {
-		apiSpec.GlanceAPITemplate.Storage.External = instance.Spec.Storage.External
+	if !apiSpec.Storage.External {
+		apiSpec.Storage.External = instance.Spec.Storage.External
 	}
 
 	// Make sure to inject the ContainerImage passed by the OpenStackVersions
 	// resource to all the underlying instances and rollout a new StatefulSet
 	// if it has been changed
-	apiSpec.GlanceAPITemplate.ContainerImage = instance.Spec.ContainerImage
+	apiSpec.ContainerImage = instance.Spec.ContainerImage
 
 	// We select which glanceAPI should register the keystoneEndpoint by using
 	// an API selector defined in the main glance CR; if it matches with the
@@ -993,8 +993,8 @@ func (r *GlanceReconciler) apiDeploymentCreateOrUpdate(
 
 	// If topology is not present in the underlying GlanceAPI,
 	// inherit from the top-level CR
-	if apiSpec.GlanceAPITemplate.TopologyRef == nil {
-		apiSpec.GlanceAPITemplate.TopologyRef = instance.Spec.TopologyRef
+	if apiSpec.TopologyRef == nil {
+		apiSpec.TopologyRef = instance.Spec.TopologyRef
 	}
 
 	// Set deployment mode (proxypass vs mod_wsgi)
@@ -1014,7 +1014,7 @@ func (r *GlanceReconciler) apiDeploymentCreateOrUpdate(
 	op, err := controllerutil.CreateOrUpdate(ctx, r.Client, glanceStatefulset, func() error {
 		// Assign the created spec containing both field provided via GlanceAPITemplate
 		// and what is inherited from the top-level CR (ExtraMounts)
-		glanceStatefulset.ObjectMeta.Annotations = apiAnnotations
+		glanceStatefulset.Annotations = apiAnnotations
 		glanceStatefulset.Spec = apiSpec
 
 		// We might want to create instances pointing to different backends in
@@ -1218,7 +1218,7 @@ func (r *GlanceReconciler) glanceAPICleanup(ctx context.Context, instance *glanc
 	listOpts := []client.ListOption{
 		client.InNamespace(instance.Namespace),
 	}
-	if err := r.Client.List(ctx, apis, listOpts...); err != nil {
+	if err := r.List(ctx, apis, listOpts...); err != nil {
 		Log.Error(err, "Unable to retrieve GlanceAPI CRs %v")
 		return nil
 	}
@@ -1237,9 +1237,9 @@ func (r *GlanceReconciler) glanceAPICleanup(ctx context.Context, instance *glanc
 		_, exists := instance.Spec.GlanceAPIs[apiName]
 		// Delete the api if it's no longer in the spec
 		if !exists && glanceAPI.DeletionTimestamp.IsZero() {
-			err := r.Client.Delete(ctx, &glanceAPI)
+			err := r.Delete(ctx, &glanceAPI)
 			if err != nil && !k8s_errors.IsNotFound(err) {
-				err = fmt.Errorf("Error cleaning up %s: %w", glanceAPI.Name, err)
+				err = fmt.Errorf("error cleaning up %s: %w", glanceAPI.Name, err)
 				return err
 			}
 			// Update the APIEndpoints in the top-level CR
@@ -1353,7 +1353,7 @@ func (r *GlanceReconciler) checkGlanceAPIsGeneration(
 	listOpts := []client.ListOption{
 		client.InNamespace(instance.Namespace),
 	}
-	if err := r.Client.List(ctx, glances, listOpts...); err != nil {
+	if err := r.List(ctx, glances, listOpts...); err != nil {
 		Log.Error(err, "Unable to retrieve Glance CRs %w")
 		return false, err
 	}

controllers/glanceapi_controller.go

@@ -100,7 +100,7 @@ func (r *GlanceAPIReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 
 	// Fetch the GlanceAPI instance
 	instance := &glancev1.GlanceAPI{}
-	err := r.Client.Get(ctx, req.NamespacedName, instance)
+	err := r.Get(ctx, req.NamespacedName, instance)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			// Request object not found, could have been deleted after reconcile request.
@@ -273,16 +273,16 @@ func (r *GlanceAPIReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Man
 
 	// Watch for changes to any CustomServiceConfigSecrets. Global secrets
 	svcSecretFn := func(_ context.Context, o client.Object) []reconcile.Request {
-		var namespace string = o.GetNamespace()
-		var secretName string = o.GetName()
+		var namespace = o.GetNamespace()
+		var secretName = o.GetName()
 		result := []reconcile.Request{}
 
 		// get all API CRs
 		apis := &glancev1.GlanceAPIList{}
 		listOpts := []client.ListOption{
 			client.InNamespace(namespace),
 		}
-		if err := r.Client.List(context.Background(), apis, listOpts...); err != nil {
+		if err := r.List(context.Background(), apis, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve API CRs %v")
 			return nil
 		}
@@ -313,7 +313,7 @@ func (r *GlanceAPIReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Man
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(context.Background(), glanceAPIs, listOpts...); err != nil {
+		if err := r.List(context.Background(), glanceAPIs, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve GlanceAPI CRs %w")
 			return nil
 		}
@@ -341,7 +341,7 @@ func (r *GlanceAPIReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Man
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(context.Background(), glanceAPIs, listOpts...); err != nil {
+		if err := r.List(context.Background(), glanceAPIs, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve GlanceAPI CRs %w")
 			return nil
 		}
@@ -742,8 +742,8 @@ func (r *GlanceAPIReconciler) reconcileNormal(
 	// iterate over availableBackends for backend specific cases
 	for i := 0; i < len(availableBackends); i++ {
 		backendToken := strings.SplitN(availableBackends[i], ":", 2)
-		switch {
-		case backendToken[1] == "cinder":
+		switch backendToken[1] {
+		case "cinder":
 			cinderList := &cinderv1.CinderList{}
 			err := r.List(ctx, cinderList, client.InNamespace(instance.Namespace))
 			if err != nil {
@@ -775,7 +775,7 @@ func (r *GlanceAPIReconciler) reconcileNormal(
 			// We see at least a Cinder CR in the namespace, unblock glance
 			// deployment
 			privileged = true
-		case backendToken[1] == "rbd":
+		case "rbd":
 			// enable image conversion by default
 			Log.Info("Ceph config detected: enable image conversion by default")
 			imageConv = true
@@ -804,7 +804,7 @@ func (r *GlanceAPIReconciler) reconcileNormal(
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -828,7 +828,7 @@ func (r *GlanceAPIReconciler) reconcileNormal(
 				condition.TLSInputReadyCondition,
 				condition.RequestedReason,
 				condition.SeverityInfo,
-				fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+				condition.TLSInputReadyWaitingMessage, err.Error()))
 			return ctrl.Result{}, nil
 		}
 		instance.Status.Conditions.Set(condition.FalseCondition(
@@ -900,7 +900,7 @@ func (r *GlanceAPIReconciler) reconcileNormal(
 		return glance.ResultRequeue, err
 	}
 
-	configVars[glance.KeystoneEndpoint] = env.SetValue(instance.ObjectMeta.Annotations[glance.KeystoneEndpoint])
+	configVars[glance.KeystoneEndpoint] = env.SetValue(instance.Annotations[glance.KeystoneEndpoint])
 	//
 	// normal reconcile tasks
 	//
@@ -1032,7 +1032,7 @@ func (r *GlanceAPIReconciler) reconcileNormal(
 		if networkReady {
 			instance.Status.Conditions.MarkTrue(condition.NetworkAttachmentsReadyCondition, condition.NetworkAttachmentsReadyMessage)
 		} else {
-			err := fmt.Errorf("not all pods have interfaces with ips as configured in NetworkAttachments: %s", instance.Spec.NetworkAttachments)
+			err := fmt.Errorf("%w: %s", ErrNetworkAttachmentConfig, instance.Spec.NetworkAttachments)
 			instance.Status.Conditions.Set(condition.FalseCondition(
 				condition.NetworkAttachmentsReadyCondition,
 				condition.ErrorReason,
@@ -1134,7 +1134,7 @@ func (r *GlanceAPIReconciler) generateServiceConfig(
 	}
 
 	var tlsCfg *tls.Service
-	if instance.Spec.TLS.Ca.CaBundleSecretName != "" {
+	if instance.Spec.TLS.CaBundleSecretName != "" {
 		tlsCfg = &tls.Service{}
 	}
 	// 02-config.conf
@@ -1369,8 +1369,8 @@ func (r *GlanceAPIReconciler) ensureKeystoneEndpoints(
 
 	// If the parent controller didn't set the annotation, the current glanceAPIs
 	// shouldn't register the endpoints in keystone
-	if len(instance.ObjectMeta.Annotations) == 0 ||
-		instance.ObjectMeta.Annotations[glance.KeystoneEndpoint] != "true" {
+	if len(instance.Annotations) == 0 ||
+		instance.Annotations[glance.KeystoneEndpoint] != "true" {
 		// Mark the KeystoneEndpointReadyCondition as True because there's nothing
 		// to do here
 		instance.Status.Conditions.MarkTrue(
@@ -1461,7 +1461,7 @@ func (r *GlanceAPIReconciler) ensureImageCacheJob(
 	}
 	cachePVCs, _ := GetPvcListWithLabel(ctx, h, instance.Namespace, serviceLabels)
 	for _, vc := range cachePVCs.Items {
-		var pvcName string = vc.GetName()
+		var pvcName = vc.GetName()
 		cacheAnnotations := vc.GetAnnotations()
 		if _, ok := cacheAnnotations["image-cache"]; ok {
 			cronSpec := glance.CronJobSpec{
@@ -1516,10 +1516,10 @@ func (r *GlanceAPIReconciler) cleanupImageCacheJob(
 	for _, vc := range cachePVCs.Items {
 		cacheAnnotations := vc.GetAnnotations()
 		if _, ok := cacheAnnotations["image-cache"]; ok {
-			var pvcName string = vc.GetName()
+			var pvcName = vc.GetName()
 			// Get the pod (by name) associated to the current pvc
 			var pod corev1.Pod
-			if err := r.Client.Get(ctx, types.NamespacedName{
+			if err := r.Get(ctx, types.NamespacedName{
 				Name:      strings.TrimPrefix(pvcName, "glance-cache-"),
 				Namespace: instance.Namespace,
 			}, &pod); err != nil && k8s_errors.IsNotFound(err) || instance.Spec.ImageCache.Size == "" {
@@ -1553,7 +1553,7 @@ func (r *GlanceAPIReconciler) deleteJob(
 	// For each imageCache we have both cleaner and pruner cronJobs to check and
 	// cleanup if the conditions are met
 	for _, cj := range []glance.CronJobType{glance.CachePruner, glance.CacheCleaner} {
-		if err = r.Client.Get(
+		if err = r.Get(
 			ctx,
 			types.NamespacedName{
 				Name:      fmt.Sprintf("%s-%s", pvcName, cj),
@@ -1626,9 +1626,9 @@ func (r *GlanceAPIReconciler) glanceAPIRefresh(
 		}
 		return err
 	}
-	err = r.Client.Delete(ctx, sts)
+	err = r.Delete(ctx, sts)
 	if err != nil && !k8s_errors.IsNotFound(err) {
-		err = fmt.Errorf("Error deleting %s: %w", instance.Name, err)
+		err = fmt.Errorf("error deleting %s: %w", instance.Name, err)
 		return err
 	}
 	return nil

main.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package main implements the glance-operator controller manager.
 package main
 
 import (

pkg/glance/const.go

@@ -13,12 +13,14 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package glance contains glance service constants and configuration.
 package glance
 
 import (
+	"time"
+
 	"github.com/openstack-k8s-operators/lib-common/modules/storage"
 	ctrl "sigs.k8s.io/controller-runtime"
-	"time"
 )
 
 // CronJobType -
@@ -63,7 +65,7 @@ const (
 	// CustomServiceConfigFileName -
 	CustomServiceConfigFileName = "02-config.conf"
 	// CustomServiceConfigSecretsFileName -
-	CustomServiceConfigSecretsFileName = "03-config.conf"
+	CustomServiceConfigSecretsFileName = "03-config.conf" // #nosec G101
 
 	// GlanceExtraVolTypeUndefined can be used to label an extraMount which
 	// is not associated with a specific backend

pkg/glance/pvc.go

@@ -19,10 +19,10 @@ func GetPvc(api *glancev1.GlanceAPI, labels map[string]string, pvcType PvcType)
 	var pvcName string
 	pvcAnnotation := map[string]string{}
 
-	switch {
-	case pvcType == PvcCache:
+	switch pvcType {
+	case PvcCache:
 		pvcAnnotation["image-cache"] = "true"
-		requestSize = api.Spec.GlanceAPITemplate.ImageCache.Size
+		requestSize = api.Spec.ImageCache.Size
 		// append -cache to avoid confusion when listing PVCs
 		pvcName = fmt.Sprintf("%s-cache", ServiceName)
 	default:

pkg/glanceapi/cachejob.go

@@ -13,6 +13,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package glanceapi contains glance API functionality and configuration.
 package glanceapi
 
 import (
@@ -69,9 +70,9 @@ func ImageCacheJob(
 	}
 
 	// add CA cert if defined from the first api
-	if instance.Spec.GlanceAPITemplate.TLS.CaBundleSecretName != "" {
-		cronJobVolume = append(cronJobVolume, instance.Spec.GlanceAPITemplate.TLS.CreateVolume())
-		cronJobVolumeMounts = append(cronJobVolumeMounts, instance.Spec.GlanceAPITemplate.TLS.CreateVolumeMounts(nil)...)
+	if instance.Spec.TLS.CaBundleSecretName != "" {
+		cronJobVolume = append(cronJobVolume, instance.Spec.TLS.CreateVolume())
+		cronJobVolumeMounts = append(cronJobVolumeMounts, instance.Spec.TLS.CreateVolumeMounts(nil)...)
 	}
 
 	// The image-cache PVC should be available to the Cache CronJobs to properly