Skip to content

Commit 830a1b9

Browse files
committed
refactor: refactor codebase for improved readability and context handling
- Add a new `.golangci.yml` configuration file with specified linters and formatters - Rename `DB` parameter to `db` in `NewStoreWithDB` function in `redis.go` - Add `context` package import in `tester.go` and `tester_options_samesite_go1.11.go` - Replace `http.NewRequest` with `http.NewRequestWithContext` in multiple test functions in `tester.go` and `tester_options_samesite_go1.11.go` - Refactor constants `sessionName` and `ok` into a single `const` block in `tester.go` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
1 parent 5414a53 commit 830a1b9

4 files changed

Lines changed: 76 additions & 27 deletions

File tree

.golangci.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
version: "2"
2+
linters:
3+
default: none
4+
enable:
5+
- bodyclose
6+
- dogsled
7+
- dupl
8+
- errcheck
9+
- exhaustive
10+
- gochecknoinits
11+
- goconst
12+
- gocritic
13+
- gocyclo
14+
- goprintffuncname
15+
- gosec
16+
- govet
17+
- ineffassign
18+
- lll
19+
- misspell
20+
- nakedret
21+
- noctx
22+
- nolintlint
23+
- rowserrcheck
24+
- staticcheck
25+
- unconvert
26+
- unparam
27+
- unused
28+
- whitespace
29+
exclusions:
30+
generated: lax
31+
presets:
32+
- comments
33+
- common-false-positives
34+
- legacy
35+
- std-error-handling
36+
paths:
37+
- third_party$
38+
- builtin$
39+
- examples$
40+
formatters:
41+
enable:
42+
- gofmt
43+
- gofumpt
44+
- goimports
45+
exclusions:
46+
generated: lax
47+
paths:
48+
- third_party$
49+
- builtin$
50+
- examples$

redis/redis.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ func NewStore(size int, network, address, username, password string, keyPairs ..
4747
// Returns:
4848
// - Store: The created session store.
4949
// - error: An error if the store could not be created.
50-
func NewStoreWithDB(size int, network, address, username, password, DB string, keyPairs ...[]byte) (Store, error) {
51-
s, err := redistore.NewRediStoreWithDB(size, network, address, username, password, DB, keyPairs...)
50+
func NewStoreWithDB(size int, network, address, username, password, db string, keyPairs ...[]byte) (Store, error) {
51+
s, err := redistore.NewRediStoreWithDB(size, network, address, username, password, db, keyPairs...)
5252
if err != nil {
5353
return nil, err
5454
}

tester/tester.go

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
package tester
55

66
import (
7+
"context"
78
"net/http"
89
"net/http/httptest"
910
"strings"
@@ -15,13 +16,10 @@ import (
1516

1617
type storeFactory func(*testing.T) sessions.Store
1718

18-
const sessionName = "mysession"
19-
20-
const ok = "ok"
21-
22-
func init() {
23-
gin.SetMode(gin.TestMode)
24-
}
19+
const (
20+
sessionName = "mysession"
21+
ok = "ok"
22+
)
2523

2624
func GetSet(t *testing.T, newStore storeFactory) {
2725
r := gin.Default()
@@ -44,11 +42,11 @@ func GetSet(t *testing.T, newStore storeFactory) {
4442
})
4543

4644
res1 := httptest.NewRecorder()
47-
req1, _ := http.NewRequest("GET", "/set", nil)
45+
req1, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/set", nil)
4846
r.ServeHTTP(res1, req1)
4947

5048
res2 := httptest.NewRecorder()
51-
req2, _ := http.NewRequest("GET", "/get", nil)
49+
req2, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/get", nil)
5250
copyCookies(req2, res1)
5351
r.ServeHTTP(res2, req2)
5452
}
@@ -81,16 +79,16 @@ func DeleteKey(t *testing.T, newStore storeFactory) {
8179
})
8280

8381
res1 := httptest.NewRecorder()
84-
req1, _ := http.NewRequest("GET", "/set", nil)
82+
req1, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/set", nil)
8583
r.ServeHTTP(res1, req1)
8684

8785
res2 := httptest.NewRecorder()
88-
req2, _ := http.NewRequest("GET", "/delete", nil)
86+
req2, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/delete", nil)
8987
copyCookies(req2, res1)
9088
r.ServeHTTP(res2, req2)
9189

9290
res3 := httptest.NewRecorder()
93-
req3, _ := http.NewRequest("GET", "/get", nil)
91+
req3, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/get", nil)
9492
copyCookies(req3, res2)
9593
r.ServeHTTP(res3, req3)
9694
}
@@ -128,16 +126,16 @@ func Flashes(t *testing.T, newStore storeFactory) {
128126
})
129127

130128
res1 := httptest.NewRecorder()
131-
req1, _ := http.NewRequest("GET", "/set", nil)
129+
req1, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/set", nil)
132130
r.ServeHTTP(res1, req1)
133131

134132
res2 := httptest.NewRecorder()
135-
req2, _ := http.NewRequest("GET", "/flash", nil)
133+
req2, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/flash", nil)
136134
copyCookies(req2, res1)
137135
r.ServeHTTP(res2, req2)
138136

139137
res3 := httptest.NewRecorder()
140-
req3, _ := http.NewRequest("GET", "/check", nil)
138+
req3, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/check", nil)
141139
copyCookies(req3, res2)
142140
r.ServeHTTP(res3, req3)
143141
}
@@ -173,11 +171,11 @@ func Clear(t *testing.T, newStore storeFactory) {
173171
})
174172

175173
res1 := httptest.NewRecorder()
176-
req1, _ := http.NewRequest("GET", "/set", nil)
174+
req1, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/set", nil)
177175
r.ServeHTTP(res1, req1)
178176

179177
res2 := httptest.NewRecorder()
180-
req2, _ := http.NewRequest("GET", "/check", nil)
178+
req2, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/check", nil)
181179
copyCookies(req2, res1)
182180
r.ServeHTTP(res2, req2)
183181
}
@@ -231,23 +229,23 @@ func Options(t *testing.T, newStore storeFactory) {
231229
testOptionSameSitego(t, r)
232230

233231
res1 := httptest.NewRecorder()
234-
req1, _ := http.NewRequest("GET", "/domain", nil)
232+
req1, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/domain", nil)
235233
r.ServeHTTP(res1, req1)
236234

237235
res2 := httptest.NewRecorder()
238-
req2, _ := http.NewRequest("GET", "/path", nil)
236+
req2, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/path", nil)
239237
r.ServeHTTP(res2, req2)
240238

241239
res3 := httptest.NewRecorder()
242-
req3, _ := http.NewRequest("GET", "/set", nil)
240+
req3, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/set", nil)
243241
r.ServeHTTP(res3, req3)
244242

245243
res4 := httptest.NewRecorder()
246-
req4, _ := http.NewRequest("GET", "/expire", nil)
244+
req4, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/expire", nil)
247245
r.ServeHTTP(res4, req4)
248246

249247
res5 := httptest.NewRecorder()
250-
req5, _ := http.NewRequest("GET", "/check", nil)
248+
req5, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/check", nil)
251249
r.ServeHTTP(res5, req5)
252250

253251
for _, c := range res1.Header().Values("Set-Cookie") {
@@ -298,11 +296,11 @@ func Many(t *testing.T, newStore storeFactory) {
298296
})
299297

300298
res1 := httptest.NewRecorder()
301-
req1, _ := http.NewRequest("GET", "/set", nil)
299+
req1, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/set", nil)
302300
r.ServeHTTP(res1, req1)
303301

304302
res2 := httptest.NewRecorder()
305-
req2, _ := http.NewRequest("GET", "/get", nil)
303+
req2, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/get", nil)
306304
header := ""
307305
for _, x := range res1.Header()["Set-Cookie"] {
308306
header += strings.Split(x, ";")[0] + "; \n"

tester/tester_options_samesite_go1.11.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
package tester
55

66
import (
7+
"context"
78
"net/http"
89
"net/http/httptest"
910
"strings"
@@ -25,7 +26,7 @@ func testOptionSameSitego(t *testing.T, r *gin.Engine) {
2526
})
2627

2728
res3 := httptest.NewRecorder()
28-
req3, _ := http.NewRequest("GET", "/sameSite", nil)
29+
req3, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/sameSite", nil)
2930
r.ServeHTTP(res3, req3)
3031

3132
s := strings.Split(res3.Header().Get("Set-Cookie"), ";")

0 commit comments

Comments
 (0)