aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/api/client/client_test.go
blob: 02980de1db8f548a0c5d40e7bee04724d1bd01c4 (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
521
522
523
524
525
526
527
528
529
// Copyright 2017 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 client

import (
    "bytes"
    "io/ioutil"
    "os"
    "path/filepath"
    "reflect"
    "sort"
    "testing"

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

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/swarm/api"
    swarmhttp "github.com/ethereum/go-ethereum/swarm/api/http"
    "github.com/ethereum/go-ethereum/swarm/multihash"
    "github.com/ethereum/go-ethereum/swarm/storage/mru"
    "github.com/ethereum/go-ethereum/swarm/testutil"
)

func serverFunc(api *api.API) testutil.TestServer {
    return swarmhttp.NewServer(api, "")
}

// TestClientUploadDownloadRaw test uploading and downloading raw data to swarm
func TestClientUploadDownloadRaw(t *testing.T) {
    testClientUploadDownloadRaw(false, t)
}
func TestClientUploadDownloadRawEncrypted(t *testing.T) {
    testClientUploadDownloadRaw(true, t)
}

func testClientUploadDownloadRaw(toEncrypt bool, t *testing.T) {
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    defer srv.Close()

    client := NewClient(srv.URL)

    // upload some raw data
    data := []byte("foo123")
    hash, err := client.UploadRaw(bytes.NewReader(data), int64(len(data)), toEncrypt)
    if err != nil {
        t.Fatal(err)
    }

    // check we can download the same data
    res, isEncrypted, err := client.DownloadRaw(hash)
    if err != nil {
        t.Fatal(err)
    }
    if isEncrypted != toEncrypt {
        t.Fatalf("Expected encyption status %v got %v", toEncrypt, isEncrypted)
    }
    defer res.Close()
    gotData, err := ioutil.ReadAll(res)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(gotData, data) {
        t.Fatalf("expected downloaded data to be %q, got %q", data, gotData)
    }
}

// TestClientUploadDownloadFiles test uploading and downloading files to swarm
// manifests
func TestClientUploadDownloadFiles(t *testing.T) {
    testClientUploadDownloadFiles(false, t)
}

func TestClientUploadDownloadFilesEncrypted(t *testing.T) {
    testClientUploadDownloadFiles(true, t)
}

func testClientUploadDownloadFiles(toEncrypt bool, t *testing.T) {
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    defer srv.Close()

    client := NewClient(srv.URL)
    upload := func(manifest, path string, data []byte) string {
        file := &File{
            ReadCloser: ioutil.NopCloser(bytes.NewReader(data)),
            ManifestEntry: api.ManifestEntry{
                Path:        path,
                ContentType: "text/plain",
                Size:        int64(len(data)),
            },
        }
        hash, err := client.Upload(file, manifest, toEncrypt)
        if err != nil {
            t.Fatal(err)
        }
        return hash
    }
    checkDownload := func(manifest, path string, expected []byte) {
        file, err := client.Download(manifest, path)
        if err != nil {
            t.Fatal(err)
        }
        defer file.Close()
        if file.Size != int64(len(expected)) {
            t.Fatalf("expected downloaded file to be %d bytes, got %d", len(expected), file.Size)
        }
        if file.ContentType != "text/plain" {
            t.Fatalf("expected downloaded file to have type %q, got %q", "text/plain", file.ContentType)
        }
        data, err := ioutil.ReadAll(file)
        if err != nil {
            t.Fatal(err)
        }
        if !bytes.Equal(data, expected) {
            t.Fatalf("expected downloaded data to be %q, got %q", expected, data)
        }
    }

    // upload a file to the root of a manifest
    rootData := []byte("some-data")
    rootHash := upload("", "", rootData)

    // check we can download the root file
    checkDownload(rootHash, "", rootData)

    // upload another file to the same manifest
    otherData := []byte("some-other-data")
    newHash := upload(rootHash, "some/other/path", otherData)

    // check we can download both files from the new manifest
    checkDownload(newHash, "", rootData)
    checkDownload(newHash, "some/other/path", otherData)

    // replace the root file with different data
    newHash = upload(newHash, "", otherData)

    // check both files have the other data
    checkDownload(newHash, "", otherData)
    checkDownload(newHash, "some/other/path", otherData)
}

var testDirFiles = []string{
    "file1.txt",
    "file2.txt",
    "dir1/file3.txt",
    "dir1/file4.txt",
    "dir2/file5.txt",
    "dir2/dir3/file6.txt",
    "dir2/dir4/file7.txt",
    "dir2/dir4/file8.txt",
}

func newTestDirectory(t *testing.T) string {
    dir, err := ioutil.TempDir("", "swarm-client-test")
    if err != nil {
        t.Fatal(err)
    }

    for _, file := range testDirFiles {
        path := filepath.Join(dir, file)
        if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
            os.RemoveAll(dir)
            t.Fatalf("error creating dir for %s: %s", path, err)
        }
        if err := ioutil.WriteFile(path, []byte(file), 0644); err != nil {
            os.RemoveAll(dir)
            t.Fatalf("error writing file %s: %s", path, err)
        }
    }

    return dir
}

// TestClientUploadDownloadDirectory tests uploading and downloading a
// directory of files to a swarm manifest
func TestClientUploadDownloadDirectory(t *testing.T) {
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    defer srv.Close()

    dir := newTestDirectory(t)
    defer os.RemoveAll(dir)

    // upload the directory
    client := NewClient(srv.URL)
    defaultPath := testDirFiles[0]
    hash, err := client.UploadDirectory(dir, defaultPath, "", false)
    if err != nil {
        t.Fatalf("error uploading directory: %s", err)
    }

    // check we can download the individual files
    checkDownloadFile := func(path string, expected []byte) {
        file, err := client.Download(hash, path)
        if err != nil {
            t.Fatal(err)
        }
        defer file.Close()
        data, err := ioutil.ReadAll(file)
        if err != nil {
            t.Fatal(err)
        }
        if !bytes.Equal(data, expected) {
            t.Fatalf("expected data to be %q, got %q", expected, data)
        }
    }
    for _, file := range testDirFiles {
        checkDownloadFile(file, []byte(file))
    }

    // check we can download the default path
    checkDownloadFile("", []byte(testDirFiles[0]))

    // check we can download the directory
    tmp, err := ioutil.TempDir("", "swarm-client-test")
    if err != nil {
        t.Fatal(err)
    }
    defer os.RemoveAll(tmp)
    if err := client.DownloadDirectory(hash, "", tmp, ""); err != nil {
        t.Fatal(err)
    }
    for _, file := range testDirFiles {
        data, err := ioutil.ReadFile(filepath.Join(tmp, file))
        if err != nil {
            t.Fatal(err)
        }
        if !bytes.Equal(data, []byte(file)) {
            t.Fatalf("expected data to be %q, got %q", file, data)
        }
    }
}

// TestClientFileList tests listing files in a swarm manifest
func TestClientFileList(t *testing.T) {
    testClientFileList(false, t)
}

func TestClientFileListEncrypted(t *testing.T) {
    testClientFileList(true, t)
}

func testClientFileList(toEncrypt bool, t *testing.T) {
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    defer srv.Close()

    dir := newTestDirectory(t)
    defer os.RemoveAll(dir)

    client := NewClient(srv.URL)
    hash, err := client.UploadDirectory(dir, "", "", toEncrypt)
    if err != nil {
        t.Fatalf("error uploading directory: %s", err)
    }

    ls := func(prefix string) []string {
        list, err := client.List(hash, prefix, "")
        if err != nil {
            t.Fatal(err)
        }
        paths := make([]string, 0, len(list.CommonPrefixes)+len(list.Entries))
        paths = append(paths, list.CommonPrefixes...)
        for _, entry := range list.Entries {
            paths = append(paths, entry.Path)
        }
        sort.Strings(paths)
        return paths
    }

    tests := map[string][]string{
        "":                    {"dir1/", "dir2/", "file1.txt", "file2.txt"},
        "file":                {"file1.txt", "file2.txt"},
        "file1":               {"file1.txt"},
        "file2.txt":           {"file2.txt"},
        "file12":              {},
        "dir":                 {"dir1/", "dir2/"},
        "dir1":                {"dir1/"},
        "dir1/":               {"dir1/file3.txt", "dir1/file4.txt"},
        "dir1/file":           {"dir1/file3.txt", "dir1/file4.txt"},
        "dir1/file3.txt":      {"dir1/file3.txt"},
        "dir1/file34":         {},
        "dir2/":               {"dir2/dir3/", "dir2/dir4/", "dir2/file5.txt"},
        "dir2/file":           {"dir2/file5.txt"},
        "dir2/dir":            {"dir2/dir3/", "dir2/dir4/"},
        "dir2/dir3/":          {"dir2/dir3/file6.txt"},
        "dir2/dir4/":          {"dir2/dir4/file7.txt", "dir2/dir4/file8.txt"},
        "dir2/dir4/file":      {"dir2/dir4/file7.txt", "dir2/dir4/file8.txt"},
        "dir2/dir4/file7.txt": {"dir2/dir4/file7.txt"},
        "dir2/dir4/file78":    {},
    }
    for prefix, expected := range tests {
        actual := ls(prefix)
        if !reflect.DeepEqual(actual, expected) {
            t.Fatalf("expected prefix %q to return %v, got %v", prefix, expected, actual)
        }
    }
}

// TestClientMultipartUpload tests uploading files to swarm using a multipart
// upload
func TestClientMultipartUpload(t *testing.T) {
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    defer srv.Close()

    // define an uploader which uploads testDirFiles with some data
    data := []byte("some-data")
    uploader := UploaderFunc(func(upload UploadFn) error {
        for _, name := range testDirFiles {
            file := &File{
                ReadCloser: ioutil.NopCloser(bytes.NewReader(data)),
                ManifestEntry: api.ManifestEntry{
                    Path:        name,
                    ContentType: "text/plain",
                    Size:        int64(len(data)),
                },
            }
            if err := upload(file); err != nil {
                return err
            }
        }
        return nil
    })

    // upload the files as a multipart upload
    client := NewClient(srv.URL)
    hash, err := client.MultipartUpload("", uploader)
    if err != nil {
        t.Fatal(err)
    }

    // check we can download the individual files
    checkDownloadFile := func(path string) {
        file, err := client.Download(hash, path)
        if err != nil {
            t.Fatal(err)
        }
        defer file.Close()
        gotData, err := ioutil.ReadAll(file)
        if err != nil {
            t.Fatal(err)
        }
        if !bytes.Equal(gotData, data) {
            t.Fatalf("expected data to be %q, got %q", data, gotData)
        }
    }
    for _, file := range testDirFiles {
        checkDownloadFile(file)
    }
}

func newTestSigner() (*mru.GenericSigner, error) {
    privKey, err := crypto.HexToECDSA("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef")
    if err != nil {
        return nil, err
    }
    return mru.NewGenericSigner(privKey), nil
}

// test the transparent resolving of multihash resource types with bzz:// scheme
//
// first upload data, and store the multihash to the resulting manifest in a resource update
// retrieving the update with the multihash should return the manifest pointing directly to the data
// and raw retrieve of that hash should return the data
func TestClientCreateResourceMultihash(t *testing.T) {

    signer, _ := newTestSigner()

    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    client := NewClient(srv.URL)
    defer srv.Close()

    // add the data our multihash aliased manifest will point to
    databytes := []byte("bar")

    swarmHash, err := client.UploadRaw(bytes.NewReader(databytes), int64(len(databytes)), false)
    if err != nil {
        t.Fatalf("Error uploading raw test data: %s", err)
    }

    s := common.FromHex(swarmHash)
    mh := multihash.ToMultihash(s)

    // our mutable resource topic
    topic, _ := mru.NewTopic("foo.eth", nil)

    createRequest := mru.NewFirstRequest(topic)

    createRequest.SetData(mh)
    if err := createRequest.Sign(signer); err != nil {
        t.Fatalf("Error signing update: %s", err)
    }

    resourceManifestHash, err := client.CreateResource(createRequest)

    if err != nil {
        t.Fatalf("Error creating resource: %s", err)
    }

    correctManifestAddrHex := "6ef40ba1492cf2a029dc9a8b5896c822cf689d3cd010842f4f1744e6db8824bd"
    if resourceManifestHash != correctManifestAddrHex {
        t.Fatalf("Response resource manifest mismatch, expected '%s', got '%s'", correctManifestAddrHex, resourceManifestHash)
    }

    // Check we get a not found error when trying to get the resource with a made-up manifest
    _, err = client.GetResource(nil, "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb")
    if err != ErrNoResourceUpdatesFound {
        t.Fatalf("Expected to receive ErrNoResourceUpdatesFound error. Got: %s", err)
    }

    reader, err := client.GetResource(nil, correctManifestAddrHex)
    if err != nil {
        t.Fatalf("Error retrieving resource: %s", err)
    }
    defer reader.Close()
    gotData, err := ioutil.ReadAll(reader)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(mh, gotData) {
        t.Fatalf("Expected: %v, got %v", mh, gotData)
    }

}

// TestClientCreateUpdateResource will check that mutable resources can be created and updated via the HTTP client.
func TestClientCreateUpdateResource(t *testing.T) {

    signer, _ := newTestSigner()

    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    client := NewClient(srv.URL)
    defer srv.Close()

    // set raw data for the resource
    databytes := []byte("En un lugar de La Mancha, de cuyo nombre no quiero acordarme...")

    // our mutable resource name
    topic, _ := mru.NewTopic("El Quijote", nil)
    createRequest := mru.NewFirstRequest(topic)

    createRequest.SetData(databytes)
    if err := createRequest.Sign(signer); err != nil {
        t.Fatalf("Error signing update: %s", err)
    }

    resourceManifestHash, err := client.CreateResource(createRequest)

    correctManifestAddrHex := "fcb8e75f53e480e197c083ad1976d265674d0ce776f2bf359c09c413fb5230b8"
    if resourceManifestHash != correctManifestAddrHex {
        t.Fatalf("Response resource manifest mismatch, expected '%s', got '%s'", correctManifestAddrHex, resourceManifestHash)
    }

    reader, err := client.GetResource(nil, correctManifestAddrHex)
    if err != nil {
        t.Fatalf("Error retrieving resource: %s", err)
    }
    defer reader.Close()
    gotData, err := ioutil.ReadAll(reader)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(databytes, gotData) {
        t.Fatalf("Expected: %v, got %v", databytes, gotData)
    }

    // define different data
    databytes = []byte("... no ha mucho tiempo que vivía un hidalgo de los de lanza en astillero ...")

    updateRequest, err := client.GetResourceMetadata(nil, correctManifestAddrHex)
    if err != nil {
        t.Fatalf("Error retrieving update request template: %s", err)
    }

    updateRequest.SetData(databytes)
    if err := updateRequest.Sign(signer); err != nil {
        t.Fatalf("Error signing update: %s", err)
    }

    if err = client.UpdateResource(updateRequest); err != nil {
        t.Fatalf("Error updating resource: %s", err)
    }

    reader, err = client.GetResource(nil, correctManifestAddrHex)
    if err != nil {
        t.Fatalf("Error retrieving resource: %s", err)
    }
    defer reader.Close()
    gotData, err = ioutil.ReadAll(reader)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(databytes, gotData) {
        t.Fatalf("Expected: %v, got %v", databytes, gotData)
    }

    // now try retrieving resource without a manifest

    view := &mru.View{
        Topic: topic,
        User:  signer.Address(),
    }

    lookupParams := mru.NewQueryLatest(view, lookup.NoClue)
    reader, err = client.GetResource(lookupParams, "")
    if err != nil {
        t.Fatalf("Error retrieving resource: %s", err)
    }
    defer reader.Close()
    gotData, err = ioutil.ReadAll(reader)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(databytes, gotData) {
        t.Fatalf("Expected: %v, got %v", databytes, gotData)
    }
}