fix golangci reported issues

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

Author: stuggi

controllers/swift_common.go

@@ -14,16 +14,18 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package controllers implements the OpenStack Swift Kubernetes controllers.
 package controllers
 
 import (
 	"context"
 	"fmt"
+	"time"
+
 	"github.com/openstack-k8s-operators/lib-common/modules/common/condition"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/helper"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/secret"
 	"k8s.io/apimachinery/pkg/types"
-	"time"
 
 	topologyv1 "github.com/openstack-k8s-operators/infra-operator/apis/topology/v1beta1"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/env"
@@ -36,7 +38,7 @@ import (
 // fields to index to reconcile when change
 const (
 	passwordSecretField     = ".spec.secret"
-	caBundleSecretNameField = ".spec.tls.caBundleSecretName"
+	caBundleSecretNameField = ".spec.tls.caBundleSecretName" //nolint:gosec // G101: Not actual credentials, just field path
 	tlsAPIInternalField     = ".spec.tls.api.internal.secretName"
 	tlsAPIPublicField       = ".spec.tls.api.public.secretName"
 	topologyField           = ".spec.topologyRef.Name"

controllers/swift_controller.go

@@ -584,7 +584,7 @@ func (r *SwiftReconciler) checkSwiftProxyGeneration(
 	listOpts := []client.ListOption{
 		client.InNamespace(instance.Namespace),
 	}
-	if err := r.Client.List(context.Background(), proxy, listOpts...); err != nil {
+	if err := r.List(context.Background(), proxy, listOpts...); err != nil {
 		Log.Error(err, "Unable to retrieve SwiftProxy %w")
 		return false, err
 	}
@@ -606,7 +606,7 @@ func (r *SwiftReconciler) checkSwiftStorageGeneration(
 	listOpts := []client.ListOption{
 		client.InNamespace(instance.Namespace),
 	}
-	if err := r.Client.List(context.Background(), sst, listOpts...); err != nil {
+	if err := r.List(context.Background(), sst, listOpts...); err != nil {
 		Log.Error(err, "Unable to retrieve SwiftStorage %w")
 		return false, err
 	}
@@ -628,7 +628,7 @@ func (r *SwiftReconciler) checkSwiftRingGeneration(
 	listOpts := []client.ListOption{
 		client.InNamespace(instance.Namespace),
 	}
-	if err := r.Client.List(context.Background(), rings, listOpts...); err != nil {
+	if err := r.List(context.Background(), rings, listOpts...); err != nil {
 		Log.Error(err, "Unable to retrieve SwiftRing %w")
 		return false, err
 	}

controllers/swiftproxy_controller.go

@@ -50,7 +50,6 @@ import (
 	"github.com/openstack-k8s-operators/lib-common/modules/common/env"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/helper"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/labels"
-	"github.com/openstack-k8s-operators/lib-common/modules/common/networkattachment"
 	nad "github.com/openstack-k8s-operators/lib-common/modules/common/networkattachment"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/secret"
 	service "github.com/openstack-k8s-operators/lib-common/modules/common/service"
@@ -220,7 +219,7 @@ func (r *SwiftProxyReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 					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(
@@ -245,7 +244,7 @@ func (r *SwiftProxyReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 				condition.TLSInputReadyCondition,
 				condition.RequestedReason,
 				condition.SeverityInfo,
-				fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+				"%s", fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
 			return ctrl.Result{}, nil
 		}
 		instance.Status.Conditions.Set(condition.FalseCondition(
@@ -609,7 +608,7 @@ func (r *SwiftProxyReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 	// networks to attach to
 	nadList := []networkv1.NetworkAttachmentDefinition{}
 	for _, netAtt := range instance.Spec.NetworkAttachments {
-		nad, err := networkattachment.GetNADWithName(ctx, helper, netAtt, instance.Namespace)
+		nad, err := nad.GetNADWithName(ctx, helper, netAtt, instance.Namespace)
 		if err != nil {
 			if apierrors.IsNotFound(err) {
 				instance.Status.Conditions.Set(condition.FalseCondition(
@@ -714,7 +713,7 @@ func (r *SwiftProxyReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		if networkReady || *instance.Spec.Replicas == 0 {
 			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", swift.ErrNetworkAttachmentsMismatch, instance.Spec.NetworkAttachments)
 			instance.Status.Conditions.Set(condition.FalseCondition(
 				condition.NetworkAttachmentsReadyCondition,
 				condition.ErrorReason,
@@ -814,7 +813,7 @@ func (r *SwiftProxyReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Ma
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(context.Background(), crList, listOpts...); err != nil {
+		if err := r.List(context.Background(), crList, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve SwiftProxy CRs %w")
 			return nil
 		}
@@ -902,7 +901,7 @@ func (r *SwiftProxyReconciler) findObjectForSrc(ctx context.Context, src client.
 	listOps := &client.ListOptions{
 		Namespace: src.GetNamespace(),
 	}
-	err := r.Client.List(ctx, crList, listOps)
+	err := r.List(ctx, crList, listOps)
 	if err != nil {
 		Log.Error(err, fmt.Sprintf("listing %s for namespace: %s", crList.GroupVersionKind().Kind, src.GetNamespace()))
 		return requests

controllers/swiftring_controller.go

@@ -235,7 +235,7 @@ func (r *SwiftRingReconciler) reconcileNormal(ctx context.Context, instance *swi
 			condition.ReadyCondition,
 			condition.ErrorReason,
 			condition.SeverityWarning,
-			err.Error()))
+			"%s", err.Error()))
 		return ctrl.Result{}, err
 	}
 
@@ -290,7 +290,7 @@ func (r *SwiftRingReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		result := []reconcile.Request{}
 		swiftRings := &swiftv1beta1.SwiftRingList{}
 		listOpts := []client.ListOption{client.InNamespace(o.GetNamespace())}
-		err := r.Client.List(context.Background(), swiftRings, listOpts...)
+		err := r.List(context.Background(), swiftRings, listOpts...)
 		if err != nil {
 			return nil
 		}

controllers/swiftstorage_controller.go

@@ -76,8 +76,7 @@ func (r *SwiftStorageReconciler) GetLogger(ctx context.Context) logr.Logger {
 	return log.FromContext(ctx).WithName("Controllers").WithName("SwiftStorage")
 }
 
-// Partial struct of the NetworkAttachmentDefinition
-// config to retrieve the subnet range
+// Netconfig represents a partial NetworkAttachmentDefinition configuration for subnet range retrieval.
 type Netconfig struct {
 	Name string `json:"name"`
 	Ipam struct {
@@ -375,7 +374,7 @@ func (r *SwiftStorageReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		if networkReady || *instance.Spec.Replicas == 0 {
 			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", swift.ErrNetworkAttachmentsMismatch, instance.Spec.NetworkAttachments)
 			instance.Status.Conditions.Set(condition.FalseCondition(
 				condition.NetworkAttachmentsReadyCondition,
 				condition.ErrorReason,
@@ -417,7 +416,7 @@ func (r *SwiftStorageReconciler) Reconcile(ctx context.Context, req ctrl.Request
 			}
 
 			if len(dnsIP) == 0 {
-				return ctrl.Result{}, errors.New("Unable to get any IP address for pod")
+				return ctrl.Result{}, swift.ErrNoPodIPAddress
 			}
 
 			hostName := fmt.Sprintf("%s.%s.%s.svc", swiftPod.Name, instance.Name, swiftPod.Namespace)
@@ -468,7 +467,7 @@ func (r *SwiftStorageReconciler) SetupWithManager(ctx context.Context, mgr ctrl.
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(context.Background(), crList, listOpts...); err != nil {
+		if err := r.List(context.Background(), crList, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve SwiftStorage CRs %w")
 			return nil
 		}
@@ -569,7 +568,7 @@ func getPodIPInNetwork(swiftPod corev1.Pod, namespace string, networkAttachment
 	networkName := fmt.Sprintf("%s/%s", namespace, networkAttachment)
 	netStat, err := networkattachment.GetNetworkStatusFromAnnotation(swiftPod.Annotations)
 	if err != nil {
-		err = fmt.Errorf("Error while getting the Network Status for pod %s: %w",
+		err = fmt.Errorf("error while getting the Network Status for pod %s: %w",
 			swiftPod.Name, err)
 		return "", err
 	}
@@ -582,6 +581,6 @@ func getPodIPInNetwork(swiftPod corev1.Pod, namespace string, networkAttachment
 	}
 
 	// If this is reached it means that no IP was found, construct error and return
-	err = fmt.Errorf("Error while getting IP address from pod %s in network %s", swiftPod.Name, networkAttachment)
+	err = fmt.Errorf("%w %s in network %s", swift.ErrPodIPAddressRetrieval, swiftPod.Name, networkAttachment)
 	return "", err
 }

main.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package main is the entry point for the Swift operator
 package main
 
 import (

pkg/swift/const.go

@@ -13,26 +13,39 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package swift provides common constants and utilities for Swift services
 package swift
 
 const (
-	RunAsUser      int64 = 42445
-	ProxyPort      int32 = 8081
+	// RunAsUser is the UID for running swift containers
+	RunAsUser int64 = 42445
+	// ProxyPort is the port for Swift proxy service
+	ProxyPort int32 = 8081
+	// ProxyHttpdPort is the HTTP port for Swift proxy
 	ProxyHttpdPort int32 = 8080
 
-	AccountServerPort   int32 = 6202
+	// AccountServerPort is the port for Swift account server
+	AccountServerPort int32 = 6202
+	// ContainerServerPort is the port for Swift container server
 	ContainerServerPort int32 = 6201
-	ObjectServerPort    int32 = 6200
-	RsyncPort           int32 = 873
-
-	ServiceName        = "swift"
-	ServiceType        = "object-store"
-	ServiceAccount     = "swift-swift"
+	// ObjectServerPort is the port for Swift object server
+	ObjectServerPort int32 = 6200
+	// RsyncPort is the port for rsync service
+	RsyncPort int32 = 873
+
+	// ServiceName is the name of the Swift service
+	ServiceName = "swift"
+	// ServiceType is the OpenStack service type for Swift
+	ServiceType = "object-store"
+	// ServiceAccount is the service account name for Swift
+	ServiceAccount = "swift-swift"
+	// ServiceDescription is the description of the Swift service
 	ServiceDescription = "Swift Object Storage"
 
+	// ClaimName is the persistent volume claim name for Swift
 	ClaimName = "swift"
 
-	// Must match with settings in the dataplane-operator
-	// and adoption docs/tests
+	// SwiftConfSecretName is the name of the secret containing swift.conf
+	// Must match with settings in the dataplane-operator and adoption docs/tests
 	SwiftConfSecretName = "swift-conf"
 )

pkg/swift/errors.go

@@ -0,0 +1,39 @@
+/*
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package swift
+
+import "errors"
+
+// Static errors for Swift operator
+var (
+	// ErrNetworkAttachmentsMismatch indicates pods don't have interfaces with IPs as configured in NetworkAttachments
+	ErrNetworkAttachmentsMismatch = errors.New("not all pods have interfaces with ips as configured in NetworkAttachments")
+
+	// ErrNoPodIPAddress indicates unable to get any IP address for pod
+	ErrNoPodIPAddress = errors.New("unable to get any IP address for pod")
+
+	// ErrPodIPAddressRetrieval indicates error while getting IP address from pod in network
+	ErrPodIPAddressRetrieval = errors.New("error while getting IP address from pod in network")
+
+	// ErrPVCNotBound indicates PersistentVolumeClaim found but not bound yet
+	ErrPVCNotBound = errors.New("PersistentVolumeClaim found, but not bound yet")
+
+	// ErrPodNotFound indicates pod not found
+	ErrPodNotFound = errors.New("pod not found")
+
+	// ErrPodNodeNameNotSet indicates pod found but NodeName not yet set
+	ErrPodNodeNameNotSet = errors.New("pod found, but NodeName not yet set")
+)

pkg/swift/funcs.go

@@ -27,6 +27,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// GetSecurityContext returns the security context for swift containers
 func GetSecurityContext() corev1.SecurityContext {
 	trueVal := true
 	falseVal := false
@@ -44,19 +45,21 @@ func GetSecurityContext() corev1.SecurityContext {
 	}
 }
 
+// Labels returns the common labels for swift resources
 func Labels() map[string]string {
 	return map[string]string{
 		common.AppSelector:       ServiceName,
 		common.ComponentSelector: ServiceName, // identical in this case
 	}
 }
 
+// RandomString generates a random string of specified length
 func RandomString(length int) string {
 	sample := "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
 	str := make([]byte, length)
 
 	for i := 0; i < length; i++ {
-		str[i] = sample[rand.Intn(len(sample))]
+		str[i] = sample[rand.Intn(len(sample))] //nolint:gosec // G404: Non-cryptographic use acceptable for Swift hash generation
 	}
 	return string(str)
 }

pkg/swift/templates.go

@@ -21,6 +21,7 @@ import (
 	swiftv1beta1 "github.com/openstack-k8s-operators/swift-operator/api/v1beta1"
 )
 
+// SecretTemplates creates secret templates for swift configuration
 func SecretTemplates(instance *swiftv1beta1.Swift, serviceLabels map[string]string) []util.Template {
 	templateParameters := make(map[string]interface{})
 	templateParameters["SwiftHashPathPrefix"] = RandomString(16)