aboutsummaryrefslogtreecommitdiffstats
path: root/Godeps/_workspace/src/github.com/syndtr/goleveldb/leveldb/testutil/kvtest.go
blob: a0b58f0e7252b632651a6480f32fc47e973cca01 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// Copyright (c) 2014, Suryandaru Triandana <syndtr@gmail.com>
// All rights reserved.
//
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package testutil

import (
    "fmt"
    "math/rand"

    . "github.com/onsi/ginkgo"
    . "github.com/onsi/gomega"

    "github.com/syndtr/goleveldb/leveldb/errors"
    "github.com/syndtr/goleveldb/leveldb/util"
)

func KeyValueTesting(rnd *rand.Rand, kv KeyValue, p DB, setup func(KeyValue) DB, teardown func(DB)) {
    if rnd == nil {
        rnd = NewRand()
    }

    if p == nil {
        BeforeEach(func() {
            p = setup(kv)
        })
        if teardown != nil {
            AfterEach(func() {
                teardown(p)
            })
        }
    }

    It("Should find all keys with Find", func() {
        if db, ok := p.(Find); ok {
            ShuffledIndex(nil, kv.Len(), 1, func(i int) {
                key_, key, value := kv.IndexInexact(i)

                // Using exact key.
                rkey, rvalue, err := db.TestFind(key)
                Expect(err).ShouldNot(HaveOccurred(), "Error for key %q", key)
                Expect(rkey).Should(Equal(key), "Key")
                Expect(rvalue).Should(Equal(value), "Value for key %q", key)

                // Using inexact key.
                rkey, rvalue, err = db.TestFind(key_)
                Expect(err).ShouldNot(HaveOccurred(), "Error for key %q (%q)", key_, key)
                Expect(rkey).Should(Equal(key))
                Expect(rvalue).Should(Equal(value), "Value for key %q (%q)", key_, key)
            })
        }
    })

    It("Should return error if the key is not present", func() {
        if db, ok := p.(Find); ok {
            var key []byte
            if kv.Len() > 0 {
                key_, _ := kv.Index(kv.Len() - 1)
                key = BytesAfter(key_)
            }
            rkey, _, err := db.TestFind(key)
            Expect(err).Should(HaveOccurred(), "Find for key %q yield key %q", key, rkey)
            Expect(err).Should(Equal(errors.ErrNotFound))
        }
    })

    It("Should only find exact key with Get", func() {
        if db, ok := p.(Get); ok {
            ShuffledIndex(nil, kv.Len(), 1, func(i int) {
                key_, key, value := kv.IndexInexact(i)

                // Using exact key.
                rvalue, err := db.TestGet(key)
                Expect(err).ShouldNot(HaveOccurred(), "Error for key %q", key)
                Expect(rvalue).Should(Equal(value), "Value for key %q", key)

                // Using inexact key.
                if len(key_) > 0 {
                    _, err = db.TestGet(key_)
                    Expect(err).Should(HaveOccurred(), "Error for key %q", key_)
                    Expect(err).Should(Equal(errors.ErrNotFound))
                }
            })
        }
    })

    It("Should only find present key with Has", func() {
        if db, ok := p.(Has); ok {
            ShuffledIndex(nil, kv.Len(), 1, func(i int) {
                key_, key, _ := kv.IndexInexact(i)

                // Using exact key.
                ret, err := db.TestHas(key)
                Expect(err).ShouldNot(HaveOccurred(), "Error for key %q", key)
                Expect(ret).Should(BeTrue(), "False for key %q", key)

                // Using inexact key.
                if len(key_) > 0 {
                    ret, err = db.TestHas(key_)
                    Expect(err).ShouldNot(HaveOccurred(), "Error for key %q", key_)
                    Expect(ret).ShouldNot(BeTrue(), "True for key %q", key)
                }
            })
        }
    })

    TestIter := func(r *util.Range, _kv KeyValue) {
        if db, ok := p.(NewIterator); ok {
            iter := db.TestNewIterator(r)
            Expect(iter.Error()).ShouldNot(HaveOccurred())

            t := IteratorTesting{
                KeyValue: _kv,
                Iter:     iter,
            }

            DoIteratorTesting(&t)
            iter.Release()
        }
    }

    It("Should iterates and seeks correctly", func(done Done) {
        TestIter(nil, kv.Clone())
        done <- true
    }, 3.0)

    RandomIndex(rnd, kv.Len(), Min(kv.Len(), 50), func(i int) {
        type slice struct {
            r            *util.Range
            start, limit int
        }

        key_, _, _ := kv.IndexInexact(i)
        for _, x := range []slice{
            {&util.Range{Start: key_, Limit: nil}, i, kv.Len()},
            {&util.Range{Start: nil, Limit: key_}, 0, i},
        } {
            It(fmt.Sprintf("Should iterates and seeks correctly of a slice %d .. %d", x.start, x.limit), func(done Done) {
                TestIter(x.r, kv.Slice(x.start, x.limit))
                done <- true
            }, 3.0)
        }
    })

    RandomRange(rnd, kv.Len(), Min(kv.Len(), 50), func(start, limit int) {
        It(fmt.Sprintf("Should iterates and seeks correctly of a slice %d .. %d", start, limit), func(done Done) {
            r := kv.Range(start, limit)
            TestIter(&r, kv.Slice(start, limit))
            done <- true
        }, 3.0)
    })
}

func AllKeyValueTesting(rnd *rand.Rand, body, setup func(KeyValue) DB, teardown func(DB)) {
    Test := func(kv *KeyValue) func() {
        return func() {
            var p DB
            if setup != nil {
                Defer("setup", func() {
                    p = setup(*kv)
                })
            }
            if teardown != nil {
                Defer("teardown", func() {
                    teardown(p)
                })
            }
            if body != nil {
                p = body(*kv)
            }
            KeyValueTesting(rnd, *kv, p, func(KeyValue) DB {
                return p
            }, nil)
        }
    }

    Describe("with no key/value (empty)", Test(&KeyValue{}))
    Describe("with empty key", Test(KeyValue_EmptyKey()))
    Describe("with empty value", Test(KeyValue_EmptyValue()))
    Describe("with one key/value", Test(KeyValue_OneKeyValue()))
    Describe("with big value", Test(KeyValue_BigValue()))
    Describe("with special key", Test(KeyValue_SpecialKey()))
    Describe("with multiple key/value", Test(KeyValue_MultipleKeyValue()))
    Describe("with generated key/value", Test(KeyValue_Generate(nil, 120, 1, 50, 10, 120)))
}