]> Cypherpunks.ru repositories - gostls13.git/blob - src/net/http/client_test.go
net/http: preserve original HTTP method when possible
[gostls13.git] / src / net / http / client_test.go
1 // Copyright 2009 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
4
5 // Tests for client.go
6
7 package http_test
8
9 import (
10         "bytes"
11         "context"
12         "crypto/tls"
13         "crypto/x509"
14         "encoding/base64"
15         "errors"
16         "fmt"
17         "io"
18         "io/ioutil"
19         "log"
20         "net"
21         . "net/http"
22         "net/http/cookiejar"
23         "net/http/httptest"
24         "net/url"
25         "reflect"
26         "strconv"
27         "strings"
28         "sync"
29         "sync/atomic"
30         "testing"
31         "time"
32 )
33
34 var robotsTxtHandler = HandlerFunc(func(w ResponseWriter, r *Request) {
35         w.Header().Set("Last-Modified", "sometime")
36         fmt.Fprintf(w, "User-agent: go\nDisallow: /something/")
37 })
38
39 // pedanticReadAll works like ioutil.ReadAll but additionally
40 // verifies that r obeys the documented io.Reader contract.
41 func pedanticReadAll(r io.Reader) (b []byte, err error) {
42         var bufa [64]byte
43         buf := bufa[:]
44         for {
45                 n, err := r.Read(buf)
46                 if n == 0 && err == nil {
47                         return nil, fmt.Errorf("Read: n=0 with err=nil")
48                 }
49                 b = append(b, buf[:n]...)
50                 if err == io.EOF {
51                         n, err := r.Read(buf)
52                         if n != 0 || err != io.EOF {
53                                 return nil, fmt.Errorf("Read: n=%d err=%#v after EOF", n, err)
54                         }
55                         return b, nil
56                 }
57                 if err != nil {
58                         return b, err
59                 }
60         }
61 }
62
63 type chanWriter chan string
64
65 func (w chanWriter) Write(p []byte) (n int, err error) {
66         w <- string(p)
67         return len(p), nil
68 }
69
70 func TestClient(t *testing.T) {
71         setParallel(t)
72         defer afterTest(t)
73         ts := httptest.NewServer(robotsTxtHandler)
74         defer ts.Close()
75
76         c := &Client{Transport: &Transport{DisableKeepAlives: true}}
77         r, err := c.Get(ts.URL)
78         var b []byte
79         if err == nil {
80                 b, err = pedanticReadAll(r.Body)
81                 r.Body.Close()
82         }
83         if err != nil {
84                 t.Error(err)
85         } else if s := string(b); !strings.HasPrefix(s, "User-agent:") {
86                 t.Errorf("Incorrect page body (did not begin with User-agent): %q", s)
87         }
88 }
89
90 func TestClientHead_h1(t *testing.T) { testClientHead(t, h1Mode) }
91 func TestClientHead_h2(t *testing.T) { testClientHead(t, h2Mode) }
92
93 func testClientHead(t *testing.T, h2 bool) {
94         defer afterTest(t)
95         cst := newClientServerTest(t, h2, robotsTxtHandler)
96         defer cst.close()
97
98         r, err := cst.c.Head(cst.ts.URL)
99         if err != nil {
100                 t.Fatal(err)
101         }
102         if _, ok := r.Header["Last-Modified"]; !ok {
103                 t.Error("Last-Modified header not found.")
104         }
105 }
106
107 type recordingTransport struct {
108         req *Request
109 }
110
111 func (t *recordingTransport) RoundTrip(req *Request) (resp *Response, err error) {
112         t.req = req
113         return nil, errors.New("dummy impl")
114 }
115
116 func TestGetRequestFormat(t *testing.T) {
117         setParallel(t)
118         defer afterTest(t)
119         tr := &recordingTransport{}
120         client := &Client{Transport: tr}
121         url := "http://dummy.faketld/"
122         client.Get(url) // Note: doesn't hit network
123         if tr.req.Method != "GET" {
124                 t.Errorf("expected method %q; got %q", "GET", tr.req.Method)
125         }
126         if tr.req.URL.String() != url {
127                 t.Errorf("expected URL %q; got %q", url, tr.req.URL.String())
128         }
129         if tr.req.Header == nil {
130                 t.Errorf("expected non-nil request Header")
131         }
132 }
133
134 func TestPostRequestFormat(t *testing.T) {
135         defer afterTest(t)
136         tr := &recordingTransport{}
137         client := &Client{Transport: tr}
138
139         url := "http://dummy.faketld/"
140         json := `{"key":"value"}`
141         b := strings.NewReader(json)
142         client.Post(url, "application/json", b) // Note: doesn't hit network
143
144         if tr.req.Method != "POST" {
145                 t.Errorf("got method %q, want %q", tr.req.Method, "POST")
146         }
147         if tr.req.URL.String() != url {
148                 t.Errorf("got URL %q, want %q", tr.req.URL.String(), url)
149         }
150         if tr.req.Header == nil {
151                 t.Fatalf("expected non-nil request Header")
152         }
153         if tr.req.Close {
154                 t.Error("got Close true, want false")
155         }
156         if g, e := tr.req.ContentLength, int64(len(json)); g != e {
157                 t.Errorf("got ContentLength %d, want %d", g, e)
158         }
159 }
160
161 func TestPostFormRequestFormat(t *testing.T) {
162         defer afterTest(t)
163         tr := &recordingTransport{}
164         client := &Client{Transport: tr}
165
166         urlStr := "http://dummy.faketld/"
167         form := make(url.Values)
168         form.Set("foo", "bar")
169         form.Add("foo", "bar2")
170         form.Set("bar", "baz")
171         client.PostForm(urlStr, form) // Note: doesn't hit network
172
173         if tr.req.Method != "POST" {
174                 t.Errorf("got method %q, want %q", tr.req.Method, "POST")
175         }
176         if tr.req.URL.String() != urlStr {
177                 t.Errorf("got URL %q, want %q", tr.req.URL.String(), urlStr)
178         }
179         if tr.req.Header == nil {
180                 t.Fatalf("expected non-nil request Header")
181         }
182         if g, e := tr.req.Header.Get("Content-Type"), "application/x-www-form-urlencoded"; g != e {
183                 t.Errorf("got Content-Type %q, want %q", g, e)
184         }
185         if tr.req.Close {
186                 t.Error("got Close true, want false")
187         }
188         // Depending on map iteration, body can be either of these.
189         expectedBody := "foo=bar&foo=bar2&bar=baz"
190         expectedBody1 := "bar=baz&foo=bar&foo=bar2"
191         if g, e := tr.req.ContentLength, int64(len(expectedBody)); g != e {
192                 t.Errorf("got ContentLength %d, want %d", g, e)
193         }
194         bodyb, err := ioutil.ReadAll(tr.req.Body)
195         if err != nil {
196                 t.Fatalf("ReadAll on req.Body: %v", err)
197         }
198         if g := string(bodyb); g != expectedBody && g != expectedBody1 {
199                 t.Errorf("got body %q, want %q or %q", g, expectedBody, expectedBody1)
200         }
201 }
202
203 func TestClientRedirects(t *testing.T) {
204         setParallel(t)
205         defer afterTest(t)
206         var ts *httptest.Server
207         ts = httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
208                 n, _ := strconv.Atoi(r.FormValue("n"))
209                 // Test Referer header. (7 is arbitrary position to test at)
210                 if n == 7 {
211                         if g, e := r.Referer(), ts.URL+"/?n=6"; e != g {
212                                 t.Errorf("on request ?n=7, expected referer of %q; got %q", e, g)
213                         }
214                 }
215                 if n < 15 {
216                         Redirect(w, r, fmt.Sprintf("/?n=%d", n+1), StatusTemporaryRedirect)
217                         return
218                 }
219                 fmt.Fprintf(w, "n=%d", n)
220         }))
221         defer ts.Close()
222
223         tr := &Transport{}
224         defer tr.CloseIdleConnections()
225
226         c := &Client{Transport: tr}
227         _, err := c.Get(ts.URL)
228         if e, g := "Get /?n=10: stopped after 10 redirects", fmt.Sprintf("%v", err); e != g {
229                 t.Errorf("with default client Get, expected error %q, got %q", e, g)
230         }
231
232         // HEAD request should also have the ability to follow redirects.
233         _, err = c.Head(ts.URL)
234         if e, g := "Head /?n=10: stopped after 10 redirects", fmt.Sprintf("%v", err); e != g {
235                 t.Errorf("with default client Head, expected error %q, got %q", e, g)
236         }
237
238         // Do should also follow redirects.
239         greq, _ := NewRequest("GET", ts.URL, nil)
240         _, err = c.Do(greq)
241         if e, g := "Get /?n=10: stopped after 10 redirects", fmt.Sprintf("%v", err); e != g {
242                 t.Errorf("with default client Do, expected error %q, got %q", e, g)
243         }
244
245         // Requests with an empty Method should also redirect (Issue 12705)
246         greq.Method = ""
247         _, err = c.Do(greq)
248         if e, g := "Get /?n=10: stopped after 10 redirects", fmt.Sprintf("%v", err); e != g {
249                 t.Errorf("with default client Do and empty Method, expected error %q, got %q", e, g)
250         }
251
252         var checkErr error
253         var lastVia []*Request
254         var lastReq *Request
255         c = &Client{
256                 Transport: tr,
257                 CheckRedirect: func(req *Request, via []*Request) error {
258                         lastReq = req
259                         lastVia = via
260                         return checkErr
261                 },
262         }
263         res, err := c.Get(ts.URL)
264         if err != nil {
265                 t.Fatalf("Get error: %v", err)
266         }
267         res.Body.Close()
268         finalUrl := res.Request.URL.String()
269         if e, g := "<nil>", fmt.Sprintf("%v", err); e != g {
270                 t.Errorf("with custom client, expected error %q, got %q", e, g)
271         }
272         if !strings.HasSuffix(finalUrl, "/?n=15") {
273                 t.Errorf("expected final url to end in /?n=15; got url %q", finalUrl)
274         }
275         if e, g := 15, len(lastVia); e != g {
276                 t.Errorf("expected lastVia to have contained %d elements; got %d", e, g)
277         }
278
279         // Test that Request.Cancel is propagated between requests (Issue 14053)
280         creq, _ := NewRequest("HEAD", ts.URL, nil)
281         cancel := make(chan struct{})
282         creq.Cancel = cancel
283         if _, err := c.Do(creq); err != nil {
284                 t.Fatal(err)
285         }
286         if lastReq == nil {
287                 t.Fatal("didn't see redirect")
288         }
289         if lastReq.Cancel != cancel {
290                 t.Errorf("expected lastReq to have the cancel channel set on the initial req")
291         }
292
293         checkErr = errors.New("no redirects allowed")
294         res, err = c.Get(ts.URL)
295         if urlError, ok := err.(*url.Error); !ok || urlError.Err != checkErr {
296                 t.Errorf("with redirects forbidden, expected a *url.Error with our 'no redirects allowed' error inside; got %#v (%q)", err, err)
297         }
298         if res == nil {
299                 t.Fatalf("Expected a non-nil Response on CheckRedirect failure (https://golang.org/issue/3795)")
300         }
301         res.Body.Close()
302         if res.Header.Get("Location") == "" {
303                 t.Errorf("no Location header in Response")
304         }
305 }
306
307 func TestClientRedirectContext(t *testing.T) {
308         setParallel(t)
309         defer afterTest(t)
310         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
311                 Redirect(w, r, "/", StatusTemporaryRedirect)
312         }))
313         defer ts.Close()
314
315         tr := &Transport{}
316         defer tr.CloseIdleConnections()
317
318         ctx, cancel := context.WithCancel(context.Background())
319         c := &Client{
320                 Transport: tr,
321                 CheckRedirect: func(req *Request, via []*Request) error {
322                         cancel()
323                         if len(via) > 2 {
324                                 return errors.New("too many redirects")
325                         }
326                         return nil
327                 },
328         }
329         req, _ := NewRequest("GET", ts.URL, nil)
330         req = req.WithContext(ctx)
331         _, err := c.Do(req)
332         ue, ok := err.(*url.Error)
333         if !ok {
334                 t.Fatalf("got error %T; want *url.Error", err)
335         }
336         if ue.Err != context.Canceled {
337                 t.Errorf("url.Error.Err = %v; want %v", ue.Err, context.Canceled)
338         }
339 }
340
341 type redirectTest struct {
342         suffix       string
343         want         int // response code
344         redirectBody string
345 }
346
347 func TestPostRedirects(t *testing.T) {
348         postRedirectTests := []redirectTest{
349                 {"/", 200, "first"},
350                 {"/?code=301&next=302", 200, "c301"},
351                 {"/?code=302&next=302", 200, "c302"},
352                 {"/?code=303&next=301", 200, "c303wc301"}, // Issue 9348
353                 {"/?code=304", 304, "c304"},
354                 {"/?code=305", 305, "c305"},
355                 {"/?code=307&next=303,308,302", 200, "c307"},
356                 {"/?code=308&next=302,301", 200, "c308"},
357                 {"/?code=404", 404, "c404"},
358         }
359
360         wantSegments := []string{
361                 `POST / "first"`,
362                 `POST /?code=301&next=302 "c301"`,
363                 `GET /?code=302 "c301"`,
364                 `GET / "c301"`,
365                 `POST /?code=302&next=302 "c302"`,
366                 `GET /?code=302 "c302"`,
367                 `GET / "c302"`,
368                 `POST /?code=303&next=301 "c303wc301"`,
369                 `GET /?code=301 "c303wc301"`,
370                 `GET / "c303wc301"`,
371                 `POST /?code=304 "c304"`,
372                 `POST /?code=305 "c305"`,
373                 `POST /?code=307&next=303,308,302 "c307"`,
374                 `POST /?code=303&next=308,302 "c307"`,
375                 `GET /?code=308&next=302 "c307"`,
376                 `GET /?code=302 "c307"`,
377                 `GET / "c307"`,
378                 `POST /?code=308&next=302,301 "c308"`,
379                 `POST /?code=302&next=301 "c308"`,
380                 `GET /?code=301 "c308"`,
381                 `GET / "c308"`,
382                 `POST /?code=404 "c404"`,
383         }
384         want := strings.Join(wantSegments, "\n")
385         testRedirectsByMethod(t, "POST", postRedirectTests, want)
386 }
387
388 func TestDeleteRedirects(t *testing.T) {
389         deleteRedirectTests := []redirectTest{
390                 {"/", 200, "first"},
391                 {"/?code=301&next=302,308", 200, "c301"},
392                 {"/?code=302&next=302", 200, "c302"},
393                 {"/?code=303", 200, "c303"},
394                 {"/?code=307&next=301,308,303,302,304", 304, "c307"},
395                 {"/?code=308&next=307", 200, "c308"},
396                 {"/?code=404", 404, "c404"},
397         }
398
399         wantSegments := []string{
400                 `DELETE / "first"`,
401                 `DELETE /?code=301&next=302,308 "c301"`,
402                 `GET /?code=302&next=308 "c301"`,
403                 `GET /?code=308 "c301"`,
404                 `GET / "c301"`,
405                 `DELETE /?code=302&next=302 "c302"`,
406                 `GET /?code=302 "c302"`,
407                 `GET / "c302"`,
408                 `DELETE /?code=303 "c303"`,
409                 `GET / "c303"`,
410                 `DELETE /?code=307&next=301,308,303,302,304 "c307"`,
411                 `DELETE /?code=301&next=308,303,302,304 "c307"`,
412                 `GET /?code=308&next=303,302,304 "c307"`,
413                 `GET /?code=303&next=302,304 "c307"`,
414                 `GET /?code=302&next=304 "c307"`,
415                 `GET /?code=304 "c307"`,
416                 `DELETE /?code=308&next=307 "c308"`,
417                 `DELETE /?code=307 "c308"`,
418                 `DELETE / "c308"`,
419                 `DELETE /?code=404 "c404"`,
420         }
421         want := strings.Join(wantSegments, "\n")
422         testRedirectsByMethod(t, "DELETE", deleteRedirectTests, want)
423 }
424
425 func testRedirectsByMethod(t *testing.T, method string, table []redirectTest, want string) {
426         defer afterTest(t)
427         var log struct {
428                 sync.Mutex
429                 bytes.Buffer
430         }
431         var ts *httptest.Server
432         ts = httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
433                 log.Lock()
434                 slurp, _ := ioutil.ReadAll(r.Body)
435                 fmt.Fprintf(&log.Buffer, "%s %s %q\n", r.Method, r.RequestURI, slurp)
436                 log.Unlock()
437                 urlQuery := r.URL.Query()
438                 if v := urlQuery.Get("code"); v != "" {
439                         location := ts.URL
440                         if final := urlQuery.Get("next"); final != "" {
441                                 splits := strings.Split(final, ",")
442                                 first, rest := splits[0], splits[1:]
443                                 location = fmt.Sprintf("%s?code=%s", location, first)
444                                 if len(rest) > 0 {
445                                         location = fmt.Sprintf("%s&next=%s", location, strings.Join(rest, ","))
446                                 }
447                         }
448                         code, _ := strconv.Atoi(v)
449                         if code/100 == 3 {
450                                 w.Header().Set("Location", location)
451                         }
452                         w.WriteHeader(code)
453                 }
454         }))
455         defer ts.Close()
456
457         for _, tt := range table {
458                 content := tt.redirectBody
459                 req, _ := NewRequest(method, ts.URL+tt.suffix, strings.NewReader(content))
460                 req.GetBody = func() (io.ReadCloser, error) { return ioutil.NopCloser(strings.NewReader(content)), nil }
461                 res, err := DefaultClient.Do(req)
462
463                 if err != nil {
464                         t.Fatal(err)
465                 }
466                 if res.StatusCode != tt.want {
467                         t.Errorf("POST %s: status code = %d; want %d", tt.suffix, res.StatusCode, tt.want)
468                 }
469         }
470         log.Lock()
471         got := log.String()
472         log.Unlock()
473
474         got = strings.TrimSpace(got)
475         want = strings.TrimSpace(want)
476
477         if got != want {
478                 t.Errorf("Log differs.\n Got:\n%s\nWant:\n%s\n", got, want)
479         }
480 }
481
482 func TestClientRedirectUseResponse(t *testing.T) {
483         setParallel(t)
484         defer afterTest(t)
485         const body = "Hello, world."
486         var ts *httptest.Server
487         ts = httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
488                 if strings.Contains(r.URL.Path, "/other") {
489                         io.WriteString(w, "wrong body")
490                 } else {
491                         w.Header().Set("Location", ts.URL+"/other")
492                         w.WriteHeader(StatusFound)
493                         io.WriteString(w, body)
494                 }
495         }))
496         defer ts.Close()
497
498         tr := &Transport{}
499         defer tr.CloseIdleConnections()
500
501         c := &Client{
502                 Transport: tr,
503                 CheckRedirect: func(req *Request, via []*Request) error {
504                         if req.Response == nil {
505                                 t.Error("expected non-nil Request.Response")
506                         }
507                         return ErrUseLastResponse
508                 },
509         }
510         res, err := c.Get(ts.URL)
511         if err != nil {
512                 t.Fatal(err)
513         }
514         if res.StatusCode != StatusFound {
515                 t.Errorf("status = %d; want %d", res.StatusCode, StatusFound)
516         }
517         defer res.Body.Close()
518         slurp, err := ioutil.ReadAll(res.Body)
519         if err != nil {
520                 t.Fatal(err)
521         }
522         if string(slurp) != body {
523                 t.Errorf("body = %q; want %q", slurp, body)
524         }
525 }
526
527 // Issue 17773: don't follow a 308 (or 307) if the response doesn't
528 // have a Location header.
529 func TestClientRedirect308NoLocation(t *testing.T) {
530         setParallel(t)
531         defer afterTest(t)
532         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
533                 w.Header().Set("Foo", "Bar")
534                 w.WriteHeader(308)
535         }))
536         defer ts.Close()
537         res, err := Get(ts.URL)
538         if err != nil {
539                 t.Fatal(err)
540         }
541         res.Body.Close()
542         if res.StatusCode != 308 {
543                 t.Errorf("status = %d; want %d", res.StatusCode, 308)
544         }
545         if got := res.Header.Get("Foo"); got != "Bar" {
546                 t.Errorf("Foo header = %q; want Bar", got)
547         }
548 }
549
550 // Don't follow a 307/308 if we can't resent the request body.
551 func TestClientRedirect308NoGetBody(t *testing.T) {
552         setParallel(t)
553         defer afterTest(t)
554         const fakeURL = "https://localhost:1234/" // won't be hit
555         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
556                 w.Header().Set("Location", fakeURL)
557                 w.WriteHeader(308)
558         }))
559         defer ts.Close()
560         req, err := NewRequest("POST", ts.URL, strings.NewReader("some body"))
561         if err != nil {
562                 t.Fatal(err)
563         }
564         req.GetBody = nil // so it can't rewind.
565         res, err := DefaultClient.Do(req)
566         if err != nil {
567                 t.Fatal(err)
568         }
569         res.Body.Close()
570         if res.StatusCode != 308 {
571                 t.Errorf("status = %d; want %d", res.StatusCode, 308)
572         }
573         if got := res.Header.Get("Location"); got != fakeURL {
574                 t.Errorf("Location header = %q; want %q", got, fakeURL)
575         }
576 }
577
578 var expectedCookies = []*Cookie{
579         {Name: "ChocolateChip", Value: "tasty"},
580         {Name: "First", Value: "Hit"},
581         {Name: "Second", Value: "Hit"},
582 }
583
584 var echoCookiesRedirectHandler = HandlerFunc(func(w ResponseWriter, r *Request) {
585         for _, cookie := range r.Cookies() {
586                 SetCookie(w, cookie)
587         }
588         if r.URL.Path == "/" {
589                 SetCookie(w, expectedCookies[1])
590                 Redirect(w, r, "/second", StatusMovedPermanently)
591         } else {
592                 SetCookie(w, expectedCookies[2])
593                 w.Write([]byte("hello"))
594         }
595 })
596
597 func TestClientSendsCookieFromJar(t *testing.T) {
598         defer afterTest(t)
599         tr := &recordingTransport{}
600         client := &Client{Transport: tr}
601         client.Jar = &TestJar{perURL: make(map[string][]*Cookie)}
602         us := "http://dummy.faketld/"
603         u, _ := url.Parse(us)
604         client.Jar.SetCookies(u, expectedCookies)
605
606         client.Get(us) // Note: doesn't hit network
607         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
608
609         client.Head(us) // Note: doesn't hit network
610         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
611
612         client.Post(us, "text/plain", strings.NewReader("body")) // Note: doesn't hit network
613         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
614
615         client.PostForm(us, url.Values{}) // Note: doesn't hit network
616         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
617
618         req, _ := NewRequest("GET", us, nil)
619         client.Do(req) // Note: doesn't hit network
620         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
621
622         req, _ = NewRequest("POST", us, nil)
623         client.Do(req) // Note: doesn't hit network
624         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
625 }
626
627 // Just enough correctness for our redirect tests. Uses the URL.Host as the
628 // scope of all cookies.
629 type TestJar struct {
630         m      sync.Mutex
631         perURL map[string][]*Cookie
632 }
633
634 func (j *TestJar) SetCookies(u *url.URL, cookies []*Cookie) {
635         j.m.Lock()
636         defer j.m.Unlock()
637         if j.perURL == nil {
638                 j.perURL = make(map[string][]*Cookie)
639         }
640         j.perURL[u.Host] = cookies
641 }
642
643 func (j *TestJar) Cookies(u *url.URL) []*Cookie {
644         j.m.Lock()
645         defer j.m.Unlock()
646         return j.perURL[u.Host]
647 }
648
649 func TestRedirectCookiesJar(t *testing.T) {
650         setParallel(t)
651         defer afterTest(t)
652         var ts *httptest.Server
653         ts = httptest.NewServer(echoCookiesRedirectHandler)
654         defer ts.Close()
655         tr := &Transport{}
656         defer tr.CloseIdleConnections()
657         c := &Client{
658                 Transport: tr,
659                 Jar:       new(TestJar),
660         }
661         u, _ := url.Parse(ts.URL)
662         c.Jar.SetCookies(u, []*Cookie{expectedCookies[0]})
663         resp, err := c.Get(ts.URL)
664         if err != nil {
665                 t.Fatalf("Get: %v", err)
666         }
667         resp.Body.Close()
668         matchReturnedCookies(t, expectedCookies, resp.Cookies())
669 }
670
671 func matchReturnedCookies(t *testing.T, expected, given []*Cookie) {
672         if len(given) != len(expected) {
673                 t.Logf("Received cookies: %v", given)
674                 t.Errorf("Expected %d cookies, got %d", len(expected), len(given))
675         }
676         for _, ec := range expected {
677                 foundC := false
678                 for _, c := range given {
679                         if ec.Name == c.Name && ec.Value == c.Value {
680                                 foundC = true
681                                 break
682                         }
683                 }
684                 if !foundC {
685                         t.Errorf("Missing cookie %v", ec)
686                 }
687         }
688 }
689
690 func TestJarCalls(t *testing.T) {
691         defer afterTest(t)
692         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
693                 pathSuffix := r.RequestURI[1:]
694                 if r.RequestURI == "/nosetcookie" {
695                         return // don't set cookies for this path
696                 }
697                 SetCookie(w, &Cookie{Name: "name" + pathSuffix, Value: "val" + pathSuffix})
698                 if r.RequestURI == "/" {
699                         Redirect(w, r, "http://secondhost.fake/secondpath", 302)
700                 }
701         }))
702         defer ts.Close()
703         jar := new(RecordingJar)
704         c := &Client{
705                 Jar: jar,
706                 Transport: &Transport{
707                         Dial: func(_ string, _ string) (net.Conn, error) {
708                                 return net.Dial("tcp", ts.Listener.Addr().String())
709                         },
710                 },
711         }
712         _, err := c.Get("http://firsthost.fake/")
713         if err != nil {
714                 t.Fatal(err)
715         }
716         _, err = c.Get("http://firsthost.fake/nosetcookie")
717         if err != nil {
718                 t.Fatal(err)
719         }
720         got := jar.log.String()
721         want := `Cookies("http://firsthost.fake/")
722 SetCookie("http://firsthost.fake/", [name=val])
723 Cookies("http://secondhost.fake/secondpath")
724 SetCookie("http://secondhost.fake/secondpath", [namesecondpath=valsecondpath])
725 Cookies("http://firsthost.fake/nosetcookie")
726 `
727         if got != want {
728                 t.Errorf("Got Jar calls:\n%s\nWant:\n%s", got, want)
729         }
730 }
731
732 // RecordingJar keeps a log of calls made to it, without
733 // tracking any cookies.
734 type RecordingJar struct {
735         mu  sync.Mutex
736         log bytes.Buffer
737 }
738
739 func (j *RecordingJar) SetCookies(u *url.URL, cookies []*Cookie) {
740         j.logf("SetCookie(%q, %v)\n", u, cookies)
741 }
742
743 func (j *RecordingJar) Cookies(u *url.URL) []*Cookie {
744         j.logf("Cookies(%q)\n", u)
745         return nil
746 }
747
748 func (j *RecordingJar) logf(format string, args ...interface{}) {
749         j.mu.Lock()
750         defer j.mu.Unlock()
751         fmt.Fprintf(&j.log, format, args...)
752 }
753
754 func TestStreamingGet_h1(t *testing.T) { testStreamingGet(t, h1Mode) }
755 func TestStreamingGet_h2(t *testing.T) { testStreamingGet(t, h2Mode) }
756
757 func testStreamingGet(t *testing.T, h2 bool) {
758         defer afterTest(t)
759         say := make(chan string)
760         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
761                 w.(Flusher).Flush()
762                 for str := range say {
763                         w.Write([]byte(str))
764                         w.(Flusher).Flush()
765                 }
766         }))
767         defer cst.close()
768
769         c := cst.c
770         res, err := c.Get(cst.ts.URL)
771         if err != nil {
772                 t.Fatal(err)
773         }
774         var buf [10]byte
775         for _, str := range []string{"i", "am", "also", "known", "as", "comet"} {
776                 say <- str
777                 n, err := io.ReadFull(res.Body, buf[0:len(str)])
778                 if err != nil {
779                         t.Fatalf("ReadFull on %q: %v", str, err)
780                 }
781                 if n != len(str) {
782                         t.Fatalf("Receiving %q, only read %d bytes", str, n)
783                 }
784                 got := string(buf[0:n])
785                 if got != str {
786                         t.Fatalf("Expected %q, got %q", str, got)
787                 }
788         }
789         close(say)
790         _, err = io.ReadFull(res.Body, buf[0:1])
791         if err != io.EOF {
792                 t.Fatalf("at end expected EOF, got %v", err)
793         }
794 }
795
796 type writeCountingConn struct {
797         net.Conn
798         count *int
799 }
800
801 func (c *writeCountingConn) Write(p []byte) (int, error) {
802         *c.count++
803         return c.Conn.Write(p)
804 }
805
806 // TestClientWrites verifies that client requests are buffered and we
807 // don't send a TCP packet per line of the http request + body.
808 func TestClientWrites(t *testing.T) {
809         defer afterTest(t)
810         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
811         }))
812         defer ts.Close()
813
814         writes := 0
815         dialer := func(netz string, addr string) (net.Conn, error) {
816                 c, err := net.Dial(netz, addr)
817                 if err == nil {
818                         c = &writeCountingConn{c, &writes}
819                 }
820                 return c, err
821         }
822         c := &Client{Transport: &Transport{Dial: dialer}}
823
824         _, err := c.Get(ts.URL)
825         if err != nil {
826                 t.Fatal(err)
827         }
828         if writes != 1 {
829                 t.Errorf("Get request did %d Write calls, want 1", writes)
830         }
831
832         writes = 0
833         _, err = c.PostForm(ts.URL, url.Values{"foo": {"bar"}})
834         if err != nil {
835                 t.Fatal(err)
836         }
837         if writes != 1 {
838                 t.Errorf("Post request did %d Write calls, want 1", writes)
839         }
840 }
841
842 func TestClientInsecureTransport(t *testing.T) {
843         setParallel(t)
844         defer afterTest(t)
845         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {
846                 w.Write([]byte("Hello"))
847         }))
848         errc := make(chanWriter, 10) // but only expecting 1
849         ts.Config.ErrorLog = log.New(errc, "", 0)
850         defer ts.Close()
851
852         // TODO(bradfitz): add tests for skipping hostname checks too?
853         // would require a new cert for testing, and probably
854         // redundant with these tests.
855         for _, insecure := range []bool{true, false} {
856                 tr := &Transport{
857                         TLSClientConfig: &tls.Config{
858                                 InsecureSkipVerify: insecure,
859                         },
860                 }
861                 defer tr.CloseIdleConnections()
862                 c := &Client{Transport: tr}
863                 res, err := c.Get(ts.URL)
864                 if (err == nil) != insecure {
865                         t.Errorf("insecure=%v: got unexpected err=%v", insecure, err)
866                 }
867                 if res != nil {
868                         res.Body.Close()
869                 }
870         }
871
872         select {
873         case v := <-errc:
874                 if !strings.Contains(v, "TLS handshake error") {
875                         t.Errorf("expected an error log message containing 'TLS handshake error'; got %q", v)
876                 }
877         case <-time.After(5 * time.Second):
878                 t.Errorf("timeout waiting for logged error")
879         }
880
881 }
882
883 func TestClientErrorWithRequestURI(t *testing.T) {
884         defer afterTest(t)
885         req, _ := NewRequest("GET", "http://localhost:1234/", nil)
886         req.RequestURI = "/this/field/is/illegal/and/should/error/"
887         _, err := DefaultClient.Do(req)
888         if err == nil {
889                 t.Fatalf("expected an error")
890         }
891         if !strings.Contains(err.Error(), "RequestURI") {
892                 t.Errorf("wanted error mentioning RequestURI; got error: %v", err)
893         }
894 }
895
896 func newTLSTransport(t *testing.T, ts *httptest.Server) *Transport {
897         certs := x509.NewCertPool()
898         for _, c := range ts.TLS.Certificates {
899                 roots, err := x509.ParseCertificates(c.Certificate[len(c.Certificate)-1])
900                 if err != nil {
901                         t.Fatalf("error parsing server's root cert: %v", err)
902                 }
903                 for _, root := range roots {
904                         certs.AddCert(root)
905                 }
906         }
907         return &Transport{
908                 TLSClientConfig: &tls.Config{RootCAs: certs},
909         }
910 }
911
912 func TestClientWithCorrectTLSServerName(t *testing.T) {
913         defer afterTest(t)
914
915         const serverName = "example.com"
916         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {
917                 if r.TLS.ServerName != serverName {
918                         t.Errorf("expected client to set ServerName %q, got: %q", serverName, r.TLS.ServerName)
919                 }
920         }))
921         defer ts.Close()
922
923         trans := newTLSTransport(t, ts)
924         trans.TLSClientConfig.ServerName = serverName
925         c := &Client{Transport: trans}
926         if _, err := c.Get(ts.URL); err != nil {
927                 t.Fatalf("expected successful TLS connection, got error: %v", err)
928         }
929 }
930
931 func TestClientWithIncorrectTLSServerName(t *testing.T) {
932         defer afterTest(t)
933         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {}))
934         defer ts.Close()
935         errc := make(chanWriter, 10) // but only expecting 1
936         ts.Config.ErrorLog = log.New(errc, "", 0)
937
938         trans := newTLSTransport(t, ts)
939         trans.TLSClientConfig.ServerName = "badserver"
940         c := &Client{Transport: trans}
941         _, err := c.Get(ts.URL)
942         if err == nil {
943                 t.Fatalf("expected an error")
944         }
945         if !strings.Contains(err.Error(), "127.0.0.1") || !strings.Contains(err.Error(), "badserver") {
946                 t.Errorf("wanted error mentioning 127.0.0.1 and badserver; got error: %v", err)
947         }
948         select {
949         case v := <-errc:
950                 if !strings.Contains(v, "TLS handshake error") {
951                         t.Errorf("expected an error log message containing 'TLS handshake error'; got %q", v)
952                 }
953         case <-time.After(5 * time.Second):
954                 t.Errorf("timeout waiting for logged error")
955         }
956 }
957
958 // Test for golang.org/issue/5829; the Transport should respect TLSClientConfig.ServerName
959 // when not empty.
960 //
961 // tls.Config.ServerName (non-empty, set to "example.com") takes
962 // precedence over "some-other-host.tld" which previously incorrectly
963 // took precedence. We don't actually connect to (or even resolve)
964 // "some-other-host.tld", though, because of the Transport.Dial hook.
965 //
966 // The httptest.Server has a cert with "example.com" as its name.
967 func TestTransportUsesTLSConfigServerName(t *testing.T) {
968         defer afterTest(t)
969         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {
970                 w.Write([]byte("Hello"))
971         }))
972         defer ts.Close()
973
974         tr := newTLSTransport(t, ts)
975         tr.TLSClientConfig.ServerName = "example.com" // one of httptest's Server cert names
976         tr.Dial = func(netw, addr string) (net.Conn, error) {
977                 return net.Dial(netw, ts.Listener.Addr().String())
978         }
979         defer tr.CloseIdleConnections()
980         c := &Client{Transport: tr}
981         res, err := c.Get("https://some-other-host.tld/")
982         if err != nil {
983                 t.Fatal(err)
984         }
985         res.Body.Close()
986 }
987
988 func TestResponseSetsTLSConnectionState(t *testing.T) {
989         defer afterTest(t)
990         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {
991                 w.Write([]byte("Hello"))
992         }))
993         defer ts.Close()
994
995         tr := newTLSTransport(t, ts)
996         tr.TLSClientConfig.CipherSuites = []uint16{tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA}
997         tr.Dial = func(netw, addr string) (net.Conn, error) {
998                 return net.Dial(netw, ts.Listener.Addr().String())
999         }
1000         defer tr.CloseIdleConnections()
1001         c := &Client{Transport: tr}
1002         res, err := c.Get("https://example.com/")
1003         if err != nil {
1004                 t.Fatal(err)
1005         }
1006         defer res.Body.Close()
1007         if res.TLS == nil {
1008                 t.Fatal("Response didn't set TLS Connection State.")
1009         }
1010         if got, want := res.TLS.CipherSuite, tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA; got != want {
1011                 t.Errorf("TLS Cipher Suite = %d; want %d", got, want)
1012         }
1013 }
1014
1015 // Check that an HTTPS client can interpret a particular TLS error
1016 // to determine that the server is speaking HTTP.
1017 // See golang.org/issue/11111.
1018 func TestHTTPSClientDetectsHTTPServer(t *testing.T) {
1019         defer afterTest(t)
1020         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {}))
1021         ts.Config.ErrorLog = quietLog
1022         defer ts.Close()
1023
1024         _, err := Get(strings.Replace(ts.URL, "http", "https", 1))
1025         if got := err.Error(); !strings.Contains(got, "HTTP response to HTTPS client") {
1026                 t.Fatalf("error = %q; want error indicating HTTP response to HTTPS request", got)
1027         }
1028 }
1029
1030 // Verify Response.ContentLength is populated. https://golang.org/issue/4126
1031 func TestClientHeadContentLength_h1(t *testing.T) {
1032         testClientHeadContentLength(t, h1Mode)
1033 }
1034
1035 func TestClientHeadContentLength_h2(t *testing.T) {
1036         testClientHeadContentLength(t, h2Mode)
1037 }
1038
1039 func testClientHeadContentLength(t *testing.T, h2 bool) {
1040         defer afterTest(t)
1041         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
1042                 if v := r.FormValue("cl"); v != "" {
1043                         w.Header().Set("Content-Length", v)
1044                 }
1045         }))
1046         defer cst.close()
1047         tests := []struct {
1048                 suffix string
1049                 want   int64
1050         }{
1051                 {"/?cl=1234", 1234},
1052                 {"/?cl=0", 0},
1053                 {"", -1},
1054         }
1055         for _, tt := range tests {
1056                 req, _ := NewRequest("HEAD", cst.ts.URL+tt.suffix, nil)
1057                 res, err := cst.c.Do(req)
1058                 if err != nil {
1059                         t.Fatal(err)
1060                 }
1061                 if res.ContentLength != tt.want {
1062                         t.Errorf("Content-Length = %d; want %d", res.ContentLength, tt.want)
1063                 }
1064                 bs, err := ioutil.ReadAll(res.Body)
1065                 if err != nil {
1066                         t.Fatal(err)
1067                 }
1068                 if len(bs) != 0 {
1069                         t.Errorf("Unexpected content: %q", bs)
1070                 }
1071         }
1072 }
1073
1074 func TestEmptyPasswordAuth(t *testing.T) {
1075         setParallel(t)
1076         defer afterTest(t)
1077         gopher := "gopher"
1078         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
1079                 auth := r.Header.Get("Authorization")
1080                 if strings.HasPrefix(auth, "Basic ") {
1081                         encoded := auth[6:]
1082                         decoded, err := base64.StdEncoding.DecodeString(encoded)
1083                         if err != nil {
1084                                 t.Fatal(err)
1085                         }
1086                         expected := gopher + ":"
1087                         s := string(decoded)
1088                         if expected != s {
1089                                 t.Errorf("Invalid Authorization header. Got %q, wanted %q", s, expected)
1090                         }
1091                 } else {
1092                         t.Errorf("Invalid auth %q", auth)
1093                 }
1094         }))
1095         defer ts.Close()
1096         tr := &Transport{}
1097         defer tr.CloseIdleConnections()
1098         c := &Client{Transport: tr}
1099         req, err := NewRequest("GET", ts.URL, nil)
1100         if err != nil {
1101                 t.Fatal(err)
1102         }
1103         req.URL.User = url.User(gopher)
1104         resp, err := c.Do(req)
1105         if err != nil {
1106                 t.Fatal(err)
1107         }
1108         defer resp.Body.Close()
1109 }
1110
1111 func TestBasicAuth(t *testing.T) {
1112         defer afterTest(t)
1113         tr := &recordingTransport{}
1114         client := &Client{Transport: tr}
1115
1116         url := "http://My%20User:My%20Pass@dummy.faketld/"
1117         expected := "My User:My Pass"
1118         client.Get(url)
1119
1120         if tr.req.Method != "GET" {
1121                 t.Errorf("got method %q, want %q", tr.req.Method, "GET")
1122         }
1123         if tr.req.URL.String() != url {
1124                 t.Errorf("got URL %q, want %q", tr.req.URL.String(), url)
1125         }
1126         if tr.req.Header == nil {
1127                 t.Fatalf("expected non-nil request Header")
1128         }
1129         auth := tr.req.Header.Get("Authorization")
1130         if strings.HasPrefix(auth, "Basic ") {
1131                 encoded := auth[6:]
1132                 decoded, err := base64.StdEncoding.DecodeString(encoded)
1133                 if err != nil {
1134                         t.Fatal(err)
1135                 }
1136                 s := string(decoded)
1137                 if expected != s {
1138                         t.Errorf("Invalid Authorization header. Got %q, wanted %q", s, expected)
1139                 }
1140         } else {
1141                 t.Errorf("Invalid auth %q", auth)
1142         }
1143 }
1144
1145 func TestBasicAuthHeadersPreserved(t *testing.T) {
1146         defer afterTest(t)
1147         tr := &recordingTransport{}
1148         client := &Client{Transport: tr}
1149
1150         // If Authorization header is provided, username in URL should not override it
1151         url := "http://My%20User@dummy.faketld/"
1152         req, err := NewRequest("GET", url, nil)
1153         if err != nil {
1154                 t.Fatal(err)
1155         }
1156         req.SetBasicAuth("My User", "My Pass")
1157         expected := "My User:My Pass"
1158         client.Do(req)
1159
1160         if tr.req.Method != "GET" {
1161                 t.Errorf("got method %q, want %q", tr.req.Method, "GET")
1162         }
1163         if tr.req.URL.String() != url {
1164                 t.Errorf("got URL %q, want %q", tr.req.URL.String(), url)
1165         }
1166         if tr.req.Header == nil {
1167                 t.Fatalf("expected non-nil request Header")
1168         }
1169         auth := tr.req.Header.Get("Authorization")
1170         if strings.HasPrefix(auth, "Basic ") {
1171                 encoded := auth[6:]
1172                 decoded, err := base64.StdEncoding.DecodeString(encoded)
1173                 if err != nil {
1174                         t.Fatal(err)
1175                 }
1176                 s := string(decoded)
1177                 if expected != s {
1178                         t.Errorf("Invalid Authorization header. Got %q, wanted %q", s, expected)
1179                 }
1180         } else {
1181                 t.Errorf("Invalid auth %q", auth)
1182         }
1183
1184 }
1185
1186 func TestClientTimeout_h1(t *testing.T) { testClientTimeout(t, h1Mode) }
1187 func TestClientTimeout_h2(t *testing.T) { testClientTimeout(t, h2Mode) }
1188
1189 func testClientTimeout(t *testing.T, h2 bool) {
1190         setParallel(t)
1191         defer afterTest(t)
1192         testDone := make(chan struct{}) // closed in defer below
1193
1194         sawRoot := make(chan bool, 1)
1195         sawSlow := make(chan bool, 1)
1196         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
1197                 if r.URL.Path == "/" {
1198                         sawRoot <- true
1199                         Redirect(w, r, "/slow", StatusFound)
1200                         return
1201                 }
1202                 if r.URL.Path == "/slow" {
1203                         sawSlow <- true
1204                         w.Write([]byte("Hello"))
1205                         w.(Flusher).Flush()
1206                         <-testDone
1207                         return
1208                 }
1209         }))
1210         defer cst.close()
1211         defer close(testDone) // before cst.close, to unblock /slow handler
1212
1213         // 200ms should be long enough to get a normal request (the /
1214         // handler), but not so long that it makes the test slow.
1215         const timeout = 200 * time.Millisecond
1216         cst.c.Timeout = timeout
1217
1218         res, err := cst.c.Get(cst.ts.URL)
1219         if err != nil {
1220                 if strings.Contains(err.Error(), "Client.Timeout") {
1221                         t.Skipf("host too slow to get fast resource in %v", timeout)
1222                 }
1223                 t.Fatal(err)
1224         }
1225
1226         select {
1227         case <-sawRoot:
1228                 // good.
1229         default:
1230                 t.Fatal("handler never got / request")
1231         }
1232
1233         select {
1234         case <-sawSlow:
1235                 // good.
1236         default:
1237                 t.Fatal("handler never got /slow request")
1238         }
1239
1240         errc := make(chan error, 1)
1241         go func() {
1242                 _, err := ioutil.ReadAll(res.Body)
1243                 errc <- err
1244                 res.Body.Close()
1245         }()
1246
1247         const failTime = 5 * time.Second
1248         select {
1249         case err := <-errc:
1250                 if err == nil {
1251                         t.Fatal("expected error from ReadAll")
1252                 }
1253                 ne, ok := err.(net.Error)
1254                 if !ok {
1255                         t.Errorf("error value from ReadAll was %T; expected some net.Error", err)
1256                 } else if !ne.Timeout() {
1257                         t.Errorf("net.Error.Timeout = false; want true")
1258                 }
1259                 if got := ne.Error(); !strings.Contains(got, "Client.Timeout exceeded") {
1260                         t.Errorf("error string = %q; missing timeout substring", got)
1261                 }
1262         case <-time.After(failTime):
1263                 t.Errorf("timeout after %v waiting for timeout of %v", failTime, timeout)
1264         }
1265 }
1266
1267 func TestClientTimeout_Headers_h1(t *testing.T) { testClientTimeout_Headers(t, h1Mode) }
1268 func TestClientTimeout_Headers_h2(t *testing.T) { testClientTimeout_Headers(t, h2Mode) }
1269
1270 // Client.Timeout firing before getting to the body
1271 func testClientTimeout_Headers(t *testing.T, h2 bool) {
1272         setParallel(t)
1273         defer afterTest(t)
1274         donec := make(chan bool, 1)
1275         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
1276                 <-donec
1277         }))
1278         defer cst.close()
1279         // Note that we use a channel send here and not a close.
1280         // The race detector doesn't know that we're waiting for a timeout
1281         // and thinks that the waitgroup inside httptest.Server is added to concurrently
1282         // with us closing it. If we timed out immediately, we could close the testserver
1283         // before we entered the handler. We're not timing out immediately and there's
1284         // no way we would be done before we entered the handler, but the race detector
1285         // doesn't know this, so synchronize explicitly.
1286         defer func() { donec <- true }()
1287
1288         cst.c.Timeout = 5 * time.Millisecond
1289         res, err := cst.c.Get(cst.ts.URL)
1290         if err == nil {
1291                 res.Body.Close()
1292                 t.Fatal("got response from Get; expected error")
1293         }
1294         if _, ok := err.(*url.Error); !ok {
1295                 t.Fatalf("Got error of type %T; want *url.Error", err)
1296         }
1297         ne, ok := err.(net.Error)
1298         if !ok {
1299                 t.Fatalf("Got error of type %T; want some net.Error", err)
1300         }
1301         if !ne.Timeout() {
1302                 t.Error("net.Error.Timeout = false; want true")
1303         }
1304         if got := ne.Error(); !strings.Contains(got, "Client.Timeout exceeded") {
1305                 t.Errorf("error string = %q; missing timeout substring", got)
1306         }
1307 }
1308
1309 // Issue 16094: if Client.Timeout is set but not hit, a Timeout error shouldn't be
1310 // returned.
1311 func TestClientTimeoutCancel(t *testing.T) {
1312         setParallel(t)
1313         defer afterTest(t)
1314
1315         testDone := make(chan struct{})
1316         ctx, cancel := context.WithCancel(context.Background())
1317
1318         cst := newClientServerTest(t, h1Mode, HandlerFunc(func(w ResponseWriter, r *Request) {
1319                 w.(Flusher).Flush()
1320                 <-testDone
1321         }))
1322         defer cst.close()
1323         defer close(testDone)
1324
1325         cst.c.Timeout = 1 * time.Hour
1326         req, _ := NewRequest("GET", cst.ts.URL, nil)
1327         req.Cancel = ctx.Done()
1328         res, err := cst.c.Do(req)
1329         if err != nil {
1330                 t.Fatal(err)
1331         }
1332         cancel()
1333         _, err = io.Copy(ioutil.Discard, res.Body)
1334         if err != ExportErrRequestCanceled {
1335                 t.Fatalf("error = %v; want errRequestCanceled", err)
1336         }
1337 }
1338
1339 func TestClientRedirectEatsBody_h1(t *testing.T) { testClientRedirectEatsBody(t, h1Mode) }
1340 func TestClientRedirectEatsBody_h2(t *testing.T) { testClientRedirectEatsBody(t, h2Mode) }
1341 func testClientRedirectEatsBody(t *testing.T, h2 bool) {
1342         setParallel(t)
1343         defer afterTest(t)
1344         saw := make(chan string, 2)
1345         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
1346                 saw <- r.RemoteAddr
1347                 if r.URL.Path == "/" {
1348                         Redirect(w, r, "/foo", StatusFound) // which includes a body
1349                 }
1350         }))
1351         defer cst.close()
1352
1353         res, err := cst.c.Get(cst.ts.URL)
1354         if err != nil {
1355                 t.Fatal(err)
1356         }
1357         _, err = ioutil.ReadAll(res.Body)
1358         res.Body.Close()
1359         if err != nil {
1360                 t.Fatal(err)
1361         }
1362
1363         var first string
1364         select {
1365         case first = <-saw:
1366         default:
1367                 t.Fatal("server didn't see a request")
1368         }
1369
1370         var second string
1371         select {
1372         case second = <-saw:
1373         default:
1374                 t.Fatal("server didn't see a second request")
1375         }
1376
1377         if first != second {
1378                 t.Fatal("server saw different client ports before & after the redirect")
1379         }
1380 }
1381
1382 // eofReaderFunc is an io.Reader that runs itself, and then returns io.EOF.
1383 type eofReaderFunc func()
1384
1385 func (f eofReaderFunc) Read(p []byte) (n int, err error) {
1386         f()
1387         return 0, io.EOF
1388 }
1389
1390 func TestReferer(t *testing.T) {
1391         tests := []struct {
1392                 lastReq, newReq string // from -> to URLs
1393                 want            string
1394         }{
1395                 // don't send user:
1396                 {"http://gopher@test.com", "http://link.com", "http://test.com"},
1397                 {"https://gopher@test.com", "https://link.com", "https://test.com"},
1398
1399                 // don't send a user and password:
1400                 {"http://gopher:go@test.com", "http://link.com", "http://test.com"},
1401                 {"https://gopher:go@test.com", "https://link.com", "https://test.com"},
1402
1403                 // nothing to do:
1404                 {"http://test.com", "http://link.com", "http://test.com"},
1405                 {"https://test.com", "https://link.com", "https://test.com"},
1406
1407                 // https to http doesn't send a referer:
1408                 {"https://test.com", "http://link.com", ""},
1409                 {"https://gopher:go@test.com", "http://link.com", ""},
1410         }
1411         for _, tt := range tests {
1412                 l, err := url.Parse(tt.lastReq)
1413                 if err != nil {
1414                         t.Fatal(err)
1415                 }
1416                 n, err := url.Parse(tt.newReq)
1417                 if err != nil {
1418                         t.Fatal(err)
1419                 }
1420                 r := ExportRefererForURL(l, n)
1421                 if r != tt.want {
1422                         t.Errorf("refererForURL(%q, %q) = %q; want %q", tt.lastReq, tt.newReq, r, tt.want)
1423                 }
1424         }
1425 }
1426
1427 // issue15577Tripper returns a Response with a redirect response
1428 // header and doesn't populate its Response.Request field.
1429 type issue15577Tripper struct{}
1430
1431 func (issue15577Tripper) RoundTrip(*Request) (*Response, error) {
1432         resp := &Response{
1433                 StatusCode: 303,
1434                 Header:     map[string][]string{"Location": {"http://www.example.com/"}},
1435                 Body:       ioutil.NopCloser(strings.NewReader("")),
1436         }
1437         return resp, nil
1438 }
1439
1440 // Issue 15577: don't assume the roundtripper's response populates its Request field.
1441 func TestClientRedirectResponseWithoutRequest(t *testing.T) {
1442         c := &Client{
1443                 CheckRedirect: func(*Request, []*Request) error { return fmt.Errorf("no redirects!") },
1444                 Transport:     issue15577Tripper{},
1445         }
1446         // Check that this doesn't crash:
1447         c.Get("http://dummy.tld")
1448 }
1449
1450 // Issue 4800: copy (some) headers when Client follows a redirect
1451 func TestClientCopyHeadersOnRedirect(t *testing.T) {
1452         const (
1453                 ua   = "some-agent/1.2"
1454                 xfoo = "foo-val"
1455         )
1456         var ts2URL string
1457         ts1 := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
1458                 want := Header{
1459                         "User-Agent":      []string{ua},
1460                         "X-Foo":           []string{xfoo},
1461                         "Referer":         []string{ts2URL},
1462                         "Accept-Encoding": []string{"gzip"},
1463                 }
1464                 if !reflect.DeepEqual(r.Header, want) {
1465                         t.Errorf("Request.Header = %#v; want %#v", r.Header, want)
1466                 }
1467                 if t.Failed() {
1468                         w.Header().Set("Result", "got errors")
1469                 } else {
1470                         w.Header().Set("Result", "ok")
1471                 }
1472         }))
1473         defer ts1.Close()
1474         ts2 := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
1475                 Redirect(w, r, ts1.URL, StatusFound)
1476         }))
1477         defer ts2.Close()
1478         ts2URL = ts2.URL
1479
1480         tr := &Transport{}
1481         defer tr.CloseIdleConnections()
1482         c := &Client{
1483                 Transport: tr,
1484                 CheckRedirect: func(r *Request, via []*Request) error {
1485                         want := Header{
1486                                 "User-Agent": []string{ua},
1487                                 "X-Foo":      []string{xfoo},
1488                                 "Referer":    []string{ts2URL},
1489                         }
1490                         if !reflect.DeepEqual(r.Header, want) {
1491                                 t.Errorf("CheckRedirect Request.Header = %#v; want %#v", r.Header, want)
1492                         }
1493                         return nil
1494                 },
1495         }
1496
1497         req, _ := NewRequest("GET", ts2.URL, nil)
1498         req.Header.Add("User-Agent", ua)
1499         req.Header.Add("X-Foo", xfoo)
1500         req.Header.Add("Cookie", "foo=bar")
1501         req.Header.Add("Authorization", "secretpassword")
1502         res, err := c.Do(req)
1503         if err != nil {
1504                 t.Fatal(err)
1505         }
1506         defer res.Body.Close()
1507         if res.StatusCode != 200 {
1508                 t.Fatal(res.Status)
1509         }
1510         if got := res.Header.Get("Result"); got != "ok" {
1511                 t.Errorf("result = %q; want ok", got)
1512         }
1513 }
1514
1515 // Issue 17494: cookies should be altered when Client follows redirects.
1516 func TestClientAltersCookiesOnRedirect(t *testing.T) {
1517         cookieMap := func(cs []*Cookie) map[string][]string {
1518                 m := make(map[string][]string)
1519                 for _, c := range cs {
1520                         m[c.Name] = append(m[c.Name], c.Value)
1521                 }
1522                 return m
1523         }
1524
1525         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
1526                 var want map[string][]string
1527                 got := cookieMap(r.Cookies())
1528
1529                 c, _ := r.Cookie("Cycle")
1530                 switch c.Value {
1531                 case "0":
1532                         want = map[string][]string{
1533                                 "Cookie1": {"OldValue1a", "OldValue1b"},
1534                                 "Cookie2": {"OldValue2"},
1535                                 "Cookie3": {"OldValue3a", "OldValue3b"},
1536                                 "Cookie4": {"OldValue4"},
1537                                 "Cycle":   {"0"},
1538                         }
1539                         SetCookie(w, &Cookie{Name: "Cycle", Value: "1", Path: "/"})
1540                         SetCookie(w, &Cookie{Name: "Cookie2", Path: "/", MaxAge: -1}) // Delete cookie from Header
1541                         Redirect(w, r, "/", StatusFound)
1542                 case "1":
1543                         want = map[string][]string{
1544                                 "Cookie1": {"OldValue1a", "OldValue1b"},
1545                                 "Cookie3": {"OldValue3a", "OldValue3b"},
1546                                 "Cookie4": {"OldValue4"},
1547                                 "Cycle":   {"1"},
1548                         }
1549                         SetCookie(w, &Cookie{Name: "Cycle", Value: "2", Path: "/"})
1550                         SetCookie(w, &Cookie{Name: "Cookie3", Value: "NewValue3", Path: "/"}) // Modify cookie in Header
1551                         SetCookie(w, &Cookie{Name: "Cookie4", Value: "NewValue4", Path: "/"}) // Modify cookie in Jar
1552                         Redirect(w, r, "/", StatusFound)
1553                 case "2":
1554                         want = map[string][]string{
1555                                 "Cookie1": {"OldValue1a", "OldValue1b"},
1556                                 "Cookie3": {"NewValue3"},
1557                                 "Cookie4": {"NewValue4"},
1558                                 "Cycle":   {"2"},
1559                         }
1560                         SetCookie(w, &Cookie{Name: "Cycle", Value: "3", Path: "/"})
1561                         SetCookie(w, &Cookie{Name: "Cookie5", Value: "NewValue5", Path: "/"}) // Insert cookie into Jar
1562                         Redirect(w, r, "/", StatusFound)
1563                 case "3":
1564                         want = map[string][]string{
1565                                 "Cookie1": {"OldValue1a", "OldValue1b"},
1566                                 "Cookie3": {"NewValue3"},
1567                                 "Cookie4": {"NewValue4"},
1568                                 "Cookie5": {"NewValue5"},
1569                                 "Cycle":   {"3"},
1570                         }
1571                         // Don't redirect to ensure the loop ends.
1572                 default:
1573                         t.Errorf("unexpected redirect cycle")
1574                         return
1575                 }
1576
1577                 if !reflect.DeepEqual(got, want) {
1578                         t.Errorf("redirect %s, Cookie = %v, want %v", c.Value, got, want)
1579                 }
1580         }))
1581         defer ts.Close()
1582
1583         tr := &Transport{}
1584         defer tr.CloseIdleConnections()
1585         jar, _ := cookiejar.New(nil)
1586         c := &Client{
1587                 Transport: tr,
1588                 Jar:       jar,
1589         }
1590
1591         u, _ := url.Parse(ts.URL)
1592         req, _ := NewRequest("GET", ts.URL, nil)
1593         req.AddCookie(&Cookie{Name: "Cookie1", Value: "OldValue1a"})
1594         req.AddCookie(&Cookie{Name: "Cookie1", Value: "OldValue1b"})
1595         req.AddCookie(&Cookie{Name: "Cookie2", Value: "OldValue2"})
1596         req.AddCookie(&Cookie{Name: "Cookie3", Value: "OldValue3a"})
1597         req.AddCookie(&Cookie{Name: "Cookie3", Value: "OldValue3b"})
1598         jar.SetCookies(u, []*Cookie{{Name: "Cookie4", Value: "OldValue4", Path: "/"}})
1599         jar.SetCookies(u, []*Cookie{{Name: "Cycle", Value: "0", Path: "/"}})
1600         res, err := c.Do(req)
1601         if err != nil {
1602                 t.Fatal(err)
1603         }
1604         defer res.Body.Close()
1605         if res.StatusCode != 200 {
1606                 t.Fatal(res.Status)
1607         }
1608 }
1609
1610 // Part of Issue 4800
1611 func TestShouldCopyHeaderOnRedirect(t *testing.T) {
1612         tests := []struct {
1613                 header     string
1614                 initialURL string
1615                 destURL    string
1616                 want       bool
1617         }{
1618                 {"User-Agent", "http://foo.com/", "http://bar.com/", true},
1619                 {"X-Foo", "http://foo.com/", "http://bar.com/", true},
1620
1621                 // Sensitive headers:
1622                 {"cookie", "http://foo.com/", "http://bar.com/", false},
1623                 {"cookie2", "http://foo.com/", "http://bar.com/", false},
1624                 {"authorization", "http://foo.com/", "http://bar.com/", false},
1625                 {"www-authenticate", "http://foo.com/", "http://bar.com/", false},
1626
1627                 // But subdomains should work:
1628                 {"www-authenticate", "http://foo.com/", "http://foo.com/", true},
1629                 {"www-authenticate", "http://foo.com/", "http://sub.foo.com/", true},
1630                 {"www-authenticate", "http://foo.com/", "http://notfoo.com/", false},
1631                 // TODO(bradfitz): make this test work, once issue 16142 is fixed:
1632                 // {"www-authenticate", "http://foo.com:80/", "http://foo.com/", true},
1633         }
1634         for i, tt := range tests {
1635                 u0, err := url.Parse(tt.initialURL)
1636                 if err != nil {
1637                         t.Errorf("%d. initial URL %q parse error: %v", i, tt.initialURL, err)
1638                         continue
1639                 }
1640                 u1, err := url.Parse(tt.destURL)
1641                 if err != nil {
1642                         t.Errorf("%d. dest URL %q parse error: %v", i, tt.destURL, err)
1643                         continue
1644                 }
1645                 got := Export_shouldCopyHeaderOnRedirect(tt.header, u0, u1)
1646                 if got != tt.want {
1647                         t.Errorf("%d. shouldCopyHeaderOnRedirect(%q, %q => %q) = %v; want %v",
1648                                 i, tt.header, tt.initialURL, tt.destURL, got, tt.want)
1649                 }
1650         }
1651 }
1652
1653 func TestClientRedirectTypes(t *testing.T) {
1654         setParallel(t)
1655         defer afterTest(t)
1656
1657         tests := [...]struct {
1658                 method       string
1659                 serverStatus int
1660                 wantMethod   string // desired subsequent client method
1661         }{
1662                 0: {method: "POST", serverStatus: 301, wantMethod: "GET"},
1663                 1: {method: "POST", serverStatus: 302, wantMethod: "GET"},
1664                 2: {method: "POST", serverStatus: 303, wantMethod: "GET"},
1665                 3: {method: "POST", serverStatus: 307, wantMethod: "POST"},
1666                 4: {method: "POST", serverStatus: 308, wantMethod: "POST"},
1667
1668                 5: {method: "HEAD", serverStatus: 301, wantMethod: "HEAD"},
1669                 6: {method: "HEAD", serverStatus: 302, wantMethod: "HEAD"},
1670                 7: {method: "HEAD", serverStatus: 303, wantMethod: "HEAD"},
1671                 8: {method: "HEAD", serverStatus: 307, wantMethod: "HEAD"},
1672                 9: {method: "HEAD", serverStatus: 308, wantMethod: "HEAD"},
1673
1674                 10: {method: "GET", serverStatus: 301, wantMethod: "GET"},
1675                 11: {method: "GET", serverStatus: 302, wantMethod: "GET"},
1676                 12: {method: "GET", serverStatus: 303, wantMethod: "GET"},
1677                 13: {method: "GET", serverStatus: 307, wantMethod: "GET"},
1678                 14: {method: "GET", serverStatus: 308, wantMethod: "GET"},
1679
1680                 15: {method: "DELETE", serverStatus: 301, wantMethod: "GET"},
1681                 16: {method: "DELETE", serverStatus: 302, wantMethod: "GET"},
1682                 17: {method: "DELETE", serverStatus: 303, wantMethod: "GET"},
1683                 18: {method: "DELETE", serverStatus: 307, wantMethod: "DELETE"},
1684                 19: {method: "DELETE", serverStatus: 308, wantMethod: "DELETE"},
1685
1686                 20: {method: "PUT", serverStatus: 301, wantMethod: "GET"},
1687                 21: {method: "PUT", serverStatus: 302, wantMethod: "GET"},
1688                 22: {method: "PUT", serverStatus: 303, wantMethod: "GET"},
1689                 23: {method: "PUT", serverStatus: 307, wantMethod: "PUT"},
1690                 24: {method: "PUT", serverStatus: 308, wantMethod: "PUT"},
1691
1692                 25: {method: "MADEUPMETHOD", serverStatus: 301, wantMethod: "GET"},
1693                 26: {method: "MADEUPMETHOD", serverStatus: 302, wantMethod: "GET"},
1694                 27: {method: "MADEUPMETHOD", serverStatus: 303, wantMethod: "GET"},
1695                 28: {method: "MADEUPMETHOD", serverStatus: 307, wantMethod: "MADEUPMETHOD"},
1696                 29: {method: "MADEUPMETHOD", serverStatus: 308, wantMethod: "MADEUPMETHOD"},
1697         }
1698
1699         handlerc := make(chan HandlerFunc, 1)
1700
1701         ts := httptest.NewServer(HandlerFunc(func(rw ResponseWriter, req *Request) {
1702                 h := <-handlerc
1703                 h(rw, req)
1704         }))
1705         defer ts.Close()
1706
1707         tr := &Transport{}
1708         defer tr.CloseIdleConnections()
1709
1710         for i, tt := range tests {
1711                 handlerc <- func(w ResponseWriter, r *Request) {
1712                         w.Header().Set("Location", ts.URL)
1713                         w.WriteHeader(tt.serverStatus)
1714                 }
1715
1716                 req, err := NewRequest(tt.method, ts.URL, nil)
1717                 if err != nil {
1718                         t.Errorf("#%d: NewRequest: %v", i, err)
1719                         continue
1720                 }
1721
1722                 c := &Client{Transport: tr}
1723                 c.CheckRedirect = func(req *Request, via []*Request) error {
1724                         if got, want := req.Method, tt.wantMethod; got != want {
1725                                 return fmt.Errorf("#%d: got next method %q; want %q", i, got, want)
1726                         }
1727                         handlerc <- func(rw ResponseWriter, req *Request) {
1728                                 // TODO: Check that the body is valid when we do 307 and 308 support
1729                         }
1730                         return nil
1731                 }
1732
1733                 res, err := c.Do(req)
1734                 if err != nil {
1735                         t.Errorf("#%d: Response: %v", i, err)
1736                         continue
1737                 }
1738
1739                 res.Body.Close()
1740         }
1741 }
1742
1743 // issue18239Body is an io.ReadCloser for TestTransportBodyReadError.
1744 // Its Read returns readErr and increments *readCalls atomically.
1745 // Its Close returns nil and increments *closeCalls atomically.
1746 type issue18239Body struct {
1747         readCalls  *int32
1748         closeCalls *int32
1749         readErr    error
1750 }
1751
1752 func (b issue18239Body) Read([]byte) (int, error) {
1753         atomic.AddInt32(b.readCalls, 1)
1754         return 0, b.readErr
1755 }
1756
1757 func (b issue18239Body) Close() error {
1758         atomic.AddInt32(b.closeCalls, 1)
1759         return nil
1760 }
1761
1762 // Issue 18239: make sure the Transport doesn't retry requests with bodies.
1763 // (Especially if Request.GetBody is not defined.)
1764 func TestTransportBodyReadError(t *testing.T) {
1765         setParallel(t)
1766         defer afterTest(t)
1767         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
1768                 if r.URL.Path == "/ping" {
1769                         return
1770                 }
1771                 buf := make([]byte, 1)
1772                 n, err := r.Body.Read(buf)
1773                 w.Header().Set("X-Body-Read", fmt.Sprintf("%v, %v", n, err))
1774         }))
1775         defer ts.Close()
1776         tr := &Transport{}
1777         defer tr.CloseIdleConnections()
1778         c := &Client{Transport: tr}
1779
1780         // Do one initial successful request to create an idle TCP connection
1781         // for the subsequent request to reuse. (The Transport only retries
1782         // requests on reused connections.)
1783         res, err := c.Get(ts.URL + "/ping")
1784         if err != nil {
1785                 t.Fatal(err)
1786         }
1787         res.Body.Close()
1788
1789         var readCallsAtomic int32
1790         var closeCallsAtomic int32 // atomic
1791         someErr := errors.New("some body read error")
1792         body := issue18239Body{&readCallsAtomic, &closeCallsAtomic, someErr}
1793
1794         req, err := NewRequest("POST", ts.URL, body)
1795         if err != nil {
1796                 t.Fatal(err)
1797         }
1798         _, err = tr.RoundTrip(req)
1799         if err != someErr {
1800                 t.Errorf("Got error: %v; want Request.Body read error: %v", err, someErr)
1801         }
1802
1803         // And verify that our Body wasn't used multiple times, which
1804         // would indicate retries. (as it buggily was during part of
1805         // Go 1.8's dev cycle)
1806         readCalls := atomic.LoadInt32(&readCallsAtomic)
1807         closeCalls := atomic.LoadInt32(&closeCallsAtomic)
1808         if readCalls != 1 {
1809                 t.Errorf("read calls = %d; want 1", readCalls)
1810         }
1811         if closeCalls != 1 {
1812                 t.Errorf("close calls = %d; want 1", closeCalls)
1813         }
1814 }