Add testing for ConditionWithContextFunc

Author: bjee19

internal/framework/status/conditionWithContextFunc_test.go

@@ -22,6 +22,7 @@ func TestConditionWithContextFunc_GetFails(t *testing.T) {
 	g := NewWithT(t)
 	fakeStatusUpdater := &statusfakes.FakeStatusUpdater{}
 	fakeGetter := &controllerfakes.FakeGetter{}
+
 	fakeGetter.GetReturns(errors.New("failed to get resource"))
 	f := status.ConditionWithContextFunc(
 		fakeGetter,
@@ -31,6 +32,7 @@ func TestConditionWithContextFunc_GetFails(t *testing.T) {
 		logr.New(nil),
 		func(client.Object) {})
 	boolean, err := f(context.Background())
+
 	g.Expect(err).ToNot(HaveOccurred())
 	g.Expect(boolean).To(BeFalse())
 }
@@ -39,6 +41,7 @@ func TestConditionWithContextFunc_GetFailsIsNotFound(t *testing.T) {
 	g := NewWithT(t)
 	fakeStatusUpdater := &statusfakes.FakeStatusUpdater{}
 	fakeGetter := &controllerfakes.FakeGetter{}
+
 	fakeGetter.GetReturns(apierrors.NewNotFound(schema.GroupResource{}, "not found"))
 	f := status.ConditionWithContextFunc(
 		fakeGetter,
@@ -48,6 +51,7 @@ func TestConditionWithContextFunc_GetFailsIsNotFound(t *testing.T) {
 		logr.New(nil),
 		func(client.Object) {})
 	boolean, err := f(context.Background())
+
 	g.Expect(err).ToNot(HaveOccurred())
 	g.Expect(boolean).To(BeTrue())
 }
@@ -56,6 +60,7 @@ func TestConditionWithContextFunc_UpdateFails(t *testing.T) {
 	g := NewWithT(t)
 	fakeStatusUpdater := &statusfakes.FakeStatusUpdater{}
 	fakeGetter := &controllerfakes.FakeGetter{}
+
 	fakeStatusUpdater.UpdateReturns(errors.New("failed to update resource"))
 	f := status.ConditionWithContextFunc(
 		fakeGetter,
@@ -65,6 +70,7 @@ func TestConditionWithContextFunc_UpdateFails(t *testing.T) {
 		logr.New(nil),
 		func(client.Object) {})
 	boolean, err := f(context.Background())
+
 	g.Expect(err).ToNot(HaveOccurred())
 	g.Expect(boolean).To(BeFalse())
 }
@@ -73,6 +79,7 @@ func TestConditionWithContextFunc_NothingFails(t *testing.T) {
 	g := NewWithT(t)
 	fakeStatusUpdater := &statusfakes.FakeStatusUpdater{}
 	fakeGetter := &controllerfakes.FakeGetter{}
+
 	f := status.ConditionWithContextFunc(
 		fakeGetter,
 		fakeStatusUpdater,
@@ -81,6 +88,7 @@ func TestConditionWithContextFunc_NothingFails(t *testing.T) {
 		logr.New(nil),
 		func(client.Object) {})
 	boolean, err := f(context.Background())
+
 	g.Expect(err).ToNot(HaveOccurred())
 	g.Expect(boolean).To(BeTrue())
 }

internal/framework/status/status_updater.go

@@ -11,6 +11,9 @@ import (
 // StatusUpdater 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 {
 	// Update is from client.StatusClient.SubResourceWriter.

internal/framework/status/updater.go

@@ -222,11 +222,6 @@ func (upd *UpdaterImpl) updateGatewayAPI(ctx context.Context, statuses GatewayAP
 	}
 }
 
-// The function in wait.ExponentialBackoffWithContext will retry if it returns nil as its error,
-// which is what we want if we encounter an error from the functions we call. However,
-// the linter will complain if we return nil if an error was found.
-//
-//nolint:nilerr
 func (upd *UpdaterImpl) writeStatuses(
 	ctx context.Context,
 	nsname types.NamespacedName,
@@ -256,7 +251,14 @@ func (upd *UpdaterImpl) writeStatuses(
 }
 
 // ConditionWithContextFunc returns a function which will be used in wait.ExponentialBackoffWithContext.
-// Exported for testing purposes.
+// The function will attempt to Update a kubernetes resource and will be retried in
+// wait.ExponentialBackoffWithContext if an error occurs. Exported for testing purposes.
+//
+// wait.ExponentialBackoffWithContext will retry if this function returns nil as its error,
+// which is what we want if we encounter an error from the functions we call. However,
+// the linter will complain if we return nil if an error was found.
+//
+//nolint:nilerr
 func ConditionWithContextFunc(
 	getter controller.Getter,
 	updater StatusUpdater,