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/httptest"
  23         "net/url"
  24         "strconv"
  25         "strings"
  26         "sync"
  27         "testing"
  28         "time"
  29 )
  30
  31 var robotsTxtHandler = HandlerFunc(func(w ResponseWriter, r *Request) {
  32         w.Header().Set("Last-Modified", "sometime")
  33         fmt.Fprintf(w, "User-agent: go\nDisallow: /something/")
  34 })
  35
  36 // pedanticReadAll works like ioutil.ReadAll but additionally
  37 // verifies that r obeys the documented io.Reader contract.
  38 func pedanticReadAll(r io.Reader) (b []byte, err error) {
  39         var bufa [64]byte
  40         buf := bufa[:]
  41         for {
  42                 n, err := r.Read(buf)
  43                 if n == 0 && err == nil {
  44                         return nil, fmt.Errorf("Read: n=0 with err=nil")
  45                 }
  46                 b = append(b, buf[:n]...)
  47                 if err == io.EOF {
  48                         n, err := r.Read(buf)
  49                         if n != 0 || err != io.EOF {
  50                                 return nil, fmt.Errorf("Read: n=%d err=%#v after EOF", n, err)
  51                         }
  52                         return b, nil
  53                 }
  54                 if err != nil {
  55                         return b, err
  56                 }
  57         }
  58 }
  59
  60 type chanWriter chan string
  61
  62 func (w chanWriter) Write(p []byte) (n int, err error) {
  63         w <- string(p)
  64         return len(p), nil
  65 }
  66
  67 func TestClient(t *testing.T) {
  68         defer afterTest(t)
  69         ts := httptest.NewServer(robotsTxtHandler)
  70         defer ts.Close()
  71
  72         r, err := Get(ts.URL)
  73         var b []byte
  74         if err == nil {
  75                 b, err = pedanticReadAll(r.Body)
  76                 r.Body.Close()
  77         }
  78         if err != nil {
  79                 t.Error(err)
  80         } else if s := string(b); !strings.HasPrefix(s, "User-agent:") {
  81                 t.Errorf("Incorrect page body (did not begin with User-agent): %q", s)
  82         }
  83 }
  84
  85 func TestClientHead_h1(t *testing.T) { testClientHead(t, h1Mode) }
  86 func TestClientHead_h2(t *testing.T) { testClientHead(t, h2Mode) }
  87
  88 func testClientHead(t *testing.T, h2 bool) {
  89         defer afterTest(t)
  90         cst := newClientServerTest(t, h2, robotsTxtHandler)
  91         defer cst.close()
  92
  93         r, err := cst.c.Head(cst.ts.URL)
  94         if err != nil {
  95                 t.Fatal(err)
  96         }
  97         if _, ok := r.Header["Last-Modified"]; !ok {
  98                 t.Error("Last-Modified header not found.")
  99         }
 100 }
 101
 102 type recordingTransport struct {
 103         req *Request
 104 }
 105
 106 func (t *recordingTransport) RoundTrip(req *Request) (resp *Response, err error) {
 107         t.req = req
 108         return nil, errors.New("dummy impl")
 109 }
 110
 111 func TestGetRequestFormat(t *testing.T) {
 112         defer afterTest(t)
 113         tr := &recordingTransport{}
 114         client := &Client{Transport: tr}
 115         url := "http://dummy.faketld/"
 116         client.Get(url) // Note: doesn't hit network
 117         if tr.req.Method != "GET" {
 118                 t.Errorf("expected method %q; got %q", "GET", tr.req.Method)
 119         }
 120         if tr.req.URL.String() != url {
 121                 t.Errorf("expected URL %q; got %q", url, tr.req.URL.String())
 122         }
 123         if tr.req.Header == nil {
 124                 t.Errorf("expected non-nil request Header")
 125         }
 126 }
 127
 128 func TestPostRequestFormat(t *testing.T) {
 129         defer afterTest(t)
 130         tr := &recordingTransport{}
 131         client := &Client{Transport: tr}
 132
 133         url := "http://dummy.faketld/"
 134         json := `{"key":"value"}`
 135         b := strings.NewReader(json)
 136         client.Post(url, "application/json", b) // Note: doesn't hit network
 137
 138         if tr.req.Method != "POST" {
 139                 t.Errorf("got method %q, want %q", tr.req.Method, "POST")
 140         }
 141         if tr.req.URL.String() != url {
 142                 t.Errorf("got URL %q, want %q", tr.req.URL.String(), url)
 143         }
 144         if tr.req.Header == nil {
 145                 t.Fatalf("expected non-nil request Header")
 146         }
 147         if tr.req.Close {
 148                 t.Error("got Close true, want false")
 149         }
 150         if g, e := tr.req.ContentLength, int64(len(json)); g != e {
 151                 t.Errorf("got ContentLength %d, want %d", g, e)
 152         }
 153 }
 154
 155 func TestPostFormRequestFormat(t *testing.T) {
 156         defer afterTest(t)
 157         tr := &recordingTransport{}
 158         client := &Client{Transport: tr}
 159
 160         urlStr := "http://dummy.faketld/"
 161         form := make(url.Values)
 162         form.Set("foo", "bar")
 163         form.Add("foo", "bar2")
 164         form.Set("bar", "baz")
 165         client.PostForm(urlStr, form) // Note: doesn't hit network
 166
 167         if tr.req.Method != "POST" {
 168                 t.Errorf("got method %q, want %q", tr.req.Method, "POST")
 169         }
 170         if tr.req.URL.String() != urlStr {
 171                 t.Errorf("got URL %q, want %q", tr.req.URL.String(), urlStr)
 172         }
 173         if tr.req.Header == nil {
 174                 t.Fatalf("expected non-nil request Header")
 175         }
 176         if g, e := tr.req.Header.Get("Content-Type"), "application/x-www-form-urlencoded"; g != e {
 177                 t.Errorf("got Content-Type %q, want %q", g, e)
 178         }
 179         if tr.req.Close {
 180                 t.Error("got Close true, want false")
 181         }
 182         // Depending on map iteration, body can be either of these.
 183         expectedBody := "foo=bar&foo=bar2&bar=baz"
 184         expectedBody1 := "bar=baz&foo=bar&foo=bar2"
 185         if g, e := tr.req.ContentLength, int64(len(expectedBody)); g != e {
 186                 t.Errorf("got ContentLength %d, want %d", g, e)
 187         }
 188         bodyb, err := ioutil.ReadAll(tr.req.Body)
 189         if err != nil {
 190                 t.Fatalf("ReadAll on req.Body: %v", err)
 191         }
 192         if g := string(bodyb); g != expectedBody && g != expectedBody1 {
 193                 t.Errorf("got body %q, want %q or %q", g, expectedBody, expectedBody1)
 194         }
 195 }
 196
 197 func TestClientRedirects(t *testing.T) {
 198         defer afterTest(t)
 199         var ts *httptest.Server
 200         ts = httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 201                 n, _ := strconv.Atoi(r.FormValue("n"))
 202                 // Test Referer header. (7 is arbitrary position to test at)
 203                 if n == 7 {
 204                         if g, e := r.Referer(), ts.URL+"/?n=6"; e != g {
 205                                 t.Errorf("on request ?n=7, expected referer of %q; got %q", e, g)
 206                         }
 207                 }
 208                 if n < 15 {
 209                         Redirect(w, r, fmt.Sprintf("/?n=%d", n+1), StatusFound)
 210                         return
 211                 }
 212                 fmt.Fprintf(w, "n=%d", n)
 213         }))
 214         defer ts.Close()
 215
 216         c := &Client{}
 217         _, err := c.Get(ts.URL)
 218         if e, g := "Get /?n=10: stopped after 10 redirects", fmt.Sprintf("%v", err); e != g {
 219                 t.Errorf("with default client Get, expected error %q, got %q", e, g)
 220         }
 221
 222         // HEAD request should also have the ability to follow redirects.
 223         _, err = c.Head(ts.URL)
 224         if e, g := "Head /?n=10: stopped after 10 redirects", fmt.Sprintf("%v", err); e != g {
 225                 t.Errorf("with default client Head, expected error %q, got %q", e, g)
 226         }
 227
 228         // Do should also follow redirects.
 229         greq, _ := NewRequest("GET", ts.URL, nil)
 230         _, err = c.Do(greq)
 231         if e, g := "Get /?n=10: stopped after 10 redirects", fmt.Sprintf("%v", err); e != g {
 232                 t.Errorf("with default client Do, expected error %q, got %q", e, g)
 233         }
 234
 235         // Requests with an empty Method should also redirect (Issue 12705)
 236         greq.Method = ""
 237         _, err = c.Do(greq)
 238         if e, g := "Get /?n=10: stopped after 10 redirects", fmt.Sprintf("%v", err); e != g {
 239                 t.Errorf("with default client Do and empty Method, expected error %q, got %q", e, g)
 240         }
 241
 242         var checkErr error
 243         var lastVia []*Request
 244         var lastReq *Request
 245         c = &Client{CheckRedirect: func(req *Request, via []*Request) error {
 246                 lastReq = req
 247                 lastVia = via
 248                 return checkErr
 249         }}
 250         res, err := c.Get(ts.URL)
 251         if err != nil {
 252                 t.Fatalf("Get error: %v", err)
 253         }
 254         res.Body.Close()
 255         finalUrl := res.Request.URL.String()
 256         if e, g := "<nil>", fmt.Sprintf("%v", err); e != g {
 257                 t.Errorf("with custom client, expected error %q, got %q", e, g)
 258         }
 259         if !strings.HasSuffix(finalUrl, "/?n=15") {
 260                 t.Errorf("expected final url to end in /?n=15; got url %q", finalUrl)
 261         }
 262         if e, g := 15, len(lastVia); e != g {
 263                 t.Errorf("expected lastVia to have contained %d elements; got %d", e, g)
 264         }
 265
 266         // Test that Request.Cancel is propagated between requests (Issue 14053)
 267         creq, _ := NewRequest("HEAD", ts.URL, nil)
 268         cancel := make(chan struct{})
 269         creq.Cancel = cancel
 270         if _, err := c.Do(creq); err != nil {
 271                 t.Fatal(err)
 272         }
 273         if lastReq == nil {
 274                 t.Fatal("didn't see redirect")
 275         }
 276         if lastReq.Cancel != cancel {
 277                 t.Errorf("expected lastReq to have the cancel channel set on the initial req")
 278         }
 279
 280         checkErr = errors.New("no redirects allowed")
 281         res, err = c.Get(ts.URL)
 282         if urlError, ok := err.(*url.Error); !ok || urlError.Err != checkErr {
 283                 t.Errorf("with redirects forbidden, expected a *url.Error with our 'no redirects allowed' error inside; got %#v (%q)", err, err)
 284         }
 285         if res == nil {
 286                 t.Fatalf("Expected a non-nil Response on CheckRedirect failure (https://golang.org/issue/3795)")
 287         }
 288         res.Body.Close()
 289         if res.Header.Get("Location") == "" {
 290                 t.Errorf("no Location header in Response")
 291         }
 292 }
 293
 294 func TestClientRedirectContext(t *testing.T) {
 295         defer afterTest(t)
 296         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 297                 Redirect(w, r, "/", StatusFound)
 298         }))
 299         defer ts.Close()
 300
 301         ctx, cancel := context.WithCancel(context.Background())
 302         c := &Client{CheckRedirect: func(req *Request, via []*Request) error {
 303                 cancel()
 304                 if len(via) > 2 {
 305                         return errors.New("too many redirects")
 306                 }
 307                 return nil
 308         }}
 309         req, _ := NewRequest("GET", ts.URL, nil)
 310         req = req.WithContext(ctx)
 311         _, err := c.Do(req)
 312         ue, ok := err.(*url.Error)
 313         if !ok {
 314                 t.Fatalf("got error %T; want *url.Error", err)
 315         }
 316         if ue.Err != context.Canceled {
 317                 t.Errorf("url.Error.Err = %v; want %v", ue.Err, context.Canceled)
 318         }
 319 }
 320
 321 func TestPostRedirects(t *testing.T) {
 322         defer afterTest(t)
 323         var log struct {
 324                 sync.Mutex
 325                 bytes.Buffer
 326         }
 327         var ts *httptest.Server
 328         ts = httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 329                 log.Lock()
 330                 fmt.Fprintf(&log.Buffer, "%s %s ", r.Method, r.RequestURI)
 331                 log.Unlock()
 332                 if v := r.URL.Query().Get("code"); v != "" {
 333                         code, _ := strconv.Atoi(v)
 334                         if code/100 == 3 {
 335                                 w.Header().Set("Location", ts.URL)
 336                         }
 337                         w.WriteHeader(code)
 338                 }
 339         }))
 340         defer ts.Close()
 341         tests := []struct {
 342                 suffix string
 343                 want   int // response code
 344         }{
 345                 {"/", 200},
 346                 {"/?code=301", 301},
 347                 {"/?code=302", 200},
 348                 {"/?code=303", 200},
 349                 {"/?code=404", 404},
 350         }
 351         for _, tt := range tests {
 352                 res, err := Post(ts.URL+tt.suffix, "text/plain", strings.NewReader("Some content"))
 353                 if err != nil {
 354                         t.Fatal(err)
 355                 }
 356                 if res.StatusCode != tt.want {
 357                         t.Errorf("POST %s: status code = %d; want %d", tt.suffix, res.StatusCode, tt.want)
 358                 }
 359         }
 360         log.Lock()
 361         got := log.String()
 362         log.Unlock()
 363         want := "POST / POST /?code=301 POST /?code=302 GET / POST /?code=303 GET / POST /?code=404 "
 364         if got != want {
 365                 t.Errorf("Log differs.\n Got: %q\nWant: %q", got, want)
 366         }
 367 }
 368
 369 func TestClientRedirectUseResponse(t *testing.T) {
 370         defer afterTest(t)
 371         const body = "Hello, world."
 372         var ts *httptest.Server
 373         ts = httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 374                 if strings.Contains(r.URL.Path, "/other") {
 375                         io.WriteString(w, "wrong body")
 376                 } else {
 377                         w.Header().Set("Location", ts.URL+"/other")
 378                         w.WriteHeader(StatusFound)
 379                         io.WriteString(w, body)
 380                 }
 381         }))
 382         defer ts.Close()
 383
 384         c := &Client{CheckRedirect: func(req *Request, via []*Request) error {
 385                 if req.Response == nil {
 386                         t.Error("expected non-nil Request.Response")
 387                 }
 388                 return ErrUseLastResponse
 389         }}
 390         res, err := c.Get(ts.URL)
 391         if err != nil {
 392                 t.Fatal(err)
 393         }
 394         if res.StatusCode != StatusFound {
 395                 t.Errorf("status = %d; want %d", res.StatusCode, StatusFound)
 396         }
 397         defer res.Body.Close()
 398         slurp, err := ioutil.ReadAll(res.Body)
 399         if err != nil {
 400                 t.Fatal(err)
 401         }
 402         if string(slurp) != body {
 403                 t.Errorf("body = %q; want %q", slurp, body)
 404         }
 405 }
 406
 407 var expectedCookies = []*Cookie{
 408         {Name: "ChocolateChip", Value: "tasty"},
 409         {Name: "First", Value: "Hit"},
 410         {Name: "Second", Value: "Hit"},
 411 }
 412
 413 var echoCookiesRedirectHandler = HandlerFunc(func(w ResponseWriter, r *Request) {
 414         for _, cookie := range r.Cookies() {
 415                 SetCookie(w, cookie)
 416         }
 417         if r.URL.Path == "/" {
 418                 SetCookie(w, expectedCookies[1])
 419                 Redirect(w, r, "/second", StatusMovedPermanently)
 420         } else {
 421                 SetCookie(w, expectedCookies[2])
 422                 w.Write([]byte("hello"))
 423         }
 424 })
 425
 426 func TestClientSendsCookieFromJar(t *testing.T) {
 427         defer afterTest(t)
 428         tr := &recordingTransport{}
 429         client := &Client{Transport: tr}
 430         client.Jar = &TestJar{perURL: make(map[string][]*Cookie)}
 431         us := "http://dummy.faketld/"
 432         u, _ := url.Parse(us)
 433         client.Jar.SetCookies(u, expectedCookies)
 434
 435         client.Get(us) // Note: doesn't hit network
 436         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
 437
 438         client.Head(us) // Note: doesn't hit network
 439         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
 440
 441         client.Post(us, "text/plain", strings.NewReader("body")) // Note: doesn't hit network
 442         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
 443
 444         client.PostForm(us, url.Values{}) // Note: doesn't hit network
 445         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
 446
 447         req, _ := NewRequest("GET", us, nil)
 448         client.Do(req) // Note: doesn't hit network
 449         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
 450
 451         req, _ = NewRequest("POST", us, nil)
 452         client.Do(req) // Note: doesn't hit network
 453         matchReturnedCookies(t, expectedCookies, tr.req.Cookies())
 454 }
 455
 456 // Just enough correctness for our redirect tests. Uses the URL.Host as the
 457 // scope of all cookies.
 458 type TestJar struct {
 459         m      sync.Mutex
 460         perURL map[string][]*Cookie
 461 }
 462
 463 func (j *TestJar) SetCookies(u *url.URL, cookies []*Cookie) {
 464         j.m.Lock()
 465         defer j.m.Unlock()
 466         if j.perURL == nil {
 467                 j.perURL = make(map[string][]*Cookie)
 468         }
 469         j.perURL[u.Host] = cookies
 470 }
 471
 472 func (j *TestJar) Cookies(u *url.URL) []*Cookie {
 473         j.m.Lock()
 474         defer j.m.Unlock()
 475         return j.perURL[u.Host]
 476 }
 477
 478 func TestRedirectCookiesJar(t *testing.T) {
 479         defer afterTest(t)
 480         var ts *httptest.Server
 481         ts = httptest.NewServer(echoCookiesRedirectHandler)
 482         defer ts.Close()
 483         c := &Client{
 484                 Jar: new(TestJar),
 485         }
 486         u, _ := url.Parse(ts.URL)
 487         c.Jar.SetCookies(u, []*Cookie{expectedCookies[0]})
 488         resp, err := c.Get(ts.URL)
 489         if err != nil {
 490                 t.Fatalf("Get: %v", err)
 491         }
 492         resp.Body.Close()
 493         matchReturnedCookies(t, expectedCookies, resp.Cookies())
 494 }
 495
 496 func matchReturnedCookies(t *testing.T, expected, given []*Cookie) {
 497         if len(given) != len(expected) {
 498                 t.Logf("Received cookies: %v", given)
 499                 t.Errorf("Expected %d cookies, got %d", len(expected), len(given))
 500         }
 501         for _, ec := range expected {
 502                 foundC := false
 503                 for _, c := range given {
 504                         if ec.Name == c.Name && ec.Value == c.Value {
 505                                 foundC = true
 506                                 break
 507                         }
 508                 }
 509                 if !foundC {
 510                         t.Errorf("Missing cookie %v", ec)
 511                 }
 512         }
 513 }
 514
 515 func TestJarCalls(t *testing.T) {
 516         defer afterTest(t)
 517         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 518                 pathSuffix := r.RequestURI[1:]
 519                 if r.RequestURI == "/nosetcookie" {
 520                         return // don't set cookies for this path
 521                 }
 522                 SetCookie(w, &Cookie{Name: "name" + pathSuffix, Value: "val" + pathSuffix})
 523                 if r.RequestURI == "/" {
 524                         Redirect(w, r, "http://secondhost.fake/secondpath", 302)
 525                 }
 526         }))
 527         defer ts.Close()
 528         jar := new(RecordingJar)
 529         c := &Client{
 530                 Jar: jar,
 531                 Transport: &Transport{
 532                         Dial: func(_ string, _ string) (net.Conn, error) {
 533                                 return net.Dial("tcp", ts.Listener.Addr().String())
 534                         },
 535                 },
 536         }
 537         _, err := c.Get("http://firsthost.fake/")
 538         if err != nil {
 539                 t.Fatal(err)
 540         }
 541         _, err = c.Get("http://firsthost.fake/nosetcookie")
 542         if err != nil {
 543                 t.Fatal(err)
 544         }
 545         got := jar.log.String()
 546         want := `Cookies("http://firsthost.fake/")
 547 SetCookie("http://firsthost.fake/", [name=val])
 548 Cookies("http://secondhost.fake/secondpath")
 549 SetCookie("http://secondhost.fake/secondpath", [namesecondpath=valsecondpath])
 550 Cookies("http://firsthost.fake/nosetcookie")
 551 `
 552         if got != want {
 553                 t.Errorf("Got Jar calls:\n%s\nWant:\n%s", got, want)
 554         }
 555 }
 556
 557 // RecordingJar keeps a log of calls made to it, without
 558 // tracking any cookies.
 559 type RecordingJar struct {
 560         mu  sync.Mutex
 561         log bytes.Buffer
 562 }
 563
 564 func (j *RecordingJar) SetCookies(u *url.URL, cookies []*Cookie) {
 565         j.logf("SetCookie(%q, %v)\n", u, cookies)
 566 }
 567
 568 func (j *RecordingJar) Cookies(u *url.URL) []*Cookie {
 569         j.logf("Cookies(%q)\n", u)
 570         return nil
 571 }
 572
 573 func (j *RecordingJar) logf(format string, args ...interface{}) {
 574         j.mu.Lock()
 575         defer j.mu.Unlock()
 576         fmt.Fprintf(&j.log, format, args...)
 577 }
 578
 579 func TestStreamingGet_h1(t *testing.T) { testStreamingGet(t, h1Mode) }
 580 func TestStreamingGet_h2(t *testing.T) { testStreamingGet(t, h2Mode) }
 581
 582 func testStreamingGet(t *testing.T, h2 bool) {
 583         defer afterTest(t)
 584         say := make(chan string)
 585         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
 586                 w.(Flusher).Flush()
 587                 for str := range say {
 588                         w.Write([]byte(str))
 589                         w.(Flusher).Flush()
 590                 }
 591         }))
 592         defer cst.close()
 593
 594         c := cst.c
 595         res, err := c.Get(cst.ts.URL)
 596         if err != nil {
 597                 t.Fatal(err)
 598         }
 599         var buf [10]byte
 600         for _, str := range []string{"i", "am", "also", "known", "as", "comet"} {
 601                 say <- str
 602                 n, err := io.ReadFull(res.Body, buf[0:len(str)])
 603                 if err != nil {
 604                         t.Fatalf("ReadFull on %q: %v", str, err)
 605                 }
 606                 if n != len(str) {
 607                         t.Fatalf("Receiving %q, only read %d bytes", str, n)
 608                 }
 609                 got := string(buf[0:n])
 610                 if got != str {
 611                         t.Fatalf("Expected %q, got %q", str, got)
 612                 }
 613         }
 614         close(say)
 615         _, err = io.ReadFull(res.Body, buf[0:1])
 616         if err != io.EOF {
 617                 t.Fatalf("at end expected EOF, got %v", err)
 618         }
 619 }
 620
 621 type writeCountingConn struct {
 622         net.Conn
 623         count *int
 624 }
 625
 626 func (c *writeCountingConn) Write(p []byte) (int, error) {
 627         *c.count++
 628         return c.Conn.Write(p)
 629 }
 630
 631 // TestClientWrites verifies that client requests are buffered and we
 632 // don't send a TCP packet per line of the http request + body.
 633 func TestClientWrites(t *testing.T) {
 634         defer afterTest(t)
 635         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 636         }))
 637         defer ts.Close()
 638
 639         writes := 0
 640         dialer := func(netz string, addr string) (net.Conn, error) {
 641                 c, err := net.Dial(netz, addr)
 642                 if err == nil {
 643                         c = &writeCountingConn{c, &writes}
 644                 }
 645                 return c, err
 646         }
 647         c := &Client{Transport: &Transport{Dial: dialer}}
 648
 649         _, err := c.Get(ts.URL)
 650         if err != nil {
 651                 t.Fatal(err)
 652         }
 653         if writes != 1 {
 654                 t.Errorf("Get request did %d Write calls, want 1", writes)
 655         }
 656
 657         writes = 0
 658         _, err = c.PostForm(ts.URL, url.Values{"foo": {"bar"}})
 659         if err != nil {
 660                 t.Fatal(err)
 661         }
 662         if writes != 1 {
 663                 t.Errorf("Post request did %d Write calls, want 1", writes)
 664         }
 665 }
 666
 667 func TestClientInsecureTransport(t *testing.T) {
 668         defer afterTest(t)
 669         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 670                 w.Write([]byte("Hello"))
 671         }))
 672         errc := make(chanWriter, 10) // but only expecting 1
 673         ts.Config.ErrorLog = log.New(errc, "", 0)
 674         defer ts.Close()
 675
 676         // TODO(bradfitz): add tests for skipping hostname checks too?
 677         // would require a new cert for testing, and probably
 678         // redundant with these tests.
 679         for _, insecure := range []bool{true, false} {
 680                 tr := &Transport{
 681                         TLSClientConfig: &tls.Config{
 682                                 InsecureSkipVerify: insecure,
 683                         },
 684                 }
 685                 defer tr.CloseIdleConnections()
 686                 c := &Client{Transport: tr}
 687                 res, err := c.Get(ts.URL)
 688                 if (err == nil) != insecure {
 689                         t.Errorf("insecure=%v: got unexpected err=%v", insecure, err)
 690                 }
 691                 if res != nil {
 692                         res.Body.Close()
 693                 }
 694         }
 695
 696         select {
 697         case v := <-errc:
 698                 if !strings.Contains(v, "TLS handshake error") {
 699                         t.Errorf("expected an error log message containing 'TLS handshake error'; got %q", v)
 700                 }
 701         case <-time.After(5 * time.Second):
 702                 t.Errorf("timeout waiting for logged error")
 703         }
 704
 705 }
 706
 707 func TestClientErrorWithRequestURI(t *testing.T) {
 708         defer afterTest(t)
 709         req, _ := NewRequest("GET", "http://localhost:1234/", nil)
 710         req.RequestURI = "/this/field/is/illegal/and/should/error/"
 711         _, err := DefaultClient.Do(req)
 712         if err == nil {
 713                 t.Fatalf("expected an error")
 714         }
 715         if !strings.Contains(err.Error(), "RequestURI") {
 716                 t.Errorf("wanted error mentioning RequestURI; got error: %v", err)
 717         }
 718 }
 719
 720 func newTLSTransport(t *testing.T, ts *httptest.Server) *Transport {
 721         certs := x509.NewCertPool()
 722         for _, c := range ts.TLS.Certificates {
 723                 roots, err := x509.ParseCertificates(c.Certificate[len(c.Certificate)-1])
 724                 if err != nil {
 725                         t.Fatalf("error parsing server's root cert: %v", err)
 726                 }
 727                 for _, root := range roots {
 728                         certs.AddCert(root)
 729                 }
 730         }
 731         return &Transport{
 732                 TLSClientConfig: &tls.Config{RootCAs: certs},
 733         }
 734 }
 735
 736 func TestClientWithCorrectTLSServerName(t *testing.T) {
 737         defer afterTest(t)
 738
 739         const serverName = "example.com"
 740         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 741                 if r.TLS.ServerName != serverName {
 742                         t.Errorf("expected client to set ServerName %q, got: %q", serverName, r.TLS.ServerName)
 743                 }
 744         }))
 745         defer ts.Close()
 746
 747         trans := newTLSTransport(t, ts)
 748         trans.TLSClientConfig.ServerName = serverName
 749         c := &Client{Transport: trans}
 750         if _, err := c.Get(ts.URL); err != nil {
 751                 t.Fatalf("expected successful TLS connection, got error: %v", err)
 752         }
 753 }
 754
 755 func TestClientWithIncorrectTLSServerName(t *testing.T) {
 756         defer afterTest(t)
 757         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {}))
 758         defer ts.Close()
 759         errc := make(chanWriter, 10) // but only expecting 1
 760         ts.Config.ErrorLog = log.New(errc, "", 0)
 761
 762         trans := newTLSTransport(t, ts)
 763         trans.TLSClientConfig.ServerName = "badserver"
 764         c := &Client{Transport: trans}
 765         _, err := c.Get(ts.URL)
 766         if err == nil {
 767                 t.Fatalf("expected an error")
 768         }
 769         if !strings.Contains(err.Error(), "127.0.0.1") || !strings.Contains(err.Error(), "badserver") {
 770                 t.Errorf("wanted error mentioning 127.0.0.1 and badserver; got error: %v", err)
 771         }
 772         select {
 773         case v := <-errc:
 774                 if !strings.Contains(v, "TLS handshake error") {
 775                         t.Errorf("expected an error log message containing 'TLS handshake error'; got %q", v)
 776                 }
 777         case <-time.After(5 * time.Second):
 778                 t.Errorf("timeout waiting for logged error")
 779         }
 780 }
 781
 782 // Test for golang.org/issue/5829; the Transport should respect TLSClientConfig.ServerName
 783 // when not empty.
 784 //
 785 // tls.Config.ServerName (non-empty, set to "example.com") takes
 786 // precedence over "some-other-host.tld" which previously incorrectly
 787 // took precedence. We don't actually connect to (or even resolve)
 788 // "some-other-host.tld", though, because of the Transport.Dial hook.
 789 //
 790 // The httptest.Server has a cert with "example.com" as its name.
 791 func TestTransportUsesTLSConfigServerName(t *testing.T) {
 792         defer afterTest(t)
 793         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 794                 w.Write([]byte("Hello"))
 795         }))
 796         defer ts.Close()
 797
 798         tr := newTLSTransport(t, ts)
 799         tr.TLSClientConfig.ServerName = "example.com" // one of httptest's Server cert names
 800         tr.Dial = func(netw, addr string) (net.Conn, error) {
 801                 return net.Dial(netw, ts.Listener.Addr().String())
 802         }
 803         defer tr.CloseIdleConnections()
 804         c := &Client{Transport: tr}
 805         res, err := c.Get("https://some-other-host.tld/")
 806         if err != nil {
 807                 t.Fatal(err)
 808         }
 809         res.Body.Close()
 810 }
 811
 812 func TestResponseSetsTLSConnectionState(t *testing.T) {
 813         defer afterTest(t)
 814         ts := httptest.NewTLSServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 815                 w.Write([]byte("Hello"))
 816         }))
 817         defer ts.Close()
 818
 819         tr := newTLSTransport(t, ts)
 820         tr.TLSClientConfig.CipherSuites = []uint16{tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA}
 821         tr.Dial = func(netw, addr string) (net.Conn, error) {
 822                 return net.Dial(netw, ts.Listener.Addr().String())
 823         }
 824         defer tr.CloseIdleConnections()
 825         c := &Client{Transport: tr}
 826         res, err := c.Get("https://example.com/")
 827         if err != nil {
 828                 t.Fatal(err)
 829         }
 830         defer res.Body.Close()
 831         if res.TLS == nil {
 832                 t.Fatal("Response didn't set TLS Connection State.")
 833         }
 834         if got, want := res.TLS.CipherSuite, tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA; got != want {
 835                 t.Errorf("TLS Cipher Suite = %d; want %d", got, want)
 836         }
 837 }
 838
 839 // Check that an HTTPS client can interpret a particular TLS error
 840 // to determine that the server is speaking HTTP.
 841 // See golang.org/issue/11111.
 842 func TestHTTPSClientDetectsHTTPServer(t *testing.T) {
 843         defer afterTest(t)
 844         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {}))
 845         defer ts.Close()
 846
 847         _, err := Get(strings.Replace(ts.URL, "http", "https", 1))
 848         if got := err.Error(); !strings.Contains(got, "HTTP response to HTTPS client") {
 849                 t.Fatalf("error = %q; want error indicating HTTP response to HTTPS request", got)
 850         }
 851 }
 852
 853 // Verify Response.ContentLength is populated. https://golang.org/issue/4126
 854 func TestClientHeadContentLength_h1(t *testing.T) {
 855         testClientHeadContentLength(t, h1Mode)
 856 }
 857
 858 func TestClientHeadContentLength_h2(t *testing.T) {
 859         testClientHeadContentLength(t, h2Mode)
 860 }
 861
 862 func testClientHeadContentLength(t *testing.T, h2 bool) {
 863         defer afterTest(t)
 864         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
 865                 if v := r.FormValue("cl"); v != "" {
 866                         w.Header().Set("Content-Length", v)
 867                 }
 868         }))
 869         defer cst.close()
 870         tests := []struct {
 871                 suffix string
 872                 want   int64
 873         }{
 874                 {"/?cl=1234", 1234},
 875                 {"/?cl=0", 0},
 876                 {"", -1},
 877         }
 878         for _, tt := range tests {
 879                 req, _ := NewRequest("HEAD", cst.ts.URL+tt.suffix, nil)
 880                 res, err := cst.c.Do(req)
 881                 if err != nil {
 882                         t.Fatal(err)
 883                 }
 884                 if res.ContentLength != tt.want {
 885                         t.Errorf("Content-Length = %d; want %d", res.ContentLength, tt.want)
 886                 }
 887                 bs, err := ioutil.ReadAll(res.Body)
 888                 if err != nil {
 889                         t.Fatal(err)
 890                 }
 891                 if len(bs) != 0 {
 892                         t.Errorf("Unexpected content: %q", bs)
 893                 }
 894         }
 895 }
 896
 897 func TestEmptyPasswordAuth(t *testing.T) {
 898         defer afterTest(t)
 899         gopher := "gopher"
 900         ts := httptest.NewServer(HandlerFunc(func(w ResponseWriter, r *Request) {
 901                 auth := r.Header.Get("Authorization")
 902                 if strings.HasPrefix(auth, "Basic ") {
 903                         encoded := auth[6:]
 904                         decoded, err := base64.StdEncoding.DecodeString(encoded)
 905                         if err != nil {
 906                                 t.Fatal(err)
 907                         }
 908                         expected := gopher + ":"
 909                         s := string(decoded)
 910                         if expected != s {
 911                                 t.Errorf("Invalid Authorization header. Got %q, wanted %q", s, expected)
 912                         }
 913                 } else {
 914                         t.Errorf("Invalid auth %q", auth)
 915                 }
 916         }))
 917         defer ts.Close()
 918         c := &Client{}
 919         req, err := NewRequest("GET", ts.URL, nil)
 920         if err != nil {
 921                 t.Fatal(err)
 922         }
 923         req.URL.User = url.User(gopher)
 924         resp, err := c.Do(req)
 925         if err != nil {
 926                 t.Fatal(err)
 927         }
 928         defer resp.Body.Close()
 929 }
 930
 931 func TestBasicAuth(t *testing.T) {
 932         defer afterTest(t)
 933         tr := &recordingTransport{}
 934         client := &Client{Transport: tr}
 935
 936         url := "http://My%20User:My%20Pass@dummy.faketld/"
 937         expected := "My User:My Pass"
 938         client.Get(url)
 939
 940         if tr.req.Method != "GET" {
 941                 t.Errorf("got method %q, want %q", tr.req.Method, "GET")
 942         }
 943         if tr.req.URL.String() != url {
 944                 t.Errorf("got URL %q, want %q", tr.req.URL.String(), url)
 945         }
 946         if tr.req.Header == nil {
 947                 t.Fatalf("expected non-nil request Header")
 948         }
 949         auth := tr.req.Header.Get("Authorization")
 950         if strings.HasPrefix(auth, "Basic ") {
 951                 encoded := auth[6:]
 952                 decoded, err := base64.StdEncoding.DecodeString(encoded)
 953                 if err != nil {
 954                         t.Fatal(err)
 955                 }
 956                 s := string(decoded)
 957                 if expected != s {
 958                         t.Errorf("Invalid Authorization header. Got %q, wanted %q", s, expected)
 959                 }
 960         } else {
 961                 t.Errorf("Invalid auth %q", auth)
 962         }
 963 }
 964
 965 func TestBasicAuthHeadersPreserved(t *testing.T) {
 966         defer afterTest(t)
 967         tr := &recordingTransport{}
 968         client := &Client{Transport: tr}
 969
 970         // If Authorization header is provided, username in URL should not override it
 971         url := "http://My%20User@dummy.faketld/"
 972         req, err := NewRequest("GET", url, nil)
 973         if err != nil {
 974                 t.Fatal(err)
 975         }
 976         req.SetBasicAuth("My User", "My Pass")
 977         expected := "My User:My Pass"
 978         client.Do(req)
 979
 980         if tr.req.Method != "GET" {
 981                 t.Errorf("got method %q, want %q", tr.req.Method, "GET")
 982         }
 983         if tr.req.URL.String() != url {
 984                 t.Errorf("got URL %q, want %q", tr.req.URL.String(), url)
 985         }
 986         if tr.req.Header == nil {
 987                 t.Fatalf("expected non-nil request Header")
 988         }
 989         auth := tr.req.Header.Get("Authorization")
 990         if strings.HasPrefix(auth, "Basic ") {
 991                 encoded := auth[6:]
 992                 decoded, err := base64.StdEncoding.DecodeString(encoded)
 993                 if err != nil {
 994                         t.Fatal(err)
 995                 }
 996                 s := string(decoded)
 997                 if expected != s {
 998                         t.Errorf("Invalid Authorization header. Got %q, wanted %q", s, expected)
 999                 }
1000         } else {
1001                 t.Errorf("Invalid auth %q", auth)
1002         }
1003
1004 }
1005
1006 func TestClientTimeout_h1(t *testing.T) { testClientTimeout(t, h1Mode) }
1007 func TestClientTimeout_h2(t *testing.T) { testClientTimeout(t, h2Mode) }
1008
1009 func testClientTimeout(t *testing.T, h2 bool) {
1010         if testing.Short() {
1011                 t.Skip("skipping in short mode")
1012         }
1013         defer afterTest(t)
1014         sawRoot := make(chan bool, 1)
1015         sawSlow := make(chan bool, 1)
1016         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
1017                 if r.URL.Path == "/" {
1018                         sawRoot <- true
1019                         Redirect(w, r, "/slow", StatusFound)
1020                         return
1021                 }
1022                 if r.URL.Path == "/slow" {
1023                         w.Write([]byte("Hello"))
1024                         w.(Flusher).Flush()
1025                         sawSlow <- true
1026                         time.Sleep(2 * time.Second)
1027                         return
1028                 }
1029         }))
1030         defer cst.close()
1031         const timeout = 500 * time.Millisecond
1032         cst.c.Timeout = timeout
1033
1034         res, err := cst.c.Get(cst.ts.URL)
1035         if err != nil {
1036                 t.Fatal(err)
1037         }
1038
1039         select {
1040         case <-sawRoot:
1041                 // good.
1042         default:
1043                 t.Fatal("handler never got / request")
1044         }
1045
1046         select {
1047         case <-sawSlow:
1048                 // good.
1049         default:
1050                 t.Fatal("handler never got /slow request")
1051         }
1052
1053         errc := make(chan error, 1)
1054         go func() {
1055                 _, err := ioutil.ReadAll(res.Body)
1056                 errc <- err
1057                 res.Body.Close()
1058         }()
1059
1060         const failTime = timeout * 2
1061         select {
1062         case err := <-errc:
1063                 if err == nil {
1064                         t.Fatal("expected error from ReadAll")
1065                 }
1066                 ne, ok := err.(net.Error)
1067                 if !ok {
1068                         t.Errorf("error value from ReadAll was %T; expected some net.Error", err)
1069                 } else if !ne.Timeout() {
1070                         t.Errorf("net.Error.Timeout = false; want true")
1071                 }
1072                 if got := ne.Error(); !strings.Contains(got, "Client.Timeout exceeded") {
1073                         t.Errorf("error string = %q; missing timeout substring", got)
1074                 }
1075         case <-time.After(failTime):
1076                 t.Errorf("timeout after %v waiting for timeout of %v", failTime, timeout)
1077         }
1078 }
1079
1080 func TestClientTimeout_Headers_h1(t *testing.T) { testClientTimeout_Headers(t, h1Mode) }
1081 func TestClientTimeout_Headers_h2(t *testing.T) { testClientTimeout_Headers(t, h2Mode) }
1082
1083 // Client.Timeout firing before getting to the body
1084 func testClientTimeout_Headers(t *testing.T, h2 bool) {
1085         if testing.Short() {
1086                 t.Skip("skipping in short mode")
1087         }
1088         defer afterTest(t)
1089         donec := make(chan bool)
1090         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
1091                 <-donec
1092         }))
1093         defer cst.close()
1094         // Note that we use a channel send here and not a close.
1095         // The race detector doesn't know that we're waiting for a timeout
1096         // and thinks that the waitgroup inside httptest.Server is added to concurrently
1097         // with us closing it. If we timed out immediately, we could close the testserver
1098         // before we entered the handler. We're not timing out immediately and there's
1099         // no way we would be done before we entered the handler, but the race detector
1100         // doesn't know this, so synchronize explicitly.
1101         defer func() { donec <- true }()
1102
1103         cst.c.Timeout = 500 * time.Millisecond
1104         _, err := cst.c.Get(cst.ts.URL)
1105         if err == nil {
1106                 t.Fatal("got response from Get; expected error")
1107         }
1108         if _, ok := err.(*url.Error); !ok {
1109                 t.Fatalf("Got error of type %T; want *url.Error", err)
1110         }
1111         ne, ok := err.(net.Error)
1112         if !ok {
1113                 t.Fatalf("Got error of type %T; want some net.Error", err)
1114         }
1115         if !ne.Timeout() {
1116                 t.Error("net.Error.Timeout = false; want true")
1117         }
1118         if got := ne.Error(); !strings.Contains(got, "Client.Timeout exceeded") {
1119                 t.Errorf("error string = %q; missing timeout substring", got)
1120         }
1121 }
1122
1123 func TestClientRedirectEatsBody_h1(t *testing.T) { testClientRedirectEatsBody(t, h1Mode) }
1124 func TestClientRedirectEatsBody_h2(t *testing.T) { testClientRedirectEatsBody(t, h2Mode) }
1125 func testClientRedirectEatsBody(t *testing.T, h2 bool) {
1126         defer afterTest(t)
1127         saw := make(chan string, 2)
1128         cst := newClientServerTest(t, h2, HandlerFunc(func(w ResponseWriter, r *Request) {
1129                 saw <- r.RemoteAddr
1130                 if r.URL.Path == "/" {
1131                         Redirect(w, r, "/foo", StatusFound) // which includes a body
1132                 }
1133         }))
1134         defer cst.close()
1135
1136         res, err := cst.c.Get(cst.ts.URL)
1137         if err != nil {
1138                 t.Fatal(err)
1139         }
1140         _, err = ioutil.ReadAll(res.Body)
1141         if err != nil {
1142                 t.Fatal(err)
1143         }
1144         res.Body.Close()
1145
1146         var first string
1147         select {
1148         case first = <-saw:
1149         default:
1150                 t.Fatal("server didn't see a request")
1151         }
1152
1153         var second string
1154         select {
1155         case second = <-saw:
1156         default:
1157                 t.Fatal("server didn't see a second request")
1158         }
1159
1160         if first != second {
1161                 t.Fatal("server saw different client ports before & after the redirect")
1162         }
1163 }
1164
1165 // eofReaderFunc is an io.Reader that runs itself, and then returns io.EOF.
1166 type eofReaderFunc func()
1167
1168 func (f eofReaderFunc) Read(p []byte) (n int, err error) {
1169         f()
1170         return 0, io.EOF
1171 }
1172
1173 func TestReferer(t *testing.T) {
1174         tests := []struct {
1175                 lastReq, newReq string // from -> to URLs
1176                 want            string
1177         }{
1178                 // don't send user:
1179                 {"http://gopher@test.com", "http://link.com", "http://test.com"},
1180                 {"https://gopher@test.com", "https://link.com", "https://test.com"},
1181
1182                 // don't send a user and password:
1183                 {"http://gopher:go@test.com", "http://link.com", "http://test.com"},
1184                 {"https://gopher:go@test.com", "https://link.com", "https://test.com"},
1185
1186                 // nothing to do:
1187                 {"http://test.com", "http://link.com", "http://test.com"},
1188                 {"https://test.com", "https://link.com", "https://test.com"},
1189
1190                 // https to http doesn't send a referer:
1191                 {"https://test.com", "http://link.com", ""},
1192                 {"https://gopher:go@test.com", "http://link.com", ""},
1193         }
1194         for _, tt := range tests {
1195                 l, err := url.Parse(tt.lastReq)
1196                 if err != nil {
1197                         t.Fatal(err)
1198                 }
1199                 n, err := url.Parse(tt.newReq)
1200                 if err != nil {
1201                         t.Fatal(err)
1202                 }
1203                 r := ExportRefererForURL(l, n)
1204                 if r != tt.want {
1205                         t.Errorf("refererForURL(%q, %q) = %q; want %q", tt.lastReq, tt.newReq, r, tt.want)
1206                 }
1207         }
1208 }
1209
1210 // issue15577Tripper returns a Response with a redirect response
1211 // header and doesn't populate its Response.Request field.
1212 type issue15577Tripper struct{}
1213
1214 func (issue15577Tripper) RoundTrip(*Request) (*Response, error) {
1215         resp := &Response{
1216                 StatusCode: 303,
1217                 Header:     map[string][]string{"Location": {"http://www.example.com/"}},
1218                 Body:       ioutil.NopCloser(strings.NewReader("")),
1219         }
1220         return resp, nil
1221 }
1222
1223 // Issue 15577: don't assume the roundtripper's response populates its Request field.
1224 func TestClientRedirectResponseWithoutRequest(t *testing.T) {
1225         c := &Client{
1226                 CheckRedirect: func(*Request, []*Request) error { return fmt.Errorf("no redirects!") },
1227                 Transport:     issue15577Tripper{},
1228         }
1229         // Check that this doesn't crash:
1230         c.Get("http://dummy.tld")
1231 }