Skip to content

Commit d02566a

Browse files
sapklunny
authored andcommitted
integration tests: Use t.Helper() (#7654)
1 parent 0c927b1 commit d02566a

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

integrations/html_helper.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ type HTMLDoc struct {
1919

2020
// NewHTMLParser parse html file
2121
func NewHTMLParser(t testing.TB, body *bytes.Buffer) *HTMLDoc {
22+
t.Helper()
2223
doc, err := goquery.NewDocumentFromReader(body)
2324
assert.NoError(t, err)
2425
return &HTMLDoc{doc: doc}

integrations/integration_test.go

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ func initIntegrationTest() {
169169
}
170170

171171
func prepareTestEnv(t testing.TB, skip ...int) {
172+
t.Helper()
172173
ourSkip := 2
173174
if len(skip) > 0 {
174175
ourSkip += skip[0]
@@ -201,6 +202,7 @@ func (s *TestSession) GetCookie(name string) *http.Cookie {
201202
}
202203

203204
func (s *TestSession) MakeRequest(t testing.TB, req *http.Request, expectedStatus int) *httptest.ResponseRecorder {
205+
t.Helper()
204206
baseURL, err := url.Parse(setting.AppURL)
205207
assert.NoError(t, err)
206208
for _, c := range s.jar.Cookies(baseURL) {
@@ -217,6 +219,7 @@ func (s *TestSession) MakeRequest(t testing.TB, req *http.Request, expectedStatu
217219
}
218220

219221
func (s *TestSession) MakeRequestNilResponseRecorder(t testing.TB, req *http.Request, expectedStatus int) *NilResponseRecorder {
222+
t.Helper()
220223
baseURL, err := url.Parse(setting.AppURL)
221224
assert.NoError(t, err)
222225
for _, c := range s.jar.Cookies(baseURL) {
@@ -237,13 +240,15 @@ const userPassword = "password"
237240
var loginSessionCache = make(map[string]*TestSession, 10)
238241

239242
func emptyTestSession(t testing.TB) *TestSession {
243+
t.Helper()
240244
jar, err := cookiejar.New(nil)
241245
assert.NoError(t, err)
242246

243247
return &TestSession{jar: jar}
244248
}
245249

246250
func loginUser(t testing.TB, userName string) *TestSession {
251+
t.Helper()
247252
if session, ok := loginSessionCache[userName]; ok {
248253
return session
249254
}
@@ -253,6 +258,7 @@ func loginUser(t testing.TB, userName string) *TestSession {
253258
}
254259

255260
func loginUserWithPassword(t testing.TB, userName, password string) *TestSession {
261+
t.Helper()
256262
req := NewRequest(t, "GET", "/user/login")
257263
resp := MakeRequest(t, req, http.StatusOK)
258264

@@ -278,6 +284,7 @@ func loginUserWithPassword(t testing.TB, userName, password string) *TestSession
278284
}
279285

280286
func getTokenForLoggedInUser(t testing.TB, session *TestSession) string {
287+
t.Helper()
281288
req := NewRequest(t, "GET", "/user/settings/applications")
282289
resp := session.MakeRequest(t, req, http.StatusOK)
283290
doc := NewHTMLParser(t, resp.Body)
@@ -294,14 +301,17 @@ func getTokenForLoggedInUser(t testing.TB, session *TestSession) string {
294301
}
295302

296303
func NewRequest(t testing.TB, method, urlStr string) *http.Request {
304+
t.Helper()
297305
return NewRequestWithBody(t, method, urlStr, nil)
298306
}
299307

300308
func NewRequestf(t testing.TB, method, urlFormat string, args ...interface{}) *http.Request {
309+
t.Helper()
301310
return NewRequest(t, method, fmt.Sprintf(urlFormat, args...))
302311
}
303312

304313
func NewRequestWithValues(t testing.TB, method, urlStr string, values map[string]string) *http.Request {
314+
t.Helper()
305315
urlValues := url.Values{}
306316
for key, value := range values {
307317
urlValues[key] = []string{value}
@@ -312,6 +322,7 @@ func NewRequestWithValues(t testing.TB, method, urlStr string, values map[string
312322
}
313323

314324
func NewRequestWithJSON(t testing.TB, method, urlStr string, v interface{}) *http.Request {
325+
t.Helper()
315326
jsonBytes, err := json.Marshal(v)
316327
assert.NoError(t, err)
317328
req := NewRequestWithBody(t, method, urlStr, bytes.NewBuffer(jsonBytes))
@@ -320,6 +331,7 @@ func NewRequestWithJSON(t testing.TB, method, urlStr string, v interface{}) *htt
320331
}
321332

322333
func NewRequestWithBody(t testing.TB, method, urlStr string, body io.Reader) *http.Request {
334+
t.Helper()
323335
request, err := http.NewRequest(method, urlStr, body)
324336
assert.NoError(t, err)
325337
request.RequestURI = urlStr
@@ -334,6 +346,7 @@ func AddBasicAuthHeader(request *http.Request, username string) *http.Request {
334346
const NoExpectedStatus = -1
335347

336348
func MakeRequest(t testing.TB, req *http.Request, expectedStatus int) *httptest.ResponseRecorder {
349+
t.Helper()
337350
recorder := httptest.NewRecorder()
338351
mac.ServeHTTP(recorder, req)
339352
if expectedStatus != NoExpectedStatus {
@@ -346,6 +359,7 @@ func MakeRequest(t testing.TB, req *http.Request, expectedStatus int) *httptest.
346359
}
347360

348361
func MakeRequestNilResponseRecorder(t testing.TB, req *http.Request, expectedStatus int) *NilResponseRecorder {
362+
t.Helper()
349363
recorder := NewNilResponseRecorder()
350364
mac.ServeHTTP(recorder, req)
351365
if expectedStatus != NoExpectedStatus {
@@ -359,6 +373,7 @@ func MakeRequestNilResponseRecorder(t testing.TB, req *http.Request, expectedSta
359373

360374
// logUnexpectedResponse logs the contents of an unexpected response.
361375
func logUnexpectedResponse(t testing.TB, recorder *httptest.ResponseRecorder) {
376+
t.Helper()
362377
respBytes := recorder.Body.Bytes()
363378
if len(respBytes) == 0 {
364379
return
@@ -381,11 +396,13 @@ func logUnexpectedResponse(t testing.TB, recorder *httptest.ResponseRecorder) {
381396
}
382397

383398
func DecodeJSON(t testing.TB, resp *httptest.ResponseRecorder, v interface{}) {
399+
t.Helper()
384400
decoder := json.NewDecoder(resp.Body)
385401
assert.NoError(t, decoder.Decode(v))
386402
}
387403

388404
func GetCSRF(t testing.TB, session *TestSession, urlStr string) string {
405+
t.Helper()
389406
req := NewRequest(t, "GET", urlStr)
390407
resp := session.MakeRequest(t, req, http.StatusOK)
391408
doc := NewHTMLParser(t, resp.Body)

0 commit comments

Comments
 (0)