forked from SAP/jenkins-library
-
Notifications
You must be signed in to change notification settings - Fork 0
/
http_test.go
687 lines (579 loc) · 23.4 KB
/
http_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
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
//go:build unit
// +build unit
package http
import (
"bytes"
"crypto/tls"
"crypto/x509"
"encoding/base64"
"encoding/xml"
"errors"
"fmt"
"io"
"io/ioutil"
"mime/multipart"
"net/http"
"net/http/httptest"
"net/url"
"os"
"path/filepath"
"testing"
"time"
"github.com/jarcoal/httpmock"
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
"github.com/SAP/jenkins-library/pkg/log"
)
func TestSend(t *testing.T) {
testURL := "https://example.org"
request, err := http.NewRequest(http.MethodGet, testURL, nil)
require.NoError(t, err)
t.Run("success", func(t *testing.T) {
// given
httpmock.Activate()
defer httpmock.DeactivateAndReset()
httpmock.RegisterResponder(http.MethodGet, testURL, httpmock.NewStringResponder(200, `OK`))
client := Client{}
client.SetOptions(ClientOptions{MaxRetries: -1, UseDefaultTransport: true})
// when
response, err := client.Send(request)
// then
assert.NoError(t, err)
assert.NotNil(t, response)
})
t.Run("failure", func(t *testing.T) {
// given
httpmock.Activate()
defer httpmock.DeactivateAndReset()
httpmock.RegisterResponder(http.MethodGet, testURL, httpmock.NewErrorResponder(errors.New("failure")))
client := Client{}
client.SetOptions(ClientOptions{MaxRetries: -1, UseDefaultTransport: true})
// when
response, err := client.Send(request)
// then
assert.Error(t, err)
assert.Nil(t, response)
})
t.Run("failure when calling via proxy", func(t *testing.T) {
// given
httpmock.Activate()
defer httpmock.DeactivateAndReset()
httpmock.RegisterResponder(http.MethodGet, testURL, httpmock.NewStringResponder(200, `OK`))
client := Client{}
transportProxy, _ := url.Parse("https://proxy.dummy.sap.com")
client.SetOptions(ClientOptions{MaxRetries: -1, TransportProxy: transportProxy})
// when
response, err := client.Send(request)
// then
assert.Error(t, err)
assert.Contains(t, err.Error(), "lookup proxy.dummy.sap.com: no such host")
assert.Nil(t, response)
})
}
func TestDefaultTransport(t *testing.T) {
const testURL string = "https://localhost/api"
t.Run("with default transport", func(t *testing.T) {
httpmock.Activate()
defer httpmock.DeactivateAndReset()
httpmock.RegisterResponder(http.MethodGet, testURL, httpmock.NewStringResponder(200, `OK`))
client := Client{}
client.SetOptions(ClientOptions{MaxRetries: -1, UseDefaultTransport: true})
// test
response, err := client.SendRequest("GET", testURL, nil, nil, nil)
// assert
assert.NoError(t, err)
// assert.NotEmpty(t, count)
assert.Equal(t, 1, httpmock.GetTotalCallCount(), "unexpected number of requests")
content, err := ioutil.ReadAll(response.Body)
defer response.Body.Close()
require.NoError(t, err, "unexpected error while reading response body")
assert.Equal(t, "OK", string(content), "unexpected response content")
})
t.Run("with custom transport", func(t *testing.T) {
httpmock.Activate()
defer httpmock.DeactivateAndReset()
httpmock.RegisterResponder(http.MethodGet, testURL, httpmock.NewStringResponder(200, `OK`))
client := Client{}
// test
_, err := client.SendRequest("GET", testURL, nil, nil, nil)
// assert
assert.Error(t, err)
assert.Contains(t, err.Error(), "connection")
assert.Contains(t, err.Error(), "refused")
assert.Equal(t, 0, httpmock.GetTotalCallCount(), "unexpected number of requests")
})
}
func TestSendRequest(t *testing.T) {
var passedHeaders = map[string][]string{}
passedCookies := []*http.Cookie{}
var passedUsername string
var passedPassword string
// Start a local HTTP server
server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
passedHeaders = map[string][]string{}
if req.Header != nil {
for name, headers := range req.Header {
passedHeaders[name] = headers
}
}
passedCookies = req.Cookies()
passedUsername, passedPassword, _ = req.BasicAuth()
rw.Write([]byte("OK"))
}))
// Close the server when test finishes
defer server.Close()
oldLogLevel := logrus.GetLevel()
defer logrus.SetLevel(oldLogLevel)
logrus.SetLevel(logrus.DebugLevel)
tt := []struct {
client Client
method string
body io.Reader
header http.Header
cookies []*http.Cookie
expected string
}{
{client: Client{logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http")}, method: "GET", expected: "OK"},
{client: Client{logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http")}, method: "GET", header: map[string][]string{"Testheader": {"Test1", "Test2"}}, expected: "OK"},
{client: Client{logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http")}, cookies: []*http.Cookie{{Name: "TestCookie1", Value: "TestValue1"}, {Name: "TestCookie2", Value: "TestValue2"}}, method: "GET", expected: "OK"},
{client: Client{logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http"), username: "TestUser", password: "TestPwd"}, method: "GET", expected: "OK"},
{client: Client{logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http"), token: "api-token-string"}, method: "GET", expected: "OK"},
}
for key, test := range tt {
t.Run(fmt.Sprintf("Row %v", key+1), func(t *testing.T) {
oldLogOutput := test.client.logger.Logger.Out
defer func() { test.client.logger.Logger.Out = oldLogOutput }()
logBuffer := new(bytes.Buffer)
test.client.logger.Logger.Out = logBuffer
response, err := test.client.SendRequest("GET", server.URL, test.body, test.header, test.cookies)
assert.NoError(t, err, "Error occurred but none expected")
content, err := ioutil.ReadAll(response.Body)
assert.Equal(t, test.expected, string(content), "Returned content incorrect")
response.Body.Close()
for k, h := range test.header {
assert.Containsf(t, passedHeaders, k, "Header %v not contained", k)
assert.Equalf(t, h, passedHeaders[k], "Header %v contains different value")
}
if len(test.cookies) > 0 {
assert.Equal(t, test.cookies, passedCookies, "Passed cookies not correct")
}
if len(test.client.username) > 0 || len(test.client.password) > 0 {
if len(test.client.username) == 0 || len(test.client.password) == 0 {
//"User and password must both be provided"
t.Fail()
}
assert.Equal(t, test.client.username, passedUsername)
assert.Equal(t, test.client.password, passedPassword)
log := fmt.Sprintf("%s", logBuffer)
credentialsEncoded := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", test.client.username, test.client.password)))
assert.NotContains(t, log, fmt.Sprintf("Authorization:[Basic %s]", credentialsEncoded))
assert.Contains(t, log, "Authorization:[<set>]")
}
// Token authentication
if len(test.client.token) > 0 {
assert.Equal(t, test.client.token, "api-token-string")
log := fmt.Sprintf("%s", logBuffer)
assert.Contains(t, log, fmt.Sprintf("Using Token Authentication ****"))
assert.Contains(t, log, "Authorization:[<set>]")
}
})
}
}
func TestSetOptions(t *testing.T) {
c := Client{}
transportProxy, _ := url.Parse("https://proxy.dummy.sap.com")
opts := ClientOptions{MaxRetries: -1, TransportTimeout: 10, TransportProxy: transportProxy, MaxRequestDuration: 5, Username: "TestUser", Password: "TestPassword", Token: "TestToken", Logger: log.Entry().WithField("package", "github.com/SAP/jenkins-library/pkg/http")}
c.SetOptions(opts)
assert.Equal(t, opts.TransportTimeout, c.transportTimeout)
assert.Equal(t, opts.TransportProxy, c.transportProxy)
assert.Equal(t, opts.TransportSkipVerification, c.transportSkipVerification)
assert.Equal(t, opts.MaxRequestDuration, c.maxRequestDuration)
assert.Equal(t, opts.Username, c.username)
assert.Equal(t, opts.Password, c.password)
assert.Equal(t, opts.Token, c.token)
}
func TestApplyDefaults(t *testing.T) {
tt := []struct {
client Client
expected Client
}{
{client: Client{}, expected: Client{transportTimeout: 3 * time.Minute, maxRequestDuration: 0, logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http")}},
{client: Client{transportTimeout: 10, maxRequestDuration: 5}, expected: Client{transportTimeout: 10, maxRequestDuration: 5, logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http")}},
}
for k, v := range tt {
v.client.applyDefaults()
assert.Equal(t, v.expected, v.client, fmt.Sprintf("Run %v failed", k))
}
}
func TestUploadRequest(t *testing.T) {
var passedHeaders = map[string][]string{}
passedCookies := []*http.Cookie{}
var passedUsername string
var passedPassword string
var multipartFile multipart.File
var multipartHeader *multipart.FileHeader
var passedFileContents []byte
// Start a local HTTP server
server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
passedHeaders = map[string][]string{}
if req.Header != nil {
for name, headers := range req.Header {
passedHeaders[name] = headers
}
}
passedCookies = req.Cookies()
passedUsername, passedPassword, _ = req.BasicAuth()
err := req.ParseMultipartForm(4096)
if err != nil {
t.FailNow()
}
multipartFile, multipartHeader, err = req.FormFile("Field1")
if err != nil {
t.FailNow()
}
defer req.Body.Close()
passedFileContents, err = ioutil.ReadAll(multipartFile)
if err != nil {
t.FailNow()
}
rw.Write([]byte("OK"))
}))
// Close the server when test finishes
defer server.Close()
testFile, err := ioutil.TempFile("", "testFileUpload")
if err != nil {
t.FailNow()
}
defer os.RemoveAll(testFile.Name()) // clean up
fileContents, err := ioutil.ReadFile(testFile.Name())
if err != nil {
t.FailNow()
}
tt := []struct {
clientOptions ClientOptions
method string
body io.Reader
header http.Header
cookies []*http.Cookie
expected string
}{
{clientOptions: ClientOptions{MaxRetries: -1}, method: "PUT", expected: "OK"},
{clientOptions: ClientOptions{MaxRetries: -1}, method: "POST", expected: "OK"},
{clientOptions: ClientOptions{MaxRetries: -1}, method: "POST", header: map[string][]string{"Testheader": {"Test1", "Test2"}}, expected: "OK"},
{clientOptions: ClientOptions{MaxRetries: -1}, cookies: []*http.Cookie{{Name: "TestCookie1", Value: "TestValue1"}, {Name: "TestCookie2", Value: "TestValue2"}}, method: "POST", expected: "OK"},
{clientOptions: ClientOptions{MaxRetries: -1, Username: "TestUser", Password: "TestPwd"}, method: "POST", expected: "OK"},
{clientOptions: ClientOptions{MaxRetries: -1, Username: "UserOnly", Password: ""}, method: "POST", expected: "OK"},
}
client := Client{logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http")}
for key, test := range tt {
t.Run(fmt.Sprintf("UploadFile Row %v", key+1), func(t *testing.T) {
client.SetOptions(test.clientOptions)
response, err := client.UploadFile(server.URL, testFile.Name(), "Field1", test.header, test.cookies, "form")
assert.NoError(t, err, "Error occurred but none expected")
content, err := ioutil.ReadAll(response.Body)
assert.NoError(t, err, "Error occurred but none expected")
assert.Equal(t, test.expected, string(content), "Returned content incorrect")
response.Body.Close()
assert.Equal(t, filepath.Base(testFile.Name()), multipartHeader.Filename, "Uploaded file incorrect")
assert.Equal(t, fileContents, passedFileContents, "Uploaded file incorrect")
for k, h := range test.header {
assert.Containsf(t, passedHeaders, k, "Header %v not contained", k)
assert.Equalf(t, h, passedHeaders[k], "Header %v contains different value")
}
if len(test.cookies) > 0 {
assert.Equal(t, test.cookies, passedCookies, "Passed cookies not correct")
}
if len(client.username) > 0 {
assert.Equal(t, client.username, passedUsername)
}
if len(client.password) > 0 {
assert.Equal(t, client.password, passedPassword)
}
})
t.Run(fmt.Sprintf("UploadRequest Row %v", key+1), func(t *testing.T) {
client.SetOptions(test.clientOptions)
response, err := client.UploadRequest(test.method, server.URL, testFile.Name(), "Field1", test.header, test.cookies, "form")
assert.NoError(t, err, "Error occurred but none expected")
content, err := ioutil.ReadAll(response.Body)
assert.NoError(t, err, "Error occurred but none expected")
assert.Equal(t, test.expected, string(content), "Returned content incorrect")
response.Body.Close()
assert.Equal(t, filepath.Base(testFile.Name()), multipartHeader.Filename, "Uploaded file incorrect")
assert.Equal(t, fileContents, passedFileContents, "Uploaded file incorrect")
for k, h := range test.header {
assert.Containsf(t, passedHeaders, k, "Header %v not contained", k)
assert.Equalf(t, h, passedHeaders[k], "Header %v contains different value")
}
if len(test.cookies) > 0 {
assert.Equal(t, test.cookies, passedCookies, "Passed cookies not correct")
}
if len(client.username) > 0 {
assert.Equal(t, client.username, passedUsername)
}
if len(client.password) > 0 {
assert.Equal(t, client.password, passedPassword)
}
})
}
}
func TestUploadRequestWrongMethod(t *testing.T) {
client := Client{logger: log.Entry().WithField("package", "SAP/jenkins-library/pkg/http")}
_, err := client.UploadRequest("GET", "dummy", "testFile", "Field1", nil, nil, "form")
assert.Error(t, err, "No error occurred but was expected")
}
func TestTransportTimout(t *testing.T) {
t.Run("timeout works on transport level", func(t *testing.T) {
// init
svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Sleep for longer than the configured timeout
time.Sleep(2 * time.Second)
}))
defer svr.Close()
client := Client{transportTimeout: 1 * time.Second}
buffer := bytes.Buffer{}
// test
_, err := client.SendRequest(http.MethodGet, svr.URL, &buffer, nil, nil)
// assert
if assert.Error(t, err, "expected request to fail") {
assert.Contains(t, err.Error(), "timeout awaiting response headers")
}
})
t.Run("timeout is not hit on transport level", func(t *testing.T) {
// init
svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Sleep for less than the configured timeout
time.Sleep(1 * time.Second)
}))
defer svr.Close()
client := Client{transportTimeout: 2 * time.Second}
buffer := bytes.Buffer{}
// test
_, err := client.SendRequest(http.MethodGet, svr.URL, &buffer, nil, nil)
// assert
assert.NoError(t, err)
})
}
func TestTransportSkipVerification(t *testing.T) {
testCases := []struct {
client Client
expectedError string
}{
{client: Client{}, expectedError: "certificate signed by unknown authority"},
{client: Client{transportSkipVerification: false}, expectedError: "certificate signed by unknown authority"},
{client: Client{transportSkipVerification: true}},
}
for _, testCase := range testCases {
// init
svr := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
defer svr.Close()
// test
_, err := testCase.client.SendRequest(http.MethodGet, svr.URL, &bytes.Buffer{}, nil, nil)
// assert
if len(testCase.expectedError) > 0 {
assert.Error(t, err, "certificate signed by unknown authority")
} else {
assert.NoError(t, err)
}
}
}
func TestTransportWithCertifacteAdded(t *testing.T) {
server := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
io.WriteString(w, "Hello")
}))
defer server.Close()
certs := x509.NewCertPool()
for _, c := range server.TLS.Certificates {
roots, err := x509.ParseCertificates(c.Certificate[len(c.Certificate)-1])
if err != nil {
println("error parsing server's root cert: %v", err)
}
for _, root := range roots {
certs.AddCert(root)
}
}
client := http.Client{Transport: &http.Transport{TLSClientConfig: &tls.Config{RootCAs: certs, InsecureSkipVerify: false}}}
_, err := client.Get(server.URL)
// assert
assert.NoError(t, err)
}
func TestMaxRetries(t *testing.T) {
testCases := []struct {
client Client
countedCalls int
method string
responseCode int
errorText string
timeout bool
}{
{client: Client{maxRetries: 1, useDefaultTransport: true, transportSkipVerification: true, transportTimeout: 1 * time.Microsecond}, responseCode: 666, timeout: true, countedCalls: 2, method: http.MethodPost, errorText: "timeout awaiting response headers"},
{client: Client{maxRetries: 0}, countedCalls: 1, method: http.MethodGet, responseCode: 500, errorText: "Internal Server Error"},
{client: Client{maxRetries: 2}, countedCalls: 3, method: http.MethodGet, responseCode: 500, errorText: "Internal Server Error"},
{client: Client{maxRetries: 3}, countedCalls: 4, method: http.MethodPost, responseCode: 503, errorText: "Service Unavailable"},
{client: Client{maxRetries: 1}, countedCalls: 2, method: http.MethodPut, responseCode: 506, errorText: "Variant Also Negotiates"},
{client: Client{maxRetries: 1}, countedCalls: 2, method: http.MethodHead, responseCode: 502, errorText: "Bad Gateway"},
{client: Client{maxRetries: 3}, countedCalls: 1, method: http.MethodHead, responseCode: 404, errorText: "Not Found"},
{client: Client{maxRetries: 3}, countedCalls: 1, method: http.MethodHead, responseCode: 401, errorText: "Authentication Error"},
{client: Client{maxRetries: 3}, countedCalls: 1, method: http.MethodHead, responseCode: 403, errorText: "Authorization Error"},
}
for _, testCase := range testCases {
// init
count := 0
svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
count++
if testCase.timeout && count == 0 {
time.Sleep(3 * time.Microsecond)
}
w.WriteHeader(testCase.responseCode)
}))
defer svr.Close()
// test
_, err := testCase.client.SendRequest(testCase.method, svr.URL, &bytes.Buffer{}, nil, nil)
// assert
assert.Error(t, err, fmt.Sprintf("%v: %v", testCase.errorText, "Expected error but did not detect one"))
assert.Equal(t, testCase.countedCalls, count, fmt.Sprintf("%v: %v", testCase.errorText, "Number of invocations mismatch"))
}
}
func TestParseHTTPResponseBodyJSON(t *testing.T) {
type myJSONStruct struct {
FullName string `json:"full_name"`
Name string `json:"name"`
Owner struct {
Login string `json:"login"`
} `json:"owner"`
}
t.Run("parse JSON successful", func(t *testing.T) {
json := `{"name":"Test Name","full_name":"test full name","owner":{"login": "octocat"}}`
// create a new reader with that JSON
r := ioutil.NopCloser(bytes.NewReader([]byte(json)))
httpResponse := http.Response{
StatusCode: 200,
Body: r,
}
var response myJSONStruct
err := ParseHTTPResponseBodyJSON(&httpResponse, &response)
if assert.NoError(t, err) {
t.Run("check correct parsing", func(t *testing.T) {
assert.Equal(t, myJSONStruct(myJSONStruct{FullName: "test full name", Name: "Test Name", Owner: struct {
Login string "json:\"login\""
}{Login: "octocat"}}), response)
})
}
})
t.Run("http response is nil", func(t *testing.T) {
var response myJSONStruct
err := ParseHTTPResponseBodyJSON(nil, &response)
t.Run("check error", func(t *testing.T) {
assert.EqualError(t, err, "cannot parse HTTP response with value <nil>")
})
})
t.Run("wrong JSON formatting", func(t *testing.T) {
json := `{"name":"Test Name","full_name":"test full name";"owner":{"login": "octocat"}}`
r := ioutil.NopCloser(bytes.NewReader([]byte(json)))
httpResponse := http.Response{
StatusCode: 200,
Body: r,
}
var response myJSONStruct
err := ParseHTTPResponseBodyJSON(&httpResponse, &response)
println(response.FullName)
t.Run("check error", func(t *testing.T) {
assert.EqualError(t, err, "HTTP response body could not be parsed as JSON: {\"name\":\"Test Name\",\"full_name\":\"test full name\";\"owner\":{\"login\": \"octocat\"}}: invalid character ';' after object key:value pair")
})
})
t.Run("IO read error", func(t *testing.T) {
mockReadCloser := mockReadCloser{}
// if Read is called, it will return error
mockReadCloser.On("Read", mock.AnythingOfType("[]uint8")).Return(0, fmt.Errorf("error reading"))
// if Close is called, it will return error
mockReadCloser.On("Close").Return(fmt.Errorf("error closing"))
httpResponse := http.Response{
StatusCode: 200,
Body: &mockReadCloser,
}
var response myJSONStruct
err := ParseHTTPResponseBodyJSON(&httpResponse, &response)
t.Run("check error", func(t *testing.T) {
assert.EqualError(t, err, "HTTP response body could not be read: error reading")
})
})
}
func TestParseHTTPResponseBodyXML(t *testing.T) {
type myXMLStruct struct {
XMLName xml.Name `xml:"service"`
Text string `xml:",chardata"`
App string `xml:"app,attr"`
Atom string `xml:"atom,attr"`
}
t.Run("parse XML successful", func(t *testing.T) {
myXML := `
<?xml version="1.0" encoding="utf-8"?>
<app:service xmlns:app="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom"/>
`
// create a new reader with that xml
r := ioutil.NopCloser(bytes.NewReader([]byte(myXML)))
httpResponse := http.Response{
StatusCode: 200,
Body: r,
}
var response myXMLStruct
err := ParseHTTPResponseBodyXML(&httpResponse, &response)
if assert.NoError(t, err) {
t.Run("check correct parsing", func(t *testing.T) {
// assert.Equal(t, "<?xml version=\"1.0\" encoding=\"utf-8\"?><app:service xmlns:app=\"http://www.w3.org/2007/app\" xmlns:atom=\"http://www.w3.org/2005/Atom\"/>", response)
assert.Equal(t, myXMLStruct(myXMLStruct{XMLName: xml.Name{Space: "http://www.w3.org/2007/app", Local: "service"}, Text: "", App: "http://www.w3.org/2007/app", Atom: "http://www.w3.org/2005/Atom"}), response)
})
}
})
t.Run("http response is nil", func(t *testing.T) {
var response myXMLStruct
err := ParseHTTPResponseBodyXML(nil, &response)
t.Run("check error", func(t *testing.T) {
assert.EqualError(t, err, "cannot parse HTTP response with value <nil>")
})
})
t.Run("wrong XML formatting", func(t *testing.T) {
myXML := `
<?xml version="1.0" encoding="utf-8"?>
<app:service xmlns:app=http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom"/>
`
r := ioutil.NopCloser(bytes.NewReader([]byte(myXML)))
httpResponse := http.Response{
StatusCode: 200,
Body: r,
}
var response myXMLStruct
err := ParseHTTPResponseBodyXML(&httpResponse, &response)
t.Run("check error", func(t *testing.T) {
assert.EqualError(t, err, "HTTP response body could not be parsed as XML: \n\t\t<?xml version=\"1.0\" encoding=\"utf-8\"?>\n\t\t<app:service xmlns:app=http://www.w3.org/2007/app\" xmlns:atom=\"http://www.w3.org/2005/Atom\"/>\n\t\t: XML syntax error on line 3: unquoted or missing attribute value in element")
})
})
t.Run("IO read error", func(t *testing.T) {
mockReadCloser := mockReadCloser{}
// if Read is called, it will return error
mockReadCloser.On("Read", mock.AnythingOfType("[]uint8")).Return(0, fmt.Errorf("error reading"))
// if Close is called, it will return error
mockReadCloser.On("Close").Return(fmt.Errorf("error closing"))
httpResponse := http.Response{
StatusCode: 200,
Body: &mockReadCloser,
}
var response myXMLStruct
err := ParseHTTPResponseBodyXML(&httpResponse, &response)
t.Run("check error", func(t *testing.T) {
assert.EqualError(t, err, "HTTP response body could not be read: error reading")
})
})
}
type mockReadCloser struct {
mock.Mock
}
func (m *mockReadCloser) Read(p []byte) (n int, err error) {
args := m.Called(p)
return args.Int(0), args.Error(1)
}
func (m *mockReadCloser) Close() error {
args := m.Called()
return args.Error(0)
}