github.com/hechain20/hechain@v0.0.0-20220316014945-b544036ba106/core/ledger/kvledger/txmgmt/statedb/stateleveldb/stateleveldb_test.go

/*
Copyright hechain. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0
*/

package stateleveldb

import (
	"errors"
	"testing"

	"github.com/hechain20/hechain/core/ledger/internal/version"
	"github.com/hechain20/hechain/core/ledger/kvledger/txmgmt/statedb"
	"github.com/hechain20/hechain/core/ledger/kvledger/txmgmt/statedb/commontests"
	"github.com/stretchr/testify/require"
)

func TestBasicRW(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestBasicRW(t, env.DBProvider)
}

func TestMultiDBBasicRW(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestMultiDBBasicRW(t, env.DBProvider)
}

func TestDeletes(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestDeletes(t, env.DBProvider)
}

func TestIterator(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestIterator(t, env.DBProvider)
	t.Run("test-iter-error-path", func(t *testing.T) {
		db, err := env.DBProvider.GetDBHandle("testiterator", nil)
		require.NoError(t, err)
		env.DBProvider.Close()
		itr, err := db.GetStateRangeScanIterator("ns1", "", "")
		require.EqualError(t, err, "internal leveldb error while obtaining db iterator: leveldb: closed")
		require.Nil(t, itr)
	})
}

func TestDataKeyEncoding(t *testing.T) {
	testDataKeyEncoding(t, "ledger1", "ns", "key")
	testDataKeyEncoding(t, "ledger2", "ns", "")
}

func testDataKeyEncoding(t *testing.T, dbName string, ns string, key string) {
	dataKey := encodeDataKey(ns, key)
	t.Logf("dataKey=%#v", dataKey)
	ns1, key1 := decodeDataKey(dataKey)
	require.Equal(t, ns, ns1)
	require.Equal(t, key, key1)
}

// TestQueryOnLevelDB tests queries on levelDB.
func TestQueryOnLevelDB(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	db, err := env.DBProvider.GetDBHandle("testquery", nil)
	require.NoError(t, err)
	require.NoError(t, db.Open())
	defer db.Close()
	batch := statedb.NewUpdateBatch()
	jsonValue1 := `{"asset_name": "marble1","color": "blue","size": 1,"owner": "tom"}`
	batch.Put("ns1", "key1", []byte(jsonValue1), version.NewHeight(1, 1))

	savePoint := version.NewHeight(2, 22)
	require.NoError(t, db.ApplyUpdates(batch, savePoint))

	// query for owner=jerry, use namespace "ns1"
	// As queries are not supported in levelDB, call to ExecuteQuery()
	// should return a error message
	itr, err := db.ExecuteQuery("ns1", `{"selector":{"owner":"jerry"}}`)
	require.Error(t, err, "ExecuteQuery not supported for leveldb")
	require.Nil(t, itr)
}

func TestGetStateMultipleKeys(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestGetStateMultipleKeys(t, env.DBProvider)
}

func TestGetVersion(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestGetVersion(t, env.DBProvider)
}

func TestUtilityFunctions(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()

	db, err := env.DBProvider.GetDBHandle("testutilityfunctions", nil)
	require.NoError(t, err)

	require.True(t, env.DBProvider.BytesKeySupported())
	require.True(t, db.BytesKeySupported())

	// ValidateKeyValue should return nil for a valid key and value
	require.NoError(t, db.ValidateKeyValue("testKey", []byte("testValue")), "leveldb should accept all key-values")
}

func TestValueAndMetadataWrites(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestValueAndMetadataWrites(t, env.DBProvider)
}

func TestPaginatedRangeQuery(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestPaginatedRangeQuery(t, env.DBProvider)
}

func TestRangeQuerySpecialCharacters(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestRangeQuerySpecialCharacters(t, env.DBProvider)
}

func TestApplyUpdatesWithNilHeight(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestApplyUpdatesWithNilHeight(t, env.DBProvider)
}

func TestDataExportImport(t *testing.T) {
	// smaller batch size for testing to cover the boundary case of writing the final batch
	maxDataImportBatchSize = 10
	env := NewTestVDBEnv(t)
	defer env.Cleanup()
	commontests.TestDataExportImport(
		t,
		env.DBProvider,
	)
}

func TestFullScanIteratorErrorPropagation(t *testing.T) {
	var env *TestVDBEnv
	var cleanup func()
	var vdbProvider *VersionedDBProvider
	var vdb *versionedDB

	initEnv := func() {
		env = NewTestVDBEnv(t)
		vdbProvider = env.DBProvider
		db, err := vdbProvider.GetDBHandle("TestFullScanIteratorErrorPropagation", nil)
		require.NoError(t, err)
		vdb = db.(*versionedDB)
		cleanup = func() {
			env.Cleanup()
		}
	}

	reInitEnv := func() {
		env.Cleanup()
		initEnv()
	}

	initEnv()
	defer cleanup()

	// error from function GetFullScanIterator
	vdbProvider.Close()
	_, err := vdb.GetFullScanIterator(
		func(string) bool {
			return false
		},
	)
	require.Contains(t, err.Error(), "internal leveldb error while obtaining db iterator:")

	// error from function Next
	reInitEnv()
	itr, err := vdb.GetFullScanIterator(
		func(string) bool {
			return false
		},
	)
	require.NoError(t, err)
	itr.Close()
	_, err = itr.Next()
	require.Contains(t, err.Error(), "internal leveldb error while retrieving data from db iterator:")
}

func TestImportStateErrorPropagation(t *testing.T) {
	var env *TestVDBEnv
	var cleanup func()
	var vdbProvider *VersionedDBProvider

	initEnv := func() {
		env = NewTestVDBEnv(t)
		vdbProvider = env.DBProvider
		cleanup = func() {
			env.Cleanup()
		}
	}

	t.Run("error-reading-from-source", func(t *testing.T) {
		initEnv()
		defer cleanup()

		err := vdbProvider.ImportFromSnapshot(
			"test-db",
			version.NewHeight(2, 2),
			&dummyFullScanIter{
				err: errors.New("error while reading from source"),
			},
		)

		require.EqualError(t, err, "error while reading from source")
	})

	t.Run("error-writing-to-db", func(t *testing.T) {
		initEnv()
		defer cleanup()

		vdbProvider.Close()
		err := vdbProvider.ImportFromSnapshot("test-db", version.NewHeight(2, 2),
			&dummyFullScanIter{
				kv: &statedb.VersionedKV{
					CompositeKey: &statedb.CompositeKey{
						Namespace: "ns",
						Key:       "key",
					},
					VersionedValue: &statedb.VersionedValue{
						Value:   []byte("value"),
						Version: version.NewHeight(1, 1),
					},
				},
			},
		)
		require.Contains(t, err.Error(), "error writing batch to leveldb")
	})
}

func TestDrop(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()

	checkDBsAfterDropFunc := func(channelName string) {
		empty, err := env.DBProvider.dbProvider.GetDBHandle(channelName).IsEmpty()
		require.NoError(t, err)
		require.True(t, empty)
	}

	commontests.TestDrop(t, env.DBProvider, checkDBsAfterDropFunc)
}

func TestDropErrorPath(t *testing.T) {
	env := NewTestVDBEnv(t)
	defer env.Cleanup()

	_, err := env.DBProvider.GetDBHandle("testdroperror", nil)
	require.NoError(t, err)

	env.DBProvider.Close()
	require.EqualError(t, env.DBProvider.Drop("testdroperror"), "internal leveldb error while obtaining db iterator: leveldb: closed")
}

type dummyFullScanIter struct {
	err error
	kv  *statedb.VersionedKV
}

func (d *dummyFullScanIter) Next() (*statedb.VersionedKV, error) {
	return d.kv, d.err
}

func (d *dummyFullScanIter) Close() {
}