Added UndeltaStore.

This will be used to connect Reflector to kubelet update channel.

Added testing.
pull/6/head
Eric Tune 2014-11-21 13:14:30 -08:00
parent 2a2cef84d6
commit 793bf6a79d
3 changed files with 198 additions and 0 deletions

View File

@ -107,3 +107,8 @@ func TestCache(t *testing.T) {
func TestFIFOCache(t *testing.T) {
doTestStore(t, NewFIFO())
}
func TestUndeltaStore(t *testing.T) {
nop := func([]interface{}) {}
doTestStore(t, NewUndeltaStore(nop))
}

81
pkg/client/cache/undelta_store.go vendored Normal file
View File

@ -0,0 +1,81 @@
/*
Copyright 2015 Google Inc. All rights reserved.
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 cache
import (
"github.com/GoogleCloudPlatform/kubernetes/pkg/util"
)
// UndeltaStore listens to incremental updates and sends complete state on every change.
// It implements the Store interface so that it can receive a stream of mirrored objects
// from Reflector. Whenever it receives any complete (Store.Replace) or incremental change
// (Store.Add, Store.Update, Store.Delete), it sends the complete state by calling PushFunc.
// It is thread-safe. It guarantees that every change (Add, Update, Replace, Delete) results
// in one call to PushFunc, but sometimes PushFunc may be called twice with the same values.
// PushFunc should be thread safe.
type UndeltaStore struct {
ActualStore Store
PushFunc func([]interface{})
}
// Assert that it implements the Store interface.
var _ Store = &UndeltaStore{}
// Note about thread safety. The Store implementation (cache.cache) uses a lock for all methods.
// In the functions below, the lock gets released and reacquired betweend the {Add,Delete,etc}
// and the List. So, the following can happen, resulting in two identical calls to PushFunc.
// time thread 1 thread 2
// 0 UndeltaStore.Add(a)
// 1 UndeltaStore.Add(b)
// 2 Store.Add(a)
// 3 Store.Add(b)
// 4 Store.List() -> [a,b]
// 5 Store.List() -> [a,b]
func (u *UndeltaStore) Add(id string, obj interface{}) {
u.ActualStore.Add(id, obj)
u.PushFunc(u.ActualStore.List())
}
func (u *UndeltaStore) Update(id string, obj interface{}) {
u.ActualStore.Update(id, obj)
u.PushFunc(u.ActualStore.List())
}
func (u *UndeltaStore) Delete(id string) {
u.ActualStore.Delete(id)
u.PushFunc(u.ActualStore.List())
}
func (u *UndeltaStore) List() []interface{} {
return u.ActualStore.List()
}
func (u *UndeltaStore) ContainedIDs() util.StringSet {
return u.ActualStore.ContainedIDs()
}
func (u *UndeltaStore) Get(id string) (item interface{}, exists bool) {
return u.ActualStore.Get(id)
}
func (u *UndeltaStore) Replace(idToObj map[string]interface{}) {
u.ActualStore.Replace(idToObj)
u.PushFunc(u.ActualStore.List())
}
// NewUndeltaStore returns an UndeltaStore implemented with a Store.
func NewUndeltaStore(pushFunc func([]interface{})) *UndeltaStore {
return &UndeltaStore{
ActualStore: NewStore(),
PushFunc: pushFunc,
}
}

112
pkg/client/cache/undelta_store_test.go vendored Normal file
View File

@ -0,0 +1,112 @@
/*
Copyright 2015 Google Inc. All rights reserved.
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 cache
import (
"reflect"
"testing"
)
// store_test.go checks that UndeltaStore conforms to the Store interface
// behavior. This test just tests that it calls the push func in addition.
type t struct{ int }
var (
o1 interface{} = t{1}
o2 interface{} = t{2}
l1 []interface{} = []interface{}{t{1}}
l12 []interface{} = []interface{}{t{1}, t{2}}
)
func TestUpdateCallsPush(t *testing.T) {
var got []interface{}
var callcount int = 0
push := func(m []interface{}) {
callcount++
got = m
}
u := NewUndeltaStore(push)
u.Add("a", o2)
u.Update("a", o1)
if callcount != 2 {
t.Errorf("Expected 2 calls, got %d", callcount)
}
if !reflect.DeepEqual(l1, got) {
t.Errorf("Expected %#v, Got %#v", l1, got)
}
}
func TestDeleteCallsPush(t *testing.T) {
var got []interface{}
var callcount int = 0
push := func(m []interface{}) {
callcount++
got = m
}
u := NewUndeltaStore(push)
u.Add("a", o2)
u.Delete("a")
if callcount != 2 {
t.Errorf("Expected 2 calls, got %d", callcount)
}
expected := []interface{}{}
if !reflect.DeepEqual(expected, got) {
t.Errorf("Expected %#v, Got %#v", expected, got)
}
}
func TestReadsDoNotCallPush(t *testing.T) {
push := func(m []interface{}) {
t.Errorf("Unexpected call to push!")
}
u := NewUndeltaStore(push)
// These should not call push.
_ = u.List()
_ = u.ContainedIDs()
_, _ = u.Get("1")
}
func TestReplaceCallsPush(t *testing.T) {
var got []interface{}
var callcount int = 0
push := func(m []interface{}) {
callcount++
got = m
}
u := NewUndeltaStore(push)
m := make(map[string]interface{})
m["1"] = o1
m["2"] = o2
u.Replace(m)
if callcount != 1 {
t.Errorf("Expected 2 calls, got %d", callcount)
}
expected := l12
if !reflect.DeepEqual(expected, got) {
t.Errorf("Expected %#v, Got %#v", expected, got)
}
}