Merge pull request #113 from chentao1596/add-unit-test-for-queue

Add condition of enqueue and unit test cases for task.Queue

core/pkg/task/queue.go

@@ -51,6 +51,11 @@ func (t *Queue) Run(period time.Duration, stopCh <-chan struct{}) {
 
 // Enqueue enqueues ns/name of the given api object in the task queue.
 func (t *Queue) Enqueue(obj interface{}) {
+	if t.IsShuttingDown() {
+		glog.Errorf("queue has been shutdown, failed to enqueue: %v", obj)
+		return
+	}
+
 	glog.V(3).Infof("queuing item %v", obj)
 	key, err := t.fn(obj)
 	if err != nil {

core/pkg/task/queue_test.go

@@ -0,0 +1,132 @@
+/*
+Copyright 2017 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 task
+
+import (
+	"fmt"
+	"testing"
+	"time"
+)
+
+var sr int = 0
+
+type mockEnqueueObj struct {
+	k string
+	v string
+}
+
+func mockSynFn(interface{}) error {
+	// sr will be plus one times after enqueue
+	sr++
+	return nil
+}
+
+func mockKeyFn(interface{}) (interface{}, error) {
+	return mockEnqueueObj{
+		k: "static_key",
+		v: "static_value",
+	}, nil
+}
+
+func mockErrorKeyFn(interface{}) (interface{}, error) {
+	return nil, fmt.Errorf("failed to get key")
+}
+
+func TestShutdown(t *testing.T) {
+	q := NewTaskQueue(mockSynFn)
+	stopCh := make(chan struct{})
+	// run queue
+	go q.Run(10*time.Second, stopCh)
+	q.Shutdown()
+	s := q.IsShuttingDown()
+	if !s {
+		t.Fatalf("queue shoule be shutdown")
+	}
+}
+
+func TestEnqueueSuccess(t *testing.T) {
+	// initialize result
+	sr = 0
+	q := NewCustomTaskQueue(mockSynFn, mockKeyFn)
+	stopCh := make(chan struct{})
+	// run queue
+	go q.Run(10*time.Second, stopCh)
+	// mock object whichi will be enqueue
+	mo := mockEnqueueObj{
+		k: "testKey",
+		v: "testValue",
+	}
+	q.Enqueue(mo)
+	// wait for 'mockSynFn'
+	time.Sleep(time.Millisecond * 10)
+	if sr != 1 {
+		t.Errorf("sr should be 1, but is %d", sr)
+	}
+
+	// shutdown queue before exit
+	q.Shutdown()
+}
+
+func TestEnqueueFailed(t *testing.T) {
+	// initialize result
+	sr = 0
+	q := NewCustomTaskQueue(mockSynFn, mockKeyFn)
+	stopCh := make(chan struct{})
+	// run queue
+	go q.Run(10*time.Second, stopCh)
+	// mock object whichi will be enqueue
+	mo := mockEnqueueObj{
+		k: "testKey",
+		v: "testValue",
+	}
+
+	// shutdown queue before enqueue
+	q.Shutdown()
+	// wait for shutdown
+	time.Sleep(time.Millisecond * 10)
+	q.Enqueue(mo)
+	// wait for 'mockSynFn'
+	time.Sleep(time.Millisecond * 10)
+	// queue is shutdown, so mockSynFn should not be executed, so the result should be 0
+	if sr != 0 {
+		t.Errorf("queue has been shutdown, so sr should be 0, but is %d", sr)
+	}
+}
+
+func TestEnqueueKeyError(t *testing.T) {
+	// initialize result
+	sr = 0
+	q := NewCustomTaskQueue(mockSynFn, mockErrorKeyFn)
+	stopCh := make(chan struct{})
+	// run queue
+	go q.Run(10*time.Second, stopCh)
+	// mock object whichi will be enqueue
+	mo := mockEnqueueObj{
+		k: "testKey",
+		v: "testValue",
+	}
+
+	q.Enqueue(mo)
+	// wait for 'mockSynFn'
+	time.Sleep(time.Millisecond * 10)
+	// key error, so the result should be 0
+	if sr != 0 {
+		t.Errorf("error occurs while get key, so sr should be 0, but is %d", sr)
+	}
+	// shutdown queue before exit
+	q.Shutdown()
+}