Fix topology plugin typos (kai-scheduler#369)

Author: davidLif

pkg/scheduler/plugins/topology/topology_plugin_job_filtering.go

@@ -30,7 +30,7 @@ func (t *topologyPlugin) prePredicateFn(_ *pod_info.PodInfo, job *podgroup_info.
 		return nil
 	}
 
-	defer t.treeAllocateableCleanup(topologyTree)
+	defer t.treeAllocatableCleanup(topologyTree)
 	maxAllocatablePods, err := t.calcTreeAllocatable(job, topologyTree)
 	if err != nil {
 		return err
@@ -42,7 +42,7 @@ func (t *topologyPlugin) prePredicateFn(_ *pod_info.PodInfo, job *podgroup_info.
 		return nil
 	}
 
-	_, err = t.getBestjobAllocateableDomains(job, topologyTree)
+	_, err = t.getBestJobAllocatableDomains(job, topologyTree)
 	if err != nil {
 		return err
 	}
@@ -105,42 +105,42 @@ func (t *topologyPlugin) calcSubTreeAllocatable(jobAllocationData *jobAllocation
 	}
 
 	for _, child := range rootDomain.Children {
-		childAllocateable, err := t.calcSubTreeAllocatable(jobAllocationData, child)
+		childAllocatable, err := t.calcSubTreeAllocatable(jobAllocationData, child)
 		if err != nil {
 			return 0, err
 		}
-		rootDomain.AllocatablePods += childAllocateable
+		rootDomain.AllocatablePods += childAllocatable
 	}
 	return rootDomain.AllocatablePods, nil
 }
 
 func calcNodeAccommodation(jobAllocationMetaData *jobAllocationMetaData, node *node_info.NodeInfo) int {
-	allocateablePodsCount := 0
+	allocatablePodsCount := 0
 	for _, resourceRepresentorPod := range jobAllocationMetaData.allocationTestPods {
 		if node.IsTaskAllocatable(resourceRepresentorPod) {
-			allocateablePodsCount++
+			allocatablePodsCount++
 		} else {
 			break
 		}
 	}
 	// Add more to jobResourcesAllocationsRepresentors until node cannot accommodate any more pods
-	if allocateablePodsCount == len(jobAllocationMetaData.allocationTestPods) {
-		for i := allocateablePodsCount; i < len(jobAllocationMetaData.tasksToAllocate); i++ {
+	if allocatablePodsCount == len(jobAllocationMetaData.allocationTestPods) {
+		for i := allocatablePodsCount; i < len(jobAllocationMetaData.tasksToAllocate); i++ {
 			latestTestPod := jobAllocationMetaData.allocationTestPods[len(jobAllocationMetaData.allocationTestPods)-1]
 
 			iAllocationsTestPod := &pod_info.PodInfo{
-				Name:   fmt.Sprintf("%d-pods-resources", allocateablePodsCount+1),
+				Name:   fmt.Sprintf("%d-pods-resources", allocatablePodsCount+1),
 				ResReq: calcNextAllocationTestPodResources(latestTestPod.ResReq, jobAllocationMetaData.maxPodResources),
 			}
 			jobAllocationMetaData.allocationTestPods = append(jobAllocationMetaData.allocationTestPods, iAllocationsTestPod)
 			if node.IsTaskAllocatable(iAllocationsTestPod) {
-				allocateablePodsCount++
+				allocatablePodsCount++
 			} else {
 				break
 			}
 		}
 	}
-	return allocateablePodsCount
+	return allocatablePodsCount
 }
 
 func calcNextAllocationTestPodResources(previousTestResources, maxPodResources *resource_info.ResourceRequirements) *resource_info.ResourceRequirements {
@@ -160,7 +160,7 @@ func calcNextAllocationTestPodResources(previousTestResources, maxPodResources *
 	return nPlus1Resources
 }
 
-func (t *topologyPlugin) getBestjobAllocateableDomains(job *podgroup_info.PodGroupInfo, topologyTree *TopologyInfo) ([]*TopologyDomainInfo, error) {
+func (t *topologyPlugin) getBestJobAllocatableDomains(job *podgroup_info.PodGroupInfo, topologyTree *TopologyInfo) ([]*TopologyDomainInfo, error) {
 	relevantLevels, err := t.calculateRelevantDomainLevels(job, topologyTree.Name, topologyTree)
 	if err != nil {
 		return nil, err
@@ -188,7 +188,7 @@ func (t *topologyPlugin) getBestjobAllocateableDomains(job *podgroup_info.PodGro
 
 	if job.PodGroup.Spec.TopologyConstraint.PreferredTopologyLevel != "" &&
 		maxDepthDomains[0].Level != job.PodGroup.Spec.TopologyConstraint.PreferredTopologyLevel {
-		// If Preferred is defined and we couldn't find a domain on the prefered level,
+		// If Preferred is defined and we couldn't find a domain on the preferred level,
 		// return a children subset and not a single domain
 		return t.improveChoiceForPreference(maxDepthDomains, job)
 	}
@@ -227,12 +227,12 @@ func (*topologyPlugin) calculateRelevantDomainLevels(
 		}
 	}
 	if requiredPlacement != "" && !foundRequiredLevel {
-		return nil, fmt.Errorf("the topology %s doesn't have a level matching the required(%s) spesified for the job %s",
+		return nil, fmt.Errorf("the topology %s doesn't have a level matching the required(%s) specified for the job %s",
 			jobTopologyName, requiredPlacement, job.Name,
 		)
 	}
 	if preferredPlacement != "" && !foundPreferredLevel {
-		return nil, fmt.Errorf("the topology %s doesn't have a level matching the preffered(%s) spesified for the job %s",
+		return nil, fmt.Errorf("the topology %s doesn't have a level matching the preferred(%s) specified for the job %s",
 			jobTopologyName, preferredPlacement, job.Name,
 		)
 	}
@@ -245,33 +245,33 @@ func (t *topologyPlugin) improveChoiceForPreference(maxDepthDomains []*TopologyD
 	// and return the one with the least number of domains required for the allocation
 	bestChildrenSubset := []*TopologyDomainInfo{}
 	for _, domain := range maxDepthDomains {
-		childDomainSubset := getJobAllocateableChildrenSubset(domain, taskToAllocateCount)
+		childDomainSubset := getJobAllocatableChildrenSubset(domain, taskToAllocateCount)
 		if len(bestChildrenSubset) == 0 || len(childDomainSubset) < len(bestChildrenSubset) {
 			bestChildrenSubset = childDomainSubset
 		}
 	}
 	return bestChildrenSubset, nil
 }
 
-func getJobAllocateableChildrenSubset(domain *TopologyDomainInfo, taskToAllocateCount int) []*TopologyDomainInfo {
+func getJobAllocatableChildrenSubset(domain *TopologyDomainInfo, taskToAllocateCount int) []*TopologyDomainInfo {
 	children := slices.Clone(domain.Children)
 	sort.SliceStable(children, func(i, j int) bool {
 		return children[i].AllocatablePods > children[j].AllocatablePods
 	})
 
-	allocateablePodsSum := 0
+	allocatablePodsSum := 0
 	childDomainSubset := []*TopologyDomainInfo{}
 	for _, childDomain := range children {
-		allocateablePodsSum += childDomain.AllocatablePods
+		allocatablePodsSum += childDomain.AllocatablePods
 		childDomainSubset = append(childDomainSubset, childDomain)
-		if allocateablePodsSum >= taskToAllocateCount {
+		if allocatablePodsSum >= taskToAllocateCount {
 			break
 		}
 	}
 	return childDomainSubset
 }
 
-func (*topologyPlugin) treeAllocateableCleanup(topologyTree *TopologyInfo) {
+func (*topologyPlugin) treeAllocatableCleanup(topologyTree *TopologyInfo) {
 	for _, levelDomains := range topologyTree.DomainsByLevel {
 		for _, domain := range levelDomains {
 			domain.AllocatablePods = 0

pkg/scheduler/plugins/topology/topology_plugin_job_filtering_test.go

@@ -194,7 +194,7 @@ func TestTopologyPlugin_calculateRelevantDomainLevels(t *testing.T) {
 				},
 			},
 			expectedLevels: nil,
-			expectedError:  "the topology test-topology doesn't have a level matching the required(nonexistent) spesified for the job test-job",
+			expectedError:  "the topology test-topology doesn't have a level matching the required(nonexistent) specified for the job test-job",
 		},
 		{
 			name: "preferred placement not found in topology",
@@ -224,7 +224,7 @@ func TestTopologyPlugin_calculateRelevantDomainLevels(t *testing.T) {
 				},
 			},
 			expectedLevels: nil,
-			expectedError:  "the topology test-topology doesn't have a level matching the preffered(nonexistent) spesified for the job test-job",
+			expectedError:  "the topology test-topology doesn't have a level matching the preferred(nonexistent) specified for the job test-job",
 		},
 		{
 			name: "required placement at first level",
@@ -879,7 +879,7 @@ func TestTopologyPlugin_calcTreeAllocatable(t *testing.T) {
 	}
 }
 
-func TestTopologyPlugin_getBestjobAllocateableDomains(t *testing.T) {
+func TestTopologyPlugin_getBestJobAllocatableDomains(t *testing.T) {
 	tests := []struct {
 		name            string
 		job             *podgroup_info.PodGroupInfo
@@ -1057,7 +1057,7 @@ func TestTopologyPlugin_getBestjobAllocateableDomains(t *testing.T) {
 				return l.(*pod_info.PodInfo).Name < r.(*pod_info.PodInfo).Name
 			},
 			expectedDomains: nil,
-			expectedError:   "the topology test-topology doesn't have a level matching the required(zone) spesified for the job test-job",
+			expectedError:   "the topology test-topology doesn't have a level matching the required(zone) specified for the job test-job",
 		},
 		{
 			name: "complex topology with multiple levels",
@@ -1370,7 +1370,7 @@ func TestTopologyPlugin_getBestjobAllocateableDomains(t *testing.T) {
 				taskOrderFunc: tt.taskOrderFunc,
 			}
 
-			result, err := plugin.getBestjobAllocateableDomains(tt.job, tt.topologyTree)
+			result, err := plugin.getBestJobAllocatableDomains(tt.job, tt.topologyTree)
 
 			// Check error
 			if tt.expectedError != "" {