helpers_test.go

package gcache

import (
	"context"
	"fmt"
	"testing"
	"time"
)

func loader(_ context.Context, key interface{}) (interface{}, error) {
	return fmt.Sprintf("valueFor%s", key), nil
}

// general background context for test calls
var ctx = context.Background()

func testSetCache(t *testing.T, gc Cache, numbers int) {
	for i := 0; i < numbers; i++ {
		key := fmt.Sprintf("Key-%d", i)
		value, err := loader(ctx, key)
		if err != nil {
			t.Error(err)
			return
		}
		gc.Set(key, value)
	}
}

func testGetCache(t *testing.T, gc Cache, numbers int) {
	for i := 0; i < numbers; i++ {
		key := fmt.Sprintf("Key-%d", i)
		v, err := gc.Get(ctx, key)
		if err != nil {
			t.Errorf("Unexpected error: %v", err)
		}
		expectedV, _ := loader(ctx, key)
		if v != expectedV {
			t.Errorf("Expected value is %v, not %v", expectedV, v)
		}
	}
}

func testGetIFPresent(t *testing.T, evT string) {
	cache :=
		New(8).
			EvictType(evT).
			LoaderFunc(
				func(_ context.Context, key interface{}) (interface{}, error) {
					return "value", nil
				}).
			Build()

	v, err := cache.GetIFPresent(ctx, "key")
	if err != KeyNotFoundError {
		t.Errorf("err should not be %v", err)
	}

	time.Sleep(2 * time.Millisecond)

	v, err = cache.GetIFPresent(ctx, "key")
	if err != nil {
		t.Errorf("err should not be %v", err)
	}
	if v != "value" {
		t.Errorf("v should not be %v", v)
	}
}

func setItemsByRange(t *testing.T, c Cache, start, end int) {
	for i := start; i < end; i++ {
		if err := c.Set(i, i); err != nil {
			t.Error(err)
		}
	}
}

func keysToMap(keys []interface{}) map[interface{}]struct{} {
	m := make(map[interface{}]struct{}, len(keys))
	for _, k := range keys {
		m[k] = struct{}{}
	}
	return m
}

func checkItemsByRange(t *testing.T, keys []interface{}, m map[interface{}]interface{}, size, start, end int) {
	if len(keys) != size {
		t.Fatalf("%v != %v", len(keys), size)
	} else if len(m) != size {
		t.Fatalf("%v != %v", len(m), size)
	}
	km := keysToMap(keys)
	for i := start; i < end; i++ {
		if _, ok := km[i]; !ok {
			t.Errorf("keys should contain %v", i)
		}
		v, ok := m[i]
		if !ok {
			t.Errorf("m should contain %v", i)
			continue
		}
		if v.(int) != i {
			t.Errorf("%v != %v", v, i)
			continue
		}
	}
}

func testExpiredItems(t *testing.T, evT string) {
	size := 8
	cache :=
		New(size).
			Expiration(time.Millisecond).
			EvictType(evT).
			Build()

	setItemsByRange(t, cache, 0, size)
	checkItemsByRange(t, cache.Keys(true), cache.GetALL(true), cache.Len(true), 0, size)

	time.Sleep(time.Millisecond)

	checkItemsByRange(t, cache.Keys(false), cache.GetALL(false), cache.Len(false), 0, size)

	if l := cache.Len(true); l != 0 {
		t.Fatalf("GetALL should returns no items, but got length %v", l)
	}

	cache.Set(1, 1)
	m := cache.GetALL(true)
	if len(m) != 1 {
		t.Fatalf("%v != %v", len(m), 1)
	} else if l := cache.Len(true); l != 1 {
		t.Fatalf("%v != %v", l, 1)
	}
	if m[1] != 1 {
		t.Fatalf("%v != %v", m[1], 1)
	}
}

func getSimpleEvictedFunc(t *testing.T) func(interface{}, interface{}) {
	return func(key, value interface{}) {
		t.Logf("Key=%v Value=%v will be evicted.\n", key, value)
	}
}

func buildTestCache(t *testing.T, tp string, size int) Cache {
	return New(size).
		EvictType(tp).
		EvictedFunc(getSimpleEvictedFunc(t)).
		Build()
}

func buildTestLoadingCache(t *testing.T, tp string, size int, loader LoaderFunc) Cache {
	return New(size).
		EvictType(tp).
		LoaderFunc(loader).
		EvictedFunc(getSimpleEvictedFunc(t)).
		Build()
}

func buildTestLoadingCacheWithExpiration(t *testing.T, tp string, size int, ep time.Duration) Cache {
	return New(size).
		EvictType(tp).
		Expiration(ep).
		LoaderFunc(loader).
		EvictedFunc(getSimpleEvictedFunc(t)).
		Build()
}