Function TestRequestHeadersAgainstRealTransport

api/request_test.go:349–378

The transport built by NewHTTPClient supplies default Accept, Content-Type and User-Agent headers. Per-request headers are only useful if they win against that real transport, so this exercises it rather than a bare test tripper.

(t *testing.T)

// headers. Per-request headers are only useful if they win against that real transport, so this
// exercises it rather than a bare test tripper.
func TestRequestHeadersAgainstRealTransport(t *testing.T) {
	var gotReq *http.Request
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		gotReq = r
		w.WriteHeader(http.StatusOK)
	}))
	defer ts.Close()

	ios, _, _, _ := iostreams.Test()
	httpClient, err := NewHTTPClient(HTTPClientOptions{
		AppVersion: "v1.2.3",
		Config:     tinyConfig{serverHostname(t, ts.URL) + ":oauth_token": "MYTOKEN"},
		Log:        ios.ErrOut,
	})
	require.NoError(t, err)
	client := NewClientFromHTTP(httpClient)

	resp, err := client.Request(ts.URL, http.MethodGet, ts.URL+"/user/repos", nil,
		WithHeader("Accept", "application/vnd.github.raw"),
		WithHeader("Content-Type", "application/zip"))
	require.NoError(t, err)
	defer resp.Body.Close()

	assert.Equal(t, "application/vnd.github.raw", gotReq.Header.Get("Accept"))
	assert.Equal(t, "application/zip", gotReq.Header.Get("Content-Type"))

	// Headers the caller did not override must still be supplied by the transport.
	assert.Equal(t, "token MYTOKEN", gotReq.Header.Get("Authorization"))
	assert.Equal(t, "GitHub CLI v1.2.3", gotReq.Header.Get("User-Agent"))
}

func TestGraphQLWithHeader(t *testing.T) {
	reg := &httpmock.Registry{}