580 lines
11 KiB
Go
580 lines
11 KiB
Go
|
package bigcache
|
||
|
|
|
||
|
|
import (
|
||
|
|
"fmt"
|
||
|
|
"sync"
|
||
|
|
"testing"
|
||
|
|
"time"
|
||
|
|
|
||
|
|
"github.com/stretchr/testify/assert"
|
||
|
|
)
|
||
|
|
|
||
|
|
var sink []byte
|
||
|
|
|
||
|
|
func TestParallel(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(DefaultConfig(5 * time.Second))
|
||
|
|
value := []byte("value")
|
||
|
|
var wg sync.WaitGroup
|
||
|
|
wg.Add(3)
|
||
|
|
keys := 1337
|
||
|
|
|
||
|
|
// when
|
||
|
|
go func() {
|
||
|
|
defer wg.Done()
|
||
|
|
for i := 0; i < keys; i++ {
|
||
|
|
cache.Set(fmt.Sprintf("key%d", i), value)
|
||
|
|
}
|
||
|
|
}()
|
||
|
|
go func() {
|
||
|
|
defer wg.Done()
|
||
|
|
for i := 0; i < keys; i++ {
|
||
|
|
sink, _ = cache.Get(fmt.Sprintf("key%d", i))
|
||
|
|
}
|
||
|
|
}()
|
||
|
|
go func() {
|
||
|
|
defer wg.Done()
|
||
|
|
for i := 0; i < keys; i++ {
|
||
|
|
cache.Delete(fmt.Sprintf("key%d", i))
|
||
|
|
}
|
||
|
|
}()
|
||
|
|
|
||
|
|
// then
|
||
|
|
wg.Wait()
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestWriteAndGetOnCache(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(DefaultConfig(5 * time.Second))
|
||
|
|
value := []byte("value")
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("key", value)
|
||
|
|
cachedValue, err := cache.Get("key")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.NoError(t, err)
|
||
|
|
assert.Equal(t, value, cachedValue)
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestConstructCacheWithDefaultHasher(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 16,
|
||
|
|
LifeWindow: 5 * time.Second,
|
||
|
|
MaxEntriesInWindow: 10,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
|
||
|
|
assert.IsType(t, fnv64a{}, cache.hash)
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestWillReturnErrorOnInvalidNumberOfPartitions(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, error := NewBigCache(Config{
|
||
|
|
Shards: 18,
|
||
|
|
LifeWindow: 5 * time.Second,
|
||
|
|
MaxEntriesInWindow: 10,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
|
||
|
|
assert.Nil(t, cache)
|
||
|
|
assert.Error(t, error, "Shards number must be power of two")
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestEntryNotFound(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 16,
|
||
|
|
LifeWindow: 5 * time.Second,
|
||
|
|
MaxEntriesInWindow: 10,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
|
||
|
|
// when
|
||
|
|
_, err := cache.Get("nonExistingKey")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.EqualError(t, err, "Entry \"nonExistingKey\" not found")
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestTimingEviction(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
clock := mockedClock{value: 0}
|
||
|
|
cache, _ := newBigCache(Config{
|
||
|
|
Shards: 1,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
}, &clock)
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("key", []byte("value"))
|
||
|
|
clock.set(5)
|
||
|
|
cache.Set("key2", []byte("value2"))
|
||
|
|
_, err := cache.Get("key")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.EqualError(t, err, "Entry \"key\" not found")
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestTimingEvictionShouldEvictOnlyFromUpdatedShard(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
clock := mockedClock{value: 0}
|
||
|
|
cache, _ := newBigCache(Config{
|
||
|
|
Shards: 4,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
}, &clock)
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("key", []byte("value"))
|
||
|
|
clock.set(5)
|
||
|
|
cache.Set("key2", []byte("value 2"))
|
||
|
|
value, err := cache.Get("key")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.NoError(t, err, "Entry \"key\" not found")
|
||
|
|
assert.Equal(t, []byte("value"), value)
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestCleanShouldEvictAll(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 4,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
CleanWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("key", []byte("value"))
|
||
|
|
<-time.After(3 * time.Second)
|
||
|
|
value, err := cache.Get("key")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.EqualError(t, err, "Entry \"key\" not found")
|
||
|
|
assert.Equal(t, value, []byte(nil))
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestOnRemoveCallback(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
clock := mockedClock{value: 0}
|
||
|
|
onRemoveInvoked := false
|
||
|
|
onRemove := func(key string, entry []byte) {
|
||
|
|
onRemoveInvoked = true
|
||
|
|
assert.Equal(t, "key", key)
|
||
|
|
assert.Equal(t, []byte("value"), entry)
|
||
|
|
}
|
||
|
|
cache, _ := newBigCache(Config{
|
||
|
|
Shards: 1,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
OnRemove: onRemove,
|
||
|
|
}, &clock)
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("key", []byte("value"))
|
||
|
|
clock.set(5)
|
||
|
|
cache.Set("key2", []byte("value2"))
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.True(t, onRemoveInvoked)
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestCacheLen(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 8,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
keys := 1337
|
||
|
|
|
||
|
|
// when
|
||
|
|
for i := 0; i < keys; i++ {
|
||
|
|
cache.Set(fmt.Sprintf("key%d", i), []byte("value"))
|
||
|
|
}
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Equal(t, keys, cache.Len())
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestCacheStats(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 8,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
|
||
|
|
// when
|
||
|
|
for i := 0; i < 100; i++ {
|
||
|
|
cache.Set(fmt.Sprintf("key%d", i), []byte("value"))
|
||
|
|
}
|
||
|
|
|
||
|
|
for i := 0; i < 10; i++ {
|
||
|
|
value, err := cache.Get(fmt.Sprintf("key%d", i))
|
||
|
|
assert.Nil(t, err)
|
||
|
|
assert.Equal(t, string(value), "value")
|
||
|
|
}
|
||
|
|
for i := 100; i < 110; i++ {
|
||
|
|
_, err := cache.Get(fmt.Sprintf("key%d", i))
|
||
|
|
assert.Error(t, err)
|
||
|
|
}
|
||
|
|
for i := 10; i < 20; i++ {
|
||
|
|
err := cache.Delete(fmt.Sprintf("key%d", i))
|
||
|
|
assert.Nil(t, err)
|
||
|
|
}
|
||
|
|
for i := 110; i < 120; i++ {
|
||
|
|
err := cache.Delete(fmt.Sprintf("key%d", i))
|
||
|
|
assert.Error(t, err)
|
||
|
|
}
|
||
|
|
|
||
|
|
// then
|
||
|
|
stats := cache.Stats()
|
||
|
|
assert.Equal(t, stats.Hits, int64(10))
|
||
|
|
assert.Equal(t, stats.Misses, int64(10))
|
||
|
|
assert.Equal(t, stats.DelHits, int64(10))
|
||
|
|
assert.Equal(t, stats.DelMisses, int64(10))
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestCacheDel(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(DefaultConfig(time.Second))
|
||
|
|
|
||
|
|
// when
|
||
|
|
err := cache.Delete("nonExistingKey")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Equal(t, err.Error(), "Entry \"nonExistingKey\" not found")
|
||
|
|
|
||
|
|
// and when
|
||
|
|
cache.Set("existingKey", nil)
|
||
|
|
err = cache.Delete("existingKey")
|
||
|
|
cachedValue, _ := cache.Get("existingKey")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Nil(t, err)
|
||
|
|
assert.Len(t, cachedValue, 0)
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestCacheReset(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 8,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
keys := 1337
|
||
|
|
|
||
|
|
// when
|
||
|
|
for i := 0; i < keys; i++ {
|
||
|
|
cache.Set(fmt.Sprintf("key%d", i), []byte("value"))
|
||
|
|
}
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Equal(t, keys, cache.Len())
|
||
|
|
|
||
|
|
// and when
|
||
|
|
cache.Reset()
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Equal(t, 0, cache.Len())
|
||
|
|
|
||
|
|
// and when
|
||
|
|
for i := 0; i < keys; i++ {
|
||
|
|
cache.Set(fmt.Sprintf("key%d", i), []byte("value"))
|
||
|
|
}
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Equal(t, keys, cache.Len())
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestIterateOnResetCache(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 8,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
keys := 1337
|
||
|
|
|
||
|
|
// when
|
||
|
|
for i := 0; i < keys; i++ {
|
||
|
|
cache.Set(fmt.Sprintf("key%d", i), []byte("value"))
|
||
|
|
}
|
||
|
|
cache.Reset()
|
||
|
|
|
||
|
|
// then
|
||
|
|
iterator := cache.Iterator()
|
||
|
|
|
||
|
|
assert.Equal(t, false, iterator.SetNext())
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestGetOnResetCache(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 8,
|
||
|
|
LifeWindow: time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
})
|
||
|
|
keys := 1337
|
||
|
|
|
||
|
|
// when
|
||
|
|
for i := 0; i < keys; i++ {
|
||
|
|
cache.Set(fmt.Sprintf("key%d", i), []byte("value"))
|
||
|
|
}
|
||
|
|
|
||
|
|
cache.Reset()
|
||
|
|
|
||
|
|
// then
|
||
|
|
value, err := cache.Get("key1")
|
||
|
|
|
||
|
|
assert.Equal(t, err.Error(), "Entry \"key1\" not found")
|
||
|
|
assert.Equal(t, value, []byte(nil))
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestEntryUpdate(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
clock := mockedClock{value: 0}
|
||
|
|
cache, _ := newBigCache(Config{
|
||
|
|
Shards: 1,
|
||
|
|
LifeWindow: 6 * time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
}, &clock)
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("key", []byte("value"))
|
||
|
|
clock.set(5)
|
||
|
|
cache.Set("key", []byte("value2"))
|
||
|
|
clock.set(7)
|
||
|
|
cache.Set("key2", []byte("value3"))
|
||
|
|
cachedValue, _ := cache.Get("key")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Equal(t, []byte("value2"), cachedValue)
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestOldestEntryDeletionWhenMaxCacheSizeIsReached(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 1,
|
||
|
|
LifeWindow: 5 * time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 1,
|
||
|
|
HardMaxCacheSize: 1,
|
||
|
|
})
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("key1", blob('a', 1024*400))
|
||
|
|
cache.Set("key2", blob('b', 1024*400))
|
||
|
|
cache.Set("key3", blob('c', 1024*800))
|
||
|
|
|
||
|
|
_, key1Err := cache.Get("key1")
|
||
|
|
_, key2Err := cache.Get("key2")
|
||
|
|
entry3, _ := cache.Get("key3")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.EqualError(t, key1Err, "Entry \"key1\" not found")
|
||
|
|
assert.EqualError(t, key2Err, "Entry \"key2\" not found")
|
||
|
|
assert.Equal(t, blob('c', 1024*800), entry3)
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestRetrievingEntryShouldCopy(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 1,
|
||
|
|
LifeWindow: 5 * time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 1,
|
||
|
|
HardMaxCacheSize: 1,
|
||
|
|
})
|
||
|
|
cache.Set("key1", blob('a', 1024*400))
|
||
|
|
value, key1Err := cache.Get("key1")
|
||
|
|
|
||
|
|
// when
|
||
|
|
// override queue
|
||
|
|
cache.Set("key2", blob('b', 1024*400))
|
||
|
|
cache.Set("key3", blob('c', 1024*400))
|
||
|
|
cache.Set("key4", blob('d', 1024*400))
|
||
|
|
cache.Set("key5", blob('d', 1024*400))
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Nil(t, key1Err)
|
||
|
|
assert.Equal(t, blob('a', 1024*400), value)
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestEntryBiggerThanMaxShardSizeError(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 1,
|
||
|
|
LifeWindow: 5 * time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 1,
|
||
|
|
HardMaxCacheSize: 1,
|
||
|
|
})
|
||
|
|
|
||
|
|
// when
|
||
|
|
err := cache.Set("key1", blob('a', 1024*1025))
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.EqualError(t, err, "entry is bigger than max shard size")
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestHashCollision(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
ml := &mockedLogger{}
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 16,
|
||
|
|
LifeWindow: 5 * time.Second,
|
||
|
|
MaxEntriesInWindow: 10,
|
||
|
|
MaxEntrySize: 256,
|
||
|
|
Verbose: true,
|
||
|
|
Hasher: hashStub(5),
|
||
|
|
Logger: ml,
|
||
|
|
})
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("liquid", []byte("value"))
|
||
|
|
cachedValue, err := cache.Get("liquid")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.NoError(t, err)
|
||
|
|
assert.Equal(t, []byte("value"), cachedValue)
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("costarring", []byte("value 2"))
|
||
|
|
cachedValue, err = cache.Get("costarring")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.NoError(t, err)
|
||
|
|
assert.Equal(t, []byte("value 2"), cachedValue)
|
||
|
|
|
||
|
|
// when
|
||
|
|
cachedValue, err = cache.Get("liquid")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.Error(t, err)
|
||
|
|
assert.Nil(t, cachedValue)
|
||
|
|
|
||
|
|
assert.NotEqual(t, "", ml.lastFormat)
|
||
|
|
assert.Equal(t, cache.Stats().Collisions, int64(1))
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestNilValueCaching(t *testing.T) {
|
||
|
|
t.Parallel()
|
||
|
|
|
||
|
|
// given
|
||
|
|
cache, _ := NewBigCache(Config{
|
||
|
|
Shards: 1,
|
||
|
|
LifeWindow: 5 * time.Second,
|
||
|
|
MaxEntriesInWindow: 1,
|
||
|
|
MaxEntrySize: 1,
|
||
|
|
HardMaxCacheSize: 1,
|
||
|
|
})
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("Kierkegaard", []byte{})
|
||
|
|
cachedValue, err := cache.Get("Kierkegaard")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.NoError(t, err)
|
||
|
|
assert.Equal(t, []byte{}, cachedValue)
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("Sartre", nil)
|
||
|
|
cachedValue, err = cache.Get("Sartre")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.NoError(t, err)
|
||
|
|
assert.Equal(t, []byte{}, cachedValue)
|
||
|
|
|
||
|
|
// when
|
||
|
|
cache.Set("Nietzsche", []byte(nil))
|
||
|
|
cachedValue, err = cache.Get("Nietzsche")
|
||
|
|
|
||
|
|
// then
|
||
|
|
assert.NoError(t, err)
|
||
|
|
assert.Equal(t, []byte{}, cachedValue)
|
||
|
|
}
|
||
|
|
|
||
|
|
type mockedLogger struct {
|
||
|
|
lastFormat string
|
||
|
|
lastArgs []interface{}
|
||
|
|
}
|
||
|
|
|
||
|
|
func (ml *mockedLogger) Printf(format string, v ...interface{}) {
|
||
|
|
ml.lastFormat = format
|
||
|
|
ml.lastArgs = v
|
||
|
|
}
|
||
|
|
|
||
|
|
type mockedClock struct {
|
||
|
|
value int64
|
||
|
|
}
|
||
|
|
|
||
|
|
func (mc *mockedClock) epoch() int64 {
|
||
|
|
return mc.value
|
||
|
|
}
|
||
|
|
|
||
|
|
func (mc *mockedClock) set(value int64) {
|
||
|
|
mc.value = value
|
||
|
|
}
|
||
|
|
|
||
|
|
func blob(char byte, len int) []byte {
|
||
|
|
b := make([]byte, len)
|
||
|
|
for index := range b {
|
||
|
|
b[index] = char
|
||
|
|
}
|
||
|
|
return b
|
||
|
|
}
|