Get controller.go test coverage to 100%

Author: pwittrock

pkg/controller/controller.go

@@ -93,6 +93,8 @@ type controller struct {
 	// the queue for processing
 	queue workqueue.RateLimitingInterface
 
+	jitterPeriod time.Duration
+
 	// once ensures unspecified fields get default values
 	once sync.Once
 
@@ -102,6 +104,8 @@ type controller struct {
 	// mu is used to synchronize controller setup
 	mu sync.Mutex
 
+	waitForCache func(stopCh <-chan struct{}, cacheSyncs ...cache.InformerSynced) bool
+
 	// TODO(pwittrock): Consider initializing a logger with the controller name as the tag
 }
 
@@ -145,21 +149,33 @@ func (c *controller) Start(stop <-chan struct{}) error {
 	for _, informer := range allInformers {
 		syncedFuncs = append(syncedFuncs, informer.HasSynced)
 	}
-	if ok := cache.WaitForCacheSync(stop, syncedFuncs...); !ok {
+
+	// Allow waitForCache to be mocked out for tests
+	if c.waitForCache == nil {
+		c.waitForCache = cache.WaitForCacheSync
+	}
+	if ok := c.waitForCache(stop, syncedFuncs...); !ok {
+		// This code is unreachable right now since WaitForCacheSync will never return an error
+		// Leaving it here because that could happen in the future
 		err := fmt.Errorf("failed to wait for %s caches to sync", c.name)
 		log.Error(err, "Could not wait for Cache to sync", "controller", c.name)
 		return err
 	}
 
+	if c.jitterPeriod == 0 {
+		c.jitterPeriod = time.Second
+	}
+
 	// Launch two workers to process resources
 	log.Info("Starting workers", "controller", c.name, "WorkerCount", c.maxConcurrentReconciles)
 	for i := 0; i < c.maxConcurrentReconciles; i++ {
-		// Continually process work items
+		// Process work items
 		go wait.Until(func() {
-			// TODO(pwittrock): Should we really use wait.Until to continuously restart this if it exits?
+			fmt.Printf("Running\n")
 			for c.processNextWorkItem() {
 			}
-		}, time.Second, stop)
+			fmt.Printf("Stopping\n")
+		}, c.jitterPeriod, stop)
 	}
 
 	<-stop
@@ -174,13 +190,12 @@ func (c *controller) processNextWorkItem() bool {
 
 	obj, shutdown := c.queue.Get()
 	if obj == nil {
-		log.Error(nil, "Encountered nil Request", "Object", obj)
+		// Sometimes the queue gives us nil items when it starts up
 		c.queue.Forget(obj)
 	}
 
 	if shutdown {
-		// Return false, this will cause the controller to back off for a second before trying again.
-		// TODO(community): This was copied from the sample-controller.  Figure out why / if we need this.
+		// Stop working
 		return false
 	}
 
@@ -210,8 +225,6 @@ func (c *controller) processNextWorkItem() bool {
 		c.queue.AddRateLimited(req)
 		log.Error(nil, "reconcile error", "controller", c.name, "Request", req)
 
-		// Return false, this will cause the controller to back off for a second before trying again.
-		// TODO(community): This was copied from the sample-controller.  Figure out why / if we need this.
 		return false
 	} else if result.Requeue {
 		c.queue.AddRateLimited(req)

pkg/controller/controller_manger_test.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2018 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package controller
+
+import (
+	. "github.com/onsi/ginkgo"
+)
+
+var _ = Describe("controller", func() {
+	BeforeEach(func() {
+	})
+
+	AfterEach(func() {
+	})
+
+	Describe("", func() {
+
+		It("should do something", func() {
+
+		})
+	})
+})

pkg/controller/controller_suite_test.go renamed to pkg/controller/controller_suite_integration_test.go

@@ -31,7 +31,7 @@ import (
 
 func TestSource(t *testing.T) {
 	RegisterFailHandler(Fail)
-	RunSpecsWithDefaultAndCustomReporters(t, "controller Suite", []Reporter{test.NewlineReporter{}})
+	RunSpecsWithDefaultAndCustomReporters(t, "Controller Integration Suite", []Reporter{test.NewlineReporter{}})
 }
 
 var testenv *test.Environment
@@ -40,7 +40,7 @@ var clientset *kubernetes.Clientset
 var icache informer.Informers
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(logf.ZapLogger(true))
+	logf.SetLogger(logf.ZapLogger(false))
 
 	testenv = &test.Environment{}