path: root/swarm/api/http/server_test.go

// 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 http

import (
    "archive/tar"
    "bytes"
    "context"
    "crypto/rand"
    "encoding/json"
    "errors"
    "flag"
    "fmt"
    "io"
    "io/ioutil"
    "math/big"
    "mime/multipart"
    "net/http"
    "net/url"
    "os"
    "path"
    "strconv"
    "strings"
    "testing"
    "time"

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

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/swarm/api"
    swarm "github.com/ethereum/go-ethereum/swarm/api/client"
    "github.com/ethereum/go-ethereum/swarm/multihash"
    "github.com/ethereum/go-ethereum/swarm/storage"
    "github.com/ethereum/go-ethereum/swarm/storage/mru"
    "github.com/ethereum/go-ethereum/swarm/testutil"
)

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

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

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-containing feed updates with bzz:// scheme
//
// first upload data, and store the multihash to the resulting manifest in a feed 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 TestBzzFeedMultihash(t *testing.T) {

    signer, _ := newTestSigner()

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

    // add the data our multihash aliased manifest will point to
    databytes := "bar"
    testBzzUrl := fmt.Sprintf("%s/bzz:/", srv.URL)
    resp, err := http.Post(testBzzUrl, "text/plain", bytes.NewReader([]byte(databytes)))
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err := ioutil.ReadAll(resp.Body)

    if err != nil {
        t.Fatal(err)
    }
    s := common.FromHex(string(b))
    mh := multihash.ToMultihash(s)

    log.Info("added data", "manifest", string(b), "data", common.ToHex(mh))

    topic, _ := mru.NewTopic("foo.eth", nil)
    updateRequest := mru.NewFirstRequest(topic)

    updateRequest.SetData(mh)

    if err := updateRequest.Sign(signer); err != nil {
        t.Fatal(err)
    }
    log.Info("added data", "manifest", string(b), "data", common.ToHex(mh))

    testUrl, err := url.Parse(fmt.Sprintf("%s/bzz-feed:/", srv.URL))
    if err != nil {
        t.Fatal(err)
    }
    query := testUrl.Query()
    body := updateRequest.AppendValues(query) // this adds all query parameters and returns the data to be posted
    query.Set("manifest", "1")                // indicate we want a manifest back
    testUrl.RawQuery = query.Encode()

    // create the multihash update
    resp, err = http.Post(testUrl.String(), "application/octet-stream", bytes.NewReader(body))
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err = ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }
    rsrcResp := &storage.Address{}
    err = json.Unmarshal(b, rsrcResp)
    if err != nil {
        t.Fatalf("data %s could not be unmarshaled: %v", b, err)
    }

    correctManifestAddrHex := "bb056a5264c295c2b0f613c8409b9c87ce9d71576ace02458160df4cc894210b"
    if rsrcResp.Hex() != correctManifestAddrHex {
        t.Fatalf("Response feed manifest address mismatch, expected '%s', got '%s'", correctManifestAddrHex, rsrcResp.Hex())
    }

    // get bzz manifest transparent feed update resolve
    testBzzUrl = fmt.Sprintf("%s/bzz:/%s", srv.URL, rsrcResp)
    resp, err = http.Get(testBzzUrl)
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err = ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(b, []byte(databytes)) {
        t.Fatalf("retrieved data mismatch, expected %x, got %x", databytes, b)
    }
}

// Test Swarm Feeds using the raw update methods
func TestBzzFeed(t *testing.T) {
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    signer, _ := newTestSigner()

    defer srv.Close()

    // data of update 1
    update1Data := make([]byte, 666)
    update1Timestamp := srv.CurrentTime
    _, err := rand.Read(update1Data)
    if err != nil {
        t.Fatal(err)
    }
    //data for update 2
    update2Data := []byte("foo")

    topic, _ := mru.NewTopic("foo.eth", nil)
    updateRequest := mru.NewFirstRequest(topic)
    if err != nil {
        t.Fatal(err)
    }
    updateRequest.SetData(update1Data)

    if err := updateRequest.Sign(signer); err != nil {
        t.Fatal(err)
    }

    // creates feed and sets update 1
    testUrl, err := url.Parse(fmt.Sprintf("%s/bzz-feed:/", srv.URL))
    if err != nil {
        t.Fatal(err)
    }
    urlQuery := testUrl.Query()
    body := updateRequest.AppendValues(urlQuery) // this adds all query parameters
    urlQuery.Set("manifest", "1")                // indicate we want a manifest back
    testUrl.RawQuery = urlQuery.Encode()

    resp, err := http.Post(testUrl.String(), "application/octet-stream", bytes.NewReader(body))
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }
    rsrcResp := &storage.Address{}
    err = json.Unmarshal(b, rsrcResp)
    if err != nil {
        t.Fatalf("data %s could not be unmarshaled: %v", b, err)
    }

    correctManifestAddrHex := "bb056a5264c295c2b0f613c8409b9c87ce9d71576ace02458160df4cc894210b"
    if rsrcResp.Hex() != correctManifestAddrHex {
        t.Fatalf("Response feed manifest mismatch, expected '%s', got '%s'", correctManifestAddrHex, rsrcResp.Hex())
    }

    // get the manifest
    testRawUrl := fmt.Sprintf("%s/bzz-raw:/%s", srv.URL, rsrcResp)
    resp, err = http.Get(testRawUrl)
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err = ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }
    manifest := &api.Manifest{}
    err = json.Unmarshal(b, manifest)
    if err != nil {
        t.Fatal(err)
    }
    if len(manifest.Entries) != 1 {
        t.Fatalf("Manifest has %d entries", len(manifest.Entries))
    }
    correctFeedHex := "0x666f6f2e65746800000000000000000000000000000000000000000000000000c96aaa54e2d44c299564da76e1cd3184a2386b8d"
    if manifest.Entries[0].Feed.Hex() != correctFeedHex {
        t.Fatalf("Expected manifest Feed '%s', got '%s'", correctFeedHex, manifest.Entries[0].Feed.Hex())
    }

    // get bzz manifest transparent feed update resolve
    testBzzUrl := fmt.Sprintf("%s/bzz:/%s", srv.URL, rsrcResp)
    resp, err = http.Get(testBzzUrl)
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode == http.StatusOK {
        t.Fatal("Expected error status since feed update does not contain multihash. Received 200 OK")
    }
    b, err = ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }

    // get non-existent name, should fail
    testBzzResUrl := fmt.Sprintf("%s/bzz-feed:/bar", srv.URL)
    resp, err = http.Get(testBzzResUrl)
    if err != nil {
        t.Fatal(err)
    }

    if resp.StatusCode != http.StatusNotFound {
        t.Fatalf("Expected get non-existent feed manifest to fail with StatusNotFound (404), got %d", resp.StatusCode)
    }

    resp.Body.Close()

    // get latest update through bzz-feed directly
    log.Info("get update latest = 1.1", "addr", correctManifestAddrHex)
    testBzzResUrl = fmt.Sprintf("%s/bzz-feed:/%s", srv.URL, correctManifestAddrHex)
    resp, err = http.Get(testBzzResUrl)
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err = ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(update1Data, b) {
        t.Fatalf("Expected body '%x', got '%x'", update1Data, b)
    }

    // update 2
    // Move the clock ahead 1 second
    srv.CurrentTime++
    log.Info("update 2")

    // 1.- get metadata about this Feed
    testBzzResUrl = fmt.Sprintf("%s/bzz-feed:/%s/", srv.URL, correctManifestAddrHex)
    resp, err = http.Get(testBzzResUrl + "?meta=1")
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("Get feed metadata returned %s", resp.Status)
    }
    b, err = ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }
    updateRequest = &mru.Request{}
    if err = updateRequest.UnmarshalJSON(b); err != nil {
        t.Fatalf("Error decoding feed metadata: %s", err)
    }
    updateRequest.SetData(update2Data)
    if err = updateRequest.Sign(signer); err != nil {
        t.Fatal(err)
    }
    testUrl, err = url.Parse(fmt.Sprintf("%s/bzz-feed:/", srv.URL))
    if err != nil {
        t.Fatal(err)
    }
    urlQuery = testUrl.Query()
    body = updateRequest.AppendValues(urlQuery) // this adds all query parameters
    testUrl.RawQuery = urlQuery.Encode()

    resp, err = http.Post(testUrl.String(), "application/octet-stream", bytes.NewReader(body))
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("Update returned %s", resp.Status)
    }

    // get latest update through bzz-feed directly
    log.Info("get update 1.2")
    testBzzResUrl = fmt.Sprintf("%s/bzz-feed:/%s", srv.URL, correctManifestAddrHex)
    resp, err = http.Get(testBzzResUrl)
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err = ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(update2Data, b) {
        t.Fatalf("Expected body '%x', got '%x'", update2Data, b)
    }

    // test manifest-less queries
    log.Info("get first update in update1Timestamp via direct query")
    query := mru.NewQuery(&updateRequest.Feed, update1Timestamp, lookup.NoClue)

    urlq, err := url.Parse(fmt.Sprintf("%s/bzz-feed:/", srv.URL))
    if err != nil {
        t.Fatal(err)
    }

    values := urlq.Query()
    query.AppendValues(values) // this adds feed query parameters
    urlq.RawQuery = values.Encode()
    resp, err = http.Get(urlq.String())
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err = ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(update1Data, b) {
        t.Fatalf("Expected body '%x', got '%x'", update1Data, b)
    }

}

func TestBzzGetPath(t *testing.T) {
    testBzzGetPath(false, t)
    testBzzGetPath(true, t)
}

func testBzzGetPath(encrypted bool, t *testing.T) {
    var err error

    testmanifest := []string{
        `{"entries":[{"path":"b","hash":"011b4d03dd8c01f1049143cf9c4c817e4b167f1d1b83e5c6f0f10d89ba1e7bce","contentType":"","status":0},{"path":"c","hash":"011b4d03dd8c01f1049143cf9c4c817e4b167f1d1b83e5c6f0f10d89ba1e7bce","contentType":"","status":0}]}`,
        `{"entries":[{"path":"a","hash":"011b4d03dd8c01f1049143cf9c4c817e4b167f1d1b83e5c6f0f10d89ba1e7bce","contentType":"","status":0},{"path":"b/","hash":"<key0>","contentType":"application/bzz-manifest+json","status":0}]}`,
        `{"entries":[{"path":"a/","hash":"<key1>","contentType":"application/bzz-manifest+json","status":0}]}`,
    }

    testrequests := make(map[string]int)
    testrequests["/"] = 2
    testrequests["/a/"] = 1
    testrequests["/a/b/"] = 0
    testrequests["/x"] = 0
    testrequests[""] = 0

    expectedfailrequests := []string{"", "/x"}

    reader := [3]*bytes.Reader{}

    addr := [3]storage.Address{}

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

    for i, mf := range testmanifest {
        reader[i] = bytes.NewReader([]byte(mf))
        var wait func(context.Context) error
        ctx := context.TODO()
        addr[i], wait, err = srv.FileStore.Store(ctx, reader[i], int64(len(mf)), encrypted)
        if err != nil {
            t.Fatal(err)
        }
        for j := i + 1; j < len(testmanifest); j++ {
            testmanifest[j] = strings.Replace(testmanifest[j], fmt.Sprintf("<key%v>", i), addr[i].Hex(), -1)
        }
        err = wait(ctx)
        if err != nil {
            t.Fatal(err)
        }
    }

    rootRef := addr[2].Hex()

    _, err = http.Get(srv.URL + "/bzz-raw:/" + rootRef + "/a")
    if err != nil {
        t.Fatalf("Failed to connect to proxy: %v", err)
    }

    for k, v := range testrequests {
        var resp *http.Response
        var respbody []byte

        url := srv.URL + "/bzz-raw:/"
        if k != "" {
            url += rootRef + "/" + k[1:] + "?content_type=text/plain"
        }
        resp, err = http.Get(url)
        if err != nil {
            t.Fatalf("Request failed: %v", err)
        }
        defer resp.Body.Close()
        respbody, err = ioutil.ReadAll(resp.Body)

        if string(respbody) != testmanifest[v] {
            isexpectedfailrequest := false

            for _, r := range expectedfailrequests {
                if k == r {
                    isexpectedfailrequest = true
                }
            }
            if !isexpectedfailrequest {
                t.Fatalf("Response body does not match, expected: %v, got %v", testmanifest[v], string(respbody))
            }
        }
    }

    for k, v := range testrequests {
        var resp *http.Response
        var respbody []byte

        url := srv.URL + "/bzz-hash:/"
        if k != "" {
            url += rootRef + "/" + k[1:]
        }
        resp, err = http.Get(url)
        if err != nil {
            t.Fatalf("Request failed: %v", err)
        }
        defer resp.Body.Close()
        respbody, err = ioutil.ReadAll(resp.Body)
        if err != nil {
            t.Fatalf("Read request body: %v", err)
        }

        if string(respbody) != addr[v].Hex() {
            isexpectedfailrequest := false

            for _, r := range expectedfailrequests {
                if k == r {
                    isexpectedfailrequest = true
                }
            }
            if !isexpectedfailrequest {
                t.Fatalf("Response body does not match, expected: %v, got %v", addr[v], string(respbody))
            }
        }
    }

    ref := addr[2].Hex()

    for _, c := range []struct {
        path          string
        json          string
        pageFragments []string
    }{
        {
            path: "/",
            json: `{"common_prefixes":["a/"]}`,
            pageFragments: []string{
                fmt.Sprintf("Swarm index of bzz:/%s/", ref),
                `<a class="normal-link" href="a/">a/</a>`,
            },
        },
        {
            path: "/a/",
            json: `{"common_prefixes":["a/b/"],"entries":[{"hash":"011b4d03dd8c01f1049143cf9c4c817e4b167f1d1b83e5c6f0f10d89ba1e7bce","path":"a/a","mod_time":"0001-01-01T00:00:00Z"}]}`,
            pageFragments: []string{
                fmt.Sprintf("Swarm index of bzz:/%s/a/", ref),
                `<a class="normal-link" href="b/">b/</a>`,
                fmt.Sprintf(`<a class="normal-link" href="/bzz:/%s/a/a">a</a>`, ref),
            },
        },
        {
            path: "/a/b/",
            json: `{"entries":[{"hash":"011b4d03dd8c01f1049143cf9c4c817e4b167f1d1b83e5c6f0f10d89ba1e7bce","path":"a/b/b","mod_time":"0001-01-01T00:00:00Z"},{"hash":"011b4d03dd8c01f1049143cf9c4c817e4b167f1d1b83e5c6f0f10d89ba1e7bce","path":"a/b/c","mod_time":"0001-01-01T00:00:00Z"}]}`,
            pageFragments: []string{
                fmt.Sprintf("Swarm index of bzz:/%s/a/b/", ref),
                fmt.Sprintf(`<a class="normal-link" href="/bzz:/%s/a/b/b">b</a>`, ref),
                fmt.Sprintf(`<a class="normal-link" href="/bzz:/%s/a/b/c">c</a>`, ref),
            },
        },
        {
            path: "/x",
        },
        {
            path: "",
        },
    } {
        k := c.path
        url := srv.URL + "/bzz-list:/"
        if k != "" {
            url += rootRef + "/" + k[1:]
        }
        t.Run("json list "+c.path, func(t *testing.T) {
            resp, err := http.Get(url)
            if err != nil {
                t.Fatalf("HTTP request: %v", err)
            }
            defer resp.Body.Close()
            respbody, err := ioutil.ReadAll(resp.Body)
            if err != nil {
                t.Fatalf("Read response body: %v", err)
            }

            body := strings.TrimSpace(string(respbody))
            if body != c.json {
                isexpectedfailrequest := false

                for _, r := range expectedfailrequests {
                    if k == r {
                        isexpectedfailrequest = true
                    }
                }
                if !isexpectedfailrequest {
                    t.Errorf("Response list body %q does not match, expected: %v, got %v", k, c.json, body)
                }
            }
        })
        t.Run("html list "+c.path, func(t *testing.T) {
            req, err := http.NewRequest(http.MethodGet, url, nil)
            if err != nil {
                t.Fatalf("New request: %v", err)
            }
            req.Header.Set("Accept", "text/html")
            resp, err := http.DefaultClient.Do(req)
            if err != nil {
                t.Fatalf("HTTP request: %v", err)
            }
            defer resp.Body.Close()
            b, err := ioutil.ReadAll(resp.Body)
            if err != nil {
                t.Fatalf("Read response body: %v", err)
            }

            body := string(b)

            for _, f := range c.pageFragments {
                if !strings.Contains(body, f) {
                    isexpectedfailrequest := false

                    for _, r := range expectedfailrequests {
                        if k == r {
                            isexpectedfailrequest = true
                        }
                    }
                    if !isexpectedfailrequest {
                        t.Errorf("Response list body %q does not contain %q: body %q", k, f, body)
                    }
                }
            }
        })
    }

    nonhashtests := []string{
        srv.URL + "/bzz:/name",
        srv.URL + "/bzz-immutable:/nonhash",
        srv.URL + "/bzz-raw:/nonhash",
        srv.URL + "/bzz-list:/nonhash",
        srv.URL + "/bzz-hash:/nonhash",
    }

    nonhashresponses := []string{
        `cannot resolve name: no DNS to resolve name: "name"`,
        `cannot resolve nonhash: no DNS to resolve name: "nonhash"`,
        `cannot resolve nonhash: no DNS to resolve name: "nonhash"`,
        `cannot resolve nonhash: no DNS to resolve name: "nonhash"`,
        `cannot resolve nonhash: no DNS to resolve name: "nonhash"`,
    }

    for i, url := range nonhashtests {
        var resp *http.Response
        var respbody []byte

        resp, err = http.Get(url)

        if err != nil {
            t.Fatalf("Request failed: %v", err)
        }
        defer resp.Body.Close()
        respbody, err = ioutil.ReadAll(resp.Body)
        if err != nil {
            t.Fatalf("ReadAll failed: %v", err)
        }
        if !strings.Contains(string(respbody), nonhashresponses[i]) {
            t.Fatalf("Non-Hash response body does not match, expected: %v, got: %v", nonhashresponses[i], string(respbody))
        }
    }
}

func TestBzzTar(t *testing.T) {
    testBzzTar(false, t)
    testBzzTar(true, t)
}

func testBzzTar(encrypted bool, t *testing.T) {
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    defer srv.Close()
    fileNames := []string{"tmp1.txt", "tmp2.lock", "tmp3.rtf"}
    fileContents := []string{"tmp1textfilevalue", "tmp2lockfilelocked", "tmp3isjustaplaintextfile"}

    buf := &bytes.Buffer{}
    tw := tar.NewWriter(buf)
    defer tw.Close()

    for i, v := range fileNames {
        size := int64(len(fileContents[i]))
        hdr := &tar.Header{
            Name:    v,
            Mode:    0644,
            Size:    size,
            ModTime: time.Now(),
            Xattrs: map[string]string{
                "user.swarm.content-type": "text/plain",
            },
        }
        if err := tw.WriteHeader(hdr); err != nil {
            t.Fatal(err)
        }

        // copy the file into the tar stream
        n, err := io.Copy(tw, bytes.NewBufferString(fileContents[i]))
        if err != nil {
            t.Fatal(err)
        } else if n != size {
            t.Fatal("size mismatch")
        }
    }

    //post tar stream
    url := srv.URL + "/bzz:/"
    if encrypted {
        url = url + "encrypt"
    }
    req, err := http.NewRequest("POST", url, buf)
    if err != nil {
        t.Fatal(err)
    }
    req.Header.Add("Content-Type", "application/x-tar")
    client := &http.Client{}
    resp2, err := client.Do(req)
    if err != nil {
        t.Fatal(err)
    }
    if resp2.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp2.Status)
    }
    swarmHash, err := ioutil.ReadAll(resp2.Body)
    resp2.Body.Close()
    if err != nil {
        t.Fatal(err)
    }

    // now do a GET to get a tarball back
    req, err = http.NewRequest("GET", fmt.Sprintf(srv.URL+"/bzz:/%s", string(swarmHash)), nil)
    if err != nil {
        t.Fatal(err)
    }
    req.Header.Add("Accept", "application/x-tar")
    resp2, err = client.Do(req)
    if err != nil {
        t.Fatal(err)
    }
    defer resp2.Body.Close()

    if h := resp2.Header.Get("Content-Type"); h != "application/x-tar" {
        t.Fatalf("Content-Type header expected: application/x-tar, got: %s", h)
    }

    expectedFileName := string(swarmHash) + ".tar"
    expectedContentDisposition := fmt.Sprintf("inline; filename=\"%s\"", expectedFileName)
    if h := resp2.Header.Get("Content-Disposition"); h != expectedContentDisposition {
        t.Fatalf("Content-Disposition header expected: %s, got: %s", expectedContentDisposition, h)
    }

    file, err := ioutil.TempFile("", "swarm-downloaded-tarball")
    if err != nil {
        t.Fatal(err)
    }
    defer os.Remove(file.Name())
    _, err = io.Copy(file, resp2.Body)
    if err != nil {
        t.Fatalf("error getting tarball: %v", err)
    }
    file.Sync()
    file.Close()

    tarFileHandle, err := os.Open(file.Name())
    if err != nil {
        t.Fatal(err)
    }
    tr := tar.NewReader(tarFileHandle)

    for {
        hdr, err := tr.Next()
        if err == io.EOF {
            break
        } else if err != nil {
            t.Fatalf("error reading tar stream: %s", err)
        }
        bb := make([]byte, hdr.Size)
        _, err = tr.Read(bb)
        if err != nil && err != io.EOF {
            t.Fatal(err)
        }
        passed := false
        for i, v := range fileNames {
            if v == hdr.Name {
                if string(bb) == fileContents[i] {
                    passed = true
                    break
                }
            }
        }
        if !passed {
            t.Fatalf("file %s did not pass content assertion", hdr.Name)
        }
    }
}

// TestBzzRootRedirect tests that getting the root path of a manifest without
// a trailing slash gets redirected to include the trailing slash so that
// relative URLs work as expected.
func TestBzzRootRedirect(t *testing.T) {
    testBzzRootRedirect(false, t)
}
func TestBzzRootRedirectEncrypted(t *testing.T) {
    testBzzRootRedirect(true, t)
}

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

    // create a manifest with some data at the root path
    client := swarm.NewClient(srv.URL)
    data := []byte("data")
    file := &swarm.File{
        ReadCloser: ioutil.NopCloser(bytes.NewReader(data)),
        ManifestEntry: api.ManifestEntry{
            Path:        "",
            ContentType: "text/plain",
            Size:        int64(len(data)),
        },
    }
    hash, err := client.Upload(file, "", toEncrypt)
    if err != nil {
        t.Fatal(err)
    }

    // define a CheckRedirect hook which ensures there is only a single
    // redirect to the correct URL
    redirected := false
    httpClient := http.Client{
        CheckRedirect: func(req *http.Request, via []*http.Request) error {
            if redirected {
                return errors.New("too many redirects")
            }
            redirected = true
            expectedPath := "/bzz:/" + hash + "/"
            if req.URL.Path != expectedPath {
                return fmt.Errorf("expected redirect to %q, got %q", expectedPath, req.URL.Path)
            }
            return nil
        },
    }

    // perform the GET request and assert the response
    res, err := httpClient.Get(srv.URL + "/bzz:/" + hash)
    if err != nil {
        t.Fatal(err)
    }
    defer res.Body.Close()
    if !redirected {
        t.Fatal("expected GET /bzz:/<hash> to redirect to /bzz:/<hash>/ but it didn't")
    }
    gotData, err := ioutil.ReadAll(res.Body)
    if err != nil {
        t.Fatal(err)
    }
    if !bytes.Equal(gotData, data) {
        t.Fatalf("expected response to equal %q, got %q", data, gotData)
    }
}

func TestMethodsNotAllowed(t *testing.T) {
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    defer srv.Close()
    databytes := "bar"
    for _, c := range []struct {
        url  string
        code int
    }{
        {
            url:  fmt.Sprintf("%s/bzz-list:/", srv.URL),
            code: http.StatusMethodNotAllowed,
        }, {
            url:  fmt.Sprintf("%s/bzz-hash:/", srv.URL),
            code: http.StatusMethodNotAllowed,
        },
        {
            url:  fmt.Sprintf("%s/bzz-immutable:/", srv.URL),
            code: http.StatusMethodNotAllowed,
        },
    } {
        res, _ := http.Post(c.url, "text/plain", bytes.NewReader([]byte(databytes)))
        if res.StatusCode != c.code {
            t.Fatalf("should have failed. requested url: %s, expected code %d, got %d", c.url, c.code, res.StatusCode)
        }
    }

}

func httpDo(httpMethod string, url string, reqBody io.Reader, headers map[string]string, verbose bool, t *testing.T) (*http.Response, string) {
    // Build the Request
    req, err := http.NewRequest(httpMethod, url, reqBody)
    if err != nil {
        t.Fatal(err)
    }
    for key, value := range headers {
        req.Header.Set(key, value)
    }
    if verbose {
        t.Log(req.Method, req.URL, req.Header, req.Body)
    }

    // Send Request out
    httpClient := &http.Client{}
    res, err := httpClient.Do(req)
    if err != nil {
        t.Fatal(err)
    }

    // Read the HTTP Body
    buffer, err := ioutil.ReadAll(res.Body)
    if err != nil {
        t.Fatal(err)
    }
    defer res.Body.Close()
    body := string(buffer)

    return res, body
}

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

    for _, testCase := range []struct {
        uri                string
        method             string
        headers            map[string]string
        expectedStatusCode int
        assertResponseBody string
        verbose            bool
    }{
        {
            uri:                fmt.Sprintf("%s/", srv.URL),
            method:             "GET",
            headers:            map[string]string{"Accept": "text/html"},
            expectedStatusCode: http.StatusOK,
            assertResponseBody: "Swarm: Serverless Hosting Incentivised Peer-To-Peer Storage And Content Distribution",
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/", srv.URL),
            method:             "GET",
            headers:            map[string]string{"Accept": "application/json"},
            expectedStatusCode: http.StatusOK,
            assertResponseBody: "Swarm: Please request a valid ENS or swarm hash with the appropriate bzz scheme",
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/robots.txt", srv.URL),
            method:             "GET",
            headers:            map[string]string{"Accept": "text/html"},
            expectedStatusCode: http.StatusOK,
            assertResponseBody: "User-agent: *\nDisallow: /",
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/nonexistent_path", srv.URL),
            method:             "GET",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusNotFound,
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/bzz:asdf/", srv.URL),
            method:             "GET",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusNotFound,
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/tbz2/", srv.URL),
            method:             "GET",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusNotFound,
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/bzz-rack:/", srv.URL),
            method:             "GET",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusNotFound,
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/bzz-ls", srv.URL),
            method:             "GET",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusNotFound,
            verbose:            false,
        }} {
        t.Run("GET "+testCase.uri, func(t *testing.T) {
            res, body := httpDo(testCase.method, testCase.uri, nil, testCase.headers, testCase.verbose, t)
            if res.StatusCode != testCase.expectedStatusCode {
                t.Fatalf("expected status code %d but got %d", testCase.expectedStatusCode, res.StatusCode)
            }
            if testCase.assertResponseBody != "" && !strings.Contains(body, testCase.assertResponseBody) {
                t.Fatalf("expected response to be: %s but got: %s", testCase.assertResponseBody, body)
            }
        })
    }
}

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

    swarmClient := swarm.NewClient(srv.URL)
    data := []byte("data")
    file := &swarm.File{
        ReadCloser: ioutil.NopCloser(bytes.NewReader(data)),
        ManifestEntry: api.ManifestEntry{
            Path:        "",
            ContentType: "text/plain",
            Size:        int64(len(data)),
        },
    }

    hash, err := swarmClient.Upload(file, "", false)
    if err != nil {
        t.Fatal(err)
    }

    for _, testCase := range []struct {
        uri                   string
        method                string
        headers               map[string]string
        requestBody           []byte
        expectedStatusCode    int
        assertResponseBody    string
        assertResponseHeaders map[string]string
        verbose               bool
    }{
        {
            uri:                fmt.Sprintf("%s/bzz:/%s", srv.URL, hash),
            method:             "DELETE",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusOK,
            assertResponseBody: "8b634aea26eec353ac0ecbec20c94f44d6f8d11f38d4578a4c207a84c74ef731",
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/bzz:/%s", srv.URL, hash),
            method:             "PUT",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusMethodNotAllowed,
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/bzz-raw:/%s", srv.URL, hash),
            method:             "PUT",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusMethodNotAllowed,
            verbose:            false,
        },
        {
            uri:                fmt.Sprintf("%s/bzz:/%s", srv.URL, hash),
            method:             "PATCH",
            headers:            map[string]string{},
            expectedStatusCode: http.StatusMethodNotAllowed,
            verbose:            false,
        },
        {
            uri:                   fmt.Sprintf("%s/bzz-raw:/", srv.URL),
            method:                "POST",
            headers:               map[string]string{},
            requestBody:           []byte("POSTdata"),
            expectedStatusCode:    http.StatusOK,
            assertResponseHeaders: map[string]string{"Content-Length": "64"},
            verbose:               false,
        },
        {
            uri:                   fmt.Sprintf("%s/bzz-raw:/encrypt", srv.URL),
            method:                "POST",
            headers:               map[string]string{},
            requestBody:           []byte("POSTdata"),
            expectedStatusCode:    http.StatusOK,
            assertResponseHeaders: map[string]string{"Content-Length": "128"},
            verbose:               false,
        },
    } {
        t.Run(testCase.method+" "+testCase.uri, func(t *testing.T) {
            reqBody := bytes.NewReader(testCase.requestBody)
            res, body := httpDo(testCase.method, testCase.uri, reqBody, testCase.headers, testCase.verbose, t)

            if res.StatusCode != testCase.expectedStatusCode {
                t.Fatalf("expected status code %d but got %d, %s", testCase.expectedStatusCode, res.StatusCode, body)
            }
            if testCase.assertResponseBody != "" && !strings.Contains(body, testCase.assertResponseBody) {
                t.Log(body)
                t.Fatalf("expected response %s but got %s", testCase.assertResponseBody, body)
            }
            for key, value := range testCase.assertResponseHeaders {
                if res.Header.Get(key) != value {
                    t.Logf("expected %s=%s in HTTP response header but got %s", key, value, res.Header.Get(key))
                }
            }
        })
    }
}

func TestMultiPartUpload(t *testing.T) {
    // POST /bzz:/ Content-Type: multipart/form-data
    verbose := false
    // Setup Swarm
    srv := testutil.NewTestSwarmServer(t, serverFunc, nil)
    defer srv.Close()

    url := fmt.Sprintf("%s/bzz:/", srv.URL)

    buf := new(bytes.Buffer)
    form := multipart.NewWriter(buf)
    form.WriteField("name", "John Doe")
    file1, _ := form.CreateFormFile("cv", "cv.txt")
    file1.Write([]byte("John Doe's Credentials"))
    file2, _ := form.CreateFormFile("profile_picture", "profile.jpg")
    file2.Write([]byte("imaginethisisjpegdata"))
    form.Close()

    headers := map[string]string{
        "Content-Type":   form.FormDataContentType(),
        "Content-Length": strconv.Itoa(buf.Len()),
    }
    res, body := httpDo("POST", url, buf, headers, verbose, t)

    if res.StatusCode != http.StatusOK {
        t.Fatalf("expected POST multipart/form-data to return 200, but it returned %d", res.StatusCode)
    }
    if len(body) != 64 {
        t.Fatalf("expected POST multipart/form-data to return a 64 char manifest but the answer was %d chars long", len(body))
    }
}

// TestBzzGetFileWithResolver tests fetching a file using a mocked ENS resolver
func TestBzzGetFileWithResolver(t *testing.T) {
    resolver := newTestResolveValidator("")
    srv := testutil.NewTestSwarmServer(t, serverFunc, resolver)
    defer srv.Close()
    fileNames := []string{"dir1/tmp1.txt", "dir2/tmp2.lock", "dir3/tmp3.rtf"}
    fileContents := []string{"tmp1textfilevalue", "tmp2lockfilelocked", "tmp3isjustaplaintextfile"}

    buf := &bytes.Buffer{}
    tw := tar.NewWriter(buf)

    for i, v := range fileNames {
        size := len(fileContents[i])
        hdr := &tar.Header{
            Name:    v,
            Mode:    0644,
            Size:    int64(size),
            ModTime: time.Now(),
            Xattrs: map[string]string{
                "user.swarm.content-type": "text/plain",
            },
        }
        if err := tw.WriteHeader(hdr); err != nil {
            t.Fatal(err)
        }

        // copy the file into the tar stream
        n, err := io.WriteString(tw, fileContents[i])
        if err != nil {
            t.Fatal(err)
        } else if n != size {
            t.Fatal("size mismatch")
        }
    }

    if err := tw.Close(); err != nil {
        t.Fatal(err)
    }

    //post tar stream
    url := srv.URL + "/bzz:/"

    req, err := http.NewRequest("POST", url, buf)
    if err != nil {
        t.Fatal(err)
    }
    req.Header.Add("Content-Type", "application/x-tar")
    client := &http.Client{}
    serverResponse, err := client.Do(req)
    if err != nil {
        t.Fatal(err)
    }
    if serverResponse.StatusCode != http.StatusOK {
        t.Fatalf("err %s", serverResponse.Status)
    }
    swarmHash, err := ioutil.ReadAll(serverResponse.Body)
    serverResponse.Body.Close()
    if err != nil {
        t.Fatal(err)
    }
    // set the resolved hash to be the swarm hash of what we've just uploaded
    hash := common.HexToHash(string(swarmHash))
    resolver.hash = &hash
    for _, v := range []struct {
        addr                string
        path                string
        expectedStatusCode  int
        expectedContentType string
        expectedFileName    string
    }{
        {
            addr:                string(swarmHash),
            path:                fileNames[0],
            expectedStatusCode:  http.StatusOK,
            expectedContentType: "text/plain",
            expectedFileName:    path.Base(fileNames[0]),
        },
        {
            addr:                "somebogusensname",
            path:                fileNames[0],
            expectedStatusCode:  http.StatusOK,
            expectedContentType: "text/plain",
            expectedFileName:    path.Base(fileNames[0]),
        },
    } {
        req, err := http.NewRequest("GET", fmt.Sprintf(srv.URL+"/bzz:/%s/%s", v.addr, v.path), nil)
        if err != nil {
            t.Fatal(err)
        }
        serverResponse, err := client.Do(req)
        if err != nil {
            t.Fatal(err)
        }
        defer serverResponse.Body.Close()
        if serverResponse.StatusCode != v.expectedStatusCode {
            t.Fatalf("expected %d, got %d", v.expectedStatusCode, serverResponse.StatusCode)
        }

        if h := serverResponse.Header.Get("Content-Type"); h != v.expectedContentType {
            t.Fatalf("Content-Type header expected: %s, got %s", v.expectedContentType, h)
        }

        expectedContentDisposition := fmt.Sprintf("inline; filename=\"%s\"", v.expectedFileName)
        if h := serverResponse.Header.Get("Content-Disposition"); h != expectedContentDisposition {
            t.Fatalf("Content-Disposition header expected: %s, got: %s", expectedContentDisposition, h)
        }

    }
}

// testResolver implements the Resolver interface and either returns the given
// hash if it is set, or returns a "name not found" error
type testResolveValidator struct {
    hash *common.Hash
}

func newTestResolveValidator(addr string) *testResolveValidator {
    r := &testResolveValidator{}
    if addr != "" {
        hash := common.HexToHash(addr)
        r.hash = &hash
    }
    return r
}

func (t *testResolveValidator) Resolve(addr string) (common.Hash, error) {
    if t.hash == nil {
        return common.Hash{}, fmt.Errorf("DNS name not found: %q", addr)
    }
    return *t.hash, nil
}

func (t *testResolveValidator) Owner(node [32]byte) (addr common.Address, err error) {
    return
}
func (t *testResolveValidator) HeaderByNumber(context.Context, *big.Int) (header *types.Header, err error) {
    return
}