1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
package api
import (
"bytes"
"fmt"
"io"
"net/http"
"testing"
"github.com/cli/go-gh/pkg/api"
"github.com/stretchr/testify/assert"
)
func TestNewHTTPClient(t *testing.T) {
reflectHTTP := tripper{
roundTrip: func(req *http.Request) (*http.Response, error) {
header := req.Header.Clone()
body := "{}"
return &http.Response{
StatusCode: 200,
Header: header,
Body: io.NopCloser(bytes.NewBufferString(body)),
}, nil
},
}
tests := []struct {
name string
enableLog bool
log *bytes.Buffer
host string
headers map[string]string
skipHeaders bool
wantHeaders http.Header
}{
{
name: "sets default headers",
wantHeaders: defaultHeaders(),
},
{
name: "allows overriding default headers",
headers: map[string]string{
authorization: "token new_token",
accept: "application/vnd.github.test-preview",
},
wantHeaders: func() http.Header {
h := defaultHeaders()
h.Set(authorization, "token new_token")
h.Set(accept, "application/vnd.github.test-preview")
return h
}(),
},
{
name: "allows setting custom headers",
headers: map[string]string{
"custom": "testing",
},
wantHeaders: func() http.Header {
h := defaultHeaders()
h.Set("custom", "testing")
return h
}(),
},
{
name: "allows setting logger",
enableLog: true,
log: &bytes.Buffer{},
wantHeaders: defaultHeaders(),
},
{
name: "does not add an authorization header for non-matching host",
host: "notauthorized.com",
wantHeaders: func() http.Header {
h := defaultHeaders()
h.Del(authorization)
return h
}(),
},
{
name: "does not add an authorization header for non-matching host subdomain",
host: "test.company",
wantHeaders: func() http.Header {
h := defaultHeaders()
h.Del(authorization)
return h
}(),
},
{
name: "adds an authorization header for a matching host",
host: "test.com",
wantHeaders: defaultHeaders(),
},
{
name: "adds an authorization header if hosts match but differ in case",
host: "TeSt.CoM",
wantHeaders: defaultHeaders(),
},
{
name: "skips default headers",
skipHeaders: true,
wantHeaders: func() http.Header {
h := defaultHeaders()
h.Del(accept)
h.Del(contentType)
h.Del(timeZone)
h.Del(userAgent)
return h
}(),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.host == "" {
tt.host = "test.com"
}
opts := api.ClientOptions{
Host: tt.host,
AuthToken: "oauth_token",
Headers: tt.headers,
SkipDefaultHeaders: tt.skipHeaders,
Transport: reflectHTTP,
LogIgnoreEnv: true,
}
if tt.enableLog {
opts.Log = tt.log
}
client := NewHTTPClient(&opts)
res, err := client.Get("https://test.com")
assert.NoError(t, err)
assert.Equal(t, tt.wantHeaders, res.Header)
if tt.enableLog {
assert.NotEmpty(t, tt.log)
}
})
}
}
func TestIsEnterprise(t *testing.T) {
tests := []struct {
name string
host string
wantOut bool
}{
{
name: "github",
host: "github.com",
wantOut: false,
},
{
name: "localhost",
host: "github.localhost",
wantOut: false,
},
{
name: "enterprise",
host: "mygithub.com",
wantOut: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
out := isEnterprise(tt.host)
assert.Equal(t, tt.wantOut, out)
})
}
}
func TestNormalizeHostname(t *testing.T) {
tests := []struct {
name string
host string
wantHost string
}{
{
name: "github domain",
host: "test.github.com",
wantHost: "github.com",
},
{
name: "capitalized",
host: "GitHub.com",
wantHost: "github.com",
},
{
name: "localhost domain",
host: "test.github.localhost",
wantHost: "github.localhost",
},
{
name: "enterprise domain",
host: "mygithub.com",
wantHost: "mygithub.com",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
normalized := normalizeHostname(tt.host)
assert.Equal(t, tt.wantHost, normalized)
})
}
}
type tripper struct {
roundTrip func(*http.Request) (*http.Response, error)
}
func (tr tripper) RoundTrip(req *http.Request) (*http.Response, error) {
return tr.roundTrip(req)
}
func defaultHeaders() http.Header {
h := http.Header{}
a := "application/vnd.github.merge-info-preview+json"
a += ", application/vnd.github.nebula-preview"
h.Set(contentType, jsonContentType)
h.Set(userAgent, "go-gh")
h.Set(authorization, fmt.Sprintf("token %s", "oauth_token"))
h.Set(timeZone, currentTimeZone())
h.Set(accept, a)
return h
}
|
