embed clock interface into templateinstance controller for testing

Author: Jim Minter

pkg/template/controller/readiness_test.go

@@ -194,7 +194,7 @@ func TestCheckReadiness(t *testing.T) {
 			groupKind: batch.Kind("Job"),
 			object: &batch.Job{
 				Status: batch.JobStatus{
-					CompletionTime: &metav1.Time{Time: time.Now()},
+					CompletionTime: &metav1.Time{Time: time.Unix(0, 0)},
 				},
 			},
 			expectedReady: true,

pkg/template/controller/templateinstance_controller.go

@@ -26,6 +26,7 @@ import (
 	kapi "k8s.io/kubernetes/pkg/apis/core"
 	kclientsetinternal "k8s.io/kubernetes/pkg/client/clientset_generated/internalclientset"
 	"k8s.io/kubernetes/pkg/kubectl/resource"
+	"k8s.io/utils/clock"
 
 	"github.com/golang/glog"
 	"github.com/prometheus/client_golang/prometheus"
@@ -66,6 +67,8 @@ type TemplateInstanceController struct {
 	queue workqueue.RateLimitingInterface
 
 	readinessLimiter workqueue.RateLimiter
+
+	clock clock.Clock
 }
 
 // NewTemplateInstanceController returns a new TemplateInstanceController.
@@ -80,6 +83,7 @@ func NewTemplateInstanceController(config *rest.Config, kc kclientsetinternal.In
 		informer:         informer.Informer(),
 		queue:            workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "openshift_template_instance_controller"),
 		readinessLimiter: workqueue.NewItemFastSlowRateLimiter(5*time.Second, 20*time.Second, 200),
+		clock:            clock.RealClock{},
 	}
 
 	c.informer.AddEventHandler(cache.ResourceEventHandlerFuncs{
@@ -144,7 +148,7 @@ func (c *TemplateInstanceController) sync(key string) error {
 	}
 
 	if !templateInstance.HasCondition(templateapi.TemplateInstanceInstantiateFailure, kapi.ConditionTrue) {
-		ready, err := c.checkReadiness(templateInstance, time.Now())
+		ready, err := c.checkReadiness(templateInstance)
 		if err != nil && !kerrors.IsTimeout(err) {
 			// NB: kerrors.IsTimeout() is true in the case of an API server
 			// timeout, not the timeout caused by readinessTimeout expiring.
@@ -196,8 +200,8 @@ func (c *TemplateInstanceController) sync(key string) error {
 	return nil
 }
 
-func (c *TemplateInstanceController) checkReadiness(templateInstance *templateapi.TemplateInstance, now time.Time) (bool, error) {
-	if now.After(templateInstance.CreationTimestamp.Add(readinessTimeout)) {
+func (c *TemplateInstanceController) checkReadiness(templateInstance *templateapi.TemplateInstance) (bool, error) {
+	if c.clock.Now().After(templateInstance.CreationTimestamp.Add(readinessTimeout)) {
 		return false, fmt.Errorf("Timeout")
 	}
 

pkg/template/controller/templateinstance_controller_test.go

@@ -16,6 +16,7 @@ import (
 	"k8s.io/kubernetes/pkg/apis/authorization"
 	kapi "k8s.io/kubernetes/pkg/apis/core"
 	"k8s.io/kubernetes/pkg/client/clientset_generated/internalclientset/fake"
+	"k8s.io/utils/clock"
 
 	templateapi "github.com/openshift/origin/pkg/template/apis/template"
 	restutil "github.com/openshift/origin/pkg/util/rest"
@@ -27,10 +28,21 @@ func (rt roundtripper) RoundTrip(r *http.Request) (*http.Response, error) {
 	return rt(r)
 }
 
+type fakeClock struct {
+	clock.RealClock
+	now time.Time
+}
+
+func (f *fakeClock) Now() time.Time {
+	return f.now
+}
+
 // TestControllerCheckReadiness verifies the basic behaviour of
 // TemplateInstanceController.checkReadiness(): that it can return ready, not
 // ready and timed out correctly.
 func TestControllerCheckReadiness(t *testing.T) {
+	clock := &fakeClock{now: time.Unix(0, 0)}
+
 	job := batchv1.Job{
 		TypeMeta: metav1.TypeMeta{
 			APIVersion: "batch/v1",
@@ -66,15 +78,15 @@ func TestControllerCheckReadiness(t *testing.T) {
 		restmapper: restutil.DefaultMultiRESTMapper(),
 		kc:         fakeclientset,
 		config:     fakerestconfig,
+		clock:      clock,
 	}
 	fakeclientset.AddReactor("create", "subjectaccessreviews", func(action clientgotesting.Action) (handled bool, ret runtime.Object, err error) {
 		return true, &authorization.SubjectAccessReview{Status: authorization.SubjectAccessReviewStatus{Allowed: true}}, nil
 	})
 
-	now := time.Now()
 	templateInstance := &templateapi.TemplateInstance{
 		ObjectMeta: metav1.ObjectMeta{
-			CreationTimestamp: metav1.Time{Time: now},
+			CreationTimestamp: metav1.Time{Time: clock.now},
 		},
 		Spec: templateapi.TemplateInstanceSpec{
 			Requester: &templateapi.TemplateInstanceRequester{},
@@ -94,27 +106,29 @@ func TestControllerCheckReadiness(t *testing.T) {
 	}
 
 	// should report not ready yet
-	ready, err := c.checkReadiness(templateInstance, now)
+	ready, err := c.checkReadiness(templateInstance)
 	if ready || err != nil {
 		t.Error(ready, err)
 	}
 
 	// should report timed out
-	ready, err = c.checkReadiness(templateInstance, now.Add(readinessTimeout+1))
+	clock.now = clock.now.Add(readinessTimeout + 1)
+	ready, err = c.checkReadiness(templateInstance)
 	if ready || err == nil || err.Error() != "Timeout" {
 		t.Error(ready, err)
 	}
 
 	// should report ready
-	job.Status.CompletionTime = &metav1.Time{Time: now}
-	ready, err = c.checkReadiness(templateInstance, now)
+	clock.now = time.Unix(0, 0)
+	job.Status.CompletionTime = &metav1.Time{Time: clock.now}
+	ready, err = c.checkReadiness(templateInstance)
 	if !ready || err != nil {
 		t.Error(ready, err)
 	}
 
 	// should report failed
-	job.Status.Failed = int32(1)
-	ready, err = c.checkReadiness(templateInstance, now)
+	job.Status.Failed = 1
+	ready, err = c.checkReadiness(templateInstance)
 	if ready || err == nil || err.Error() != "Readiness failed on Job namespace/name" {
 		t.Error(ready, err)
 	}