Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

database: add applicable dbtests for linkeddb #3486

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 36 additions & 17 deletions database/dbtest/dbtest.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,20 @@ import (
"github.com/ava-labs/avalanchego/utils/units"
)

// TestsBasic is a list of all basic database tests that require only
// a KeyValueReaderWriterDeleter.
var TestsBasic = map[string]func(t *testing.T, db database.KeyValueReaderWriterDeleter){
"SimpleKeyValue": TestSimpleKeyValue,
"OverwriteKeyValue": TestOverwriteKeyValue,
"EmptyKey": TestEmptyKey,
"KeyEmptyValue": TestKeyEmptyValue,
"MemorySafetyDatabase": TestMemorySafetyDatabase,
"ModifyValueAfterPut": TestModifyValueAfterPut,
"PutGetEmpty": TestPutGetEmpty,
}

// Tests is a list of all database tests
var Tests = map[string]func(t *testing.T, db database.Database){
"SimpleKeyValue": TestSimpleKeyValue,
"OverwriteKeyValue": TestOverwriteKeyValue,
"EmptyKey": TestEmptyKey,
"KeyEmptyValue": TestKeyEmptyValue,
"SimpleKeyValueClosed": TestSimpleKeyValueClosed,
"NewBatchClosed": TestNewBatchClosed,
"BatchPut": TestBatchPut,
Expand All @@ -49,23 +57,29 @@ var Tests = map[string]func(t *testing.T, db database.Database){
"IteratorError": TestIteratorError,
"IteratorErrorAfterRelease": TestIteratorErrorAfterRelease,
"CompactNoPanic": TestCompactNoPanic,
"MemorySafetyDatabase": TestMemorySafetyDatabase,
"MemorySafetyBatch": TestMemorySafetyBatch,
"AtomicClear": TestAtomicClear,
"Clear": TestClear,
"AtomicClearPrefix": TestAtomicClearPrefix,
"ClearPrefix": TestClearPrefix,
"ModifyValueAfterPut": TestModifyValueAfterPut,
"ModifyValueAfterBatchPut": TestModifyValueAfterBatchPut,
"ModifyValueAfterBatchPutReplay": TestModifyValueAfterBatchPutReplay,
"ConcurrentBatches": TestConcurrentBatches,
"ManySmallConcurrentKVPairBatches": TestManySmallConcurrentKVPairBatches,
"PutGetEmpty": TestPutGetEmpty,
}

func init() {
// Add all basic database tests to the database tests
for name, test := range TestsBasic {
Tests[name] = func(t *testing.T, db database.Database) {
test(t, db)
}
}
}

// TestSimpleKeyValue tests to make sure that simple Put + Get + Delete + Has
// calls return the expected values.
func TestSimpleKeyValue(t *testing.T, db database.Database) {
func TestSimpleKeyValue(t *testing.T, db database.KeyValueReaderWriterDeleter) {
require := require.New(t)

key := []byte("hello")
Expand Down Expand Up @@ -101,7 +115,7 @@ func TestSimpleKeyValue(t *testing.T, db database.Database) {
require.NoError(db.Delete(key))
}

func TestOverwriteKeyValue(t *testing.T, db database.Database) {
func TestOverwriteKeyValue(t *testing.T, db database.KeyValueReaderWriterDeleter) {
require := require.New(t)

key := []byte("hello")
Expand All @@ -117,7 +131,7 @@ func TestOverwriteKeyValue(t *testing.T, db database.Database) {
require.Equal(value2, gotValue)
}

func TestKeyEmptyValue(t *testing.T, db database.Database) {
func TestKeyEmptyValue(t *testing.T, db database.KeyValueReaderWriterDeleter) {
require := require.New(t)

key := []byte("hello")
Expand All @@ -133,7 +147,7 @@ func TestKeyEmptyValue(t *testing.T, db database.Database) {
require.Empty(value)
}

func TestEmptyKey(t *testing.T, db database.Database) {
func TestEmptyKey(t *testing.T, db database.KeyValueReaderWriterDeleter) {
require := require.New(t)

var (
Expand Down Expand Up @@ -202,7 +216,7 @@ func TestSimpleKeyValueClosed(t *testing.T, db database.Database) {

// TestMemorySafetyDatabase ensures it is safe to modify a key after passing it
// to Database.Put and Database.Get.
func TestMemorySafetyDatabase(t *testing.T, db database.Database) {
func TestMemorySafetyDatabase(t *testing.T, db database.KeyValueReaderWriterDeleter) {
require := require.New(t)

key := []byte("1key")
Expand All @@ -211,9 +225,14 @@ func TestMemorySafetyDatabase(t *testing.T, db database.Database) {
key2 := []byte("2key")
value2 := []byte("value2")

// Put both K/V pairs in the database
// Put key in the database directly
require.NoError(db.Put(key, value))
require.NoError(db.Put(key2, value2))

// Put key2 in the database by modifying key, which should be safe
// to modify after the Put call
key[0] = key2[0]
require.NoError(db.Put(key, value2))
key[0] = keyCopy[0]

// Get the value for [key]
gotVal, err := db.Get(key)
Expand Down Expand Up @@ -1042,7 +1061,7 @@ func testClearPrefix(t *testing.T, db database.Database, clearF func(database.Da
require.NoError(db.Close())
}

func TestModifyValueAfterPut(t *testing.T, db database.Database) {
func TestModifyValueAfterPut(t *testing.T, db database.KeyValueReaderWriterDeleter) {
require := require.New(t)

key := []byte{1}
Expand Down Expand Up @@ -1166,7 +1185,7 @@ func runConcurrentBatches(
return eg.Wait()
}

func TestPutGetEmpty(t *testing.T, db database.Database) {
func TestPutGetEmpty(t *testing.T, db database.KeyValueReaderWriterDeleter) {
require := require.New(t)

key := []byte("hello")
Expand All @@ -1184,7 +1203,7 @@ func TestPutGetEmpty(t *testing.T, db database.Database) {
require.Empty(value) // May be nil or empty byte slice.
}

func FuzzKeyValue(f *testing.F, db database.Database) {
func FuzzKeyValue(f *testing.F, db database.KeyValueReaderWriterDeleter) {
f.Fuzz(func(t *testing.T, key []byte, value []byte) {
require := require.New(t)

Expand Down
25 changes: 25 additions & 0 deletions database/linkeddb/db_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.

package linkeddb

import (
"testing"

"github.com/ava-labs/avalanchego/database/dbtest"
"github.com/ava-labs/avalanchego/database/memdb"
)

func TestInterface(t *testing.T) {
for name, test := range dbtest.TestsBasic {
t.Run(name, func(t *testing.T) {
db := NewDefault(memdb.New())
test(t, db)
})
}
}

func FuzzKeyValue(f *testing.F) {
db := NewDefault(memdb.New())
dbtest.FuzzKeyValue(f, db)
}
2 changes: 2 additions & 0 deletions database/linkeddb/linkeddb.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ func (ldb *linkedDB) Put(key, value []byte) error {
}

// The key isn't currently in the list, so we should add it as the head.
// Note we will copy the key so it's safe to store references to it.
key = slices.Clone(key)
newHead := node{Value: slices.Clone(value)}
if headKey, err := ldb.getHeadKey(); err == nil {
// The list currently has a head, so we need to update the old head.
Expand Down
Loading