Function TestNewExternalHTTPClient

api/http_client_test.go:471–518

(t *testing.T)

}

func TestNewExternalHTTPClient(t *testing.T) {
	tests := []struct {
		name string
		url  string
	}{
		{
			name: "third-party host",
			url:  "https://example.com/path",
		},
		{
			// Even when talking to GitHub, the external client must not set
			// authorization or any GitHub-specific headers.
			name: "github.com host",
			url:  "https://api.github.com/repos/cli/cli",
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			var gotReq *http.Request
			transport := &funcTripper{roundTrip: func(req *http.Request) (*http.Response, error) {
				gotReq = req
				return &http.Response{StatusCode: 204, Body: io.NopCloser(strings.NewReader(""))}, nil
			}}

			client, err := NewExternalHTTPClient(ExternalHTTPClientOptions{
				AppVersion: "v1.2.3",
				Transport:  transport,
			})
			require.NoError(t, err)

			req, err := http.NewRequest("GET", tt.url, nil)
			require.NoError(t, err)

			res, err := client.Do(req)
			require.NoError(t, err)
			assert.Equal(t, 204, res.StatusCode)

			// No headers should be set by default, except for User-Agent which should include the app version.
			assert.Equal(t, []string{"GitHub CLI v1.2.3"}, gotReq.Header.Values("user-agent"))
			assert.Empty(t, gotReq.Header.Values("authorization"))
			assert.Empty(t, gotReq.Header.Values("x-github-api-version"))
			assert.Empty(t, gotReq.Header.Values("accept"))
			assert.Empty(t, gotReq.Header.Values("content-type"))
			assert.Empty(t, gotReq.Header.Values("time-zone"))
		})
	}
}

type fakeTelemetryDisabler struct {
	disabled bool