aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/api/api_test.go
blob: e673f76c426700328cebfc6633a3c4d9c631ea30 (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
// Copyright 2016 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 api

import (
    "errors"
    "fmt"
    "io"
    "io/ioutil"
    "os"
    "testing"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/swarm/storage"
)

func testApi(t *testing.T, f func(*Api)) {
    datadir, err := ioutil.TempDir("", "bzz-test")
    if err != nil {
        t.Fatalf("unable to create temp dir: %v", err)
    }
    os.RemoveAll(datadir)
    defer os.RemoveAll(datadir)
    dpa, err := storage.NewLocalDPA(datadir)
    if err != nil {
        return
    }
    api := NewApi(dpa, nil)
    dpa.Start()
    f(api)
    dpa.Stop()
}

type testResponse struct {
    reader storage.LazySectionReader
    *Response
}

func checkResponse(t *testing.T, resp *testResponse, exp *Response) {

    if resp.MimeType != exp.MimeType {
        t.Errorf("incorrect mimeType. expected '%s', got '%s'", exp.MimeType, resp.MimeType)
    }
    if resp.Status != exp.Status {
        t.Errorf("incorrect status. expected '%d', got '%d'", exp.Status, resp.Status)
    }
    if resp.Size != exp.Size {
        t.Errorf("incorrect size. expected '%d', got '%d'", exp.Size, resp.Size)
    }
    if resp.reader != nil {
        content := make([]byte, resp.Size)
        read, _ := resp.reader.Read(content)
        if int64(read) != exp.Size {
            t.Errorf("incorrect content length. expected '%d...', got '%d...'", read, exp.Size)
        }
        resp.Content = string(content)
    }
    if resp.Content != exp.Content {
        // if !bytes.Equal(resp.Content, exp.Content)
        t.Errorf("incorrect content. expected '%s...', got '%s...'", string(exp.Content), string(resp.Content))
    }
}

// func expResponse(content []byte, mimeType string, status int) *Response {
func expResponse(content string, mimeType string, status int) *Response {
    log.Trace(fmt.Sprintf("expected content (%v): %v ", len(content), content))
    return &Response{mimeType, status, int64(len(content)), content}
}

// func testGet(t *testing.T, api *Api, bzzhash string) *testResponse {
func testGet(t *testing.T, api *Api, bzzhash, path string) *testResponse {
    key := storage.Key(common.Hex2Bytes(bzzhash))
    reader, mimeType, status, err := api.Get(key, path)
    if err != nil {
        t.Fatalf("unexpected error: %v", err)
    }
    quitC := make(chan bool)
    size, err := reader.Size(quitC)
    if err != nil {
        t.Fatalf("unexpected error: %v", err)
    }
    log.Trace(fmt.Sprintf("reader size: %v ", size))
    s := make([]byte, size)
    _, err = reader.Read(s)
    if err != io.EOF {
        t.Fatalf("unexpected error: %v", err)
    }
    reader.Seek(0, 0)
    return &testResponse{reader, &Response{mimeType, status, size, string(s)}}
    // return &testResponse{reader, &Response{mimeType, status, reader.Size(), nil}}
}

func TestApiPut(t *testing.T) {
    testApi(t, func(api *Api) {
        content := "hello"
        exp := expResponse(content, "text/plain", 0)
        // exp := expResponse([]byte(content), "text/plain", 0)
        key, err := api.Put(content, exp.MimeType)
        if err != nil {
            t.Fatalf("unexpected error: %v", err)
        }
        resp := testGet(t, api, key.String(), "")
        checkResponse(t, resp, exp)
    })
}

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

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

func (t *testResolver) 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
}

// TestAPIResolve tests resolving URIs which can either contain content hashes
// or ENS names
func TestAPIResolve(t *testing.T) {
    ensAddr := "swarm.eth"
    hashAddr := "1111111111111111111111111111111111111111111111111111111111111111"
    resolvedAddr := "2222222222222222222222222222222222222222222222222222222222222222"
    doesResolve := newTestResolver(resolvedAddr)
    doesntResolve := newTestResolver("")

    type test struct {
        desc      string
        dns       Resolver
        addr      string
        immutable bool
        result    string
        expectErr error
    }

    tests := []*test{
        {
            desc:   "DNS not configured, hash address, returns hash address",
            dns:    nil,
            addr:   hashAddr,
            result: hashAddr,
        },
        {
            desc:      "DNS not configured, ENS address, returns error",
            dns:       nil,
            addr:      ensAddr,
            expectErr: errors.New(`no DNS to resolve name: "swarm.eth"`),
        },
        {
            desc:   "DNS configured, hash address, hash resolves, returns resolved address",
            dns:    doesResolve,
            addr:   hashAddr,
            result: resolvedAddr,
        },
        {
            desc:      "DNS configured, immutable hash address, hash resolves, returns hash address",
            dns:       doesResolve,
            addr:      hashAddr,
            immutable: true,
            result:    hashAddr,
        },
        {
            desc:   "DNS configured, hash address, hash doesn't resolve, returns hash address",
            dns:    doesntResolve,
            addr:   hashAddr,
            result: hashAddr,
        },
        {
            desc:   "DNS configured, ENS address, name resolves, returns resolved address",
            dns:    doesResolve,
            addr:   ensAddr,
            result: resolvedAddr,
        },
        {
            desc:      "DNS configured, immutable ENS address, name resolves, returns error",
            dns:       doesResolve,
            addr:      ensAddr,
            immutable: true,
            expectErr: errors.New(`immutable address not a content hash: "swarm.eth"`),
        },
        {
            desc:      "DNS configured, ENS address, name doesn't resolve, returns error",
            dns:       doesntResolve,
            addr:      ensAddr,
            expectErr: errors.New(`DNS name not found: "swarm.eth"`),
        },
    }
    for _, x := range tests {
        t.Run(x.desc, func(t *testing.T) {
            api := &Api{dns: x.dns}
            uri := &URI{Addr: x.addr, Scheme: "bzz"}
            if x.immutable {
                uri.Scheme = "bzz-immutable"
            }
            res, err := api.Resolve(uri)
            if err == nil {
                if x.expectErr != nil {
                    t.Fatalf("expected error %q, got result %q", x.expectErr, res)
                }
                if res.String() != x.result {
                    t.Fatalf("expected result %q, got %q", x.result, res)
                }
            } else {
                if x.expectErr == nil {
                    t.Fatalf("expected no error, got %q", err)
                }
                if err.Error() != x.expectErr.Error() {
                    t.Fatalf("expected error %q, got %q", x.expectErr, err)
                }
            }
        })
    }
}