fix golangci reported issues

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

Author: stuggi

apis/network/v1beta1/ipset_webhook.go

@@ -75,7 +75,7 @@ func (r *IPSet) ValidateCreate() (admission.Warnings, error) {
 	}
 	// stop if there is no NetConfig in the namespace.
 	if netcfg == nil {
-		return nil, fmt.Errorf(fmt.Sprintf("no NetConfig found in namespace %s. Please create one.", r.GetNamespace()))
+		return nil, fmt.Errorf("no NetConfig found in namespace %s. Please create one.", r.GetNamespace())
 	}
 
 	allErrs := field.ErrorList{}
@@ -126,7 +126,7 @@ func (r *IPSet) ValidateUpdate(old runtime.Object) (admission.Warnings, error) {
 		}
 		// stop if there is no NetConfig in the namespace.
 		if netcfg == nil {
-			return nil, fmt.Errorf(fmt.Sprintf("no NetConfig found in namespace %s. Please create one.", r.GetNamespace()))
+			return nil, fmt.Errorf("no NetConfig found in namespace %s. Please create one.", r.GetNamespace())
 		}
 
 		basePath := field.NewPath("spec")

apis/network/v1beta1/netconfig_webhook.go

@@ -73,7 +73,7 @@ func (r *NetConfig) ValidateCreate() (admission.Warnings, error) {
 	}
 	// stop if there is already a NetConfig in the namespace.
 	if netcfg != nil {
-		return nil, fmt.Errorf(fmt.Sprintf("there is already NetConfig %s in namespace %s. There can only be one.", netcfg.GetName(), r.GetNamespace()))
+		return nil, fmt.Errorf("there is already NetConfig %s in namespace %s. There can only be one.", netcfg.GetName(), r.GetNamespace())
 	}
 
 	allErrs := field.ErrorList{}

controllers/instanceha/instanceha_controller.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package instanceha implements the InstanceHA controller for managing high availability instances
 package instanceha
 
 import (
@@ -62,7 +63,7 @@ import (
 	instanceha "github.com/openstack-k8s-operators/infra-operator/pkg/instanceha"
 )
 
-// InstanceHaReconciler reconciles a InstanceHa object
+// Reconciler reconciles a InstanceHa object
 type Reconciler struct {
 	client.Client
 	Scheme  *runtime.Scheme
@@ -91,11 +92,10 @@ func (r *Reconciler) GetLogger(ctx context.Context) logr.Logger {
 
 // Reconcile -
 func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, _err error) {
-
 	Log := r.GetLogger(ctx)
 
 	instance := &instancehav1.InstanceHa{}
-	err := r.Client.Get(context.TODO(), req.NamespacedName, instance)
+	err := r.Get(context.TODO(), req.NamespacedName, instance)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			Log.Info("InstanceHa CR not found")
@@ -333,7 +333,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ct
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -495,7 +495,6 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ct
 	}
 
 	return ctrl.Result{}, nil
-
 }
 
 // fields to index to reconcile when change
@@ -508,20 +507,17 @@ const (
 	topologyField              = ".spec.topologyRef.Name"
 )
 
-var (
-	allWatchFields = []string{
-		caBundleSecretNameField,
-		openStackConfigMapField,
-		openStackConfigSecretField,
-		fencingSecretField,
-		instanceHaConfigMapField,
-		topologyField,
-	}
-)
+var allWatchFields = []string{
+	caBundleSecretNameField,
+	openStackConfigMapField,
+	openStackConfigSecretField,
+	fencingSecretField,
+	instanceHaConfigMapField,
+	topologyField,
+}
 
 // SetupWithManager sets up the controller with the Manager.
 func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
-
 	// index caBundleSecretNameField
 	if err := mgr.GetFieldIndexer().IndexField(context.Background(), &instancehav1.InstanceHa{}, caBundleSecretNameField, func(rawObj client.Object) []string {
 		cr := rawObj.(*instancehav1.InstanceHa)
@@ -644,6 +640,8 @@ func (r *Reconciler) findObjectsForSrc(ctx context.Context, src client.Object) [
 	return requests
 }
 
+// GetContainerImage returns the container image to use for the instance, either from
+// the provided containerImage parameter or from the infra-instanceha-config ConfigMap
 func (r *Reconciler) GetContainerImage(
 	ctx context.Context,
 	containerImage string,
@@ -657,7 +655,7 @@ func (r *Reconciler) GetContainerImage(
 	}
 
 	objectKey := client.ObjectKey{Namespace: src.GetNamespace(), Name: instanceHaConfigMapName}
-	err := r.Client.Get(ctx, objectKey, cm)
+	err := r.Get(ctx, objectKey, cm)
 	if err != nil {
 		return "", err
 	}

controllers/memcached/memcached_controller.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package memcached implements the Memcached controller for managing Memcached instances
 package memcached
 
 import (
@@ -64,13 +65,11 @@ const (
 	topologyField          = ".spec.topologyRef.Name"
 )
 
-var (
-	allWatchFields = []string{
-		serviceSecretNameField,
-		caSecretNameField,
-		topologyField,
-	}
-)
+var allWatchFields = []string{
+	serviceSecretNameField,
+	caSecretNameField,
+	topologyField,
+}
 
 // Reconciler reconciles a Memcached object
 type Reconciler struct {
@@ -263,7 +262,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ct
 					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(
@@ -289,7 +288,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ct
 					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(
@@ -313,7 +312,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ct
 						memcachedv1.MTLSInputReadyCondition,
 						condition.RequestedReason,
 						condition.SeverityInfo,
-						fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+						condition.TLSInputReadyWaitingMessage, err.Error()))
 					return ctrl.Result{}, nil
 				}
 				instance.Status.Conditions.Set(condition.FalseCondition(
@@ -332,7 +331,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ct
 				memcachedv1.MTLSInputReadyCondition,
 				condition.RequestedReason,
 				condition.SeverityInfo,
-				fmt.Sprintf(memcachedv1.MTLSInputReadyWaitingMessage)))
+				"%s", fmt.Sprintf(memcachedv1.MTLSInputReadyWaitingMessage)))
 			return ctrl.Result{}, nil
 		}
 	}
@@ -497,9 +496,10 @@ func (r *Reconciler) generateConfigMaps(
 			"-o ssl_key=/etc/pki/tls/private/memcached.key " +
 			"-o ssl_ca_cert=/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem"
 
-		if instance.Spec.TLS.MTLS.SslVerifyMode == "Request" {
+		switch instance.Spec.TLS.MTLS.SslVerifyMode {
+		case "Request":
 			memcachedTLSOptions = memcachedTLSOptions + " -o ssl_verify_mode=1"
-		} else if instance.Spec.TLS.MTLS.SslVerifyMode == "Require" {
+		case "Require":
 			memcachedTLSOptions = memcachedTLSOptions + " -o ssl_verify_mode=2"
 		}
 
@@ -552,8 +552,8 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
 		// Extract the secret name from the spec, if one is provided
 		cr := rawObj.(*memcachedv1.Memcached)
 		tls := &cr.Spec.TLS
-		if tls.Ca.CaBundleSecretName != "" {
-			return []string{tls.Ca.CaBundleSecretName}
+		if tls.CaBundleSecretName != "" {
+			return []string{tls.CaBundleSecretName}
 		}
 		return nil
 	}); err != nil {
@@ -565,7 +565,7 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
 		cr := rawObj.(*memcachedv1.Memcached)
 		tls := &cr.Spec.TLS
 		if tls.Enabled() {
-			return []string{*tls.GenericService.SecretName}
+			return []string{*tls.SecretName}
 		}
 		return nil
 	}); err != nil {

controllers/network/bgpconfiguration_controller.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package network implements network controllers for managing BGP configuration and related network resources
 package network
 
 import (
@@ -85,7 +86,7 @@ func (r *BGPConfigurationReconciler) Reconcile(ctx context.Context, req ctrl.Req
 
 	// Fetch the BGPConfiguration instance
 	instance := &networkv1.BGPConfiguration{}
-	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.
@@ -175,7 +176,7 @@ func (r *BGPConfigurationReconciler) SetupWithManager(ctx context.Context, mgr c
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(ctx, bgpConfigurationList, listOpts...); err != nil {
+		if err := r.List(ctx, bgpConfigurationList, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve BGPConfigurationList in namespace %s", o.GetNamespace())
 			return nil
 		}
@@ -214,7 +215,7 @@ func (r *BGPConfigurationReconciler) SetupWithManager(ctx context.Context, mgr c
 		listOpts := []client.ListOption{
 			client.InNamespace(bgpConfigurationNamespace),
 		}
-		if err := r.Client.List(ctx, bgpConfigurationList, listOpts...); err != nil {
+		if err := r.List(ctx, bgpConfigurationList, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve BGPConfigurationList in namespace %s", bgpConfigurationNamespace)
 			return nil
 		}
@@ -331,7 +332,7 @@ func (r *BGPConfigurationReconciler) reconcileDelete(ctx context.Context, instan
 
 	// Delete all FRRConfiguration in the Spec.FRRConfigurationNamespace namespace,
 	// which have the correct owner and ownernamespace label
-	err := r.Client.DeleteAllOf(
+	err := r.DeleteAllOf(
 		ctx,
 		&frrk8sv1.FRRConfiguration{},
 		client.InNamespace(instance.Spec.FRRConfigurationNamespace),
@@ -341,7 +342,7 @@ func (r *BGPConfigurationReconciler) reconcileDelete(ctx context.Context, instan
 		},
 	)
 	if err != nil && !k8s_errors.IsNotFound(err) {
-		return ctrl.Result{}, fmt.Errorf("Error DeleteAllOf FRRConfiguration: %w", err)
+		return ctrl.Result{}, fmt.Errorf("error DeleteAllOf FRRConfiguration: %w", err)
 	}
 
 	// Service is deleted so remove the finalizer.
@@ -361,8 +362,8 @@ func (r *BGPConfigurationReconciler) reconcileNormal(ctx context.Context, instan
 	listOpts := []client.ListOption{
 		client.InNamespace(instance.Namespace),
 	}
-	if err := r.Client.List(ctx, podList, listOpts...); err != nil {
-		return ctrl.Result{}, fmt.Errorf("Unable to retrieve PodList %w", err)
+	if err := r.List(ctx, podList, listOpts...); err != nil {
+		return ctrl.Result{}, fmt.Errorf("unable to retrieve PodList %w", err)
 	}
 
 	// get podDetail all pods which have additional interfaces configured
@@ -376,8 +377,8 @@ func (r *BGPConfigurationReconciler) reconcileNormal(ctx context.Context, instan
 	listOpts = []client.ListOption{
 		client.InNamespace(instance.Spec.FRRConfigurationNamespace), // defaults to metallb-system
 	}
-	if err := r.Client.List(ctx, frrConfigList, listOpts...); err != nil {
-		return ctrl.Result{}, fmt.Errorf("Unable to retrieve FRRConfigurationList %w", err)
+	if err := r.List(ctx, frrConfigList, listOpts...); err != nil {
+		return ctrl.Result{}, fmt.Errorf("unable to retrieve FRRConfigurationList %w", err)
 	}
 
 	// get all frr configs for the nodes pods are scheduled on
@@ -465,7 +466,7 @@ func (r *BGPConfigurationReconciler) deleteStaleFRRConfigurations(ctx context.Co
 				idx := slices.IndexFunc(podNetworkDetailList, f)
 				if idx < 0 {
 					// There is no pod in the namespace corrsponding to the FRRConfiguration, delete it
-					if err := r.Client.Delete(ctx, &cfg); err != nil && !k8s_errors.IsNotFound(err) {
+					if err := r.Delete(ctx, &cfg); err != nil && !k8s_errors.IsNotFound(err) {
 						return fmt.Errorf("unable to delete FRRConfiguration %w", err)
 					}
 					r.GetLogger(ctx).Info(fmt.Sprintf("pod with name: %s either in state deleted, completed, failed or unknown, deleted FRRConfiguration %s", podName, cfg.Name))
@@ -508,7 +509,7 @@ func getPodNetworkDetails(
 
 				// verify the nodeName information is already present in the pod spec, otherwise report an error to reconcile
 				if pod.Spec.NodeName == "" {
-					return detailList, fmt.Errorf(fmt.Sprintf("empty spec.nodeName on pod %s", pod.Name))
+					return detailList, fmt.Errorf("empty spec.nodeName on pod %s", pod.Name)
 				}
 
 				detail := bgp.PodDetail{
@@ -525,11 +526,11 @@ func getPodNetworkDetails(
 				// reflect all requested networks. return with an error to reconcile if the length
 				// is <= the status. Note: the status also has the pod network
 				if len(netsStatus) <= len(netAttach) {
-					return detailList, fmt.Errorf(fmt.Sprintf("metadata.Annotations['k8s.ovn.org/pod-networks'] %s on pod %s, does not match requested networks %s",
-						pod.GetAnnotations()[k8s_networkv1.NetworkStatusAnnot], pod.Name, netAttachString))
+					return detailList, fmt.Errorf("metadata.Annotations['k8s.ovn.org/pod-networks'] %s on pod %s, does not match requested networks %s",
+						pod.GetAnnotations()[k8s_networkv1.NetworkStatusAnnot], pod.Name, netAttachString)
 				}
 
-				var netsStatusCopy = make([]k8s_networkv1.NetworkStatus, len(netsStatus))
+				netsStatusCopy := make([]k8s_networkv1.NetworkStatus, len(netsStatus))
 				copy(netsStatusCopy, netsStatus)
 				// verify there are IP information for all networks in the status, otherwise report an error to reconcile
 				for idx, netStat := range netsStatusCopy {
@@ -562,7 +563,7 @@ func getPodNetworkDetails(
 
 					// verify there is IP information for the network, otherwise report an error to reconcile
 					if len(netStat.IPs) == 0 {
-						return detailList, fmt.Errorf(fmt.Sprintf("no IP information for network %s on pod %s", netStat.Name, pod.Name))
+						return detailList, fmt.Errorf("no IP information for network %s on pod %s", netStat.Name, pod.Name)
 					}
 				}
 

controllers/network/dnsdata_controller.go

@@ -71,7 +71,7 @@ func (r *DNSDataReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 
 	// Fetch the DNSData instance
 	instance := &networkv1.DNSData{}
-	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.

controllers/network/dnsmasq_controller.go

@@ -109,7 +109,7 @@ func (r *DNSMasqReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 
 	// Fetch the DNSMasq instance
 	instance := &networkv1.DNSMasq{}
-	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.
@@ -237,7 +237,7 @@ func (r *DNSMasqReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manag
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(ctx, dnsmasqs, listOpts...); err != nil {
+		if err := r.List(ctx, dnsmasqs, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve DNSMasqList")
 			return nil
 		}

controllers/network/ipset_controller.go

@@ -46,6 +46,7 @@ import (
 	util "github.com/openstack-k8s-operators/lib-common/modules/common/util"
 )
 
+// CtlPlaneNetwork defines the default control plane network name
 const CtlPlaneNetwork = "ctlplane"
 
 // IPSetReconciler reconciles a IPSet object
@@ -76,7 +77,7 @@ func (r *IPSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (resu
 	Log := r.GetLogger(ctx)
 	// Fetch the IPSet instance
 	instance := &networkv1.IPSet{}
-	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.
@@ -170,7 +171,7 @@ func (r *IPSetReconciler) SetupWithManager(_ context.Context, mgr ctrl.Manager)
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(ctx, ipsets, listOpts...); err != nil {
+		if err := r.List(ctx, ipsets, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve IPSetList")
 			return nil
 		}