aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/storage/common_test.go
blob: 6955ee8279c6dfaf40c987cabcb99369bbe02da3 (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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
// Copyright 2016 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package storage

import (
    "bytes"
    "context"
    "flag"
    "fmt"
    "io"
    "io/ioutil"
    "os"
    "sync"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/log"
    ch "github.com/ethereum/go-ethereum/swarm/chunk"
    "github.com/mattn/go-colorable"
)

var (
    loglevel   = flag.Int("loglevel", 3, "verbosity of logs")
    getTimeout = 30 * time.Second
)

func init() {
    flag.Parse()
    log.PrintOrigins(true)
    log.Root().SetHandler(log.LvlFilterHandler(log.Lvl(*loglevel), log.StreamHandler(colorable.NewColorableStderr(), log.TerminalFormat(true))))
}

type brokenLimitedReader struct {
    lr    io.Reader
    errAt int
    off   int
    size  int
}

func brokenLimitReader(data io.Reader, size int, errAt int) *brokenLimitedReader {
    return &brokenLimitedReader{
        lr:    data,
        errAt: errAt,
        size:  size,
    }
}

func newLDBStore(t *testing.T) (*LDBStore, func()) {
    dir, err := ioutil.TempDir("", "bzz-storage-test")
    if err != nil {
        t.Fatal(err)
    }
    log.Trace("memstore.tempdir", "dir", dir)

    ldbparams := NewLDBStoreParams(NewDefaultStoreParams(), dir)
    db, err := NewLDBStore(ldbparams)
    if err != nil {
        t.Fatal(err)
    }

    cleanup := func() {
        db.Close()
        err := os.RemoveAll(dir)
        if err != nil {
            t.Fatal(err)
        }
    }

    return db, cleanup
}

func mputRandomChunks(store ChunkStore, n int) ([]Chunk, error) {
    return mput(store, n, GenerateRandomChunk)
}

func mput(store ChunkStore, n int, f func(i int64) Chunk) (hs []Chunk, err error) {
    // put to localstore and wait for stored channel
    // does not check delivery error state
    errc := make(chan error)
    ctx, cancel := context.WithTimeout(context.Background(), 1*time.Minute)
    defer cancel()
    for i := int64(0); i < int64(n); i++ {
        chunk := f(ch.DefaultSize)
        go func() {
            select {
            case errc <- store.Put(ctx, chunk):
            case <-ctx.Done():
            }
        }()
        hs = append(hs, chunk)
    }

    // wait for all chunks to be stored
    for i := 0; i < n; i++ {
        err := <-errc
        if err != nil {
            return nil, err
        }
    }
    return hs, nil
}

func mget(store ChunkStore, hs []Address, f func(h Address, chunk Chunk) error) error {
    wg := sync.WaitGroup{}
    wg.Add(len(hs))
    errc := make(chan error)

    for _, k := range hs {
        go func(h Address) {
            defer wg.Done()
            // TODO: write timeout with context
            chunk, err := store.Get(context.TODO(), h)
            if err != nil {
                errc <- err
                return
            }
            if f != nil {
                err = f(h, chunk)
                if err != nil {
                    errc <- err
                    return
                }
            }
        }(k)
    }
    go func() {
        wg.Wait()
        close(errc)
    }()
    var err error
    timeout := 10 * time.Second
    select {
    case err = <-errc:
    case <-time.NewTimer(timeout).C:
        err = fmt.Errorf("timed out after %v", timeout)
    }
    return err
}

func (r *brokenLimitedReader) Read(buf []byte) (int, error) {
    if r.off+len(buf) > r.errAt {
        return 0, fmt.Errorf("Broken reader")
    }
    r.off += len(buf)
    return r.lr.Read(buf)
}

func testStoreRandom(m ChunkStore, n int, t *testing.T) {
    chunks, err := mputRandomChunks(m, n)
    if err != nil {
        t.Fatalf("expected no error, got %v", err)
    }
    err = mget(m, chunkAddresses(chunks), nil)
    if err != nil {
        t.Fatalf("testStore failed: %v", err)
    }
}

func testStoreCorrect(m ChunkStore, n int, t *testing.T) {
    chunks, err := mputRandomChunks(m, n)
    if err != nil {
        t.Fatalf("expected no error, got %v", err)
    }
    f := func(h Address, chunk Chunk) error {
        if !bytes.Equal(h, chunk.Address()) {
            return fmt.Errorf("key does not match retrieved chunk Address")
        }
        hasher := MakeHashFunc(DefaultHash)()
        data := chunk.Data()
        hasher.ResetWithLength(data[:8])
        hasher.Write(data[8:])
        exp := hasher.Sum(nil)
        if !bytes.Equal(h, exp) {
            return fmt.Errorf("key is not hash of chunk data")
        }
        return nil
    }
    err = mget(m, chunkAddresses(chunks), f)
    if err != nil {
        t.Fatalf("testStore failed: %v", err)
    }
}

func benchmarkStorePut(store ChunkStore, n int, b *testing.B) {
    chunks := make([]Chunk, n)
    i := 0
    f := func(dataSize int64) Chunk {
        chunk := GenerateRandomChunk(dataSize)
        chunks[i] = chunk
        i++
        return chunk
    }

    mput(store, n, f)

    f = func(dataSize int64) Chunk {
        chunk := chunks[i]
        i++
        return chunk
    }

    b.ReportAllocs()
    b.ResetTimer()

    for j := 0; j < b.N; j++ {
        i = 0
        mput(store, n, f)
    }
}

func benchmarkStoreGet(store ChunkStore, n int, b *testing.B) {
    chunks, err := mputRandomChunks(store, n)
    if err != nil {
        b.Fatalf("expected no error, got %v", err)
    }
    b.ReportAllocs()
    b.ResetTimer()
    addrs := chunkAddresses(chunks)
    for i := 0; i < b.N; i++ {
        err := mget(store, addrs, nil)
        if err != nil {
            b.Fatalf("mget failed: %v", err)
        }
    }
}

// MapChunkStore is a very simple ChunkStore implementation to store chunks in a map in memory.
type MapChunkStore struct {
    chunks map[string]Chunk
    mu     sync.RWMutex
}

func NewMapChunkStore() *MapChunkStore {
    return &MapChunkStore{
        chunks: make(map[string]Chunk),
    }
}

func (m *MapChunkStore) Put(_ context.Context, ch Chunk) error {
    m.mu.Lock()
    defer m.mu.Unlock()
    m.chunks[ch.Address().Hex()] = ch
    return nil
}

func (m *MapChunkStore) Get(_ context.Context, ref Address) (Chunk, error) {
    m.mu.RLock()
    defer m.mu.RUnlock()
    chunk := m.chunks[ref.Hex()]
    if chunk == nil {
        return nil, ErrChunkNotFound
    }
    return chunk, nil
}

// Need to implement Has from SyncChunkStore
func (m *MapChunkStore) Has(ctx context.Context, ref Address) bool {
    m.mu.RLock()
    defer m.mu.RUnlock()

    _, has := m.chunks[ref.Hex()]
    return has
}

func (m *MapChunkStore) Close() {
}

func chunkAddresses(chunks []Chunk) []Address {
    addrs := make([]Address, len(chunks))
    for i, ch := range chunks {
        addrs[i] = ch.Address()
    }
    return addrs
}