Generate a fake clock

Author: pleshakov

internal/status/clock.go

@@ -1,10 +1,14 @@
 package status
 
-import "time"
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 . Clock
 
 // Clock returns the current local time.
 type Clock interface {
-	Now() time.Time
+	Now() metav1.Time
 }
 
 // Real clock returns the current local time.
@@ -17,21 +21,6 @@ func NewRealClock() *RealClock {
 }
 
 // Now returns the current local time.
-func (c *RealClock) Now() time.Time {
-	return time.Now()
-}
-
-// FakeClock allows you to control the returned time.
-type FakeClock struct {
-	time time.Time
-}
-
-// NewFakeClock creates a FakeClock. The clock will always return the specified time.
-func NewFakeClock(time time.Time) *FakeClock {
-	return &FakeClock{time: time}
-}
-
-// Now is a fake implementation of Now().
-func (c FakeClock) Now() time.Time {
-	return c.time
+func (c *RealClock) Now() metav1.Time {
+	return metav1.Now()
 }

internal/status/clock_test.go

@@ -13,7 +13,7 @@ import (
 // FIXME(pleshakov): Be compliant with in the Gateway API.
 // Currently, we only support simple valid/invalid status per each listener.
 // Extend support to cover more cases.
-func prepareGatewayStatus(statuses newstate.ListenerStatuses, clock Clock) v1alpha2.GatewayStatus {
+func prepareGatewayStatus(statuses newstate.ListenerStatuses, transitionTime metav1.Time) v1alpha2.GatewayStatus {
 	listenerStatuses := make([]v1alpha2.ListenerStatus, 0, len(statuses))
 
 	// FIXME(pleshakov) Maintain the order from the Gateway resource
@@ -41,7 +41,7 @@ func prepareGatewayStatus(statuses newstate.ListenerStatuses, clock Clock) v1alp
 			Status: metav1.ConditionStatus(status),
 			// FIXME(pleshakov) Set the observed generation to the last processed generation of the Gateway resource.
 			ObservedGeneration: 123,
-			LastTransitionTime: metav1.NewTime(clock.Now()),
+			LastTransitionTime: transitionTime,
 			Reason:             reason,
 			Message:            "", // FIXME(pleshakov) Come up with a good message
 		}

internal/status/gateway.go

@@ -23,8 +23,7 @@ func TestPrepareGatewayStatus(t *testing.T) {
 		},
 	}
 
-	expectedTime := time.Now()
-	clock := NewFakeClock(expectedTime)
+	transitionTime := metav1.NewTime(time.Now())
 
 	expected := v1alpha2.GatewayStatus{
 		Listeners: []v1alpha2.ListenerStatus{
@@ -41,7 +40,7 @@ func TestPrepareGatewayStatus(t *testing.T) {
 						Type:               string(v1alpha2.ListenerConditionReady),
 						Status:             "False",
 						ObservedGeneration: 123,
-						LastTransitionTime: metav1.Time{Time: expectedTime},
+						LastTransitionTime: transitionTime,
 						Reason:             string(v1alpha2.ListenerReasonInvalid),
 					},
 				},
@@ -59,15 +58,15 @@ func TestPrepareGatewayStatus(t *testing.T) {
 						Type:               string(v1alpha2.ListenerConditionReady),
 						Status:             "True",
 						ObservedGeneration: 123,
-						LastTransitionTime: metav1.Time{Time: expectedTime},
+						LastTransitionTime: transitionTime,
 						Reason:             string(v1alpha2.ListenerReasonReady),
 					},
 				},
 			},
 		},
 	}
 
-	result := prepareGatewayStatus(statuses, clock)
+	result := prepareGatewayStatus(statuses, transitionTime)
 	if diff := cmp.Diff(expected, result); diff != "" {
 		t.Errorf("prepareGatewayStatus() mismatch (-want +got):\n%s", diff)
 	}

internal/status/gateway_test.go

@@ -18,7 +18,7 @@ func prepareHTTPRouteStatus(
 	status newstate.HTTPRouteStatus,
 	gwNsName types.NamespacedName,
 	gatewayCtlrName string,
-	clock Clock,
+	transitionTime metav1.Time,
 ) v1alpha2.HTTPRouteStatus {
 	parents := make([]v1alpha2.RouteParentStatus, 0, len(status.ParentStatuses))
 
@@ -56,7 +56,7 @@ func prepareHTTPRouteStatus(
 					Status: metav1.ConditionStatus(status),
 					// FIXME(pleshakov) Set the observed generation to the last processed generation of the HTTPRoute resource.
 					ObservedGeneration: 123,
-					LastTransitionTime: metav1.NewTime(clock.Now()),
+					LastTransitionTime: transitionTime,
 					Reason:             reason,
 					Message:            "", // FIXME(pleshakov): Figure out a good message
 				},

internal/status/httproute.go

@@ -28,8 +28,7 @@ func TestPrepareHTTPRouteStatus(t *testing.T) {
 	gwNsName := types.NamespacedName{Namespace: "test", Name: "gateway"}
 	gatewayCtlrName := "test.example.com"
 
-	expectedTime := time.Now()
-	clock := NewFakeClock(expectedTime)
+	transitionTime := metav1.NewTime(time.Now())
 
 	expected := v1alpha2.HTTPRouteStatus{
 		RouteStatus: v1alpha2.RouteStatus{
@@ -46,7 +45,7 @@ func TestPrepareHTTPRouteStatus(t *testing.T) {
 							Type:               string(v1alpha2.ConditionRouteAccepted),
 							Status:             "True",
 							ObservedGeneration: 123,
-							LastTransitionTime: metav1.Time{Time: expectedTime},
+							LastTransitionTime: transitionTime,
 							Reason:             "Attached",
 						},
 					},
@@ -63,7 +62,7 @@ func TestPrepareHTTPRouteStatus(t *testing.T) {
 							Type:               string(v1alpha2.ConditionRouteAccepted),
 							Status:             "False",
 							ObservedGeneration: 123,
-							LastTransitionTime: metav1.Time{Time: expectedTime},
+							LastTransitionTime: transitionTime,
 							Reason:             "Not attached",
 						},
 					},
@@ -72,7 +71,7 @@ func TestPrepareHTTPRouteStatus(t *testing.T) {
 		},
 	}
 
-	result := prepareHTTPRouteStatus(status, gwNsName, gatewayCtlrName, clock)
+	result := prepareHTTPRouteStatus(status, gwNsName, gatewayCtlrName, transitionTime)
 	if diff := cmp.Diff(expected, result); diff != "" {
 		t.Errorf("prepareHTTPRouteStatus() mismatch (-want +got):\n%s", diff)
 	}

internal/status/httproute_test.go

@@ -88,7 +88,7 @@ func (upd *updaterImpl) Update(ctx context.Context, statuses newstate.Statuses)
 
 	upd.update(ctx, upd.gwNsName, &v1alpha2.Gateway{}, func(object client.Object) {
 		gw := object.(*v1alpha2.Gateway)
-		gw.Status = prepareGatewayStatus(statuses.ListenerStatuses, upd.clock)
+		gw.Status = prepareGatewayStatus(statuses.ListenerStatuses, upd.clock.Now())
 	})
 
 	for nsname, rs := range statuses.HTTPRouteStatuses {
@@ -100,7 +100,7 @@ func (upd *updaterImpl) Update(ctx context.Context, statuses newstate.Statuses)
 
 		upd.update(ctx, nsname, &v1alpha2.HTTPRoute{}, func(object client.Object) {
 			hr := object.(*v1alpha2.HTTPRoute)
-			hr.Status = prepareHTTPRouteStatus(rs, upd.gwNsName, upd.gatewayCtlrName, upd.clock)
+			hr.Status = prepareHTTPRouteStatus(rs, upd.gwNsName, upd.gatewayCtlrName, upd.clock.Now())
 		})
 	}
 }

internal/status/statusfakes/fake_clock.go

@@ -18,14 +18,14 @@ import (
 	"github.com/nginxinc/nginx-kubernetes-gateway/internal/helpers"
 	"github.com/nginxinc/nginx-kubernetes-gateway/internal/newstate"
 	"github.com/nginxinc/nginx-kubernetes-gateway/internal/status"
+	"github.com/nginxinc/nginx-kubernetes-gateway/internal/status/statusfakes"
 )
 
 var _ = Describe("Updater", func() {
 	var (
 		updater         status.Updater
 		client          client.Client
 		fakeClockTime   metav1.Time
-		fakeClock       *status.FakeClock
 		gatewayCtrlName string
 		gwNsName        types.NamespacedName
 	)
@@ -43,7 +43,8 @@ var _ = Describe("Updater", func() {
 		// We need to remove it, because updating the status in the FakeClient and then getting the resource back
 		// involves encoding and decoding the resource to/from JSON, which removes the monotonic clock reading.
 		fakeClockTime = metav1.NewTime(time.Now()).Rfc3339Copy()
-		fakeClock = status.NewFakeClock(fakeClockTime.Time)
+		fakeClock := &statusfakes.FakeClock{}
+		fakeClock.NowReturns(fakeClockTime)
 
 		gatewayCtrlName = "test.example.com"
 		gwNsName = types.NamespacedName{Namespace: "test", Name: "gateway"}