forked from cavaliergopher/grab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
client_test.go
603 lines (542 loc) · 17.8 KB
/
client_test.go
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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
package grab
import (
"context"
"crypto/md5"
"crypto/sha1"
"crypto/sha256"
"crypto/sha512"
"encoding/hex"
"errors"
"fmt"
"hash"
"math/rand"
"net/http"
"os"
"strings"
"testing"
"time"
)
// TestFilenameResolutions tests that the destination filename for Requests can
// be determined correctly, using an explicitly requested path,
// Content-Disposition headers or a URL path - with or without an existing
// target directory.
func TestFilenameResolution(t *testing.T) {
testCases := []struct {
Name string
Filename string
URL string
Expect string
}{
{"Using Request.Filename", ".testWithFilename", "/url-filename?filename=header-filename", ".testWithFilename"},
{"Using Content-Disposition Header", "", "/url-filename?filename=.testWithHeaderFilename", ".testWithHeaderFilename"},
{"Using Content-Disposition Header with target directory", ".test", "/url-filename?filename=header-filename", ".test/header-filename"},
{"Using URL Path", "", "/.testWithURLFilename?params-filename", ".testWithURLFilename"},
{"Using URL Path with target directory", ".test", "/url-filename?garbage", ".test/url-filename"},
{"Failure", "", "", ""},
}
err := os.Mkdir(".test", 0777)
if err != nil {
panic(err)
}
defer os.RemoveAll(".test")
for _, tc := range testCases {
t.Run(tc.Name, func(t *testing.T) {
req, _ := NewRequest(tc.Filename, ts.URL+tc.URL)
resp := DefaultClient.Do(req)
defer os.Remove(resp.Filename)
if err := resp.Err(); err != nil {
if tc.Expect != "" || err != ErrNoFilename {
panic(err)
}
} else {
if tc.Expect == "" {
t.Errorf("expected: %v, got: %v", ErrNoFilename, err)
}
}
if resp.Filename != tc.Expect {
t.Errorf("Filename mismatch. Expected '%s', got '%s'.", tc.Expect, resp.Filename)
}
testComplete(t, resp)
})
}
}
// TestChecksums checks that checksum validation behaves as expected for valid
// and corrupted downloads.
func TestChecksums(t *testing.T) {
tests := []struct {
size int
hash hash.Hash
sum string
match bool
}{
{128, md5.New(), "37eff01866ba3f538421b30b7cbefcac", true},
{128, md5.New(), "37eff01866ba3f538421b30b7cbefcad", false},
{1024, md5.New(), "b2ea9f7fcea831a4a63b213f41a8855b", true},
{1024, md5.New(), "b2ea9f7fcea831a4a63b213f41a8855c", false},
{1048576, md5.New(), "c35cc7d8d91728a0cb052831bc4ef372", true},
{1048576, md5.New(), "c35cc7d8d91728a0cb052831bc4ef373", false},
{128, sha1.New(), "e6434bc401f98603d7eda504790c98c67385d535", true},
{128, sha1.New(), "e6434bc401f98603d7eda504790c98c67385d536", false},
{1024, sha1.New(), "5b00669c480d5cffbdfa8bdba99561160f2d1b77", true},
{1024, sha1.New(), "5b00669c480d5cffbdfa8bdba99561160f2d1b78", false},
{1048576, sha1.New(), "ecfc8e86fdd83811f9cc9bf500993b63069923be", true},
{1048576, sha1.New(), "ecfc8e86fdd83811f9cc9bf500993b63069923bf", false},
{128, sha256.New(), "471fb943aa23c511f6f72f8d1652d9c880cfa392ad80503120547703e56a2be5", true},
{128, sha256.New(), "471fb943aa23c511f6f72f8d1652d9c880cfa392ad80503120547703e56a2be4", false},
{1024, sha256.New(), "785b0751fc2c53dc14a4ce3d800e69ef9ce1009eb327ccf458afe09c242c26c9", true},
{1024, sha256.New(), "785b0751fc2c53dc14a4ce3d800e69ef9ce1009eb327ccf458afe09c242c26c8", false},
{1048576, sha256.New(), "fbbab289f7f94b25736c58be46a994c441fd02552cc6022352e3d86d2fab7c83", true},
{1048576, sha256.New(), "fbbab289f7f94b25736c58be46a994c441fd02552cc6022352e3d86d2fab7c82", false},
{128, sha512.New(), "1dffd5e3adb71d45d2245939665521ae001a317a03720a45732ba1900ca3b8351fc5c9b4ca513eba6f80bc7b1d1fdad4abd13491cb824d61b08d8c0e1561b3f7", true},
{128, sha512.New(), "1dffd5e3adb71d45d2245939665521ae001a317a03720a45732ba1900ca3b8351fc5c9b4ca513eba6f80bc7b1d1fdad4abd13491cb824d61b08d8c0e1561b3f8", false},
{1024, sha512.New(), "37f652be867f28ed033269cbba201af2112c2b3fd334a89fd2f757938ddee815787cc61d6e24a8a33340d0f7e86ffc058816b88530766ba6e231620a130b566c", true},
{1024, sha512.New(), "37f652bf867f28ed033269cbba201af2112c2b3fd334a89fd2f757938ddee815787cc61d6e24a8a33340d0f7e86ffc058816b88530766ba6e231620a130b566d", false},
{1048576, sha512.New(), "ac1d097b4ea6f6ad7ba640275b9ac290e4828cd760a0ebf76d555463a4f505f95df4f611629539a2dd1848e7c1304633baa1826462b3c87521c0c6e3469b67af", true},
{1048576, sha512.New(), "ac1d097c4ea6f6ad7ba640275b9ac290e4828cd760a0ebf76d555463a4f505f95df4f611629539a2dd1848e7c1304633baa1826462b3c87521c0c6e3469b67af", false},
}
for _, test := range tests {
var expect error
comparison := "Match"
if !test.match {
comparison = "Mismatch"
expect = ErrBadChecksum
}
t.Run(fmt.Sprintf("With%s%s", comparison, test.sum[:8]), func(t *testing.T) {
filename := fmt.Sprintf(".testChecksum-%s-%s", comparison, test.sum[:8])
defer os.Remove(filename)
b, _ := hex.DecodeString(test.sum)
req, _ := NewRequest(filename, ts.URL+fmt.Sprintf("?size=%d", test.size))
req.SetChecksum(test.hash, b, true)
resp := DefaultClient.Do(req)
err := resp.Err()
if err != expect {
t.Errorf("expected error: %v, got: %v", expect, err)
}
// ensure mismatch file was deleted
if !test.match {
if _, err := os.Stat(filename); err == nil {
t.Errorf("checksum failure not cleaned up: %s", filename)
} else if !os.IsNotExist(err) {
panic(err)
}
}
testComplete(t, resp)
})
}
}
// TestContentLength ensures that ErrBadLength is returned if a server response
// does not match the requested length.
func TestContentLength(t *testing.T) {
size := int64(32768)
testCases := []struct {
Name string
URL string
Expect int64
Match bool
}{
{"Good size in HEAD request", fmt.Sprintf("?size=%d", size), size, true},
{"Good size in GET request", fmt.Sprintf("?nohead&size=%d", size), size, true},
{"Bad size in HEAD request", fmt.Sprintf("?size=%d", size-1), size, false},
{"Bad size in GET request", fmt.Sprintf("?nohead&size=%d", size-1), size, false},
}
for _, tc := range testCases {
t.Run(tc.Name, func(t *testing.T) {
req, _ := NewRequest(".testSize-mismatch-head", ts.URL+tc.URL)
req.Size = size
resp := DefaultClient.Do(req)
defer os.Remove(resp.Filename)
err := resp.Err()
if tc.Match {
if err == ErrBadLength {
t.Errorf("error: %v", err)
} else if err != nil {
panic(err)
} else if resp.Size != size {
t.Errorf("expected %v bytes, got %v bytes", size, resp.Size)
}
} else {
if err == nil {
t.Errorf("expected: %v, got %v", ErrBadLength, err)
} else if err != ErrBadLength {
panic(err)
}
}
testComplete(t, resp)
})
}
}
// TestAutoResume tests segmented downloading of a large file.
func TestAutoResume(t *testing.T) {
segs := 8
size := 1048576
sum, _ := hex.DecodeString("fbbab289f7f94b25736c58be46a994c441fd02552cc6022352e3d86d2fab7c83")
filename := ".testAutoResume"
defer os.Remove(filename)
for i := 0; i < segs; i++ {
segsize := (i + 1) * (size / segs)
t.Run(fmt.Sprintf("With%vBytes", segsize), func(t *testing.T) {
req, _ := NewRequest(filename, ts.URL+fmt.Sprintf("?size=%d", segsize))
if i == segs-1 {
req.SetChecksum(sha256.New(), sum, false)
}
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
t.Errorf("error: %v", err)
return
}
if i > 0 && !resp.DidResume {
t.Errorf("expected Response.DidResume to be true")
}
testComplete(t, resp)
})
}
t.Run("WithFailure", func(t *testing.T) {
// request smaller segment
req, _ := NewRequest(filename, ts.URL+fmt.Sprintf("?size=%d", size-1))
resp := DefaultClient.Do(req)
if err := resp.Err(); err != ErrBadLength {
t.Errorf("expected ErrBadLength for smaller request, got: %v", err)
}
})
t.Run("WithNoResume", func(t *testing.T) {
req, _ := NewRequest(filename, ts.URL+fmt.Sprintf("?size=%d", size+1))
req.NoResume = true
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
panic(err)
}
if resp.DidResume == true {
t.Errorf("expected Response.DidResume to be false")
}
testComplete(t, resp)
})
t.Run("WithNoResumeAndTruncate", func(t *testing.T) {
req, _ := NewRequest(filename, ts.URL+fmt.Sprintf("?size=%d", size-1))
req.NoResume = true
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
t.Errorf("error in response: %v", err)
}
if resp.DidResume == true {
t.Errorf("expected Response.DidResume to be false")
}
testComplete(t, resp)
})
// TODO: test when existing file is corrupted
}
func TestSkipExisting(t *testing.T) {
filename := ".testSkipExisting"
defer os.Remove(filename)
// download a file
req, _ := NewRequest(filename, ts.URL)
resp := DefaultClient.Do(req)
testComplete(t, resp)
// redownload
req, _ = NewRequest(filename, ts.URL)
resp = DefaultClient.Do(req)
testComplete(t, resp)
// ensure download was resumed
if !resp.DidResume {
t.Fatalf("Expected download to skip existing file, but it did not")
}
// ensure all bytes were resumed
if resp.Size == 0 || resp.Size != resp.bytesResumed {
t.Fatalf("Expected to skip %d bytes in redownload; got %d", resp.Size, resp.bytesResumed)
}
// ensure checksum is performed on pre-existing file
req, _ = NewRequest(filename, ts.URL)
req.SetChecksum(sha256.New(), []byte{0x01, 0x02, 0x03, 0x04}, true)
resp = DefaultClient.Do(req)
if err := resp.Err(); err != ErrBadChecksum {
t.Fatalf("Expected checksum error, got: %v", err)
}
}
// TestBatch executes multiple requests simultaneously and validates the
// responses.
func TestBatch(t *testing.T) {
tests := 32
size := 32768
sum := "e11360251d1173650cdcd20f111d8f1ca2e412f572e8b36a4dc067121c1799b8"
sumb, _ := hex.DecodeString(sum)
// test with 4 workers and with one per request
for _, workerCount := range []int{4, 0} {
// create requests
reqs := make([]*Request, tests)
for i := 0; i < len(reqs); i++ {
filename := fmt.Sprintf(".testBatch.%d", i+1)
reqs[i], _ = NewRequest(filename, ts.URL+fmt.Sprintf("/request_%d?size=%d&sleep=10", i, size))
reqs[i].Label = fmt.Sprintf("Test %d", i+1)
reqs[i].SetChecksum(sha256.New(), sumb, false)
}
// batch run
responses := DefaultClient.DoBatch(workerCount, reqs...)
// listen for responses
Loop:
for i := 0; i < len(reqs); {
select {
case resp := <-responses:
if resp == nil {
break Loop
}
testComplete(t, resp)
if err := resp.Err(); err != nil {
t.Errorf("%s: %v", resp.Filename, err)
}
// remove test file
if resp.IsComplete() {
os.Remove(resp.Filename) // ignore errors
}
i++
}
}
}
}
// TestCancelContext tests that a batch of requests can be cancel using a
// context.Context cancellation. Requests are cancelled in multiple states:
// in-progress and unstarted.
func TestCancelContext(t *testing.T) {
tests := 256
client := NewClient()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
reqs := make([]*Request, tests)
for i := 0; i < tests; i++ {
req, _ := NewRequest("", fmt.Sprintf("%s/.testCancelContext%d?size=134217728", ts.URL, i))
reqs[i] = req.WithContext(ctx)
}
respch := client.DoBatch(8, reqs...)
time.Sleep(time.Millisecond * 500)
cancel()
for resp := range respch {
defer os.Remove(resp.Filename)
// err should be context.Canceled or http.errRequestCanceled
if !strings.Contains(resp.Err().Error(), "canceled") {
t.Errorf("expected '%v', got '%v'", context.Canceled, resp.Err())
}
}
}
// TestNestedDirectory tests that missing subdirectories are created.
func TestNestedDirectory(t *testing.T) {
dir := "./.testNested/one/two/three"
filename := ".testNestedFile"
expect := dir + "/" + filename
t.Run("Create", func(t *testing.T) {
req, _ := NewRequest(expect, ts.URL+"/"+filename)
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
panic(err)
}
defer os.RemoveAll("./.testNested/")
if resp.Filename != expect {
t.Errorf("expected nested Request.Filename to be %v, got %v", expect, resp.Filename)
}
})
t.Run("No create", func(t *testing.T) {
req, _ := NewRequest(expect, ts.URL+"/"+filename)
req.NoCreateDirectories = true
resp := DefaultClient.Do(req)
err := resp.Err()
if !os.IsNotExist(err) {
t.Errorf("expected: %v, got: %v", os.ErrNotExist, err)
}
})
}
// TestRemoteTime tests that the timestamp of the downloaded file can be set
// according to the timestamp of the remote file.
func TestRemoteTime(t *testing.T) {
filename := "./.testRemoteTime"
defer os.Remove(filename)
// random number between 0 and now
lastmod := rand.Int63n(time.Now().Unix())
u := fmt.Sprintf("%s?lastmod=%d", ts.URL, lastmod)
req, _ := NewRequest(filename, u)
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
panic(err)
}
fi, err := os.Stat(resp.Filename)
if err != nil {
panic(err)
}
if fi.ModTime().Unix() != lastmod {
t.Errorf("expected %v, got %v", time.Unix(lastmod, 0), fi.ModTime())
}
}
func TestResponseCode(t *testing.T) {
filename := "./.testResponseCode"
t.Run("With404", func(t *testing.T) {
defer os.Remove(filename)
req, _ := NewRequest(filename, ts.URL+"?status=404")
resp := DefaultClient.Do(req)
expect := StatusCodeError(http.StatusNotFound)
err := resp.Err()
if err != expect {
t.Errorf("expected %v, got '%v'", expect, err)
}
if !IsStatusCodeError(err) {
t.Errorf("expected IsStatusCodeError to return true for %T: %v", err, err)
}
})
t.Run("WithIgnoreNon2XX", func(t *testing.T) {
defer os.Remove(filename)
req, _ := NewRequest(filename, ts.URL+"?status=404")
req.IgnoreBadStatusCodes = true
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
t.Errorf("expected nil, got '%v'", err)
}
})
}
func TestBeforeCopyHook(t *testing.T) {
filename := "./.testBeforeCopy"
t.Run("Noop", func(t *testing.T) {
defer os.RemoveAll(filename)
called := false
req, _ := NewRequest(filename, ts.URL)
req.BeforeCopy = func(resp *Response) error {
called = true
if resp.IsComplete() {
t.Error("Response object passed to BeforeCopy hook has already been closed")
}
if resp.Progress() != 0 {
t.Error("Download progress already > 0 when BeforeCopy hook was called")
}
if resp.Duration() == 0 {
t.Error("Duration was zero when BeforeCopy was called")
}
if resp.BytesComplete() != 0 {
t.Error("BytesComplete already > 0 when BeforeCopy hook was called")
}
return nil
}
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
t.Errorf("unexpected error using BeforeCopy hook: %v", err)
}
testComplete(t, resp)
if !called {
t.Error("BeforeCopy hook was never called")
}
})
t.Run("WithError", func(t *testing.T) {
defer os.RemoveAll(filename)
testError := errors.New("test")
req, _ := NewRequest(filename, ts.URL)
req.BeforeCopy = func(resp *Response) error {
return testError
}
resp := DefaultClient.Do(req)
if err := resp.Err(); err != testError {
t.Errorf("expected error '%v', got '%v'", testError, err)
}
if resp.BytesComplete() != 0 {
t.Errorf("expected 0 bytes completed for canceled BeforeCopy hook, got %d",
resp.BytesComplete())
}
testComplete(t, resp)
})
}
func TestAfterCopyHook(t *testing.T) {
filename := "./.testAfterCopy"
t.Run("Noop", func(t *testing.T) {
defer os.RemoveAll(filename)
called := false
req, _ := NewRequest(filename, ts.URL)
req.AfterCopy = func(resp *Response) error {
called = true
if resp.IsComplete() {
t.Error("Response object passed to AfterCopy hook has already been closed")
}
if resp.Progress() <= 0 {
t.Error("Download progress was 0 when AfterCopy hook was called")
}
if resp.Duration() == 0 {
t.Error("Duration was zero when AfterCopy was called")
}
if resp.BytesComplete() <= 0 {
t.Error("BytesComplete was 0 when AfterCopy hook was called")
}
return nil
}
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
t.Errorf("unexpected error using AfterCopy hook: %v", err)
}
testComplete(t, resp)
if !called {
t.Error("AfterCopy hook was never called")
}
})
t.Run("WithError", func(t *testing.T) {
defer os.RemoveAll(filename)
testError := errors.New("test")
req, _ := NewRequest(filename, ts.URL)
req.AfterCopy = func(resp *Response) error {
return testError
}
resp := DefaultClient.Do(req)
if err := resp.Err(); err != testError {
t.Errorf("expected error '%v', got '%v'", testError, err)
}
if resp.BytesComplete() <= 0 {
t.Errorf("ByteCompleted was %d after AfterCopy hook was called",
resp.BytesComplete())
}
testComplete(t, resp)
})
}
func TestIssue37(t *testing.T) {
// ref: https://github.com/cavaliercoder/grab/issues/37
filename := "./.testIssue37"
largeSize := 2097152
smallSize := 1048576
defer os.RemoveAll(filename)
// download large file
req, _ := NewRequest(filename, fmt.Sprintf("%s?size=%d", ts.URL, largeSize))
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
t.Fatal(err)
}
// download new, smaller version of same file
req, _ = NewRequest(filename, fmt.Sprintf("%s?size=%d", ts.URL, smallSize))
req.NoResume = true
resp = DefaultClient.Do(req)
if err := resp.Err(); err != nil {
t.Fatal(err)
}
// local file should have truncated and not resumed
if resp.DidResume {
t.Errorf("expected download to truncate, resumed instead")
}
fi, err := os.Stat(filename)
if err != nil {
t.Fatal(err)
}
if fi.Size() != int64(smallSize) {
t.Errorf("expected file size %d, got %d", smallSize, fi.Size())
}
}
// TestHeadBadStatus validates that HEAD requests that return non-200 can be
// ignored and succeed if the GET requests succeeeds.
//
// Fixes: https://github.com/cavaliercoder/grab/issues/43
func TestHeadBadStatus(t *testing.T) {
expect := http.StatusOK
filename := ".testIssue43"
testURL := fmt.Sprintf(
"%s/%s?headStatus=%d",
ts.URL,
filename,
http.StatusForbidden)
req, _ := NewRequest("", testURL)
resp := DefaultClient.Do(req)
if err := resp.Err(); err != nil {
t.Fatal(err)
}
if resp.HTTPResponse.StatusCode != expect {
t.Errorf(
"expected status code: %d, got:% d",
expect,
resp.HTTPResponse.StatusCode)
}
}