fix: Result.Requeue Deprecation

With the update to controller-runtime v0.21.0, the `Result.Requeue`
field is deprecated. This change updates all references of
`Result.Requeue` to either have no value (do not requeue) or set its
replacement `Result.RequeueAfter` to a 1-second delay.

Assisted-by: Cursor
Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>

Author: adambkaplan

controllers/result.go

@@ -1,12 +1,14 @@
 package controllers
 
 import (
+	"time"
+
 	ctrl "sigs.k8s.io/controller-runtime"
 )
 
 // Requeue triggers a object requeue.
 func Requeue() (ctrl.Result, error) {
-	return ctrl.Result{Requeue: true}, nil
+	return ctrl.Result{RequeueAfter: 1 * time.Second}, nil
 }
 
 // RequeueOnError triggers requeue when error is not nil.
@@ -16,10 +18,10 @@ func RequeueOnError(err error) (ctrl.Result, error) {
 
 // RequeueWithError triggers a object requeue because the informed error happend.
 func RequeueWithError(err error) (ctrl.Result, error) {
-	return ctrl.Result{Requeue: true}, err
+	return ctrl.Result{RequeueAfter: 1 * time.Second}, err
 }
 
 // NoRequeue all done, the object does not need reconciliation anymore.
 func NoRequeue() (ctrl.Result, error) {
-	return ctrl.Result{Requeue: false}, nil
+	return ctrl.Result{}, nil
 }

controllers/shipwrightbuild_controller.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"fmt"
 	"path/filepath"
+	"time"
 
 	"github.com/go-logr/logr"
 	"github.com/manifestival/manifestival"
@@ -180,7 +181,11 @@ func (r *ShipwrightBuildReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 	// ReconcileTekton
 	_, requeue, err := tekton.ReconcileTekton(ctx, r.CRDClient, r.TektonOperatorClient)
 	if err != nil {
-		return ctrl.Result{Requeue: requeue}, err
+		requeueInterval := 0 * time.Second
+		if requeue {
+			requeueInterval = 1 * time.Second
+		}
+		return ctrl.Result{RequeueAfter: requeueInterval}, err
 	}
 	if requeue {
 		return Requeue()
@@ -261,7 +266,11 @@ func (r *ShipwrightBuildReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 	if common.BoolFromEnvVar(UseManagedWebhookCerts) {
 		requeue, err = certmanager.ReconcileCertManager(ctx, r.CRDClient, r.Client, r.Logger, targetNamespace)
 		if err != nil {
-			return ctrl.Result{Requeue: requeue}, err
+			requeueInterval := 0 * time.Second
+			if requeue {
+				requeueInterval = 1 * time.Second
+			}
+			return ctrl.Result{RequeueAfter: requeueInterval}, err
 		}
 		if requeue {
 			return Requeue()

controllers/shipwrightbuild_controller_test.go

@@ -176,7 +176,7 @@ func testShipwrightBuildReconcilerReconcile(t *testing.T, targetNamespace string
 		// This makes testing brittle and unable to capture the behavior on a real cluster.
 		// Requeue can return "true" because the tests think the CRD for ClusterBuildStrategies
 		// do not exist yet.
-		g.Expect(res.Requeue).To(o.BeTrue(), "checking requeue for Reconcile")
+		g.Expect(res.RequeueAfter).NotTo(o.BeZero(), "checking requeue for Reconcile")
 		err = c.Get(ctx, deploymentName, &appsv1.Deployment{})
 		g.Expect(err).To(o.BeNil())
 		err = c.Get(ctx, namespacedName, b)
@@ -199,7 +199,7 @@ func testShipwrightBuildReconcilerReconcile(t *testing.T, targetNamespace string
 		// This makes testing brittle and unable to capture the behavior on a real cluster.
 		// Requeue can return "true" because the tests think the CRD for ClusterBuildStrategies
 		// do not exist yet.
-		g.Expect(res.Requeue).To(o.BeTrue())
+		g.Expect(res.RequeueAfter).NotTo(o.BeZero())
 		err = c.Get(ctx, deploymentName, deployment)
 		g.Expect(err).To(o.BeNil())
 		containers := deployment.Spec.Template.Spec.Containers
@@ -229,7 +229,7 @@ func testShipwrightBuildReconcilerReconcile(t *testing.T, targetNamespace string
 
 		res, err := r.Reconcile(ctx, req)
 		g.Expect(err).To(o.BeNil())
-		g.Expect(res.Requeue).To(o.BeFalse())
+		g.Expect(res.RequeueAfter).To(o.BeZero())
 
 		err = c.Get(ctx, deploymentName, &appsv1.Deployment{})
 		g.Expect(errors.IsNotFound(err)).To(o.BeTrue())
@@ -342,7 +342,7 @@ func TestShipwrightBuildReconciler_OperandReadiness(t *testing.T) {
 	req := reconcile.Request{NamespacedName: namespacedName}
 	res, err := r.Reconcile(ctx, req)
 	g.Expect(err).To(o.BeNil())
-	g.Expect(res.Requeue).To(o.BeTrue(), "Reconciliation should requeue when TektonConfig is not ready")
+	g.Expect(res.RequeueAfter).NotTo(o.BeZero(), "Reconciliation should requeue when TektonConfig is not ready")
 
 	// Verify that the ShipwrightBuild is marked as not ready
 	updated := &v1alpha1.ShipwrightBuild{}
@@ -363,7 +363,7 @@ func TestShipwrightBuildReconciler_OperandReadiness(t *testing.T) {
 	// Trigger reconciliation again
 	res, err = r.Reconcile(ctx, req)
 	g.Expect(err).To(o.BeNil())
-	g.Expect(res.Requeue).To(o.BeFalse(), "Should not requeue after TektonConfig is ready")
+	g.Expect(res.RequeueAfter).To(o.BeZero(), "Should not requeue after TektonConfig is ready")
 
 	// Fetch and verify ShipwrightBuild is now ready
 	err = c.Get(ctx, req.NamespacedName, updated)

pkg/certmanager/cert_manager.go

@@ -36,14 +36,14 @@ func ReconcileCertManager(ctx context.Context, crdClient crdclientv1.Apiextensio
 
 	manifest, err := common.SetupManifestival(client, "certificates.yaml", false, logger)
 	if err != nil {
-		return true, fmt.Errorf("Error creating inital certificates manifest")
+		return true, fmt.Errorf("error creating inital certificates manifest")
 	}
 	manifest, err = manifest.
 		Filter(mf.Not(mf.ByKind("Namespace"))).
 		Transform(mf.InjectNamespace(namespace), injectDnsNames(buildCertDomains(namespace)))
 
 	if err != nil {
-		return true, fmt.Errorf("Error transorming manifest using target namespace")
+		return true, fmt.Errorf("error transorming manifest using target namespace")
 	}
 
 	if err = manifest.Apply(); err != nil {