Refactor variable names according to Go style guide (#2202)

Author: alexandear

.golangci.yaml

@@ -18,6 +18,7 @@ linters-settings:
     enable-all-rules: false
     rules:
       - name: empty-lines
+      - name: var-naming
 
 # Settings for enabling and disabling linters
 linters:

apis/config/v1beta1/defaults.go

@@ -60,6 +60,8 @@ func getOperatorNamespace() string {
 }
 
 // SetDefaults_Configuration sets default values for ComponentConfig.
+//
+//nolint:revive // format required by generated code for defaulting
 func SetDefaults_Configuration(cfg *Configuration) {
 	if cfg.Namespace == nil {
 		cfg.Namespace = ptr.To(getOperatorNamespace())

apis/visibility/v1alpha1/defaults.go

@@ -30,6 +30,7 @@ func addDefaultingFuncs(scheme *runtime.Scheme) error {
 	return RegisterDefaults(scheme)
 }
 
+//nolint:revive // format required by generated code for defaulting
 func SetDefaults_PendingWorkloadOptions(obj *PendingWorkloadOptions) {
 	if obj.Limit == 0 {
 		obj.Limit = constants.DefaultPendingWorkloadsLimit

cmd/importer/pod/import.go

@@ -135,9 +135,9 @@ func Import(ctx context.Context, c client.Client, cache *util.ImportCache, jobs
 }
 
 func checkError(err error) (retry, reload bool, timeout time.Duration) {
-	retry_seconds, retry := apierrors.SuggestsClientDelay(err)
+	retrySeconds, retry := apierrors.SuggestsClientDelay(err)
 	if retry {
-		return true, false, time.Duration(retry_seconds) * time.Second
+		return true, false, time.Duration(retrySeconds) * time.Second
 	}
 
 	if apierrors.IsConflict(err) {

pkg/controller/admissionchecks/multikueue/fswatch.go

@@ -150,16 +150,16 @@ func (w *KubeConfigFSWatcher) remove(cluster string) {
 	kcPath := w.clusterToFile[cluster]
 	dir := path.Dir(kcPath)
 
-	file_removed := false
+	fileRemoved := false
 	if s, found := w.fileToClusters[kcPath]; found {
 		s.Delete(cluster)
 		if s.Len() == 0 {
 			delete(w.fileToClusters, kcPath)
-			file_removed = true
+			fileRemoved = true
 		}
 	}
 
-	if file_removed {
+	if fileRemoved {
 		if s, found := w.parentDirToFiles[dir]; found {
 			s.Delete(kcPath)
 			if s.Len() == 0 {

pkg/controller/jobframework/reconciler.go

@@ -888,14 +888,14 @@ func (r *JobReconciler) constructWorkload(ctx context.Context, job GenericJob, o
 	if wl.Labels == nil {
 		wl.Labels = make(map[string]string)
 	}
-	jobUid := string(job.Object().GetUID())
-	if errs := validation.IsValidLabelValue(jobUid); len(errs) == 0 {
-		wl.Labels[controllerconsts.JobUIDLabel] = jobUid
+	jobUID := string(job.Object().GetUID())
+	if errs := validation.IsValidLabelValue(jobUID); len(errs) == 0 {
+		wl.Labels[controllerconsts.JobUIDLabel] = jobUID
 	} else {
 		log.V(2).Info(
 			"Validation of the owner job UID label has failed. Creating workload without the label.",
 			"ValidationErrors", errs,
-			"LabelValue", jobUid,
+			"LabelValue", jobUID,
 		)
 	}
 

pkg/controller/jobs/job/job_controller.go

@@ -214,8 +214,8 @@ func (j *Job) ReclaimablePods() ([]kueue.ReclaimablePod, error) {
 var (
 	// the legacy names are no longer defined in the api, only in k/2/apis/batch
 	legacyJobNameLabel       = "job-name"
-	legacyControllerUidLabel = "controller-uid"
-	ManagedLabels            = []string{legacyJobNameLabel, legacyControllerUidLabel, batchv1.JobNameLabel, batchv1.ControllerUidLabel}
+	legacyControllerUIDLabel = "controller-uid"
+	ManagedLabels            = []string{legacyJobNameLabel, legacyControllerUIDLabel, batchv1.JobNameLabel, batchv1.ControllerUidLabel}
 )
 
 func cleanManagedLabels(pt *corev1.PodTemplateSpec) *corev1.PodTemplateSpec {

pkg/controller/jobs/pod/pod_controller.go

@@ -588,13 +588,13 @@ func getRoleHash(p corev1.Pod) (string, error) {
 		},
 	}
 
-	shapeJson, err := json.Marshal(shape)
+	shapeJSON, err := json.Marshal(shape)
 	if err != nil {
 		return "", err
 	}
 
 	// Trim hash to 8 characters and return
-	return fmt.Sprintf("%x", sha256.Sum256(shapeJson))[:8], nil
+	return fmt.Sprintf("%x", sha256.Sum256(shapeJSON))[:8], nil
 }
 
 // Load loads all pods in the group
@@ -951,14 +951,14 @@ func (p *Pod) ConstructComposableWorkload(ctx context.Context, c client.Client,
 		wl.Spec.PodSets = p.PodSets()
 
 		wl.Name = jobframework.GetWorkloadNameForOwnerWithGVK(p.pod.GetName(), p.pod.GetUID(), p.GVK())
-		jobUid := string(object.GetUID())
-		if errs := validation.IsValidLabelValue(jobUid); len(errs) == 0 {
-			wl.Labels[controllerconsts.JobUIDLabel] = jobUid
+		jobUID := string(object.GetUID())
+		if errs := validation.IsValidLabelValue(jobUID); len(errs) == 0 {
+			wl.Labels[controllerconsts.JobUIDLabel] = jobUID
 		} else {
 			log.V(2).Info(
 				"Validation of the owner job UID label has failed. Creating workload without the label.",
 				"ValidationErrors", errs,
-				"LabelValue", jobUid,
+				"LabelValue", jobUID,
 			)
 		}
 

pkg/scheduler/flavorassigner/flavorassigner.go

@@ -380,7 +380,7 @@ func (a *Assignment) append(requests workload.Requests, psAssignment *PodSetAssi
 // reasons or failure.
 func (a *FlavorAssigner) findFlavorForPodSetResource(
 	log logr.Logger,
-	psId int,
+	psID int,
 	requests workload.Requests,
 	resName corev1.ResourceName,
 	assignmentUsage cache.FlavorResourceQuantities,
@@ -394,15 +394,15 @@ func (a *FlavorAssigner) findFlavorForPodSetResource(
 
 	status := &Status{}
 	requests = filterRequestedResources(requests, resourceGroup.CoveredResources)
-	podSpec := &a.wl.Obj.Spec.PodSets[psId].Template.Spec
+	podSpec := &a.wl.Obj.Spec.PodSets[psID].Template.Spec
 
 	var bestAssignment ResourceAssignment
 	bestAssignmentMode := NoFit
 
 	// We will only check against the flavors' labels for the resource.
 	selector := flavorSelector(podSpec, resourceGroup.LabelKeys)
 	assignedFlavorIdx := -1
-	idx := a.wl.LastAssignment.NextFlavorToTryForPodSetResource(psId, resName)
+	idx := a.wl.LastAssignment.NextFlavorToTryForPodSetResource(psID, resName)
 	for ; idx < len(resourceGroup.Flavors); idx++ {
 		flvQuotas := resourceGroup.Flavors[idx]
 		flavor, exist := a.resourceFlavors[flvQuotas.Name]

pkg/scheduler/scheduler_test.go

@@ -1967,7 +1967,7 @@ func TestLastSchedulingContext(t *testing.T) {
 					Resource(corev1.ResourceCPU, "100", "0").Obj(),
 			).Obj(),
 	}
-	clusterQueue_cohort := []kueue.ClusterQueue{
+	clusterQueueCohort := []kueue.ClusterQueue{
 		*utiltesting.MakeClusterQueue("eng-cohort-alpha").
 			Cohort("cohort").
 			QueueingStrategy(kueue.StrictFIFO).
@@ -2118,7 +2118,7 @@ func TestLastSchedulingContext(t *testing.T) {
 		},
 		{
 			name: "borrow before next flavor",
-			cqs:  clusterQueue_cohort,
+			cqs:  clusterQueueCohort,
 			admittedWorkloads: []kueue.Workload{
 				*utiltesting.MakeWorkload("placeholder", "default").
 					Request(corev1.ResourceCPU, "50").
@@ -2150,7 +2150,7 @@ func TestLastSchedulingContext(t *testing.T) {
 		},
 		{
 			name: "borrow after all flavors",
-			cqs:  clusterQueue_cohort,
+			cqs:  clusterQueueCohort,
 			admittedWorkloads: []kueue.Workload{
 				*utiltesting.MakeWorkload("placeholder", "default").
 					Request(corev1.ResourceCPU, "50").
@@ -2182,7 +2182,7 @@ func TestLastSchedulingContext(t *testing.T) {
 		},
 		{
 			name: "when the next flavor is full, but can borrow on first",
-			cqs:  clusterQueue_cohort,
+			cqs:  clusterQueueCohort,
 			admittedWorkloads: []kueue.Workload{
 				*utiltesting.MakeWorkload("placeholder", "default").
 					Request(corev1.ResourceCPU, "40").
@@ -2220,7 +2220,7 @@ func TestLastSchedulingContext(t *testing.T) {
 		},
 		{
 			name: "when the next flavor is full, but can preempt on first",
-			cqs:  clusterQueue_cohort,
+			cqs:  clusterQueueCohort,
 			admittedWorkloads: []kueue.Workload{
 				*utiltesting.MakeWorkload("placeholder-alpha", "default").
 					Priority(-1).