storj/storage/testsuite/test_list.go

// Copyright (C) 2018 Storj Labs, Inc.
// See LICENSE for copying information.

package testsuite

import (
	"math/rand"
	"testing"

	"storj.io/storj/storage"

	"github.com/google/go-cmp/cmp"
	"github.com/google/go-cmp/cmp/cmpopts"
)

func testList(t *testing.T, store storage.KeyValueStore) {
	items := storage.Items{
		newItem("path/0", "\x00\xFF\x00", false),
		newItem("path/1", "\x01\xFF\x01", false),
		newItem("path/2", "\x02\xFF\x02", false),
		newItem("path/3", "\x03\xFF\x03", false),
		newItem("path/4", "\x04\xFF\x04", false),
		newItem("path/5", "\x05\xFF\x05", false),
	}
	rand.Shuffle(len(items), items.Swap)

	defer cleanupItems(store, items)

	for _, item := range items {
		if err := store.Put(item.Key, item.Value); err != nil {
			t.Fatalf("failed to put: %v", err)
		}
	}

	type Test struct {
		Name     string
		Reverse  bool
		First    storage.Key
		Limit    storage.Limit
		Expected storage.Keys
	}

	newKeys := func(xs ...string) storage.Keys {
		var keys storage.Keys
		for _, x := range xs {
			keys = append(keys, storage.Key(x))
		}
		return keys
	}

	tests := []Test{
		{"without key", false,
			nil, 3,
			newKeys("path/0", "path/1", "path/2")},
		{"without key, limit 0", false,
			nil, 0,
			newKeys("path/0", "path/1", "path/2", "path/3", "path/4", "path/5")},
		{"with key", false,
			storage.Key("path/2"), 3,
			newKeys("path/2", "path/3", "path/4")},
		{"without key 100", false,
			nil, 100,
			newKeys("path/0", "path/1", "path/2", "path/3", "path/4", "path/5")},
		{"reverse without key", true,
			nil, 3,
			newKeys("path/5", "path/4", "path/3")},
		{"reverse with key", true,
			storage.Key("path/2"), 3,
			newKeys("path/2", "path/1", "path/0")},
		{"reverse without key 100", true,
			nil, 100,
			newKeys("path/5", "path/4", "path/3", "path/2", "path/1", "path/0")},
	}

	for _, test := range tests {
		var keys storage.Keys
		var err error
		if !test.Reverse {
			keys, err = store.List(test.First, test.Limit)
		} else {
			keys, err = store.ReverseList(test.First, test.Limit)
		}
		if err != nil {
			t.Errorf("%s: %s", test.Name, err)
			continue
		}
		if diff := cmp.Diff(test.Expected, keys, cmpopts.EquateEmpty()); diff != "" {
			t.Errorf("%s: (-want +got)\n%s", test.Name, diff)
		}
	}
}