aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/storage/localstore_test.go
blob: 7c5acdf9dfe378a93cc337201fcd912e6ae08767 (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
// 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 storage

import (
    "context"
    "io/ioutil"
    "os"
    "testing"
    "time"

    ch "github.com/tangerine-network/go-tangerine/swarm/chunk"
)

var (
    hashfunc = MakeHashFunc(DefaultHash)
)

// tests that the content address validator correctly checks the data
// tests that feed update chunks are passed through content address validator
// the test checking the resouce update validator internal correctness is found in storage/feeds/handler_test.go
func TestValidator(t *testing.T) {
    // set up localstore
    datadir, err := ioutil.TempDir("", "storage-testvalidator")
    if err != nil {
        t.Fatal(err)
    }
    defer os.RemoveAll(datadir)

    params := NewDefaultLocalStoreParams()
    params.Init(datadir)
    store, err := NewLocalStore(params, nil)
    if err != nil {
        t.Fatal(err)
    }

    // check puts with no validators, both succeed
    chunks := GenerateRandomChunks(259, 2)
    goodChunk := chunks[0]
    badChunk := chunks[1]
    copy(badChunk.Data(), goodChunk.Data())

    errs := putChunks(store, goodChunk, badChunk)
    if errs[0] != nil {
        t.Fatalf("expected no error on good content address chunk in spite of no validation, but got: %s", err)
    }
    if errs[1] != nil {
        t.Fatalf("expected no error on bad content address chunk in spite of no validation, but got: %s", err)
    }

    // add content address validator and check puts
    // bad should fail, good should pass
    store.Validators = append(store.Validators, NewContentAddressValidator(hashfunc))
    chunks = GenerateRandomChunks(ch.DefaultSize, 2)
    goodChunk = chunks[0]
    badChunk = chunks[1]
    copy(badChunk.Data(), goodChunk.Data())

    errs = putChunks(store, goodChunk, badChunk)
    if errs[0] != nil {
        t.Fatalf("expected no error on good content address chunk with content address validator only, but got: %s", err)
    }
    if errs[1] == nil {
        t.Fatal("expected error on bad content address chunk with content address validator only, but got nil")
    }

    // append a validator that always denies
    // bad should fail, good should pass,
    var negV boolTestValidator
    store.Validators = append(store.Validators, negV)

    chunks = GenerateRandomChunks(ch.DefaultSize, 2)
    goodChunk = chunks[0]
    badChunk = chunks[1]
    copy(badChunk.Data(), goodChunk.Data())

    errs = putChunks(store, goodChunk, badChunk)
    if errs[0] != nil {
        t.Fatalf("expected no error on good content address chunk with content address validator only, but got: %s", err)
    }
    if errs[1] == nil {
        t.Fatal("expected error on bad content address chunk with content address validator only, but got nil")
    }

    // append a validator that always approves
    // all shall pass
    var posV boolTestValidator = true
    store.Validators = append(store.Validators, posV)

    chunks = GenerateRandomChunks(ch.DefaultSize, 2)
    goodChunk = chunks[0]
    badChunk = chunks[1]
    copy(badChunk.Data(), goodChunk.Data())

    errs = putChunks(store, goodChunk, badChunk)
    if errs[0] != nil {
        t.Fatalf("expected no error on good content address chunk with content address validator only, but got: %s", err)
    }
    if errs[1] != nil {
        t.Fatalf("expected no error on bad content address chunk in spite of no validation, but got: %s", err)
    }

}

type boolTestValidator bool

func (self boolTestValidator) Validate(chunk Chunk) bool {
    return bool(self)
}

// putChunks adds chunks  to localstore
// It waits for receive on the stored channel
// It logs but does not fail on delivery error
func putChunks(store *LocalStore, chunks ...Chunk) []error {
    i := 0
    f := func(n int64) Chunk {
        chunk := chunks[i]
        i++
        return chunk
    }
    _, errs := put(store, len(chunks), f)
    return errs
}

func put(store *LocalStore, n int, f func(i int64) Chunk) (hs []Address, errs []error) {
    for i := int64(0); i < int64(n); i++ {
        chunk := f(ch.DefaultSize)
        err := store.Put(context.TODO(), chunk)
        errs = append(errs, err)
        hs = append(hs, chunk.Address())
    }
    return hs, errs
}

// TestGetFrequentlyAccessedChunkWontGetGarbageCollected tests that the most
// frequently accessed chunk is not garbage collected from LDBStore, i.e.,
// from disk when we are at the capacity and garbage collector runs. For that
// we start putting random chunks into the DB while continuously accessing the
// chunk we care about then check if we can still retrieve it from disk.
func TestGetFrequentlyAccessedChunkWontGetGarbageCollected(t *testing.T) {
    ldbCap := defaultGCRatio
    store, cleanup := setupLocalStore(t, ldbCap)
    defer cleanup()

    var chunks []Chunk
    for i := 0; i < ldbCap; i++ {
        chunks = append(chunks, GenerateRandomChunk(ch.DefaultSize))
    }

    mostAccessed := chunks[0].Address()
    for _, chunk := range chunks {
        if err := store.Put(context.Background(), chunk); err != nil {
            t.Fatal(err)
        }

        if _, err := store.Get(context.Background(), mostAccessed); err != nil {
            t.Fatal(err)
        }
        // Add time for MarkAccessed() to be able to finish in a separate Goroutine
        time.Sleep(1 * time.Millisecond)
    }

    store.DbStore.collectGarbage()
    if _, err := store.DbStore.Get(context.Background(), mostAccessed); err != nil {
        t.Logf("most frequntly accessed chunk not found on disk (key: %v)", mostAccessed)
        t.Fatal(err)
    }

}

func setupLocalStore(t *testing.T, ldbCap int) (ls *LocalStore, cleanup func()) {
    t.Helper()

    var err error
    datadir, err := ioutil.TempDir("", "storage")
    if err != nil {
        t.Fatal(err)
    }

    params := &LocalStoreParams{
        StoreParams: NewStoreParams(uint64(ldbCap), uint(ldbCap), nil, nil),
    }
    params.Init(datadir)

    store, err := NewLocalStore(params, nil)
    if err != nil {
        _ = os.RemoveAll(datadir)
        t.Fatal(err)
    }

    cleanup = func() {
        store.Close()
        _ = os.RemoveAll(datadir)
    }

    return store, cleanup
}

func TestHas(t *testing.T) {
    ldbCap := defaultGCRatio
    store, cleanup := setupLocalStore(t, ldbCap)
    defer cleanup()

    nonStoredAddr := GenerateRandomChunk(128).Address()

    has := store.Has(context.Background(), nonStoredAddr)
    if has {
        t.Fatal("Expected Has() to return false, but returned true!")
    }

    storeChunks := GenerateRandomChunks(128, 3)
    for _, ch := range storeChunks {
        err := store.Put(context.Background(), ch)
        if err != nil {
            t.Fatalf("Expected store to store chunk, but it failed: %v", err)
        }

        has := store.Has(context.Background(), ch.Address())
        if !has {
            t.Fatal("Expected Has() to return true, but returned false!")
        }
    }

    //let's be paranoic and test again that the non-existent chunk returns false
    has = store.Has(context.Background(), nonStoredAddr)
    if has {
        t.Fatal("Expected Has() to return false, but returned true!")
    }

}