aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/storage/localstore/mode_get_test.go
blob: 6615a3b8896e3b919f2c15b5ff3bfd4513b575fc (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
// 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 localstore

import (
    "bytes"
    "testing"
    "time"
)

// TestModeGetRequest validates ModeGetRequest index values on the provided DB.
func TestModeGetRequest(t *testing.T) {
    db, cleanupFunc := newTestDB(t, nil)
    defer cleanupFunc()

    uploadTimestamp := time.Now().UTC().UnixNano()
    defer setNow(func() (t int64) {
        return uploadTimestamp
    })()

    chunk := generateRandomChunk()

    err := db.NewPutter(ModePutUpload).Put(chunk)
    if err != nil {
        t.Fatal(err)
    }

    requester := db.NewGetter(ModeGetRequest)

    // set update gc test hook to signal when
    // update gc goroutine is done by sending to
    // testHookUpdateGCChan channel, which is
    // used to wait for garbage colletion index
    // changes
    testHookUpdateGCChan := make(chan struct{})
    defer setTestHookUpdateGC(func() {
        testHookUpdateGCChan <- struct{}{}
    })()

    t.Run("get unsynced", func(t *testing.T) {
        got, err := requester.Get(chunk.Address())
        if err != nil {
            t.Fatal(err)
        }
        // wait for update gc goroutine to be done
        <-testHookUpdateGCChan

        if !bytes.Equal(got.Address(), chunk.Address()) {
            t.Errorf("got chunk address %x, want %x", got.Address(), chunk.Address())
        }

        if !bytes.Equal(got.Data(), chunk.Data()) {
            t.Errorf("got chunk data %x, want %x", got.Data(), chunk.Data())
        }

        t.Run("retrieve indexes", newRetrieveIndexesTestWithAccess(db, chunk, uploadTimestamp, 0))

        t.Run("gc index count", newItemsCountTest(db.gcIndex, 0))

        t.Run("gc size", newIndexGCSizeTest(db))
    })

    // set chunk to synced state
    err = db.NewSetter(ModeSetSync).Set(chunk.Address())
    if err != nil {
        t.Fatal(err)
    }

    t.Run("first get", func(t *testing.T) {
        got, err := requester.Get(chunk.Address())
        if err != nil {
            t.Fatal(err)
        }
        // wait for update gc goroutine to be done
        <-testHookUpdateGCChan

        if !bytes.Equal(got.Address(), chunk.Address()) {
            t.Errorf("got chunk address %x, want %x", got.Address(), chunk.Address())
        }

        if !bytes.Equal(got.Data(), chunk.Data()) {
            t.Errorf("got chunk data %x, want %x", got.Data(), chunk.Data())
        }

        t.Run("retrieve indexes", newRetrieveIndexesTestWithAccess(db, chunk, uploadTimestamp, uploadTimestamp))

        t.Run("gc index", newGCIndexTest(db, chunk, uploadTimestamp, uploadTimestamp))

        t.Run("gc index count", newItemsCountTest(db.gcIndex, 1))

        t.Run("gc size", newIndexGCSizeTest(db))
    })

    t.Run("second get", func(t *testing.T) {
        accessTimestamp := time.Now().UTC().UnixNano()
        defer setNow(func() (t int64) {
            return accessTimestamp
        })()

        got, err := requester.Get(chunk.Address())
        if err != nil {
            t.Fatal(err)
        }
        // wait for update gc goroutine to be done
        <-testHookUpdateGCChan

        if !bytes.Equal(got.Address(), chunk.Address()) {
            t.Errorf("got chunk address %x, want %x", got.Address(), chunk.Address())
        }

        if !bytes.Equal(got.Data(), chunk.Data()) {
            t.Errorf("got chunk data %x, want %x", got.Data(), chunk.Data())
        }

        t.Run("retrieve indexes", newRetrieveIndexesTestWithAccess(db, chunk, uploadTimestamp, accessTimestamp))

        t.Run("gc index", newGCIndexTest(db, chunk, uploadTimestamp, accessTimestamp))

        t.Run("gc index count", newItemsCountTest(db.gcIndex, 1))

        t.Run("gc size", newIndexGCSizeTest(db))
    })
}

// TestModeGetSync validates ModeGetSync index values on the provided DB.
func TestModeGetSync(t *testing.T) {
    db, cleanupFunc := newTestDB(t, nil)
    defer cleanupFunc()

    uploadTimestamp := time.Now().UTC().UnixNano()
    defer setNow(func() (t int64) {
        return uploadTimestamp
    })()

    chunk := generateRandomChunk()

    err := db.NewPutter(ModePutUpload).Put(chunk)
    if err != nil {
        t.Fatal(err)
    }

    got, err := db.NewGetter(ModeGetSync).Get(chunk.Address())
    if err != nil {
        t.Fatal(err)
    }

    if !bytes.Equal(got.Address(), chunk.Address()) {
        t.Errorf("got chunk address %x, want %x", got.Address(), chunk.Address())
    }

    if !bytes.Equal(got.Data(), chunk.Data()) {
        t.Errorf("got chunk data %x, want %x", got.Data(), chunk.Data())
    }

    t.Run("retrieve indexes", newRetrieveIndexesTestWithAccess(db, chunk, uploadTimestamp, 0))

    t.Run("gc index count", newItemsCountTest(db.gcIndex, 0))

    t.Run("gc size", newIndexGCSizeTest(db))
}

// setTestHookUpdateGC sets testHookUpdateGC and
// returns a function that will reset it to the
// value before the change.
func setTestHookUpdateGC(h func()) (reset func()) {
    current := testHookUpdateGC
    reset = func() { testHookUpdateGC = current }
    testHookUpdateGC = h
    return reset
}

// TestSetTestHookUpdateGC tests if setTestHookUpdateGC changes
// testHookUpdateGC function correctly and if its reset function
// resets the original function.
func TestSetTestHookUpdateGC(t *testing.T) {
    // Set the current function after the test finishes.
    defer func(h func()) { testHookUpdateGC = h }(testHookUpdateGC)

    // expected value for the unchanged function
    original := 1
    // expected value for the changed function
    changed := 2

    // this variable will be set with two different functions
    var got int

    // define the original (unchanged) functions
    testHookUpdateGC = func() {
        got = original
    }

    // set got variable
    testHookUpdateGC()

    // test if got variable is set correctly
    if got != original {
        t.Errorf("got hook value %v, want %v", got, original)
    }

    // set the new function
    reset := setTestHookUpdateGC(func() {
        got = changed
    })

    // set got variable
    testHookUpdateGC()

    // test if got variable is set correctly to changed value
    if got != changed {
        t.Errorf("got hook value %v, want %v", got, changed)
    }

    // set the function to the original one
    reset()

    // set got variable
    testHookUpdateGC()

    // test if got variable is set correctly to original value
    if got != original {
        t.Errorf("got hook value %v, want %v", got, original)
    }
}