fix golangci reported issuers

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

Author: stuggi

cmd/operator/main.go

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

controllers/client/openstackclient_controller.go

@@ -11,6 +11,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package client contains the OpenStackClient controller implementation
 package client
 
 import (
@@ -87,7 +88,7 @@ func (r *OpenStackClientReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 	Log := r.GetLogger(ctx)
 
 	instance := &clientv1.OpenStackClient{}
-	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("OpenStackClient CR not found")
@@ -271,7 +272,8 @@ func (r *OpenStackClientReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 					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(
@@ -320,7 +322,7 @@ func (r *OpenStackClientReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 	podSpecHashName := "podSpec"
 
 	op, err := controllerutil.CreateOrPatch(ctx, r.Client, osclient, func() error {
-		isPodUpdate := !osclient.ObjectMeta.CreationTimestamp.IsZero()
+		isPodUpdate := !osclient.CreationTimestamp.IsZero()
 		currentPodSpecHash := instance.Status.Hash[podSpecHashName]
 		if !isPodUpdate || currentPodSpecHash != podSpecHash {
 			osclient.Spec = spec
@@ -348,14 +350,14 @@ func (r *OpenStackClientReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 			// openstackclient pod
 			if err := r.Delete(ctx, osclient); err != nil && !k8s_errors.IsNotFound(err) {
 				// Error deleting the object
-				return ctrl.Result{}, fmt.Errorf("Error deleting OpenStackClient pod %s: %w", osclient.Name, err)
+				return ctrl.Result{}, fmt.Errorf("error deleting OpenStackClient pod %s: %w", osclient.Name, err)
 			}
 			Log.Info(fmt.Sprintf("OpenStackClient pod deleted due to change %s", err.Error()))
 
 			return ctrl.Result{Requeue: true}, nil
 		}
 
-		return ctrl.Result{}, fmt.Errorf("Failed to create or update pod %s: %w", osclient.Name, err)
+		return ctrl.Result{}, fmt.Errorf("failed to create or update pod %s: %w", osclient.Name, err)
 	}
 
 	if err != nil {
@@ -383,9 +385,9 @@ func (r *OpenStackClientReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 		terminatingDuration := time.Since(osclient.DeletionTimestamp.Time)
 		if terminatingDuration > time.Minute*3 {
 			// Force delete only truly stuck pods
-			err := r.Client.Delete(ctx, osclient, client.GracePeriodSeconds(0))
+			err := r.Delete(ctx, osclient, client.GracePeriodSeconds(0))
 			if err != nil {
-				return ctrl.Result{}, fmt.Errorf("Failed to force delete pod: %w", err)
+				return ctrl.Result{}, fmt.Errorf("failed to force delete pod: %w", err)
 			}
 		}
 	}
@@ -480,7 +482,7 @@ func (r *OpenStackClientReconciler) SetupWithManager(
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(ctx, openstackclients, listOpts...); err != nil {
+		if err := r.List(ctx, openstackclients, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve OpenstackClient CRs %v")
 			return nil
 		}

controllers/core/openstackcontrolplane_controller.go

@@ -13,6 +13,8 @@ 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 core contains the OpenStackControlPlane controller implementation
 package core
 
 import (
@@ -32,7 +34,6 @@ import (
 	ironicv1 "github.com/openstack-k8s-operators/ironic-operator/api/v1beta1"
 	keystonev1 "github.com/openstack-k8s-operators/keystone-operator/api/v1beta1"
 	condition "github.com/openstack-k8s-operators/lib-common/modules/common/condition"
-	"github.com/openstack-k8s-operators/lib-common/modules/common/helper"
 	common_helper "github.com/openstack-k8s-operators/lib-common/modules/common/helper"
 	corev1 "k8s.io/api/core/v1"
 
@@ -131,7 +132,7 @@ func (r *OpenStackControlPlaneReconciler) Reconcile(ctx context.Context, req ctr
 	Log := r.GetLogger(ctx)
 	// Fetch the OpenStackControlPlane instance
 	instance := &corev1beta1.OpenStackControlPlane{}
-	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.
@@ -777,7 +778,7 @@ func (r *OpenStackControlPlaneReconciler) findObjectsForSrc(ctx context.Context,
 // Verify the referenced topology exists
 func (r *OpenStackControlPlaneReconciler) checkTopologyRef(
 	ctx context.Context,
-	h *helper.Helper,
+	h *common_helper.Helper,
 	topologyRef *topologyv1.TopoRef,
 	namespace string,
 ) error {

controllers/core/openstackversion_controller.go

@@ -93,7 +93,7 @@ func (r *OpenStackVersionReconciler) Reconcile(ctx context.Context, req ctrl.Req
 	Log.Info("Reconciling OpenStackVersion")
 	// Fetch the instance
 	instance := &corev1beta1.OpenStackVersion{}
-	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.
@@ -228,7 +228,7 @@ func (r *OpenStackVersionReconciler) Reconcile(ctx context.Context, req ctrl.Req
 
 	// lookup the current Controlplane object
 	controlPlane := &corev1beta1.OpenStackControlPlane{}
-	err = r.Client.Get(ctx, client.ObjectKey{
+	err = r.Get(ctx, client.ObjectKey{
 		Namespace: instance.Namespace,
 		Name:      instance.Name,
 	}, controlPlane)
@@ -414,7 +414,7 @@ func (r *OpenStackVersionReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(ctx, versionList, listOpts...); err != nil {
+		if err := r.List(ctx, versionList, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve OpenStackVersion")
 			return nil
 		}

controllers/dataplane/openstackdataplanedeployment_controller.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package dataplane contains the OpenStackDataPlaneDeployment controller implementation
 package dataplane
 
 import (
@@ -82,7 +83,7 @@ func (r *OpenStackDataPlaneDeploymentReconciler) Reconcile(ctx context.Context,
 	}
 	// Fetch the OpenStackDataPlaneDeployment instance
 	instance := &dataplanev1.OpenStackDataPlaneDeployment{}
-	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.
@@ -343,7 +344,7 @@ func (r *OpenStackDataPlaneDeploymentReconciler) Reconcile(ctx context.Context,
 			severity,
 			condition.DeploymentReadyErrorMessage,
 			deploymentErrMsg)
-		return ctrl.Result{}, fmt.Errorf(deploymentErrMsg)
+		return ctrl.Result{}, fmt.Errorf("%s", deploymentErrMsg)
 	}
 
 	if shouldRequeue {
@@ -365,7 +366,7 @@ func (r *OpenStackDataPlaneDeploymentReconciler) Reconcile(ctx context.Context,
 	return ctrl.Result{}, nil
 }
 
-// GetService
+// GetService retrieves a service for the OpenStackDataPlaneDeployment
 func (r *OpenStackDataPlaneDeploymentReconciler) GetService(
 	ctx context.Context,
 	helper *helper.Helper,
@@ -456,7 +457,7 @@ func (r *OpenStackDataPlaneDeploymentReconciler) SetupWithManager(mgr ctrl.Manag
 		listOpts := []client.ListOption{
 			client.InNamespace(obj.GetNamespace()),
 		}
-		if err := r.Client.List(context.Background(), deployments, listOpts...); err != nil {
+		if err := r.List(context.Background(), deployments, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve deployments %w")
 			return nil
 		}
@@ -504,7 +505,7 @@ func (r *OpenStackDataPlaneDeploymentReconciler) listNodeSets(ctx context.Contex
 
 		// Fetch the OpenStackDataPlaneNodeSet instance
 		nodeSetInstance := &dataplanev1.OpenStackDataPlaneNodeSet{}
-		err := r.Client.Get(
+		err := r.Get(
 			ctx,
 			types.NamespacedName{
 				Namespace: instance.GetNamespace(),

controllers/dataplane/openstackdataplanenodeset_controller.go

@@ -145,7 +145,7 @@ func (r *OpenStackDataPlaneNodeSetReconciler) Reconcile(ctx context.Context, req
 
 	// Fetch the OpenStackDataPlaneNodeSet instance
 	instance := &dataplanev1.OpenStackDataPlaneNodeSet{}
-	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.
@@ -282,7 +282,7 @@ func (r *OpenStackDataPlaneNodeSetReconciler) Reconcile(ctx context.Context, req
 			condition.InputReadyCondition,
 			condition.RequestedReason,
 			condition.SeverityError,
-			err.Error())
+			"%s", err.Error())
 		return result, err
 	} else if (result != ctrl.Result{}) {
 		instance.Status.Conditions.MarkFalse(
@@ -461,7 +461,7 @@ func (r *OpenStackDataPlaneNodeSetReconciler) Reconcile(ctx context.Context, req
 		}
 		instance.Status.Conditions.MarkFalse(condition.DeploymentReadyCondition,
 			condition.ErrorReason, condition.SeverityError,
-			deployErrorMsg)
+			"%s", deployErrorMsg)
 	}
 
 	return ctrl.Result{}, err
@@ -511,7 +511,7 @@ func checkDeployment(ctx context.Context, helper *helper.Helper,
 			instance.Status.DeploymentStatuses[deployment.Name] = deploymentConditions
 			deploymentCondition := deploymentConditions.Get(dataplanev1.NodeSetDeploymentReadyCondition)
 			if condition.IsError(deploymentCondition) {
-				err = fmt.Errorf(deploymentCondition.Message)
+				err = fmt.Errorf("%s", deploymentCondition.Message)
 				isDeploymentFailed = true
 				failedDeploymentName = deployment.Name
 				break
@@ -677,7 +677,7 @@ func (r *OpenStackDataPlaneNodeSetReconciler) machineConfigWatcherFn(
 	listOpts := []client.ListOption{
 		client.InNamespace(obj.GetNamespace()),
 	}
-	if err := r.Client.List(ctx, nodeSets, listOpts...); err != nil {
+	if err := r.List(ctx, nodeSets, listOpts...); err != nil {
 		Log.Error(err, "Unable to retrieve OpenStackDataPlaneNodeSetList")
 		return nil
 	}
@@ -739,7 +739,7 @@ func (r *OpenStackDataPlaneNodeSetReconciler) genericWatcherFn(
 	listOpts := []client.ListOption{
 		client.InNamespace(obj.GetNamespace()),
 	}
-	if err := r.Client.List(ctx, nodeSets, listOpts...); err != nil {
+	if err := r.List(ctx, nodeSets, listOpts...); err != nil {
 		Log.Error(err, "Unable to retrieve OpenStackDataPlaneNodeSetList")
 		return nil
 	}

controllers/operator/openstack_controller.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package operator contains the OpenStack operator controller implementation
 package operator
 
 import (
@@ -133,12 +134,12 @@ func (r *OpenStackReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 
 	// Fetch the OpenStack instance
 	instanceList := &operatorv1beta1.OpenStackList{}
-	err := r.Client.List(ctx, instanceList, &client.ListOptions{})
+	err := r.List(ctx, instanceList, &client.ListOptions{})
 	if err != nil {
 		return ctrl.Result{}, errors.Wrap(err, "failed listing all OpenStack instances")
 	}
 	instance := &operatorv1beta1.OpenStack{}
-	err = r.Client.Get(ctx, req.NamespacedName, instance)
+	err = r.Get(ctx, req.NamespacedName, instance)
 	if err != nil {
 		if apierrors.IsNotFound(err) {
 			// Request object not found, could have been deleted after reconcile req.
@@ -229,7 +230,7 @@ func (r *OpenStackReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 		}
 		if instanceList.Items[0].Name != req.Name {
 			Log.Info("Ignoring OpenStack.operator.openstack.org because one already exists and does not match existing name")
-			err = r.Client.Delete(ctx, instance, &client.DeleteOptions{})
+			err = r.Delete(ctx, instance, &client.DeleteOptions{})
 			if err != nil {
 				instance.Status.Conditions.Set(condition.FalseCondition(
 					operatorv1beta1.OpenStackOperatorReadyCondition,
@@ -363,7 +364,7 @@ func (r *OpenStackReconciler) reconcileDelete(ctx context.Context, instance *ope
 func (r *OpenStackReconciler) countDeployments(ctx context.Context, instance *operatorv1beta1.OpenStack) (int, []string, error) {
 	deployments := &appsv1.DeploymentList{}
 	pending := []string{}
-	err := r.Client.List(ctx, deployments, &client.ListOptions{Namespace: instance.Namespace})
+	err := r.List(ctx, deployments, &client.ListOptions{Namespace: instance.Namespace})
 	if err != nil {
 		return 0, pending, err
 	}
@@ -409,7 +410,7 @@ func (r *OpenStackReconciler) checkServiceEndpoints(ctx context.Context, instanc
 	Log := r.GetLogger(ctx)
 
 	endpointSliceList := &discoveryv1.EndpointSliceList{}
-	err := r.Client.List(ctx, endpointSliceList, &client.ListOptions{Namespace: instance.Namespace})
+	err := r.List(ctx, endpointSliceList, &client.ListOptions{Namespace: instance.Namespace})
 	if err != nil {
 		if apierrors.IsNotFound(err) {
 			Log.Info("Webhook endpoint not found. Requeuing...")
@@ -755,14 +756,14 @@ func (r *OpenStackReconciler) cleanupObsoleteResources(ctx context.Context, inst
 
 	csvList := &uns.UnstructuredList{}
 	csvList.SetGroupVersionKind(csvGVR.GroupVersion().WithKind("ClusterServiceVersion"))
-	err := r.Client.List(ctx, csvList, &client.ListOptions{Namespace: instance.Namespace})
+	err := r.List(ctx, csvList, &client.ListOptions{Namespace: instance.Namespace})
 	if err != nil {
 		return err
 	}
 	for _, csv := range csvList.Items {
 		Log.Info("Found CSV", "name", csv.GetName())
 		if isServiceOperatorResource(csv.GetName()) {
-			err = r.Client.Delete(ctx, &csv)
+			err = r.Delete(ctx, &csv)
 			if err != nil {
 				if apierrors.IsNotFound(err) {
 					Log.Info("CSV not found on delete. Continuing...", "name", csv.GetName())
@@ -776,14 +777,14 @@ func (r *OpenStackReconciler) cleanupObsoleteResources(ctx context.Context, inst
 
 	subscriptionList := &uns.UnstructuredList{}
 	subscriptionList.SetGroupVersionKind(subscriptionGVR.GroupVersion().WithKind("Subscription"))
-	err = r.Client.List(ctx, subscriptionList, &client.ListOptions{Namespace: instance.Namespace})
+	err = r.List(ctx, subscriptionList, &client.ListOptions{Namespace: instance.Namespace})
 	if err != nil {
 		return err
 	}
 	for _, subscription := range subscriptionList.Items {
 		Log.Info("Found Subscription", "name", subscription.GetName())
 		if isServiceOperatorResource(subscription.GetName()) {
-			err = r.Client.Delete(ctx, &subscription)
+			err = r.Delete(ctx, &subscription)
 			if err != nil {
 				if apierrors.IsNotFound(err) {
 					Log.Info("Subscription not found on delete. Continuing...", "name", subscription.GetName())
@@ -800,7 +801,7 @@ func (r *OpenStackReconciler) cleanupObsoleteResources(ctx context.Context, inst
 	installPlanList := &uns.UnstructuredList{}
 	installPlanList.SetGroupVersionKind(installPlanGVR.GroupVersion().WithKind("InstallPlan"))
 
-	err = r.Client.List(ctx, installPlanList, &client.ListOptions{Namespace: instance.Namespace})
+	err = r.List(ctx, installPlanList, &client.ListOptions{Namespace: instance.Namespace})
 	if err != nil {
 		return err
 	}
@@ -814,7 +815,7 @@ func (r *OpenStackReconciler) cleanupObsoleteResources(ctx context.Context, inst
 		if found {
 			// just checking for the first one should be sufficient
 			if isServiceOperatorResource(csvNames[0].(string)) {
-				err = r.Client.Delete(ctx, &installPlan)
+				err = r.Delete(ctx, &installPlan)
 				if err != nil {
 					if apierrors.IsNotFound(err) {
 						Log.Info("Installplane not found on delete. Continuing...", "name", installPlan.GetName())
@@ -848,7 +849,7 @@ func (r *OpenStackReconciler) postCleanupObsoleteResources(ctx context.Context,
 	// 4) installPlan from old service operators removed
 	operatorList := &uns.UnstructuredList{}
 	operatorList.SetGroupVersionKind(operatorGVR.GroupVersion().WithKind("Operator"))
-	err := r.Client.List(ctx, operatorList, &client.ListOptions{Namespace: instance.Namespace})
+	err := r.List(ctx, operatorList, &client.ListOptions{Namespace: instance.Namespace})
 	if err != nil {
 		return err
 	}
@@ -894,7 +895,7 @@ func (r *OpenStackReconciler) postCleanupObsoleteResources(ctx context.Context,
 					// references from CRD's should be removed before this function is called
 					// but this is a safeguard as we do not want to delete them
 					if refData["kind"].(string) != "CustomResourceDefinition" {
-						err = r.Client.Delete(ctx, &obj)
+						err = r.Delete(ctx, &obj)
 						if err != nil {
 							if apierrors.IsNotFound(err) {
 								Log.Info("Object not found on delete. Continuing...", "name", obj.GetName())
@@ -908,7 +909,7 @@ func (r *OpenStackReconciler) postCleanupObsoleteResources(ctx context.Context,
 				return fmt.Errorf("Requeuing/Found references for operator name: %s, refs: %v", operator.GetName(), refs)
 			}
 			// no refs found so we should be able to successfully delete the operator
-			err = r.Client.Delete(ctx, &operator)
+			err = r.Delete(ctx, &operator)
 			if err != nil {
 				return err
 			}

main.go

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