Update dependencies

pkg/task/queue.go

@@ -0,0 +1,168 @@
+/*
+Copyright 2015 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"
+	"time"
+
+	"github.com/golang/glog"
+
+	"k8s.io/apimachinery/pkg/util/wait"
+	"k8s.io/client-go/tools/cache"
+	"k8s.io/client-go/util/workqueue"
+)
+
+var (
+	keyFunc = cache.DeletionHandlingMetaNamespaceKeyFunc
+)
+
+// Queue manages a time work queue through an independent worker that invokes the
+// given sync function for every work item inserted.
+// The queue uses an internal timestamp that allows the removal of certain elements
+// which timestamp is older than the last successful get operation.
+type Queue struct {
+	// queue is the work queue the worker polls
+	queue workqueue.RateLimitingInterface
+	// sync is called for each item in the queue
+	sync func(interface{}) error
+	// workerDone is closed when the worker exits
+	workerDone chan bool
+
+	fn func(obj interface{}) (interface{}, error)
+
+	lastSync int64
+}
+
+// Element represents one item of the queue
+type Element struct {
+	Key       interface{}
+	Timestamp int64
+}
+
+// Run ...
+func (t *Queue) Run(period time.Duration, stopCh <-chan struct{}) {
+	wait.Until(t.worker, period, stopCh)
+}
+
+// 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
+	}
+
+	ts := time.Now().UnixNano()
+	glog.V(3).Infof("queuing item %v", obj)
+	key, err := t.fn(obj)
+	if err != nil {
+		glog.Errorf("%v", err)
+		return
+	}
+	t.queue.Add(Element{
+		Key:       key,
+		Timestamp: ts,
+	})
+}
+
+func (t *Queue) defaultKeyFunc(obj interface{}) (interface{}, error) {
+	key, err := keyFunc(obj)
+	if err != nil {
+		return "", fmt.Errorf("could not get key for object %+v: %v", obj, err)
+	}
+
+	return key, nil
+}
+
+// worker processes work in the queue through sync.
+func (t *Queue) worker() {
+	for {
+		key, quit := t.queue.Get()
+		if quit {
+			if !isClosed(t.workerDone) {
+				close(t.workerDone)
+			}
+			return
+		}
+		ts := time.Now().UnixNano()
+
+		item := key.(Element)
+		if t.lastSync > item.Timestamp {
+			glog.V(3).Infof("skipping %v sync (%v > %v)", item.Key, t.lastSync, item.Timestamp)
+			t.queue.Forget(key)
+			t.queue.Done(key)
+			continue
+		}
+
+		glog.V(3).Infof("syncing %v", item.Key)
+		if err := t.sync(key); err != nil {
+			glog.Warningf("requeuing %v, err %v", item.Key, err)
+			t.queue.AddRateLimited(Element{
+				Key:       item.Key,
+				Timestamp: time.Now().UnixNano(),
+			})
+		} else {
+			t.queue.Forget(key)
+			t.lastSync = ts
+		}
+
+		t.queue.Done(key)
+	}
+}
+
+func isClosed(ch <-chan bool) bool {
+	select {
+	case <-ch:
+		return true
+	default:
+	}
+
+	return false
+}
+
+// Shutdown shuts down the work queue and waits for the worker to ACK
+func (t *Queue) Shutdown() {
+	t.queue.ShutDown()
+	<-t.workerDone
+}
+
+// IsShuttingDown returns if the method Shutdown was invoked
+func (t *Queue) IsShuttingDown() bool {
+	return t.queue.ShuttingDown()
+}
+
+// NewTaskQueue creates a new task queue with the given sync function.
+// The sync function is called for every element inserted into the queue.
+func NewTaskQueue(syncFn func(interface{}) error) *Queue {
+	return NewCustomTaskQueue(syncFn, nil)
+}
+
+// NewCustomTaskQueue ...
+func NewCustomTaskQueue(syncFn func(interface{}) error, fn func(interface{}) (interface{}, error)) *Queue {
+	q := &Queue{
+		queue:      workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
+		sync:       syncFn,
+		workerDone: make(chan bool),
+		fn:         fn,
+	}
+
+	if fn == nil {
+		q.fn = q.defaultKeyFunc
+	}
+
+	return q
+}

pkg/task/queue_test.go

@@ -0,0 +1,159 @@
+/*
+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"
+	"sync/atomic"
+	"testing"
+	"time"
+)
+
+var sr uint32
+
+type mockEnqueueObj struct {
+	k string
+	v string
+}
+
+func mockSynFn(interface{}) error {
+	// sr will be plus one times after enqueue
+	atomic.AddUint32(&sr, 1)
+	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.Errorf("queue should be shutdown")
+	}
+}
+
+func TestEnqueueSuccess(t *testing.T) {
+	// initialize result
+	atomic.StoreUint32(&sr, 0)
+	q := NewCustomTaskQueue(mockSynFn, mockKeyFn)
+	stopCh := make(chan struct{})
+	// run queue
+	go q.Run(5*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 atomic.LoadUint32(&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
+	atomic.StoreUint32(&sr, 0)
+	q := NewCustomTaskQueue(mockSynFn, mockKeyFn)
+	stopCh := make(chan struct{})
+	// run queue
+	go q.Run(5*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 atomic.LoadUint32(&sr) != 0 {
+		t.Errorf("queue has been shutdown, so sr should be 0, but is %d", sr)
+	}
+}
+
+func TestEnqueueKeyError(t *testing.T) {
+	// initialize result
+	atomic.StoreUint32(&sr, 0)
+	q := NewCustomTaskQueue(mockSynFn, mockErrorKeyFn)
+	stopCh := make(chan struct{})
+	// run queue
+	go q.Run(5*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 atomic.LoadUint32(&sr) != 0 {
+		t.Errorf("error occurs while get key, so sr should be 0, but is %d", sr)
+	}
+	// shutdown queue before exit
+	q.Shutdown()
+}
+
+func TestSkipEnqueue(t *testing.T) {
+	// initialize result
+	atomic.StoreUint32(&sr, 0)
+	q := NewCustomTaskQueue(mockSynFn, mockKeyFn)
+	stopCh := make(chan struct{})
+	// run queue
+	go q.Run(time.Second, stopCh)
+	// mock object whichi will be enqueue
+	mo := mockEnqueueObj{
+		k: "testKey",
+		v: "testValue",
+	}
+	q.Enqueue(mo)
+	q.Enqueue(mo)
+	q.Enqueue(mo)
+	q.Enqueue(mo)
+	// wait for 'mockSynFn'
+	time.Sleep(time.Millisecond * 10)
+	if atomic.LoadUint32(&sr) != 1 {
+		t.Errorf("sr should be 1, but is %d", sr)
+	}
+
+	// shutdown queue before exit
+	q.Shutdown()
+}