aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/storage/mock/test/test.go
blob: 10180985f3304cd4778ea29dbab24631cfd77236 (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
// Copyright 2018 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 test provides functions that are used for testing
// GlobalStorer implementations.
package test

import (
    "bytes"
    "fmt"
    "io"
    "strconv"
    "testing"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/swarm/storage"
    "github.com/ethereum/go-ethereum/swarm/storage/mock"
)

// MockStore creates NodeStore instances from provided GlobalStorer,
// each one with a unique address, stores different chunks on them
// and checks if they are retrievable or not on all nodes.
// Attribute n defines the number of NodeStores that will be created.
func MockStore(t *testing.T, globalStore mock.GlobalStorer, n int) {
    t.Run("GlobalStore", func(t *testing.T) {
        addrs := make([]common.Address, n)
        for i := 0; i < n; i++ {
            addrs[i] = common.HexToAddress(strconv.FormatInt(int64(i)+1, 16))
        }

        for i, addr := range addrs {
            chunkAddr := storage.Address(append(addr[:], []byte(strconv.FormatInt(int64(i)+1, 16))...))
            data := []byte(strconv.FormatInt(int64(i)+1, 16))
            data = append(data, make([]byte, 4096-len(data))...)
            globalStore.Put(addr, chunkAddr, data)

            for _, cAddr := range addrs {
                cData, err := globalStore.Get(cAddr, chunkAddr)
                if cAddr == addr {
                    if err != nil {
                        t.Fatalf("get data from store %s key %s: %v", cAddr.Hex(), chunkAddr.Hex(), err)
                    }
                    if !bytes.Equal(data, cData) {
                        t.Fatalf("data on store %s: expected %x, got %x", cAddr.Hex(), data, cData)
                    }
                    if !globalStore.HasKey(cAddr, chunkAddr) {
                        t.Fatalf("expected key %s on global store for node %s, but it was not found", chunkAddr.Hex(), cAddr.Hex())
                    }
                } else {
                    if err != mock.ErrNotFound {
                        t.Fatalf("expected error from store %s: %v, got %v", cAddr.Hex(), mock.ErrNotFound, err)
                    }
                    if len(cData) > 0 {
                        t.Fatalf("data on store %s: expected nil, got %x", cAddr.Hex(), cData)
                    }
                    if globalStore.HasKey(cAddr, chunkAddr) {
                        t.Fatalf("not expected key %s on global store for node %s, but it was found", chunkAddr.Hex(), cAddr.Hex())
                    }
                }
            }
        }
        t.Run("delete", func(t *testing.T) {
            chunkAddr := storage.Address([]byte("1234567890abcd"))
            for _, addr := range addrs {
                err := globalStore.Put(addr, chunkAddr, []byte("data"))
                if err != nil {
                    t.Fatalf("put data to store %s key %s: %v", addr.Hex(), chunkAddr.Hex(), err)
                }
            }
            firstNodeAddr := addrs[0]
            if err := globalStore.Delete(firstNodeAddr, chunkAddr); err != nil {
                t.Fatalf("delete from store %s key %s: %v", firstNodeAddr.Hex(), chunkAddr.Hex(), err)
            }
            for i, addr := range addrs {
                _, err := globalStore.Get(addr, chunkAddr)
                if i == 0 {
                    if err != mock.ErrNotFound {
                        t.Errorf("get data from store %s key %s: expected mock.ErrNotFound error, got %v", addr.Hex(), chunkAddr.Hex(), err)
                    }
                } else {
                    if err != nil {
                        t.Errorf("get data from store %s key %s: %v", addr.Hex(), chunkAddr.Hex(), err)
                    }
                }
            }
        })
    })

    t.Run("NodeStore", func(t *testing.T) {
        nodes := make(map[common.Address]*mock.NodeStore)
        for i := 0; i < n; i++ {
            addr := common.HexToAddress(strconv.FormatInt(int64(i)+1, 16))
            nodes[addr] = globalStore.NewNodeStore(addr)
        }

        i := 0
        for addr, store := range nodes {
            i++
            chunkAddr := storage.Address(append(addr[:], []byte(fmt.Sprintf("%x", i))...))
            data := []byte(strconv.FormatInt(int64(i)+1, 16))
            data = append(data, make([]byte, 4096-len(data))...)
            store.Put(chunkAddr, data)

            for cAddr, cStore := range nodes {
                cData, err := cStore.Get(chunkAddr)
                if cAddr == addr {
                    if err != nil {
                        t.Fatalf("get data from store %s key %s: %v", cAddr.Hex(), chunkAddr.Hex(), err)
                    }
                    if !bytes.Equal(data, cData) {
                        t.Fatalf("data on store %s: expected %x, got %x", cAddr.Hex(), data, cData)
                    }
                    if !globalStore.HasKey(cAddr, chunkAddr) {
                        t.Fatalf("expected key %s on global store for node %s, but it was not found", chunkAddr.Hex(), cAddr.Hex())
                    }
                } else {
                    if err != mock.ErrNotFound {
                        t.Fatalf("expected error from store %s: %v, got %v", cAddr.Hex(), mock.ErrNotFound, err)
                    }
                    if len(cData) > 0 {
                        t.Fatalf("data on store %s: expected nil, got %x", cAddr.Hex(), cData)
                    }
                    if globalStore.HasKey(cAddr, chunkAddr) {
                        t.Fatalf("not expected key %s on global store for node %s, but it was found", chunkAddr.Hex(), cAddr.Hex())
                    }
                }
            }
        }
        t.Run("delete", func(t *testing.T) {
            chunkAddr := storage.Address([]byte("1234567890abcd"))
            var chosenStore *mock.NodeStore
            for addr, store := range nodes {
                if chosenStore == nil {
                    chosenStore = store
                }
                err := store.Put(chunkAddr, []byte("data"))
                if err != nil {
                    t.Fatalf("put data to store %s key %s: %v", addr.Hex(), chunkAddr.Hex(), err)
                }
            }
            if err := chosenStore.Delete(chunkAddr); err != nil {
                t.Fatalf("delete key %s: %v", chunkAddr.Hex(), err)
            }
            for addr, store := range nodes {
                _, err := store.Get(chunkAddr)
                if store == chosenStore {
                    if err != mock.ErrNotFound {
                        t.Errorf("get data from store %s key %s: expected mock.ErrNotFound error, got %v", addr.Hex(), chunkAddr.Hex(), err)
                    }
                } else {
                    if err != nil {
                        t.Errorf("get data from store %s key %s: %v", addr.Hex(), chunkAddr.Hex(), err)
                    }
                }
            }
        })
    })
}

// ImportExport saves chunks to the outStore, exports them to the tar archive,
// imports tar archive to the inStore and checks if all chunks are imported correctly.
func ImportExport(t *testing.T, outStore, inStore mock.GlobalStorer, n int) {
    exporter, ok := outStore.(mock.Exporter)
    if !ok {
        t.Fatal("outStore does not implement mock.Exporter")
    }
    importer, ok := inStore.(mock.Importer)
    if !ok {
        t.Fatal("inStore does not implement mock.Importer")
    }
    addrs := make([]common.Address, n)
    for i := 0; i < n; i++ {
        addrs[i] = common.HexToAddress(strconv.FormatInt(int64(i)+1, 16))
    }

    for i, addr := range addrs {
        chunkAddr := storage.Address(append(addr[:], []byte(strconv.FormatInt(int64(i)+1, 16))...))
        data := []byte(strconv.FormatInt(int64(i)+1, 16))
        data = append(data, make([]byte, 4096-len(data))...)
        outStore.Put(addr, chunkAddr, data)
    }

    r, w := io.Pipe()
    defer r.Close()

    go func() {
        defer w.Close()
        if _, err := exporter.Export(w); err != nil {
            t.Fatalf("export: %v", err)
        }
    }()

    if _, err := importer.Import(r); err != nil {
        t.Fatalf("import: %v", err)
    }

    for i, addr := range addrs {
        chunkAddr := storage.Address(append(addr[:], []byte(strconv.FormatInt(int64(i)+1, 16))...))
        data := []byte(strconv.FormatInt(int64(i)+1, 16))
        data = append(data, make([]byte, 4096-len(data))...)
        for _, cAddr := range addrs {
            cData, err := inStore.Get(cAddr, chunkAddr)
            if cAddr == addr {
                if err != nil {
                    t.Fatalf("get data from store %s key %s: %v", cAddr.Hex(), chunkAddr.Hex(), err)
                }
                if !bytes.Equal(data, cData) {
                    t.Fatalf("data on store %s: expected %x, got %x", cAddr.Hex(), data, cData)
                }
                if !inStore.HasKey(cAddr, chunkAddr) {
                    t.Fatalf("expected key %s on global store for node %s, but it was not found", chunkAddr.Hex(), cAddr.Hex())
                }
            } else {
                if err != mock.ErrNotFound {
                    t.Fatalf("expected error from store %s: %v, got %v", cAddr.Hex(), mock.ErrNotFound, err)
                }
                if len(cData) > 0 {
                    t.Fatalf("data on store %s: expected nil, got %x", cAddr.Hex(), cData)
                }
                if inStore.HasKey(cAddr, chunkAddr) {
                    t.Fatalf("not expected key %s on global store for node %s, but it was found", chunkAddr.Hex(), cAddr.Hex())
                }
            }
        }
    }
}