aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/storage/mru/handler_test.go
blob: 13eb9e51b30104607f87f510d3f216d45865380f (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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
// 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 mru

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

    "github.com/ethereum/go-ethereum/crypto"

    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/swarm/chunk"
    "github.com/ethereum/go-ethereum/swarm/storage"
    "github.com/ethereum/go-ethereum/swarm/storage/mru/lookup"
)

var (
    loglevel  = flag.Int("loglevel", 3, "loglevel")
    startTime = Timestamp{
        Time: uint64(4200),
    }
    cleanF       func()
    resourceName = "føø.bar"
    hashfunc     = storage.MakeHashFunc(storage.DefaultHash)
)

func init() {
    flag.Parse()
    log.Root().SetHandler(log.CallerFileHandler(log.LvlFilterHandler(log.Lvl(*loglevel), log.StreamHandler(os.Stderr, log.TerminalFormat(true)))))
}

// simulated timeProvider
type fakeTimeProvider struct {
    currentTime uint64
}

func (f *fakeTimeProvider) Tick() {
    f.currentTime++
}

func (f *fakeTimeProvider) Set(time uint64) {
    f.currentTime = time
}

func (f *fakeTimeProvider) FastForward(offset uint64) {
    f.currentTime += offset
}

func (f *fakeTimeProvider) Now() Timestamp {
    return Timestamp{
        Time: f.currentTime,
    }
}

// make updates and retrieve them based on periods and versions
func TestResourceHandler(t *testing.T) {

    // make fake timeProvider
    clock := &fakeTimeProvider{
        currentTime: startTime.Time, // clock starts at t=4200
    }

    // signer containing private key
    signer := newAliceSigner()

    rh, datadir, teardownTest, err := setupTest(clock, signer)
    if err != nil {
        t.Fatal(err)
    }
    defer teardownTest()

    // create a new resource
    ctx, cancel := context.WithCancel(context.Background())
    defer cancel()

    topic, _ := NewTopic("Mess with mru code and see what ghost catches you", nil)
    view := View{
        Topic: topic,
        User:  signer.Address(),
    }

    // data for updates:
    updates := []string{
        "blinky", // t=4200
        "pinky",  // t=4242
        "inky",   // t=4284
        "clyde",  // t=4285
    }

    request := NewFirstRequest(view.Topic) // this timestamps the update at t = 4200 (start time)
    resourcekey := make(map[string]storage.Address)
    data := []byte(updates[0])
    request.SetData(data)
    if err := request.Sign(signer); err != nil {
        t.Fatal(err)
    }
    resourcekey[updates[0]], err = rh.Update(ctx, request)
    if err != nil {
        t.Fatal(err)
    }

    // move the clock ahead 21 seconds
    clock.FastForward(21) // t=4221

    request, err = rh.NewRequest(ctx, &request.View) // this timestamps the update at t = 4221
    if err != nil {
        t.Fatal(err)
    }
    if request.Epoch.Base() != 0 || request.Epoch.Level != lookup.HighestLevel-1 {
        t.Fatalf("Suggested epoch BaseTime should be 0 and Epoch level should be %d", lookup.HighestLevel-1)
    }

    request.Epoch.Level = lookup.HighestLevel // force level 25 instead of 24 to make it fail
    data = []byte(updates[1])
    request.SetData(data)
    if err := request.Sign(signer); err != nil {
        t.Fatal(err)
    }
    resourcekey[updates[1]], err = rh.Update(ctx, request)
    if err == nil {
        t.Fatal("Expected update to fail since an update in this epoch already exists")
    }

    // move the clock ahead 21 seconds
    clock.FastForward(21) // t=4242
    request, err = rh.NewRequest(ctx, &request.View)
    if err != nil {
        t.Fatal(err)
    }
    request.SetData(data)
    if err := request.Sign(signer); err != nil {
        t.Fatal(err)
    }
    resourcekey[updates[1]], err = rh.Update(ctx, request)
    if err != nil {
        t.Fatal(err)
    }

    // move the clock ahead 42 seconds
    clock.FastForward(42) // t=4284
    request, err = rh.NewRequest(ctx, &request.View)
    if err != nil {
        t.Fatal(err)
    }
    data = []byte(updates[2])
    request.SetData(data)
    if err := request.Sign(signer); err != nil {
        t.Fatal(err)
    }
    resourcekey[updates[2]], err = rh.Update(ctx, request)
    if err != nil {
        t.Fatal(err)
    }

    // move the clock ahead 1 second
    clock.FastForward(1) // t=4285
    request, err = rh.NewRequest(ctx, &request.View)
    if err != nil {
        t.Fatal(err)
    }
    if request.Epoch.Base() != 0 || request.Epoch.Level != 22 {
        t.Fatalf("Expected epoch base time to be %d, got %d. Expected epoch level to be %d, got %d", 0, request.Epoch.Base(), 22, request.Epoch.Level)
    }
    data = []byte(updates[3])
    request.SetData(data)

    if err := request.Sign(signer); err != nil {
        t.Fatal(err)
    }
    resourcekey[updates[3]], err = rh.Update(ctx, request)
    if err != nil {
        t.Fatal(err)
    }

    time.Sleep(time.Second)
    rh.Close()

    // check we can retrieve the updates after close
    clock.FastForward(2000) // t=6285

    rhparams := &HandlerParams{}

    rh2, err := NewTestHandler(datadir, rhparams)
    if err != nil {
        t.Fatal(err)
    }

    rsrc2, err := rh2.Lookup(ctx, NewQueryLatest(&request.View, lookup.NoClue))
    if err != nil {
        t.Fatal(err)
    }

    // last update should be "clyde"
    if !bytes.Equal(rsrc2.data, []byte(updates[len(updates)-1])) {
        t.Fatalf("resource data was %v, expected %v", string(rsrc2.data), updates[len(updates)-1])
    }
    if rsrc2.Level != 22 {
        t.Fatalf("resource epoch level was %d, expected 22", rsrc2.Level)
    }
    if rsrc2.Base() != 0 {
        t.Fatalf("resource epoch base time was %d, expected 0", rsrc2.Base())
    }
    log.Debug("Latest lookup", "epoch base time", rsrc2.Base(), "epoch level", rsrc2.Level, "data", rsrc2.data)

    // specific point in time
    rsrc, err := rh2.Lookup(ctx, NewQuery(&request.View, 4284, lookup.NoClue))
    if err != nil {
        t.Fatal(err)
    }
    // check data
    if !bytes.Equal(rsrc.data, []byte(updates[2])) {
        t.Fatalf("resource data (historical) was %v, expected %v", string(rsrc2.data), updates[2])
    }
    log.Debug("Historical lookup", "epoch base time", rsrc2.Base(), "epoch level", rsrc2.Level, "data", rsrc2.data)

    // beyond the first should yield an error
    rsrc, err = rh2.Lookup(ctx, NewQuery(&request.View, startTime.Time-1, lookup.NoClue))
    if err == nil {
        t.Fatalf("expected previous to fail, returned epoch %s data %v", rsrc.Epoch.String(), rsrc.data)
    }

}

const Day = 60 * 60 * 24
const Year = Day * 365
const Month = Day * 30

func generateData(x uint64) []byte {
    return []byte(fmt.Sprintf("%d", x))
}

func TestSparseUpdates(t *testing.T) {

    // make fake timeProvider
    timeProvider := &fakeTimeProvider{
        currentTime: startTime.Time,
    }

    // signer containing private key
    signer := newAliceSigner()

    rh, datadir, teardownTest, err := setupTest(timeProvider, signer)
    if err != nil {
        t.Fatal(err)
    }
    defer teardownTest()
    defer os.RemoveAll(datadir)

    // create a new resource
    ctx, cancel := context.WithCancel(context.Background())
    defer cancel()
    topic, _ := NewTopic("Very slow updates", nil)
    view := View{
        Topic: topic,
        User:  signer.Address(),
    }

    // publish one update every 5 years since Unix 0 until today
    today := uint64(1533799046)
    var epoch lookup.Epoch
    var lastUpdateTime uint64
    for T := uint64(0); T < today; T += 5 * Year {
        request := NewFirstRequest(view.Topic)
        request.Epoch = lookup.GetNextEpoch(epoch, T)
        request.data = generateData(T) // this generates some data that depends on T, so we can check later
        request.Sign(signer)
        if err != nil {
            t.Fatal(err)
        }

        if _, err := rh.Update(ctx, request); err != nil {
            t.Fatal(err)
        }
        epoch = request.Epoch
        lastUpdateTime = T
    }

    query := NewQuery(&view, today, lookup.NoClue)

    _, err = rh.Lookup(ctx, query)
    if err != nil {
        t.Fatal(err)
    }

    _, content, err := rh.GetContent(&view)
    if err != nil {
        t.Fatal(err)
    }

    if !bytes.Equal(generateData(lastUpdateTime), content) {
        t.Fatalf("Expected to recover last written value %d, got %s", lastUpdateTime, string(content))
    }

    // lookup the closest update to 35*Year + 6* Month (~ June 2005):
    // it should find the update we put on 35*Year, since we were updating every 5 years.

    query.TimeLimit = 35*Year + 6*Month

    _, err = rh.Lookup(ctx, query)
    if err != nil {
        t.Fatal(err)
    }

    _, content, err = rh.GetContent(&view)
    if err != nil {
        t.Fatal(err)
    }

    if !bytes.Equal(generateData(35*Year), content) {
        t.Fatalf("Expected to recover %d, got %s", 35*Year, string(content))
    }
}

func TestValidator(t *testing.T) {

    // make fake timeProvider
    timeProvider := &fakeTimeProvider{
        currentTime: startTime.Time,
    }

    // signer containing private key. Alice will be the good girl
    signer := newAliceSigner()

    // set up  sim timeProvider
    rh, _, teardownTest, err := setupTest(timeProvider, signer)
    if err != nil {
        t.Fatal(err)
    }
    defer teardownTest()

    // create new resource
    topic, _ := NewTopic(resourceName, nil)
    view := View{
        Topic: topic,
        User:  signer.Address(),
    }
    mr := NewFirstRequest(view.Topic)

    // chunk with address
    data := []byte("foo")
    mr.SetData(data)
    if err := mr.Sign(signer); err != nil {
        t.Fatalf("sign fail: %v", err)
    }

    chunk, err := mr.toChunk()
    if err != nil {
        t.Fatal(err)
    }
    if !rh.Validate(chunk.Address(), chunk.Data()) {
        t.Fatal("Chunk validator fail on update chunk")
    }

    address := chunk.Address()
    // mess with the address
    address[0] = 11
    address[15] = 99

    if rh.Validate(address, chunk.Data()) {
        t.Fatal("Expected Validate to fail with false chunk address")
    }
}

// tests that the content address validator correctly checks the data
// tests that resource update chunks are passed through content address validator
// there is some redundancy in this test as it also tests content addressed chunks,
// which should be evaluated as invalid chunks by this validator
func TestValidatorInStore(t *testing.T) {

    // make fake timeProvider
    TimestampProvider = &fakeTimeProvider{
        currentTime: startTime.Time,
    }

    // signer containing private key
    signer := newAliceSigner()

    // set up localstore
    datadir, err := ioutil.TempDir("", "storage-testresourcevalidator")
    if err != nil {
        t.Fatal(err)
    }
    defer os.RemoveAll(datadir)

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

    // set up resource handler and add is as a validator to the localstore
    rhParams := &HandlerParams{}
    rh := NewHandler(rhParams)
    store.Validators = append(store.Validators, rh)

    // create content addressed chunks, one good, one faulty
    chunks := storage.GenerateRandomChunks(chunk.DefaultSize, 2)
    goodChunk := chunks[0]
    badChunk := storage.NewChunk(chunks[1].Address(), goodChunk.Data())

    topic, _ := NewTopic("xyzzy", nil)
    view := View{
        Topic: topic,
        User:  signer.Address(),
    }

    // create a resource update chunk with correct publickey
    id := ID{
        Epoch: lookup.Epoch{Time: 42,
            Level: 1,
        },
        View: view,
    }

    updateAddr := id.Addr()
    data := []byte("bar")

    r := new(Request)
    r.idAddr = updateAddr
    r.ResourceUpdate.ID = id
    r.data = data

    r.Sign(signer)

    uglyChunk, err := r.toChunk()
    if err != nil {
        t.Fatal(err)
    }

    // put the chunks in the store and check their error status
    err = store.Put(context.Background(), goodChunk)
    if err == nil {
        t.Fatal("expected error on good content address chunk with resource validator only, but got nil")
    }
    err = store.Put(context.Background(), badChunk)
    if err == nil {
        t.Fatal("expected error on bad content address chunk with resource validator only, but got nil")
    }
    err = store.Put(context.Background(), uglyChunk)
    if err != nil {
        t.Fatalf("expected no error on resource update chunk with resource validator only, but got: %s", err)
    }
}

// create rpc and resourcehandler
func setupTest(timeProvider timestampProvider, signer Signer) (rh *TestHandler, datadir string, teardown func(), err error) {

    var fsClean func()
    var rpcClean func()
    cleanF = func() {
        if fsClean != nil {
            fsClean()
        }
        if rpcClean != nil {
            rpcClean()
        }
    }

    // temp datadir
    datadir, err = ioutil.TempDir("", "rh")
    if err != nil {
        return nil, "", nil, err
    }
    fsClean = func() {
        os.RemoveAll(datadir)
    }

    TimestampProvider = timeProvider
    rhparams := &HandlerParams{}
    rh, err = NewTestHandler(datadir, rhparams)
    return rh, datadir, cleanF, err
}

func newAliceSigner() *GenericSigner {
    privKey, _ := crypto.HexToECDSA("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef")
    return NewGenericSigner(privKey)
}

func newBobSigner() *GenericSigner {
    privKey, _ := crypto.HexToECDSA("accedeaccedeaccedeaccedeaccedeaccedeaccedeaccedeaccedeaccedecaca")
    return NewGenericSigner(privKey)
}

func newCharlieSigner() *GenericSigner {
    privKey, _ := crypto.HexToECDSA("facadefacadefacadefacadefacadefacadefacadefacadefacadefacadefaca")
    return NewGenericSigner(privKey)
}

func getUpdateDirect(rh *Handler, addr storage.Address) ([]byte, error) {
    chunk, err := rh.chunkStore.Get(context.TODO(), addr)
    if err != nil {
        return nil, err
    }
    var r Request
    if err := r.fromChunk(addr, chunk.Data()); err != nil {
        return nil, err
    }
    return r.data, nil
}