mirror of https://github.com/hak5/bolt.git
1154 lines
31 KiB
Go
1154 lines
31 KiB
Go
package bolt_test
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/binary"
|
|
"errors"
|
|
"fmt"
|
|
"math/rand"
|
|
"os"
|
|
"strconv"
|
|
"strings"
|
|
"testing"
|
|
"testing/quick"
|
|
|
|
"github.com/boltdb/bolt"
|
|
)
|
|
|
|
// Ensure that a bucket that gets a non-existent key returns nil.
|
|
func TestBucket_Get_NonExistent(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
value := tx.Bucket([]byte("widgets")).Get([]byte("foo"))
|
|
assert(t, value == nil, "")
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket can read a value that is not flushed yet.
|
|
func TestBucket_Get_FromNode(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
b.Put([]byte("foo"), []byte("bar"))
|
|
value := b.Get([]byte("foo"))
|
|
equals(t, []byte("bar"), value)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket retrieved via Get() returns a nil.
|
|
func TestBucket_Get_IncompatibleValue(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
_, err := tx.Bucket([]byte("widgets")).CreateBucket([]byte("foo"))
|
|
ok(t, err)
|
|
assert(t, tx.Bucket([]byte("widgets")).Get([]byte("foo")) == nil, "")
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket can write a key/value.
|
|
func TestBucket_Put(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
err := tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("bar"))
|
|
ok(t, err)
|
|
value := tx.Bucket([]byte("widgets")).Get([]byte("foo"))
|
|
equals(t, value, []byte("bar"))
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket can rewrite a key in the same transaction.
|
|
func TestBucket_Put_Repeat(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
ok(t, b.Put([]byte("foo"), []byte("bar")))
|
|
ok(t, b.Put([]byte("foo"), []byte("baz")))
|
|
value := tx.Bucket([]byte("widgets")).Get([]byte("foo"))
|
|
equals(t, value, []byte("baz"))
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket can write a bunch of large values.
|
|
func TestBucket_Put_Large(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
|
|
count, factor := 100, 200
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
for i := 1; i < count; i++ {
|
|
ok(t, b.Put([]byte(strings.Repeat("0", i*factor)), []byte(strings.Repeat("X", (count-i)*factor))))
|
|
}
|
|
return nil
|
|
})
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("widgets"))
|
|
for i := 1; i < count; i++ {
|
|
value := b.Get([]byte(strings.Repeat("0", i*factor)))
|
|
equals(t, []byte(strings.Repeat("X", (count-i)*factor)), value)
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a database can perform multiple large appends safely.
|
|
func TestDB_Put_VeryLarge(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping test in short mode.")
|
|
}
|
|
|
|
n, batchN := 400000, 200000
|
|
ksize, vsize := 8, 500
|
|
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
|
|
for i := 0; i < n; i += batchN {
|
|
err := db.Update(func(tx *bolt.Tx) error {
|
|
b, _ := tx.CreateBucketIfNotExists([]byte("widgets"))
|
|
for j := 0; j < batchN; j++ {
|
|
k, v := make([]byte, ksize), make([]byte, vsize)
|
|
binary.BigEndian.PutUint32(k, uint32(i+j))
|
|
ok(t, b.Put(k, v))
|
|
}
|
|
return nil
|
|
})
|
|
ok(t, err)
|
|
}
|
|
}
|
|
|
|
// Ensure that a setting a value on a key with a bucket value returns an error.
|
|
func TestBucket_Put_IncompatibleValue(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
_, err := tx.Bucket([]byte("widgets")).CreateBucket([]byte("foo"))
|
|
ok(t, err)
|
|
equals(t, bolt.ErrIncompatibleValue, tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("bar")))
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a setting a value while the transaction is closed returns an error.
|
|
func TestBucket_Put_Closed(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
tx, _ := db.Begin(true)
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
tx.Rollback()
|
|
equals(t, bolt.ErrTxClosed, b.Put([]byte("foo"), []byte("bar")))
|
|
}
|
|
|
|
// Ensure that setting a value on a read-only bucket returns an error.
|
|
func TestBucket_Put_ReadOnly(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, err := tx.CreateBucket([]byte("widgets"))
|
|
ok(t, err)
|
|
return nil
|
|
})
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("widgets"))
|
|
err := b.Put([]byte("foo"), []byte("bar"))
|
|
equals(t, err, bolt.ErrTxNotWritable)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket can delete an existing key.
|
|
func TestBucket_Delete(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("bar"))
|
|
err := tx.Bucket([]byte("widgets")).Delete([]byte("foo"))
|
|
ok(t, err)
|
|
value := tx.Bucket([]byte("widgets")).Get([]byte("foo"))
|
|
assert(t, value == nil, "")
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that deleting a large set of keys will work correctly.
|
|
func TestBucket_Delete_Large(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
var b, _ = tx.CreateBucket([]byte("widgets"))
|
|
for i := 0; i < 100; i++ {
|
|
ok(t, b.Put([]byte(strconv.Itoa(i)), []byte(strings.Repeat("*", 1024))))
|
|
}
|
|
return nil
|
|
})
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
var b = tx.Bucket([]byte("widgets"))
|
|
for i := 0; i < 100; i++ {
|
|
ok(t, b.Delete([]byte(strconv.Itoa(i))))
|
|
}
|
|
return nil
|
|
})
|
|
db.View(func(tx *bolt.Tx) error {
|
|
var b = tx.Bucket([]byte("widgets"))
|
|
for i := 0; i < 100; i++ {
|
|
assert(t, b.Get([]byte(strconv.Itoa(i))) == nil, "")
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Deleting a very large list of keys will cause the freelist to use overflow.
|
|
func TestBucket_Delete_FreelistOverflow(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping test in short mode.")
|
|
}
|
|
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
k := make([]byte, 16)
|
|
for i := uint64(0); i < 10000; i++ {
|
|
err := db.Update(func(tx *bolt.Tx) error {
|
|
b, err := tx.CreateBucketIfNotExists([]byte("0"))
|
|
if err != nil {
|
|
t.Fatalf("bucket error: %s", err)
|
|
}
|
|
|
|
for j := uint64(0); j < 1000; j++ {
|
|
binary.BigEndian.PutUint64(k[:8], i)
|
|
binary.BigEndian.PutUint64(k[8:], j)
|
|
if err := b.Put(k, nil); err != nil {
|
|
t.Fatalf("put error: %s", err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
})
|
|
|
|
if err != nil {
|
|
t.Fatalf("update error: %s", err)
|
|
}
|
|
}
|
|
|
|
// Delete all of them in one large transaction
|
|
err := db.Update(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("0"))
|
|
c := b.Cursor()
|
|
for k, _ := c.First(); k != nil; k, _ = c.Next() {
|
|
b.Delete(k)
|
|
}
|
|
return nil
|
|
})
|
|
|
|
// Check that a freelist overflow occurred.
|
|
ok(t, err)
|
|
}
|
|
|
|
// Ensure that accessing and updating nested buckets is ok across transactions.
|
|
func TestBucket_Nested(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
// Create a widgets bucket.
|
|
b, err := tx.CreateBucket([]byte("widgets"))
|
|
ok(t, err)
|
|
|
|
// Create a widgets/foo bucket.
|
|
_, err = b.CreateBucket([]byte("foo"))
|
|
ok(t, err)
|
|
|
|
// Create a widgets/bar key.
|
|
ok(t, b.Put([]byte("bar"), []byte("0000")))
|
|
|
|
return nil
|
|
})
|
|
db.MustCheck()
|
|
|
|
// Update widgets/bar.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
var b = tx.Bucket([]byte("widgets"))
|
|
ok(t, b.Put([]byte("bar"), []byte("xxxx")))
|
|
return nil
|
|
})
|
|
db.MustCheck()
|
|
|
|
// Cause a split.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
var b = tx.Bucket([]byte("widgets"))
|
|
for i := 0; i < 10000; i++ {
|
|
ok(t, b.Put([]byte(strconv.Itoa(i)), []byte(strconv.Itoa(i))))
|
|
}
|
|
return nil
|
|
})
|
|
db.MustCheck()
|
|
|
|
// Insert into widgets/foo/baz.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
var b = tx.Bucket([]byte("widgets"))
|
|
ok(t, b.Bucket([]byte("foo")).Put([]byte("baz"), []byte("yyyy")))
|
|
return nil
|
|
})
|
|
db.MustCheck()
|
|
|
|
// Verify.
|
|
db.View(func(tx *bolt.Tx) error {
|
|
var b = tx.Bucket([]byte("widgets"))
|
|
equals(t, []byte("yyyy"), b.Bucket([]byte("foo")).Get([]byte("baz")))
|
|
equals(t, []byte("xxxx"), b.Get([]byte("bar")))
|
|
for i := 0; i < 10000; i++ {
|
|
equals(t, []byte(strconv.Itoa(i)), b.Get([]byte(strconv.Itoa(i))))
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that deleting a bucket using Delete() returns an error.
|
|
func TestBucket_Delete_Bucket(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
_, err := b.CreateBucket([]byte("foo"))
|
|
ok(t, err)
|
|
equals(t, bolt.ErrIncompatibleValue, b.Delete([]byte("foo")))
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that deleting a key on a read-only bucket returns an error.
|
|
func TestBucket_Delete_ReadOnly(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
return nil
|
|
})
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("widgets"))
|
|
err := b.Delete([]byte("foo"))
|
|
equals(t, err, bolt.ErrTxNotWritable)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a deleting value while the transaction is closed returns an error.
|
|
func TestBucket_Delete_Closed(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
tx, _ := db.Begin(true)
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
tx.Rollback()
|
|
equals(t, bolt.ErrTxClosed, b.Delete([]byte("foo")))
|
|
}
|
|
|
|
// Ensure that deleting a bucket causes nested buckets to be deleted.
|
|
func TestBucket_DeleteBucket_Nested(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
_, err := tx.Bucket([]byte("widgets")).CreateBucket([]byte("foo"))
|
|
ok(t, err)
|
|
_, err = tx.Bucket([]byte("widgets")).Bucket([]byte("foo")).CreateBucket([]byte("bar"))
|
|
ok(t, err)
|
|
ok(t, tx.Bucket([]byte("widgets")).Bucket([]byte("foo")).Bucket([]byte("bar")).Put([]byte("baz"), []byte("bat")))
|
|
ok(t, tx.Bucket([]byte("widgets")).DeleteBucket([]byte("foo")))
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that deleting a bucket causes nested buckets to be deleted after they have been committed.
|
|
func TestBucket_DeleteBucket_Nested2(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
_, err := tx.Bucket([]byte("widgets")).CreateBucket([]byte("foo"))
|
|
ok(t, err)
|
|
_, err = tx.Bucket([]byte("widgets")).Bucket([]byte("foo")).CreateBucket([]byte("bar"))
|
|
ok(t, err)
|
|
ok(t, tx.Bucket([]byte("widgets")).Bucket([]byte("foo")).Bucket([]byte("bar")).Put([]byte("baz"), []byte("bat")))
|
|
return nil
|
|
})
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
assert(t, tx.Bucket([]byte("widgets")) != nil, "")
|
|
assert(t, tx.Bucket([]byte("widgets")).Bucket([]byte("foo")) != nil, "")
|
|
assert(t, tx.Bucket([]byte("widgets")).Bucket([]byte("foo")).Bucket([]byte("bar")) != nil, "")
|
|
equals(t, []byte("bat"), tx.Bucket([]byte("widgets")).Bucket([]byte("foo")).Bucket([]byte("bar")).Get([]byte("baz")))
|
|
ok(t, tx.DeleteBucket([]byte("widgets")))
|
|
return nil
|
|
})
|
|
db.View(func(tx *bolt.Tx) error {
|
|
assert(t, tx.Bucket([]byte("widgets")) == nil, "")
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that deleting a child bucket with multiple pages causes all pages to get collected.
|
|
func TestBucket_DeleteBucket_Large(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, err := tx.CreateBucket([]byte("widgets"))
|
|
ok(t, err)
|
|
_, err = tx.Bucket([]byte("widgets")).CreateBucket([]byte("foo"))
|
|
ok(t, err)
|
|
b := tx.Bucket([]byte("widgets")).Bucket([]byte("foo"))
|
|
for i := 0; i < 1000; i++ {
|
|
ok(t, b.Put([]byte(fmt.Sprintf("%d", i)), []byte(fmt.Sprintf("%0100d", i))))
|
|
}
|
|
return nil
|
|
})
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
ok(t, tx.DeleteBucket([]byte("widgets")))
|
|
return nil
|
|
})
|
|
|
|
// NOTE: Consistency check in TestDB.Close() will panic if pages not freed properly.
|
|
}
|
|
|
|
// Ensure that a simple value retrieved via Bucket() returns a nil.
|
|
func TestBucket_Bucket_IncompatibleValue(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
ok(t, tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("bar")))
|
|
assert(t, tx.Bucket([]byte("widgets")).Bucket([]byte("foo")) == nil, "")
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that creating a bucket on an existing non-bucket key returns an error.
|
|
func TestBucket_CreateBucket_IncompatibleValue(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, err := tx.CreateBucket([]byte("widgets"))
|
|
ok(t, err)
|
|
ok(t, tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("bar")))
|
|
_, err = tx.Bucket([]byte("widgets")).CreateBucket([]byte("foo"))
|
|
equals(t, bolt.ErrIncompatibleValue, err)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that deleting a bucket on an existing non-bucket key returns an error.
|
|
func TestBucket_DeleteBucket_IncompatibleValue(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, err := tx.CreateBucket([]byte("widgets"))
|
|
ok(t, err)
|
|
ok(t, tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("bar")))
|
|
equals(t, bolt.ErrIncompatibleValue, tx.Bucket([]byte("widgets")).DeleteBucket([]byte("foo")))
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket can return an autoincrementing sequence.
|
|
func TestBucket_NextSequence(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
tx.CreateBucket([]byte("woojits"))
|
|
|
|
// Make sure sequence increments.
|
|
seq, err := tx.Bucket([]byte("widgets")).NextSequence()
|
|
ok(t, err)
|
|
equals(t, seq, uint64(1))
|
|
seq, err = tx.Bucket([]byte("widgets")).NextSequence()
|
|
ok(t, err)
|
|
equals(t, seq, uint64(2))
|
|
|
|
// Buckets should be separate.
|
|
seq, err = tx.Bucket([]byte("woojits")).NextSequence()
|
|
ok(t, err)
|
|
equals(t, seq, uint64(1))
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket will persist an autoincrementing sequence even if its
|
|
// the only thing updated on the bucket.
|
|
// https://github.com/boltdb/bolt/issues/296
|
|
func TestBucket_NextSequence_Persist(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, _ = tx.CreateBucket([]byte("widgets"))
|
|
return nil
|
|
})
|
|
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, _ = tx.Bucket([]byte("widgets")).NextSequence()
|
|
return nil
|
|
})
|
|
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
seq, err := tx.Bucket([]byte("widgets")).NextSequence()
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %s", err)
|
|
} else if seq != 2 {
|
|
t.Fatalf("unexpected sequence: %d", seq)
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that retrieving the next sequence on a read-only bucket returns an error.
|
|
func TestBucket_NextSequence_ReadOnly(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
return nil
|
|
})
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("widgets"))
|
|
i, err := b.NextSequence()
|
|
equals(t, i, uint64(0))
|
|
equals(t, err, bolt.ErrTxNotWritable)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that retrieving the next sequence for a bucket on a closed database return an error.
|
|
func TestBucket_NextSequence_Closed(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
tx, _ := db.Begin(true)
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
tx.Rollback()
|
|
_, err := b.NextSequence()
|
|
equals(t, bolt.ErrTxClosed, err)
|
|
}
|
|
|
|
// Ensure a user can loop over all key/value pairs in a bucket.
|
|
func TestBucket_ForEach(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("0000"))
|
|
tx.Bucket([]byte("widgets")).Put([]byte("baz"), []byte("0001"))
|
|
tx.Bucket([]byte("widgets")).Put([]byte("bar"), []byte("0002"))
|
|
|
|
var index int
|
|
err := tx.Bucket([]byte("widgets")).ForEach(func(k, v []byte) error {
|
|
switch index {
|
|
case 0:
|
|
equals(t, k, []byte("bar"))
|
|
equals(t, v, []byte("0002"))
|
|
case 1:
|
|
equals(t, k, []byte("baz"))
|
|
equals(t, v, []byte("0001"))
|
|
case 2:
|
|
equals(t, k, []byte("foo"))
|
|
equals(t, v, []byte("0000"))
|
|
}
|
|
index++
|
|
return nil
|
|
})
|
|
ok(t, err)
|
|
equals(t, index, 3)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure a database can stop iteration early.
|
|
func TestBucket_ForEach_ShortCircuit(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
tx.Bucket([]byte("widgets")).Put([]byte("bar"), []byte("0000"))
|
|
tx.Bucket([]byte("widgets")).Put([]byte("baz"), []byte("0000"))
|
|
tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("0000"))
|
|
|
|
var index int
|
|
err := tx.Bucket([]byte("widgets")).ForEach(func(k, v []byte) error {
|
|
index++
|
|
if bytes.Equal(k, []byte("baz")) {
|
|
return errors.New("marker")
|
|
}
|
|
return nil
|
|
})
|
|
equals(t, errors.New("marker"), err)
|
|
equals(t, 2, index)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that looping over a bucket on a closed database returns an error.
|
|
func TestBucket_ForEach_Closed(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
tx, _ := db.Begin(true)
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
tx.Rollback()
|
|
err := b.ForEach(func(k, v []byte) error { return nil })
|
|
equals(t, bolt.ErrTxClosed, err)
|
|
}
|
|
|
|
// Ensure that an error is returned when inserting with an empty key.
|
|
func TestBucket_Put_EmptyKey(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
err := tx.Bucket([]byte("widgets")).Put([]byte(""), []byte("bar"))
|
|
equals(t, err, bolt.ErrKeyRequired)
|
|
err = tx.Bucket([]byte("widgets")).Put(nil, []byte("bar"))
|
|
equals(t, err, bolt.ErrKeyRequired)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that an error is returned when inserting with a key that's too large.
|
|
func TestBucket_Put_KeyTooLarge(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("widgets"))
|
|
err := tx.Bucket([]byte("widgets")).Put(make([]byte, 32769), []byte("bar"))
|
|
equals(t, err, bolt.ErrKeyTooLarge)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure a bucket can calculate stats.
|
|
func TestBucket_Stats(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
|
|
// Add bucket with fewer keys but one big value.
|
|
big_key := []byte("really-big-value")
|
|
for i := 0; i < 500; i++ {
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
b, _ := tx.CreateBucketIfNotExists([]byte("woojits"))
|
|
return b.Put([]byte(fmt.Sprintf("%03d", i)), []byte(strconv.Itoa(i)))
|
|
})
|
|
}
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
b, _ := tx.CreateBucketIfNotExists([]byte("woojits"))
|
|
return b.Put(big_key, []byte(strings.Repeat("*", 10000)))
|
|
})
|
|
|
|
db.MustCheck()
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("woojits"))
|
|
stats := b.Stats()
|
|
equals(t, 1, stats.BranchPageN)
|
|
equals(t, 0, stats.BranchOverflowN)
|
|
equals(t, 7, stats.LeafPageN)
|
|
equals(t, 2, stats.LeafOverflowN)
|
|
equals(t, 501, stats.KeyN)
|
|
equals(t, 2, stats.Depth)
|
|
|
|
branchInuse := 16 // branch page header
|
|
branchInuse += 7 * 16 // branch elements
|
|
branchInuse += 7 * 3 // branch keys (6 3-byte keys)
|
|
equals(t, branchInuse, stats.BranchInuse)
|
|
|
|
leafInuse := 7 * 16 // leaf page header
|
|
leafInuse += 501 * 16 // leaf elements
|
|
leafInuse += 500*3 + len(big_key) // leaf keys
|
|
leafInuse += 1*10 + 2*90 + 3*400 + 10000 // leaf values
|
|
equals(t, leafInuse, stats.LeafInuse)
|
|
|
|
if os.Getpagesize() == 4096 {
|
|
// Incompatible page size
|
|
equals(t, 4096, stats.BranchAlloc)
|
|
equals(t, 36864, stats.LeafAlloc)
|
|
}
|
|
|
|
equals(t, 1, stats.BucketN)
|
|
equals(t, 0, stats.InlineBucketN)
|
|
equals(t, 0, stats.InlineBucketInuse)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure a bucket with random insertion utilizes fill percentage correctly.
|
|
func TestBucket_Stats_RandomFill(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping test in short mode.")
|
|
} else if os.Getpagesize() != 4096 {
|
|
t.Skip("invalid page size for test")
|
|
}
|
|
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
|
|
// Add a set of values in random order. It will be the same random
|
|
// order so we can maintain consistency between test runs.
|
|
var count int
|
|
r := rand.New(rand.NewSource(42))
|
|
for _, i := range r.Perm(1000) {
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
b, _ := tx.CreateBucketIfNotExists([]byte("woojits"))
|
|
b.FillPercent = 0.9
|
|
for _, j := range r.Perm(100) {
|
|
index := (j * 10000) + i
|
|
b.Put([]byte(fmt.Sprintf("%d000000000000000", index)), []byte("0000000000"))
|
|
count++
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
db.MustCheck()
|
|
|
|
db.View(func(tx *bolt.Tx) error {
|
|
s := tx.Bucket([]byte("woojits")).Stats()
|
|
equals(t, 100000, s.KeyN)
|
|
|
|
equals(t, 98, s.BranchPageN)
|
|
equals(t, 0, s.BranchOverflowN)
|
|
equals(t, 130984, s.BranchInuse)
|
|
equals(t, 401408, s.BranchAlloc)
|
|
|
|
equals(t, 3412, s.LeafPageN)
|
|
equals(t, 0, s.LeafOverflowN)
|
|
equals(t, 4742482, s.LeafInuse)
|
|
equals(t, 13975552, s.LeafAlloc)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure a bucket can calculate stats.
|
|
func TestBucket_Stats_Small(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
// Add a bucket that fits on a single root leaf.
|
|
b, err := tx.CreateBucket([]byte("whozawhats"))
|
|
ok(t, err)
|
|
b.Put([]byte("foo"), []byte("bar"))
|
|
|
|
return nil
|
|
})
|
|
db.MustCheck()
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("whozawhats"))
|
|
stats := b.Stats()
|
|
equals(t, 0, stats.BranchPageN)
|
|
equals(t, 0, stats.BranchOverflowN)
|
|
equals(t, 0, stats.LeafPageN)
|
|
equals(t, 0, stats.LeafOverflowN)
|
|
equals(t, 1, stats.KeyN)
|
|
equals(t, 1, stats.Depth)
|
|
equals(t, 0, stats.BranchInuse)
|
|
equals(t, 0, stats.LeafInuse)
|
|
if os.Getpagesize() == 4096 {
|
|
// Incompatible page size
|
|
equals(t, 0, stats.BranchAlloc)
|
|
equals(t, 0, stats.LeafAlloc)
|
|
}
|
|
equals(t, 1, stats.BucketN)
|
|
equals(t, 1, stats.InlineBucketN)
|
|
equals(t, 16+16+6, stats.InlineBucketInuse)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
func TestBucket_Stats_EmptyBucket(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
// Add a bucket that fits on a single root leaf.
|
|
_, err := tx.CreateBucket([]byte("whozawhats"))
|
|
ok(t, err)
|
|
return nil
|
|
})
|
|
db.MustCheck()
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("whozawhats"))
|
|
stats := b.Stats()
|
|
equals(t, 0, stats.BranchPageN)
|
|
equals(t, 0, stats.BranchOverflowN)
|
|
equals(t, 0, stats.LeafPageN)
|
|
equals(t, 0, stats.LeafOverflowN)
|
|
equals(t, 0, stats.KeyN)
|
|
equals(t, 1, stats.Depth)
|
|
equals(t, 0, stats.BranchInuse)
|
|
equals(t, 0, stats.LeafInuse)
|
|
if os.Getpagesize() == 4096 {
|
|
// Incompatible page size
|
|
equals(t, 0, stats.BranchAlloc)
|
|
equals(t, 0, stats.LeafAlloc)
|
|
}
|
|
equals(t, 1, stats.BucketN)
|
|
equals(t, 1, stats.InlineBucketN)
|
|
equals(t, 16, stats.InlineBucketInuse)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure a bucket can calculate stats.
|
|
func TestBucket_Stats_Nested(t *testing.T) {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
b, err := tx.CreateBucket([]byte("foo"))
|
|
ok(t, err)
|
|
for i := 0; i < 100; i++ {
|
|
b.Put([]byte(fmt.Sprintf("%02d", i)), []byte(fmt.Sprintf("%02d", i)))
|
|
}
|
|
bar, err := b.CreateBucket([]byte("bar"))
|
|
ok(t, err)
|
|
for i := 0; i < 10; i++ {
|
|
bar.Put([]byte(strconv.Itoa(i)), []byte(strconv.Itoa(i)))
|
|
}
|
|
baz, err := bar.CreateBucket([]byte("baz"))
|
|
ok(t, err)
|
|
for i := 0; i < 10; i++ {
|
|
baz.Put([]byte(strconv.Itoa(i)), []byte(strconv.Itoa(i)))
|
|
}
|
|
return nil
|
|
})
|
|
|
|
db.MustCheck()
|
|
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("foo"))
|
|
stats := b.Stats()
|
|
equals(t, 0, stats.BranchPageN)
|
|
equals(t, 0, stats.BranchOverflowN)
|
|
equals(t, 2, stats.LeafPageN)
|
|
equals(t, 0, stats.LeafOverflowN)
|
|
equals(t, 122, stats.KeyN)
|
|
equals(t, 3, stats.Depth)
|
|
equals(t, 0, stats.BranchInuse)
|
|
|
|
foo := 16 // foo (pghdr)
|
|
foo += 101 * 16 // foo leaf elements
|
|
foo += 100*2 + 100*2 // foo leaf key/values
|
|
foo += 3 + 16 // foo -> bar key/value
|
|
|
|
bar := 16 // bar (pghdr)
|
|
bar += 11 * 16 // bar leaf elements
|
|
bar += 10 + 10 // bar leaf key/values
|
|
bar += 3 + 16 // bar -> baz key/value
|
|
|
|
baz := 16 // baz (inline) (pghdr)
|
|
baz += 10 * 16 // baz leaf elements
|
|
baz += 10 + 10 // baz leaf key/values
|
|
|
|
equals(t, foo+bar+baz, stats.LeafInuse)
|
|
if os.Getpagesize() == 4096 {
|
|
// Incompatible page size
|
|
equals(t, 0, stats.BranchAlloc)
|
|
equals(t, 8192, stats.LeafAlloc)
|
|
}
|
|
equals(t, 3, stats.BucketN)
|
|
equals(t, 1, stats.InlineBucketN)
|
|
equals(t, baz, stats.InlineBucketInuse)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure a large bucket can calculate stats.
|
|
func TestBucket_Stats_Large(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping test in short mode.")
|
|
}
|
|
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
|
|
var index int
|
|
for i := 0; i < 100; i++ {
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
// Add bucket with lots of keys.
|
|
b, _ := tx.CreateBucketIfNotExists([]byte("widgets"))
|
|
for i := 0; i < 1000; i++ {
|
|
b.Put([]byte(strconv.Itoa(index)), []byte(strconv.Itoa(index)))
|
|
index++
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
db.MustCheck()
|
|
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("widgets"))
|
|
stats := b.Stats()
|
|
equals(t, 13, stats.BranchPageN)
|
|
equals(t, 0, stats.BranchOverflowN)
|
|
equals(t, 1196, stats.LeafPageN)
|
|
equals(t, 0, stats.LeafOverflowN)
|
|
equals(t, 100000, stats.KeyN)
|
|
equals(t, 3, stats.Depth)
|
|
equals(t, 25257, stats.BranchInuse)
|
|
equals(t, 2596916, stats.LeafInuse)
|
|
if os.Getpagesize() == 4096 {
|
|
// Incompatible page size
|
|
equals(t, 53248, stats.BranchAlloc)
|
|
equals(t, 4898816, stats.LeafAlloc)
|
|
}
|
|
equals(t, 1, stats.BucketN)
|
|
equals(t, 0, stats.InlineBucketN)
|
|
equals(t, 0, stats.InlineBucketInuse)
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// Ensure that a bucket can write random keys and values across multiple transactions.
|
|
func TestBucket_Put_Single(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping test in short mode.")
|
|
}
|
|
|
|
index := 0
|
|
f := func(items testdata) bool {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
|
|
m := make(map[string][]byte)
|
|
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, err := tx.CreateBucket([]byte("widgets"))
|
|
return err
|
|
})
|
|
for _, item := range items {
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
if err := tx.Bucket([]byte("widgets")).Put(item.Key, item.Value); err != nil {
|
|
panic("put error: " + err.Error())
|
|
}
|
|
m[string(item.Key)] = item.Value
|
|
return nil
|
|
})
|
|
|
|
// Verify all key/values so far.
|
|
db.View(func(tx *bolt.Tx) error {
|
|
i := 0
|
|
for k, v := range m {
|
|
value := tx.Bucket([]byte("widgets")).Get([]byte(k))
|
|
if !bytes.Equal(value, v) {
|
|
t.Logf("value mismatch [run %d] (%d of %d):\nkey: %x\ngot: %x\nexp: %x", index, i, len(m), []byte(k), value, v)
|
|
db.CopyTempFile()
|
|
t.FailNow()
|
|
}
|
|
i++
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
index++
|
|
return true
|
|
}
|
|
if err := quick.Check(f, qconfig()); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
// Ensure that a transaction can insert multiple key/value pairs at once.
|
|
func TestBucket_Put_Multiple(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping test in short mode.")
|
|
}
|
|
|
|
f := func(items testdata) bool {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
// Bulk insert all values.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, err := tx.CreateBucket([]byte("widgets"))
|
|
return err
|
|
})
|
|
err := db.Update(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("widgets"))
|
|
for _, item := range items {
|
|
ok(t, b.Put(item.Key, item.Value))
|
|
}
|
|
return nil
|
|
})
|
|
ok(t, err)
|
|
|
|
// Verify all items exist.
|
|
db.View(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("widgets"))
|
|
for _, item := range items {
|
|
value := b.Get(item.Key)
|
|
if !bytes.Equal(item.Value, value) {
|
|
db.CopyTempFile()
|
|
t.Fatalf("exp=%x; got=%x", item.Value, value)
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
return true
|
|
}
|
|
if err := quick.Check(f, qconfig()); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
// Ensure that a transaction can delete all key/value pairs and return to a single leaf page.
|
|
func TestBucket_Delete_Quick(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping test in short mode.")
|
|
}
|
|
|
|
f := func(items testdata) bool {
|
|
db := NewTestDB()
|
|
defer db.Close()
|
|
// Bulk insert all values.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
_, err := tx.CreateBucket([]byte("widgets"))
|
|
return err
|
|
})
|
|
err := db.Update(func(tx *bolt.Tx) error {
|
|
b := tx.Bucket([]byte("widgets"))
|
|
for _, item := range items {
|
|
ok(t, b.Put(item.Key, item.Value))
|
|
}
|
|
return nil
|
|
})
|
|
ok(t, err)
|
|
|
|
// Remove items one at a time and check consistency.
|
|
for _, item := range items {
|
|
err := db.Update(func(tx *bolt.Tx) error {
|
|
return tx.Bucket([]byte("widgets")).Delete(item.Key)
|
|
})
|
|
ok(t, err)
|
|
}
|
|
|
|
// Anything before our deletion index should be nil.
|
|
db.View(func(tx *bolt.Tx) error {
|
|
tx.Bucket([]byte("widgets")).ForEach(func(k, v []byte) error {
|
|
t.Fatalf("bucket should be empty; found: %06x", trunc(k, 3))
|
|
return nil
|
|
})
|
|
return nil
|
|
})
|
|
return true
|
|
}
|
|
if err := quick.Check(f, qconfig()); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
func ExampleBucket_Put() {
|
|
// Open the database.
|
|
db, _ := bolt.Open(tempfile(), 0666, nil)
|
|
defer os.Remove(db.Path())
|
|
defer db.Close()
|
|
|
|
// Start a write transaction.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
// Create a bucket.
|
|
tx.CreateBucket([]byte("widgets"))
|
|
|
|
// Set the value "bar" for the key "foo".
|
|
tx.Bucket([]byte("widgets")).Put([]byte("foo"), []byte("bar"))
|
|
return nil
|
|
})
|
|
|
|
// Read value back in a different read-only transaction.
|
|
db.View(func(tx *bolt.Tx) error {
|
|
value := tx.Bucket([]byte("widgets")).Get([]byte("foo"))
|
|
fmt.Printf("The value of 'foo' is: %s\n", value)
|
|
return nil
|
|
})
|
|
|
|
// Output:
|
|
// The value of 'foo' is: bar
|
|
}
|
|
|
|
func ExampleBucket_Delete() {
|
|
// Open the database.
|
|
db, _ := bolt.Open(tempfile(), 0666, nil)
|
|
defer os.Remove(db.Path())
|
|
defer db.Close()
|
|
|
|
// Start a write transaction.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
// Create a bucket.
|
|
tx.CreateBucket([]byte("widgets"))
|
|
b := tx.Bucket([]byte("widgets"))
|
|
|
|
// Set the value "bar" for the key "foo".
|
|
b.Put([]byte("foo"), []byte("bar"))
|
|
|
|
// Retrieve the key back from the database and verify it.
|
|
value := b.Get([]byte("foo"))
|
|
fmt.Printf("The value of 'foo' was: %s\n", value)
|
|
return nil
|
|
})
|
|
|
|
// Delete the key in a different write transaction.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
return tx.Bucket([]byte("widgets")).Delete([]byte("foo"))
|
|
})
|
|
|
|
// Retrieve the key again.
|
|
db.View(func(tx *bolt.Tx) error {
|
|
value := tx.Bucket([]byte("widgets")).Get([]byte("foo"))
|
|
if value == nil {
|
|
fmt.Printf("The value of 'foo' is now: nil\n")
|
|
}
|
|
return nil
|
|
})
|
|
|
|
// Output:
|
|
// The value of 'foo' was: bar
|
|
// The value of 'foo' is now: nil
|
|
}
|
|
|
|
func ExampleBucket_ForEach() {
|
|
// Open the database.
|
|
db, _ := bolt.Open(tempfile(), 0666, nil)
|
|
defer os.Remove(db.Path())
|
|
defer db.Close()
|
|
|
|
// Insert data into a bucket.
|
|
db.Update(func(tx *bolt.Tx) error {
|
|
tx.CreateBucket([]byte("animals"))
|
|
b := tx.Bucket([]byte("animals"))
|
|
b.Put([]byte("dog"), []byte("fun"))
|
|
b.Put([]byte("cat"), []byte("lame"))
|
|
b.Put([]byte("liger"), []byte("awesome"))
|
|
|
|
// Iterate over items in sorted key order.
|
|
b.ForEach(func(k, v []byte) error {
|
|
fmt.Printf("A %s is %s.\n", k, v)
|
|
return nil
|
|
})
|
|
return nil
|
|
})
|
|
|
|
// Output:
|
|
// A cat is lame.
|
|
// A dog is fun.
|
|
// A liger is awesome.
|
|
}
|