Change naming and add subtests

Author: bjee19

internal/framework/status/conditionWithContextFunc_test.go

@@ -6,16 +6,11 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-//go:generate go run github.com./maxbrunsfeld/counterfeiter/v6 . StatusUpdater
+//go:generate go run github.com./maxbrunsfeld/counterfeiter/v6 . K8sUpdater
 
-// StatusUpdater updates a resource from the k8s API.
+// K8sUpdater updates a resource from the k8s API.
 // It allows us to mock the client.Reader.Status.Update method.
-//
-// There already is an interface in updater.go that is named "Updater"
-// so naming this StatusUpdater works, but the linter does not like
-// the interface name starting with the package name.
-// nolint:revive
-type StatusUpdater interface {
+type K8sUpdater interface {
 	// Update is from client.StatusClient.SubResourceWriter.
 	Update(ctx context.Context, obj client.Object, opts ...client.SubResourceUpdateOption) error
 }

internal/framework/status/status_updater.go renamed to internal/framework/status/k8s_updater.go

@@ -238,7 +238,7 @@ func (upd *UpdaterImpl) writeStatuses(
 			Cap:      time.Millisecond * 3000,
 		},
 		// Function returns true if the condition is satisfied, or an error if the loop should be aborted.
-		ConditionWithContextFunc(upd.cfg.Client, upd.cfg.Client.Status(), nsname, obj, upd.cfg.Logger, statusSetter),
+		NewRetryUpdateFunc(upd.cfg.Client, upd.cfg.Client.Status(), nsname, obj, upd.cfg.Logger, statusSetter),
 	)
 	if err != nil && !errors.Is(err, context.Canceled) {
 		upd.cfg.Logger.Error(
@@ -250,7 +250,7 @@ func (upd *UpdaterImpl) writeStatuses(
 	}
 }
 
-// ConditionWithContextFunc returns a function which will be used in wait.ExponentialBackoffWithContext.
+// NewRetryUpdateFunc returns a function which will be used in wait.ExponentialBackoffWithContext.
 // The function will attempt to Update a kubernetes resource and will be retried in
 // wait.ExponentialBackoffWithContext if an error occurs. Exported for testing purposes.
 //
@@ -259,9 +259,9 @@ func (upd *UpdaterImpl) writeStatuses(
 // the linter will complain if we return nil if an error was found.
 //
 //nolint:nilerr
-func ConditionWithContextFunc(
+func NewRetryUpdateFunc(
 	getter controller.Getter,
-	updater StatusUpdater,
+	updater K8sUpdater,
 	nsname types.NamespacedName,
 	obj client.Object,
 	logger logr.Logger,

internal/framework/status/statusfakes/fake_status_updater.go renamed to internal/framework/status/statusfakes/fake_k8s_updater.go

@@ -0,0 +1,78 @@
+package status_test
+
+import (
+	"context"
+	"errors"
+	"testing"
+
+	. "github.com./onsi/gomega"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	"sigs.k8s.io/gateway-api/apis/v1beta1"
+
+	"github.com./nginxinc/nginx-gateway-fabric/internal/framework/controller/controllerfakes"
+	"github.com./nginxinc/nginx-gateway-fabric/internal/framework/status"
+	"github.com./nginxinc/nginx-gateway-fabric/internal/framework/status/statusfakes"
+)
+
+func TestNewRetryUpdateFunc(t *testing.T) {
+	tests := []struct {
+		getReturns         error
+		updateReturns      error
+		name               string
+		expConditionPassed bool
+	}{
+		{
+			getReturns:         errors.New("failed to get resource"),
+			updateReturns:      nil,
+			name:               "get fails",
+			expConditionPassed: false,
+		},
+		{
+			getReturns:         apierrors.NewNotFound(schema.GroupResource{}, "not found"),
+			updateReturns:      nil,
+			name:               "get fails and apierrors is not found",
+			expConditionPassed: true,
+		},
+		{
+			getReturns:         nil,
+			updateReturns:      errors.New("failed to update resource"),
+			name:               "update fails",
+			expConditionPassed: false,
+		},
+		{
+			getReturns:         nil,
+			updateReturns:      nil,
+			name:               "nothing fails",
+			expConditionPassed: true,
+		},
+	}
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			g := NewWithT(t)
+			fakeStatusUpdater := &statusfakes.FakeK8sUpdater{}
+			fakeGetter := &controllerfakes.FakeGetter{}
+			fakeStatusUpdater.UpdateReturns(test.updateReturns)
+			fakeGetter.GetReturns(test.getReturns)
+			f := status.NewRetryUpdateFunc(
+				fakeGetter,
+				fakeStatusUpdater,
+				types.NamespacedName{},
+				&v1beta1.GatewayClass{},
+				zap.New(),
+				func(client.Object) {})
+			conditionPassed, err := f(context.Background())
+
+			// For now, the function should always return nil
+			g.Expect(err).ToNot(HaveOccurred())
+			if test.expConditionPassed {
+				g.Expect(conditionPassed).To(BeTrue())
+			} else {
+				g.Expect(conditionPassed).To(BeFalse())
+			}
+		})
+	}
+}