github.com/iotexproject/iotex-core@v1.14.1-rc1/db/range_index_test.go

// Copyright (c) 2019 IoTeX Foundation
// This source code is provided 'as is' and no warranties are given as to title or non-infringement, merchantability
// or fitness for purpose and, to the extent permitted by law, all liability for your use of the code is disclaimed.
// This source code is governed by Apache License 2.0 that can be found in the LICENSE file.

package db

import (
	"context"
	"math/rand"
	"testing"

	"github.com/stretchr/testify/require"

	"github.com/iotexproject/iotex-core/testutil"
)

func TestRangeIndex(t *testing.T) {
	require := require.New(t)

	rangeTests := []struct {
		k uint64
		v []byte
	}{
		{1, []byte("beyond")},
		{7, []byte("seven")},
		{29, []byte("twenty-nine")},
		{100, []byte("hundred")},
		{999, []byte("nine-nine-nine")},
	}

	path := "test-indexer"
	testPath, err := testutil.PathOfTempFile(path)
	require.NoError(err)
	cfg := DefaultConfig
	cfg.DbPath = testPath
	defer testutil.CleanupPath(testPath)

	kv := NewBoltDB(cfg)
	require.NotNil(kv)

	require.NoError(kv.Start(context.Background()))
	defer func() {
		require.NoError(kv.Stop(context.Background()))
	}()

	index, err := NewRangeIndex(kv, []byte("test"), NotExist)
	require.NoError(err)
	v, err := index.Get(0)
	require.NoError(err)
	require.Equal(NotExist, v)
	v, err = index.Get(1)
	require.NoError(err)
	require.Equal(NotExist, v)

	// cannot insert 0
	require.Error(index.Insert(0, NotExist))

	for i, e := range rangeTests {
		require.NoError(index.Insert(e.k, e.v))
		if i == 0 {
			v, err = index.Get(rangeTests[0].k)
			require.NoError(err)
			require.Equal(rangeTests[0].v, v)
			continue
		}
		// test 5 random keys between the new and previous insertion
		gap := e.k - rangeTests[i-1].k
		for j := 0; j < 5; j++ {
			k := rangeTests[i-1].k + uint64(rand.Intn(int(gap)))
			v, err = index.Get(k)
			require.NoError(err)
			require.Equal(rangeTests[i-1].v, v)
		}
		v, err = index.Get(e.k - 1)
		require.NoError(err)
		require.Equal(rangeTests[i-1].v, v)
		v, err = index.Get(e.k)
		require.NoError(err)
		require.Equal(e.v, v)

		// test 5 random keys beyond new insertion
		for j := 0; j < 5; j++ {
			k := e.k + uint64(rand.Int())
			v, err = index.Get(k)
			require.NoError(err)
			require.Equal(e.v, v)
		}
	}

	// delete rangeTests[1].k
	require.NoError(index.Delete(rangeTests[0].k))
	require.NoError(index.Delete(rangeTests[1].k))
	v, err = index.Get(rangeTests[1].k)
	require.NoError(err)
	require.Equal(NotExist, v)
	for i := 2; i < len(rangeTests); i++ {
		v, err = index.Get(rangeTests[i].k)
		require.NoError(err)
		require.Equal(rangeTests[i].v, v)
		v, err = index.Get(rangeTests[i].k + 1)
		require.NoError(err)
		require.Equal(rangeTests[i].v, v)
	}

	// delete rangeTests[3].k
	require.NoError(index.Delete(rangeTests[3].k))
	for i := 2; i <= 3; i++ {
		v, err = index.Get(rangeTests[i].k)
		require.NoError(err)
		require.Equal(rangeTests[2].v, v)
		v, err = index.Get(rangeTests[i].k + 1)
		require.NoError(err)
		require.Equal(rangeTests[2].v, v)
	}

	// key 4 not affected
	v, err = index.Get(rangeTests[4].k)
	require.NoError(err)
	require.Equal(rangeTests[4].v, v)
	v, err = index.Get(rangeTests[4].k + 1)
	require.NoError(err)
	require.Equal(rangeTests[4].v, v)

	// add rangeTests[3].k back with a diff value
	rangeTests[3].v = []byte("not-hundred")
	require.NoError(index.Insert(rangeTests[3].k, rangeTests[3].v))
	for i := 2; i < len(rangeTests); i++ {
		v, err = index.Get(rangeTests[i].k)
		require.NoError(err)
		require.Equal(rangeTests[i].v, v)
		v, err = index.Get(rangeTests[i].k + 1)
		require.NoError(err)
		require.Equal(rangeTests[i].v, v)
	}

	// purge rangeTests[3].k
	require.NoError(index.Purge(rangeTests[3].k))
	for i := 1; i <= 3; i++ {
		v, err = index.Get(rangeTests[i].k)
		require.NoError(err)
		require.Equal(NotExist, v)
		v, err = index.Get(rangeTests[i].k + 1)
		require.NoError(err)
		require.Equal(NotExist, v)
	}

	// key 4 not affected
	v, err = index.Get(rangeTests[4].k)
	require.NoError(err)
	require.Equal(rangeTests[4].v, v)
	v, err = index.Get(rangeTests[4].k + 1)
	require.NoError(err)
	require.Equal(rangeTests[4].v, v)
}

func TestRangeIndex2(t *testing.T) {
	require := require.New(t)

	path := "test-ranger"
	testPath, err := testutil.PathOfTempFile(path)
	require.NoError(err)
	cfg := DefaultConfig
	cfg.DbPath = testPath
	defer testutil.CleanupPath(testPath)

	kv := NewBoltDB(cfg)
	require.NotNil(kv)

	require.NoError(kv.Start(context.Background()))
	defer func() {
		require.NoError(kv.Stop(context.Background()))
	}()

	testNS := []byte("test")
	index, err := NewRangeIndex(kv, testNS, NotExist)
	require.NoError(err)
	// special case: insert 1
	require.NoError(index.Insert(1, []byte("1")))
	v, err := index.Get(5)
	require.NoError(err)
	require.Equal([]byte("1"), v)
	// remove 1
	require.NoError(index.Purge(1))
	// insert 7
	require.NoError(index.Insert(7, []byte("7")))
	// Case I: key before 7
	for i := uint64(1); i < 6; i++ {
		v, err = index.Get(i)
		require.NoError(err)
		require.Equal(v, NotExist)
	}
	// Case II: key is 7 and greater than 7
	for i := uint64(7); i < 10; i++ {
		v, err = index.Get(i)
		require.NoError(err)
		require.Equal([]byte("7"), v)
	}
	// Case III: duplicate key
	require.NoError(index.Insert(7, []byte("7777")))
	for i := uint64(7); i < 10; i++ {
		v, err = index.Get(i)
		require.NoError(err)
		require.Equal([]byte("7777"), v)
	}
	// Case IV: delete key less than 7
	require.NoError(index.Insert(66, []byte("66")))
	for i := uint64(1); i < 7; i++ {
		err = index.Delete(i)
		require.NoError(err)
	}
	v, err = index.Get(7)
	require.NoError(err)
	require.Equal([]byte("7777"), v)
	// Case V: delete key 7
	require.NoError(index.Purge(10))
	for i := uint64(1); i < 66; i++ {
		v, err = index.Get(i)
		require.NoError(err)
		require.Equal(v, NotExist)
	}
	for i := uint64(66); i < 70; i++ {
		v, err = index.Get(i)
		require.NoError(err)
		require.Equal([]byte("66"), v)
	}
	// Case VI: delete key before 80,all keys deleted
	require.NoError(index.Insert(70, []byte("70")))
	require.NoError(index.Insert(80, []byte("80")))
	require.NoError(index.Insert(91, []byte("91")))
	require.NoError(index.Purge(79))
	for i := uint64(1); i < 80; i++ {
		v, err = index.Get(i)
		require.NoError(err)
		require.Equal(v, NotExist)
	}
	for i := uint64(80); i < 91; i++ {
		v, err = index.Get(i)
		require.NoError(err)
		require.Equal([]byte("80"), v)
	}
	for i := uint64(91); i < 100; i++ {
		v, err = index.Get(i)
		require.NoError(err)
		require.Equal([]byte("91"), v)
	}
}