lru_cache_key_string_test.go

// Copyright 2012, Google Inc. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package lru

import (
	"encoding/json"
	key "github.com/0studio/storage_key"
	"testing"
)

func TestKeyStringInitialState(t *testing.T) {
	cache := NewLRUCacheKeyString(5)
	l, sz, c := cache.Stats()
	if l != 0 {
		t.Errorf("length = %v, want 0", l)
	}
	if sz != 0 {
		t.Errorf("size = %v, want 0", sz)
	}
	if c != 5 {
		t.Errorf("capacity = %v, want 5", c)
	}
}

func TestKeyStringSetInsertsValue(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	data := &CacheValue{0}
	var k key.String = "1"
	cache.Set(k, data)

	v, ok := cache.Get(k)
	if !ok || v.(*CacheValue) != data {
		t.Errorf("Cache has incorrect value: %v != %v", data, v)
	}

	keys := cache.Keys()
	if len(keys) != 1 || keys[0] != k {
		t.Errorf("Cache.Keys() returned incorrect items: %v", k)
	}
	items := cache.Items()
	if len(items) != 1 || items[0].Key != k {
		t.Errorf("Cache.Values() returned incorrect items: %v", items)
	}
	values := cache.Values()
	if len(values) != 1 {
		t.Errorf("Cache.Values() returned incorrect values: %v", values)
	}

}

func TestKeyStringSetIfAbsent(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	data := &CacheValue{0}
	var k key.String = "1"
	cache.SetIfAbsent(k, data)

	v, ok := cache.Get(k)
	if !ok || v.(*CacheValue) != data {
		t.Errorf("Cache has incorrect value: %v != %v", data, v)
	}

	cache.SetIfAbsent(k, &CacheValue{1})

	v, ok = cache.Get(k)
	if !ok || v.(*CacheValue) != data {
		t.Errorf("Cache has incorrect value: %v != %v", data, v)
	}
}

func TestKeyStringGetValueWithMultipleTypes(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	data := &CacheValue{0}
	var k key.String = "1"
	cache.Set(k, data)

	v, ok := cache.Get(k)
	if !ok || v.(*CacheValue) != data {
		t.Errorf("Cache has incorrect value for \"k\": %v != %v", data, v)
	}

	// v, ok = cache.Get(string([]byte{'k', 'e', 'y'}))
	// if !ok || v.(*CacheValue) != data {
	// 	t.Errorf("Cache has incorrect value for []byte {'k','e','y'}: %v != %v", data, v)
	// }
}

func TestKeyStringSetUpdatesSize(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	emptyValue := &CacheValue{0}
	k := key.String(1)
	cache.Set(k, emptyValue)
	if _, sz, _ := cache.Stats(); sz != 0 {
		t.Errorf("cache.Size() = %v, expected 0", sz)
	}
	someValue := &CacheValue{20}
	k = key.String(2)
	cache.Set(k, someValue)
	if _, sz, _ := cache.Stats(); sz != 20 {
		t.Errorf("cache.Size() = %v, expected 20", sz)
	}
}

func TestKeyStringSetWithOldKeyUpdatesValue(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	emptyValue := &CacheValue{0}
	k := key.String(1)
	cache.Set(k, emptyValue)
	someValue := &CacheValue{20}
	cache.Set(k, someValue)

	v, ok := cache.Get(k)
	if !ok || v.(*CacheValue) != someValue {
		t.Errorf("Cache has incorrect value: %v != %v", someValue, v)
	}
}

func TestKeyStringSetWithOldKeyUpdatesSize(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	emptyValue := &CacheValue{0}
	k := key.String(1)
	cache.Set(k, emptyValue)

	if _, sz, _ := cache.Stats(); sz != 0 {
		t.Errorf("cache.Size() = %v, expected %v", sz, 0)
	}

	someValue := &CacheValue{20}
	cache.Set(k, someValue)
	expected := int64(someValue.size)
	if _, sz, _ := cache.Stats(); sz != expected {
		t.Errorf("cache.Size() = %v, expected %v", sz, expected)
	}
}

func TestKeyStringGetNonExistent(t *testing.T) {
	cache := NewLRUCacheKeyString(100)

	if _, ok := cache.Get(key.String("1")); ok {
		t.Error("Cache returned a crap value after no inserts.")
	}
}

func TestKeyStringDelete(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	value := &CacheValue{1}
	var k key.String = "1"

	if cache.Delete(k) {
		t.Error("Item unexpectedly already in cache.")
	}

	cache.Set(k, value)

	if !cache.Delete(k) {
		t.Error("Expected item to be in cache.")
	}

	if _, sz, _ := cache.Stats(); sz != 0 {
		t.Errorf("cache.Size() = %v, expected 0", sz)
	}

	if _, ok := cache.Get(k); ok {
		t.Error("Cache returned a value after deletion.")
	}
}

func TestKeyStringClear(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	value := &CacheValue{1}
	var k key.String = "1"

	cache.Set(k, value)
	cache.Clear()

	if _, sz, _ := cache.Stats(); sz != 0 {
		t.Errorf("cache.Size() = %v, expected 0 after Clear()", sz)
	}
}

func TestKeyStringCapacityIsObeyed(t *testing.T) {
	size := int64(3)
	cache := NewLRUCacheKeyString(100)
	cache.SetCapacity(size)
	value := &CacheValue{1}

	// Insert up to the cache's capacity.
	cache.Set(key.String("1"), value)
	cache.Set(key.String("2"), value)
	cache.Set(key.String("3"), value)
	if _, sz, _ := cache.Stats(); sz != size {
		t.Errorf("cache.Size() = %v, expected %v", sz, size)
	}
	// Insert one more; something should be evicted to make room.
	cache.Set(key.String("4"), value)
	if _, sz, _ := cache.Stats(); sz != size {
		t.Errorf("post-evict cache.Size() = %v, expected %v", sz, size)
	}

	// Check json stats
	data := cache.StatsJSON()
	m := make(map[string]interface{})
	if err := json.Unmarshal([]byte(data), &m); err != nil {
		t.Errorf("cache.StatsJSON() returned bad json data: %v %v", data, err)
	}
	if m["Size"].(float64) != float64(size) {
		t.Errorf("cache.StatsJSON() returned bad size: %v", m)
	}

	// Check various other stats
	if l := cache.Length(); l != size {
		t.Errorf("cache.StatsJSON() returned bad length: %v", l)
	}
	if s := cache.Size(); s != size {
		t.Errorf("cache.StatsJSON() returned bad size: %v", s)
	}
	if c := cache.Capacity(); c != size {
		t.Errorf("cache.StatsJSON() returned bad length: %v", c)
	}

	// checks StatsJSON on nil
	cache = nil
	if s := cache.StatsJSON(); s != "{}" {
		t.Errorf("cache.StatsJSON() on nil object returned %v", s)
	}
}

func TestKeyStringLRUIsEvicted(t *testing.T) {
	size := int64(3)
	cache := NewLRUCacheKeyString(size)

	cache.Set(key.String("1"), &CacheValue{1})
	cache.Set(key.String("2"), &CacheValue{1})
	cache.Set(key.String("3"), &CacheValue{1})
	// lru: [k3, k2, k1]

	// Look up the elements. This will rearrange the LRU ordering.
	cache.Get(key.String("3"))
	// beforeKey2 := time.Now()
	cache.Get(key.String("2"))
	// afterKey2 := time.Now()
	cache.Get(key.String("1"))
	// lru: [k1, k2, k3]

	cache.Set(key.String("0"), &CacheValue{1})
	// lru: [k0, k1, k2]

	// The least recently used one should have been evicted.
	if _, ok := cache.Get(key.String("3")); ok {
		t.Error("Least recently used element was not evicted.")
	}

	// // Check oldest
	// if o := cache.Oldest(); o.Before(beforeKey2) || o.After(afterKey2) {
	// 	t.Errorf("cache.Oldest returned an unexpected value: got %v, expected a value between %v and %v", o, beforeKey2, afterKey2)
	// }
}

type PurgeCacheValueKeyString struct {
}

func (cv *PurgeCacheValueKeyString) OnPurge(why PurgeReason) {
	purgeReasonFlag4TestKeyString = why
}

var purgeReasonFlag4TestKeyString PurgeReason

func TestKeyStringDeleteOnPurge(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	value := &PurgeCacheValueKeyString{}
	purgeReasonFlag4TestKeyString = PURGE_REASON_CACHEFULL // init
	var k key.String = "1"

	cache.Set(k, value)
	cache.Delete(k)
	if purgeReasonFlag4TestKeyString != PURGE_REASON_DELETE {
		t.Errorf("after cache.Delete ,purgeReason should be %d ,but get %d", PURGE_REASON_DELETE, purgeReasonFlag4TestKeyString)
	}

}

func TestKeyStringUpdateOnPurge(t *testing.T) {
	cache := NewLRUCacheKeyString(100)
	value := &PurgeCacheValueKeyString{}
	purgeReasonFlag4TestKeyString = PURGE_REASON_CACHEFULL // init
	var k key.String = "1"

	cache.Set(k, value)
	cache.Set(k, value) // set again
	if purgeReasonFlag4TestKeyString != PURGE_REASON_UPDATE {
		t.Errorf("after cache.Delete ,purgeReason should be %d ,but get %d", PURGE_REASON_UPDATE, purgeReasonFlag4TestKeyString)
	}

}

func TestKeyStringCacheFullOnPurge(t *testing.T) {
	cache := NewLRUCacheKeyString(1)
	value := &PurgeCacheValueKeyString{}
	k1 := key.String(1)
	k2 := key.String(2)

	cache.Set(k1, value)                                // after this cache is full
	purgeReasonFlag4TestKeyString = PURGE_REASON_DELETE // init
	cache.Set(k2, value)                                // after this k1 is delete and reason set to  PURGE_REASON_CACHEFULL
	if purgeReasonFlag4TestKeyString != PURGE_REASON_CACHEFULL {
		t.Errorf("after cache.Delete ,purgeReason should be %d ,but get %d", PURGE_REASON_CACHEFULL, purgeReasonFlag4TestKeyString)
	}

}

func TestKeyStringClearOnPurge(t *testing.T) {
	cache := NewLRUCacheKeyString(1)
	value := &PurgeCacheValueKeyString{}
	k1 := key.String(1)
	purgeReasonFlag4TestKeyString = PURGE_REASON_DELETE // init
	cache.Set(k1, value)                                // after this cache is full
	cache.Clear()
	if purgeReasonFlag4TestKeyString != PURGE_REASON_CLEAR_ALL {
		t.Errorf("after cache.Delete ,purgeReason should be %d ,but get %d", PURGE_REASON_CLEAR_ALL, purgeReasonFlag4TestKeyString)
	}

}

func TestKeyStringOnMiss(t *testing.T) {
	fun := func(k key.String) (Cacheable, bool) {
		return 1, true
	}
	cache := NewLRUCacheKeyString(1)
	cache.OnMiss(fun)
	k1 := key.String(1)
	v, ok := cache.Get(k1) //
	if ok != true && v != 1 {
		t.Errorf("lru.onMiss is errror")
	}

}