// 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 . package client import ( "bytes" "io/ioutil" "os" "path/filepath" "reflect" "sort" "testing" "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/storage/feed" ) func serverFunc(api *api.API) swarmhttp.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 := swarmhttp.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 := swarmhttp.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 := swarmhttp.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 := swarmhttp.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 := swarmhttp.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() (*feed.GenericSigner, error) { privKey, err := crypto.HexToECDSA("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef") if err != nil { return nil, err } return feed.NewGenericSigner(privKey), nil } // Test the transparent resolving of feed updates with bzz:// scheme // // First upload data to bzz:, and store the Swarm hash to the resulting manifest in a feed update. // This effectively uses a feed to store a pointer to content rather than the content itself // Retrieving the update with the Swarm hash should return the manifest pointing directly to the data // and raw retrieve of that hash should return the data // func TestClientBzzWithFeed(t *testing.T) { // signer, _ := newTestSigner() // // Initialize a Swarm test server // srv := swarmhttp.NewTestSwarmServer(t, serverFunc, nil) // swarmClient := NewClient(srv.URL) // defer srv.Close() // // put together some data for our test: // dataBytes := []byte(` // // // // Create some data our manifest will point to. Data that could be very big and wouldn't fit in a feed update. // // So what we are going to do is upload it to Swarm bzz:// and obtain a **manifest hash** pointing to it: // // // // MANIFEST HASH --> DATA // // // // Then, we store that **manifest hash** into a Swarm Feed update. Once we have done this, // // we can use the **feed manifest hash** in bzz:// instead, this way: bzz://feed-manifest-hash. // // // // FEED MANIFEST HASH --> MANIFEST HASH --> DATA // // // // Given that we can update the feed at any time with a new **manifest hash** but the **feed manifest hash** // // stays constant, we have effectively created a fixed address to changing content. (Applause) // // // // FEED MANIFEST HASH (the same) --> MANIFEST HASH(2) --> DATA(2) // // // `) // // Create a virtual File out of memory containing the above data // f := &File{ // ReadCloser: ioutil.NopCloser(bytes.NewReader(dataBytes)), // ManifestEntry: api.ManifestEntry{ // ContentType: "text/plain", // Mode: 0660, // Size: int64(len(dataBytes)), // }, // } // // upload data to bzz:// and retrieve the content-addressed manifest hash, hex-encoded. // manifestAddressHex, err := swarmClient.Upload(f, "", false) // if err != nil { // t.Fatalf("Error creating manifest: %s", err) // } // // convert the hex-encoded manifest hash to a 32-byte slice // manifestAddress := common.FromHex(manifestAddressHex) // if len(manifestAddress) != storage.AddressLength { // t.Fatalf("Something went wrong. Got a hash of an unexpected length. Expected %d bytes. Got %d", storage.AddressLength, len(manifestAddress)) // } // // Now create a **feed manifest**. For that, we need a topic: // topic, _ := feed.NewTopic("interesting topic indeed", nil) // // Build a feed request to update data // request := feed.NewFirstRequest(topic) // // Put the 32-byte address of the manifest into the feed update // request.SetData(manifestAddress) // // Sign the update // if err := request.Sign(signer); err != nil { // t.Fatalf("Error signing update: %s", err) // } // // Publish the update and at the same time request a **feed manifest** to be created // feedManifestAddressHex, err := swarmClient.CreateFeedWithManifest(request) // if err != nil { // t.Fatalf("Error creating feed manifest: %s", err) // } // // Check we have received the exact **feed manifest** to be expected // // given the topic and user signing the updates: // correctFeedManifestAddrHex := "747c402e5b9dc715a25a4393147512167bab018a007fad7cdcd9adc7fce1ced2" // if feedManifestAddressHex != correctFeedManifestAddrHex { // t.Fatalf("Response feed manifest mismatch, expected '%s', got '%s'", correctFeedManifestAddrHex, feedManifestAddressHex) // } // // Check we get a not found error when trying to get feed updates with a made-up manifest // _, err = swarmClient.QueryFeed(nil, "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb") // if err != ErrNoFeedUpdatesFound { // t.Fatalf("Expected to receive ErrNoFeedUpdatesFound error. Got: %s", err) // } // // If we query the feed directly we should get **manifest hash** back: // reader, err := swarmClient.QueryFeed(nil, correctFeedManifestAddrHex) // if err != nil { // t.Fatalf("Error retrieving feed updates: %s", err) // } // defer reader.Close() // gotData, err := ioutil.ReadAll(reader) // if err != nil { // t.Fatal(err) // } // //Check that indeed the **manifest hash** is retrieved // if !bytes.Equal(manifestAddress, gotData) { // t.Fatalf("Expected: %v, got %v", manifestAddress, gotData) // } // // Now the final test we were looking for: Use bzz:// and that should resolve all manifests // // and return the original data directly: // f, err = swarmClient.Download(feedManifestAddressHex, "") // if err != nil { // t.Fatal(err) // } // gotData, err = ioutil.ReadAll(f) // if err != nil { // t.Fatal(err) // } // // Check that we get back the original data: // if !bytes.Equal(dataBytes, gotData) { // t.Fatalf("Expected: %v, got %v", manifestAddress, gotData) // } // } // TestClientCreateUpdateFeed will check that feeds can be created and updated via the HTTP client. // func TestClientCreateUpdateFeed(t *testing.T) { // signer, _ := newTestSigner() // srv := swarmhttp.NewTestSwarmServer(t, serverFunc, nil) // client := NewClient(srv.URL) // defer srv.Close() // // set raw data for the feed update // databytes := []byte("En un lugar de La Mancha, de cuyo nombre no quiero acordarme...") // // our feed topic name // topic, _ := feed.NewTopic("El Quijote", nil) // createRequest := feed.NewFirstRequest(topic) // createRequest.SetData(databytes) // if err := createRequest.Sign(signer); err != nil { // t.Fatalf("Error signing update: %s", err) // } // feedManifestHash, err := client.CreateFeedWithManifest(createRequest) // if err != nil { // t.Fatal(err) // } // correctManifestAddrHex := "0e9b645ebc3da167b1d56399adc3276f7a08229301b72a03336be0e7d4b71882" // if feedManifestHash != correctManifestAddrHex { // t.Fatalf("Response feed manifest mismatch, expected '%s', got '%s'", correctManifestAddrHex, feedManifestHash) // } // reader, err := client.QueryFeed(nil, correctManifestAddrHex) // if err != nil { // t.Fatalf("Error retrieving feed updates: %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.GetFeedRequest(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.UpdateFeed(updateRequest); err != nil { // t.Fatalf("Error updating feed: %s", err) // } // reader, err = client.QueryFeed(nil, correctManifestAddrHex) // if err != nil { // t.Fatalf("Error retrieving feed updates: %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 feed updates without a manifest // fd := &feed.Feed{ // Topic: topic, // User: signer.Address(), // } // lookupParams := feed.NewQueryLatest(fd, lookup.NoClue) // reader, err = client.QueryFeed(lookupParams, "") // if err != nil { // t.Fatalf("Error retrieving feed updates: %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) // } // }