Merge pull request #123044 from yanhuan0802/fix-incorrect-comment

k8s-ci-robot · web-flow · commit 0deaf12b885f · 2024-02-20T09:42:03.000-08:00
fix: correct incorrect comment &amp; function name about SchedulingGated
diff --git a/pkg/printers/internalversion/printers.go b/pkg/printers/internalversion/printers.go
@@ -836,7 +836,7 @@ func printPod(pod *api.Pod, options printers.GenerateOptions) ([]metav1.TableRow
 		reason = pod.Status.Reason
 	}
 
-	// If the Pod carries {type:PodScheduled, reason:WaitingForGates}, set reason to 'SchedulingGated'.
+	// If the Pod carries {type:PodScheduled, reason:SchedulingGated}, set reason to 'SchedulingGated'.
 	for _, condition := range pod.Status.Conditions {
 		if condition.Type == api.PodScheduled && condition.Reason == apiv1.PodReasonSchedulingGated {
 			reason = apiv1.PodReasonSchedulingGated
diff --git a/pkg/printers/internalversion/printers_test.go b/pkg/printers/internalversion/printers_test.go
@@ -1506,7 +1506,7 @@ func TestPrintPod(t *testing.T) {
 			[]metav1.TableRow{{Cells: []interface{}{"test14", "2/2", "Running", "9 (5d ago)", "<unknown>"}}},
 		},
 		{
-			// Test PodScheduled condition with reason WaitingForGates
+			// Test PodScheduled condition with reason SchedulingGated
 			api.Pod{
 				ObjectMeta: metav1.ObjectMeta{Name: "test15"},
 				Spec:       api.PodSpec{Containers: make([]api.Container, 2)},
diff --git a/pkg/registry/core/pod/strategy.go b/pkg/registry/core/pod/strategy.go
@@ -89,7 +89,7 @@ func (podStrategy) PrepareForCreate(ctx context.Context, obj runtime.Object) {
 
 	podutil.DropDisabledPodFields(pod, nil)
 
-	applyWaitingForSchedulingGatesCondition(pod)
+	applySchedulingGatedCondition(pod)
 	mutatePodAffinity(pod)
 }
 
@@ -737,9 +737,9 @@ func mutatePodAffinity(pod *api.Pod) {
 	}
 }
 
-// applyWaitingForSchedulingGatesCondition adds a {type:PodScheduled, reason:WaitingForGates} condition
+// applySchedulingGatedCondition adds a {type:PodScheduled, reason:SchedulingGated} condition
 // to a new-created Pod if necessary.
-func applyWaitingForSchedulingGatesCondition(pod *api.Pod) {
+func applySchedulingGatedCondition(pod *api.Pod) {
 	if !utilfeature.DefaultFeatureGate.Enabled(features.PodSchedulingReadiness) ||
 		len(pod.Spec.SchedulingGates) == 0 {
 		return
diff --git a/pkg/registry/core/pod/strategy_test.go b/pkg/registry/core/pod/strategy_test.go
@@ -312,7 +312,7 @@ func TestGetPodQOS(t *testing.T) {
 	}
 }
 
-func TestWaitingForGatesCondition(t *testing.T) {
+func TestSchedulingGatedCondition(t *testing.T) {
 	tests := []struct {
 		name           string
 		pod            *api.Pod

Original file line number	Diff line number	Diff line change
`@@ -836,7 +836,7 @@ func printPod(pod *api.Pod, options printers.GenerateOptions) ([]metav1.TableRow`
`836`	`836`	`reason = pod.Status.Reason`
`837`	`837`	`}`
`838`	`838`
`839`		`- // If the Pod carries {type:PodScheduled, reason:WaitingForGates}, set reason to 'SchedulingGated'.`
	`839`	`+ // If the Pod carries {type:PodScheduled, reason:SchedulingGated}, set reason to 'SchedulingGated'.`
`840`	`840`	`for _, condition := range pod.Status.Conditions {`
`841`	`841`	`if condition.Type == api.PodScheduled && condition.Reason == apiv1.PodReasonSchedulingGated {`
`842`	`842`	`reason = apiv1.PodReasonSchedulingGated`
Original file line number	Diff line number	Diff line change
`@@ -1506,7 +1506,7 @@ func TestPrintPod(t *testing.T) {`
`1506`	`1506`	`[]metav1.TableRow{{Cells: []interface{}{"test14", "2/2", "Running", "9 (5d ago)", "<unknown>"}}},`
`1507`	`1507`	`},`
`1508`	`1508`	`{`
`1509`		`- // Test PodScheduled condition with reason WaitingForGates`
	`1509`	`+ // Test PodScheduled condition with reason SchedulingGated`
`1510`	`1510`	`api.Pod{`
`1511`	`1511`	`ObjectMeta: metav1.ObjectMeta{Name: "test15"},`
`1512`	`1512`	`Spec: api.PodSpec{Containers: make([]api.Container, 2)},`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ func (podStrategy) PrepareForCreate(ctx context.Context, obj runtime.Object) {`
`89`	`89`
`90`	`90`	`podutil.DropDisabledPodFields(pod, nil)`
`91`	`91`
`92`		`- applyWaitingForSchedulingGatesCondition(pod)`
	`92`	`+ applySchedulingGatedCondition(pod)`
`93`	`93`	`mutatePodAffinity(pod)`
`94`	`94`	`}`
`95`	`95`
`@@ -737,9 +737,9 @@ func mutatePodAffinity(pod *api.Pod) {`
`737`	`737`	`}`
`738`	`738`	`}`
`739`	`739`
`740`		`-// applyWaitingForSchedulingGatesCondition adds a {type:PodScheduled, reason:WaitingForGates} condition`
	`740`	`+// applySchedulingGatedCondition adds a {type:PodScheduled, reason:SchedulingGated} condition`
`741`	`741`	`// to a new-created Pod if necessary.`
`742`		`-func applyWaitingForSchedulingGatesCondition(pod *api.Pod) {`
	`742`	`+func applySchedulingGatedCondition(pod *api.Pod) {`
`743`	`743`	`if !utilfeature.DefaultFeatureGate.Enabled(features.PodSchedulingReadiness) \|\|`
`744`	`744`	`len(pod.Spec.SchedulingGates) == 0 {`
`745`	`745`	`return`
Original file line number	Diff line number	Diff line change
`@@ -312,7 +312,7 @@ func TestGetPodQOS(t *testing.T) {`
`312`	`312`	`}`
`313`	`313`	`}`
`314`	`314`
`315`		`-func TestWaitingForGatesCondition(t *testing.T) {`
	`315`	`+func TestSchedulingGatedCondition(t *testing.T) {`
`316`	`316`	`tests := []struct {`
`317`	`317`	`name string`
`318`	`318`	`pod *api.Pod`