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/lightspeed/openstacklightspeed_controller.go

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package lightspeed implements the OpenStackLightspeed controller for managing OpenStack Lightspeed resources
 package lightspeed
 
 import (
@@ -39,7 +40,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 
-	lightspeedv1beta1 "github.com/openstack-k8s-operators/openstack-operator/apis/lightspeed/v1beta1"
 	"github.com/openstack-k8s-operators/openstack-operator/pkg/lightspeed"
 )
 
@@ -74,8 +74,8 @@ func (r *OpenStackLightspeedReconciler) GetLogger(ctx context.Context) logr.Logg
 func (r *OpenStackLightspeedReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	Log := r.GetLogger(ctx)
 
-	instance := &lightspeedv1beta1.OpenStackLightspeed{}
-	err := r.Client.Get(ctx, req.NamespacedName, instance)
+	instance := &lightspeedv1.OpenStackLightspeed{}
+	err := r.Get(ctx, req.NamespacedName, instance)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			Log.Info("OpenStackLightspeed CR not found")
@@ -145,7 +145,7 @@ func (r *OpenStackLightspeedReconciler) Reconcile(ctx context.Context, req ctrl.
 	}
 
 	if instance.Spec.RAGImage == "" {
-		instance.Spec.RAGImage = lightspeedv1beta1.OpenStackLightspeedDefaultValues.RAGImageURL
+		instance.Spec.RAGImage = lightspeedv1.OpenStackLightspeedDefaultValues.RAGImageURL
 	}
 
 	OLSOperatorInstalled, err := lightspeed.IsOLSOperatorInstalled(ctx, helper)
@@ -242,7 +242,7 @@ func (r *OpenStackLightspeedReconciler) Reconcile(ctx context.Context, req ctrl.
 func (r *OpenStackLightspeedReconciler) reconcileDelete(
 	ctx context.Context,
 	helper *common_helper.Helper,
-	instance *lightspeedv1beta1.OpenStackLightspeed,
+	instance *lightspeedv1.OpenStackLightspeed,
 ) (ctrl.Result, error) {
 	Log := r.GetLogger(ctx)
 
@@ -272,7 +272,7 @@ func (r *OpenStackLightspeedReconciler) reconcileDelete(
 		return ctrl.Result{}, err
 	}
 
-	err = r.Client.Delete(ctx, &olsConfig)
+	err = r.Delete(ctx, &olsConfig)
 	if err != nil {
 		return ctrl.Result{}, err
 	}
@@ -293,7 +293,7 @@ func (r *OpenStackLightspeedReconciler) 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
 		}
@@ -313,7 +313,7 @@ func (r *OpenStackLightspeedReconciler) SetupWithManager(mgr ctrl.Manager) error
 	})
 
 	return ctrl.NewControllerManagedBy(mgr).
-		For(&lightspeedv1beta1.OpenStackLightspeed{}).
+		For(&lightspeedv1.OpenStackLightspeed{}).
 		Watches(&corev1beta1.OpenStackVersion{}, versionFunc).
 		Complete(r)
 }