Skip to content

Commit 9aff561

Browse files
sivcharisivchari
committed
migrate Requeue to RequeueAfter
Signed-off-by: sivchari <[email protected]>
1 parent bfb09ac commit 9aff561

File tree

15 files changed

+51
-59
lines changed

15 files changed

+51
-59
lines changed

‎.golangci.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,10 +265,6 @@ linters:
265265
- linters:
266266
- staticcheck
267267
text: 'SA1019: .*\.Deprecated\.V1Beta1.* is deprecated'
268-
# CR v0.21 deprecated Result.Requeue, will be fixed incrementally and tracked via https://github.com/kubernetes-sigs/cluster-api/issues/12272
269-
- linters:
270-
- staticcheck
271-
text: 'SA1019: .*(res|result|i|j)\.Requeue is deprecated: Use `RequeueAfter` instead'
272268
# TODO: var-naming: avoid meaningless package names by revive
273269
# * test/infrastructure/docker/internal/docker/types/
274270
# * bootstrap/kubeadm/types/

‎bootstrap/kubeadm/internal/controllers/kubeadmconfig_controller_reconciler_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ package controllers
1818

1919
import (
2020
"testing"
21+
"time"
2122

2223
. "github.com/onsi/gomega"
2324
ctrl "sigs.k8s.io/controller-runtime"
@@ -61,7 +62,7 @@ func TestKubeadmConfigReconciler(t *testing.T) {
6162
},
6263
})
6364
g.Expect(err).To(Succeed())
64-
g.Expect(result.Requeue).To(BeFalse())
65+
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
6566
})
6667
})
6768
}

‎bootstrap/kubeadm/internal/controllers/kubeadmconfig_controller_test.go

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,6 @@ func TestKubeadmConfigReconciler_Reconcile_ReturnEarlyIfKubeadmConfigIsReady(t *
124124
}
125125
result, err := k.Reconcile(ctx, request)
126126
g.Expect(err).ToNot(HaveOccurred())
127-
g.Expect(result.Requeue).To(BeFalse())
128127
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
129128
}
130129

@@ -297,7 +296,6 @@ func TestKubeadmConfigReconciler_Reconcile_ReturnEarlyIfMachineHasDataSecretName
297296
actual := &bootstrapv1.KubeadmConfig{}
298297
g.Expect(myclient.Get(ctx, client.ObjectKey{Namespace: config.Namespace, Name: config.Name}, actual)).To(Succeed())
299298
g.Expect(err).ToNot(HaveOccurred())
300-
g.Expect(result.Requeue).To(BeFalse())
301299
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
302300
assertHasTrueCondition(g, myclient, request, bootstrapv1.KubeadmConfigDataSecretAvailableCondition)
303301
}
@@ -476,7 +474,6 @@ func TestKubeadmConfigReconciler_Reconcile_RequeueJoiningNodesIfControlPlaneNotI
476474

477475
result, err := k.Reconcile(ctx, tc.request)
478476
g.Expect(err).ToNot(HaveOccurred())
479-
g.Expect(result.Requeue).To(BeFalse())
480477
g.Expect(result.RequeueAfter).To(Equal(30 * time.Second))
481478
assertHasFalseCondition(g, myclient, tc.request, bootstrapv1.KubeadmConfigDataSecretAvailableCondition, bootstrapv1.KubeadmConfigDataSecretNotAvailableReason)
482479
})
@@ -528,7 +525,6 @@ func TestKubeadmConfigReconciler_Reconcile_GenerateCloudConfigData(t *testing.T)
528525

529526
result, err := k.Reconcile(ctx, request)
530527
g.Expect(err).ToNot(HaveOccurred())
531-
g.Expect(result.Requeue).To(BeFalse())
532528
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
533529

534530
cfg, err := getKubeadmConfig(myclient, "control-plane-init-cfg", metav1.NamespaceDefault)
@@ -631,7 +627,6 @@ func TestKubeadmConfigReconciler_Reconcile_RequeueIfControlPlaneIsMissingAPIEndp
631627
}
632628
result, err := k.Reconcile(ctx, request)
633629
g.Expect(err).ToNot(HaveOccurred())
634-
g.Expect(result.Requeue).To(BeFalse())
635630
g.Expect(result.RequeueAfter).To(Equal(10 * time.Second))
636631

637632
actualConfig := &bootstrapv1.KubeadmConfig{}
@@ -709,7 +704,6 @@ func TestReconcileIfJoinCertificatesAvailableConditioninNodesAndControlPlaneIsRe
709704
}
710705
result, err := k.Reconcile(ctx, request)
711706
g.Expect(err).ToNot(HaveOccurred())
712-
g.Expect(result.Requeue).To(BeFalse())
713707
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
714708

715709
cfg, err := getKubeadmConfig(myclient, rt.configName, metav1.NamespaceDefault)
@@ -786,7 +780,6 @@ func TestReconcileIfJoinNodePoolsAndControlPlaneIsReady(t *testing.T) {
786780
}
787781
result, err := k.Reconcile(ctx, request)
788782
g.Expect(err).ToNot(HaveOccurred())
789-
g.Expect(result.Requeue).To(BeFalse())
790783
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
791784

792785
cfg, err := getKubeadmConfig(myclient, rt.configName, metav1.NamespaceDefault)
@@ -993,7 +986,6 @@ func TestKubeadmConfigSecretCreatedStatusNotPatched(t *testing.T) {
993986
g.Expect(err).ToNot(HaveOccurred())
994987
result, err := k.Reconcile(ctx, request)
995988
g.Expect(err).ToNot(HaveOccurred())
996-
g.Expect(result.Requeue).To(BeFalse())
997989
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
998990

999991
cfg, err := getKubeadmConfig(myclient, "worker-join-cfg", metav1.NamespaceDefault)
@@ -1236,7 +1228,6 @@ func TestBootstrapTokenTTLExtension(t *testing.T) {
12361228
} {
12371229
result, err := k.Reconcile(ctx, req)
12381230
g.Expect(err).ToNot(HaveOccurred())
1239-
g.Expect(result.Requeue).To(BeFalse())
12401231
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
12411232
}
12421233

@@ -2085,7 +2076,6 @@ func TestKubeadmConfigReconciler_Reconcile_ExactlyOneControlPlaneMachineInitiali
20852076
}
20862077
result, err := k.Reconcile(ctx, request)
20872078
g.Expect(err).ToNot(HaveOccurred())
2088-
g.Expect(result.Requeue).To(BeFalse())
20892079
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
20902080

20912081
request = ctrl.Request{
@@ -2096,7 +2086,6 @@ func TestKubeadmConfigReconciler_Reconcile_ExactlyOneControlPlaneMachineInitiali
20962086
}
20972087
result, err = k.Reconcile(ctx, request)
20982088
g.Expect(err).ToNot(HaveOccurred())
2099-
g.Expect(result.Requeue).To(BeFalse())
21002089
g.Expect(result.RequeueAfter).To(Equal(30 * time.Second))
21012090
confList := &bootstrapv1.KubeadmConfigList{}
21022091
g.Expect(myclient.List(ctx, confList)).To(Succeed())
@@ -2151,7 +2140,6 @@ func TestKubeadmConfigReconciler_Reconcile_PatchWhenErrorOccurred(t *testing.T)
21512140

21522141
result, err := k.Reconcile(ctx, request)
21532142
g.Expect(err).To(HaveOccurred())
2154-
g.Expect(result.Requeue).To(BeFalse())
21552143
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
21562144

21572145
cfg, err := getKubeadmConfig(myclient, "control-plane-init-cfg", metav1.NamespaceDefault)

‎controlplane/kubeadm/internal/controllers/consts.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,10 @@ const (
3030
// dependentCertRequeueAfter is how long to wait before checking again to see if
3131
// dependent certificates have been created.
3232
dependentCertRequeueAfter = 30 * time.Second
33+
34+
// scaleRequeueAfter is how long to wait before scaling up/down again after a scale operation has been requested.
35+
scaleRequeueAfter = 15 * time.Second
36+
37+
// initializationRequeueAfter is how long to wait before checking again to see if the initialization has been completed.
38+
initializationRequeueAfter = 15 * time.Second
3339
)

‎controlplane/kubeadm/internal/controllers/controller.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,7 @@ func (r *KubeadmControlPlaneReconciler) Reconcile(ctx context.Context, req ctrl.
194194
// Initialize the patch helper.
195195
patchHelper, err := patch.NewHelper(kcp, r.Client)
196196
if err != nil {
197-
log.Error(err, "Failed to configure the patch helper")
198-
return ctrl.Result{Requeue: true}, nil
197+
return ctrl.Result{}, errors.Wrap(err, "failed to configure the patch helper")
199198
}
200199

201200
if isPaused, requeue, err := paused.EnsurePausedCondition(ctx, r.Client, cluster, kcp); err != nil || isPaused || requeue {
@@ -506,8 +505,7 @@ func (r *KubeadmControlPlaneReconciler) reconcile(ctx context.Context, controlPl
506505
// Get the workload cluster client.
507506
workloadCluster, err := controlPlane.GetWorkloadCluster(ctx)
508507
if err != nil {
509-
log.V(2).Info("cannot get remote client to workload cluster, will requeue", "cause", err)
510-
return ctrl.Result{Requeue: true}, nil
508+
return ctrl.Result{}, errors.Wrapf(err, "cannot get remote client to workload cluster for KubeadmControlPlane %s/%s", controlPlane.KCP.Namespace, controlPlane.KCP.Name)
511509
}
512510

513511
// Update kube-proxy daemonset.

‎controlplane/kubeadm/internal/controllers/controller_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ func TestReconcileClusterNoEndpoints(t *testing.T) {
482482
result, err = r.Reconcile(ctx, ctrl.Request{NamespacedName: util.ObjectKey(kcp)})
483483
g.Expect(err).ToNot(HaveOccurred())
484484
// TODO: this should stop to re-queue as soon as we have a proper remote cluster cache in place.
485-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: false, RequeueAfter: 20 * time.Second}))
485+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: 20 * time.Second}))
486486
g.Expect(r.Client.Get(ctx, util.ObjectKey(kcp), kcp)).To(Succeed())
487487

488488
// Always expect that the Finalizer is set on the passed in resource

‎controlplane/kubeadm/internal/controllers/remediation.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ func (r *KubeadmControlPlaneReconciler) reconcileUnhealthyMachines(ctx context.C
368368
controlplanev1.RemediationInProgressAnnotation: remediationInProgressValue,
369369
})
370370

371-
return ctrl.Result{Requeue: true}, nil
371+
return ctrl.Result{RequeueAfter: time.Second * 20}, nil
372372
}
373373

374374
// Gets the machine to be remediated, which is the "most broken" among the unhealthy machines, determined as the machine

‎controlplane/kubeadm/internal/controllers/scale.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func (r *KubeadmControlPlaneReconciler) initializeControlPlane(ctx context.Conte
6868
newMachine.Spec.Bootstrap.ConfigRef.Kind, klog.KRef(newMachine.Namespace, newMachine.Spec.Bootstrap.ConfigRef.Name))
6969

7070
// Requeue the control plane, in case there are additional operations to perform
71-
return ctrl.Result{Requeue: true}, nil
71+
return ctrl.Result{RequeueAfter: initializationRequeueAfter}, nil
7272
}
7373

7474
func (r *KubeadmControlPlaneReconciler) scaleUpControlPlane(ctx context.Context, controlPlane *internal.ControlPlane) (ctrl.Result, error) {
@@ -107,7 +107,7 @@ func (r *KubeadmControlPlaneReconciler) scaleUpControlPlane(ctx context.Context,
107107
newMachine.Spec.Bootstrap.ConfigRef.Kind, klog.KRef(newMachine.Namespace, newMachine.Spec.Bootstrap.ConfigRef.Name))
108108

109109
// Requeue the control plane, in case there are other operations to perform
110-
return ctrl.Result{Requeue: true}, nil
110+
return ctrl.Result{RequeueAfter: scaleRequeueAfter}, nil
111111
}
112112

113113
func (r *KubeadmControlPlaneReconciler) scaleDownControlPlane(
@@ -163,7 +163,7 @@ func (r *KubeadmControlPlaneReconciler) scaleDownControlPlane(
163163
Info("Deleting Machine (scale down)", "Machine", klog.KObj(machineToDelete))
164164

165165
// Requeue the control plane, in case there are additional operations to perform
166-
return ctrl.Result{Requeue: true}, nil
166+
return ctrl.Result{RequeueAfter: scaleRequeueAfter}, nil
167167
}
168168

169169
// preflightChecks checks if the control plane is stable before proceeding with a scale up/scale down operation,

‎controlplane/kubeadm/internal/controllers/scale_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func TestKubeadmControlPlaneReconciler_initializeControlPlane(t *testing.T) {
8181
}
8282

8383
result, err := r.initializeControlPlane(ctx, controlPlane)
84-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
84+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: initializationRequeueAfter}))
8585
g.Expect(err).ToNot(HaveOccurred())
8686

8787
machineList := &clusterv1.MachineList{}
@@ -161,7 +161,7 @@ func TestKubeadmControlPlaneReconciler_scaleUpControlPlane(t *testing.T) {
161161
}
162162

163163
result, err := r.scaleUpControlPlane(ctx, controlPlane)
164-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
164+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
165165
g.Expect(err).ToNot(HaveOccurred())
166166

167167
controlPlaneMachines := clusterv1.MachineList{}
@@ -285,7 +285,7 @@ func TestKubeadmControlPlaneReconciler_scaleDownControlPlane_NoError(t *testing.
285285

286286
result, err := r.scaleDownControlPlane(context.Background(), controlPlane, controlPlane.Machines)
287287
g.Expect(err).ToNot(HaveOccurred())
288-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
288+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
289289

290290
controlPlaneMachines := clusterv1.MachineList{}
291291
g.Expect(fakeClient.List(context.Background(), &controlPlaneMachines)).To(Succeed())
@@ -327,7 +327,7 @@ func TestKubeadmControlPlaneReconciler_scaleDownControlPlane_NoError(t *testing.
327327

328328
result, err := r.scaleDownControlPlane(context.Background(), controlPlane, controlPlane.Machines)
329329
g.Expect(err).ToNot(HaveOccurred())
330-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
330+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
331331

332332
controlPlaneMachines := clusterv1.MachineList{}
333333
g.Expect(fakeClient.List(context.Background(), &controlPlaneMachines)).To(Succeed())

‎controlplane/kubeadm/internal/controllers/upgrade_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ func TestKubeadmControlPlaneReconciler_RolloutStrategy_ScaleUp(t *testing.T) {
105105
controlPlane.InjectTestManagementCluster(r.managementCluster)
106106

107107
result, err := r.initializeControlPlane(ctx, controlPlane)
108-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
108+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: initializationRequeueAfter}))
109109
g.Expect(err).ToNot(HaveOccurred())
110110

111111
// initial setup
@@ -127,7 +127,7 @@ func TestKubeadmControlPlaneReconciler_RolloutStrategy_ScaleUp(t *testing.T) {
127127
needingUpgrade := collections.FromMachineList(initialMachine)
128128
controlPlane.Machines = needingUpgrade
129129
result, err = r.upgradeControlPlane(ctx, controlPlane, needingUpgrade)
130-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
130+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
131131
g.Expect(err).ToNot(HaveOccurred())
132132
bothMachines := &clusterv1.MachineList{}
133133
g.Eventually(func(g Gomega) {
@@ -170,7 +170,7 @@ func TestKubeadmControlPlaneReconciler_RolloutStrategy_ScaleUp(t *testing.T) {
170170
// run upgrade the second time, expect we scale down
171171
result, err = r.upgradeControlPlane(ctx, controlPlane, machinesRequireUpgrade)
172172
g.Expect(err).ToNot(HaveOccurred())
173-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
173+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
174174
finalMachine := &clusterv1.MachineList{}
175175
g.Eventually(func(g Gomega) {
176176
g.Expect(env.List(ctx, finalMachine, client.InNamespace(cluster.Namespace))).To(Succeed())
@@ -261,7 +261,7 @@ func TestKubeadmControlPlaneReconciler_RolloutStrategy_ScaleDown(t *testing.T) {
261261
controlPlane.Machines = needingUpgrade
262262

263263
result, err = r.upgradeControlPlane(ctx, controlPlane, needingUpgrade)
264-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
264+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
265265
g.Expect(err).ToNot(HaveOccurred())
266266
remainingMachines := &clusterv1.MachineList{}
267267
g.Expect(fakeClient.List(ctx, remainingMachines, client.InNamespace(cluster.Namespace))).To(Succeed())

0 commit comments

Comments
 (0)