Skip to content

Commit afa4f42

Browse files
cstocktonChris Stockton
authored and
cemalkilic
committed
feat: hooks round 4 - update tests to use require package (#2030)
## Hooks Round 4 This PR will contain a series of commits preparing for the implementation of before & after user created hooks. It takes the feedback from #2012 into consideration. ### Summary [feat: hooks round 4](#2030) - update tests to use require package * use pkg `require` for tests in: [f2b3600](f2b3600) * pkg `internal/e2e/...` * pkg `internal/hooks/...` ### Depends on [feat: hooks round 1](#2023) - prepare package structure * Renamed pkg `internal/hooks/v0hooks/v0http` -> `internal/hooks/hookshttp` [8a398ab](8a398ab) * Renamed pkg `internal/hooks/v0hooks/v0pgfunc` -> `internal/hooks/hookspgfunc` [8a398ab](8a398ab) * Use pkg `internal/e2e` for test setup in: * pkg `internal/hooks/hookspgfunc` [4d60288](4d60288) * pkg `internal/hooks/v0hooks` [4a7432b](4a7432b) [feat: hooks round 2](#2025) - remove indirection and simplify error handling * update pkg `internal/api` to: * uses `internal/hooks/v0hooks.Manager` instead of `internal/hooks/hooks.Manager` [aec5995](aec5995) * remove pkg `internal/hooks/hooks.Manager` [062da5d](062da5d) * add pkg `internal/hooks/hookserrors` [7e80afc](7e80afc) * use pkg `internal/hooks/hookserrors` in `internal/hooks/v0hooks` [57744e8](57744e8) * update pkg `internal/hooks/v0hooks` with an `Enabled` method [16cc4c9](16cc4c9) [feat: hooks round 3](#2028) - begin adding the Before and After user created hooks * update pkg `internal/conf` [d5f5436](d5f5436) * add `BeforeUserCreated` and `AfterUserCreated` to `HookConfiguration` struct * add test cases for `EmailValidationBlockedMX` to restore 100% test coverage * update pkg `internal/hooks/v0hooks` [bd37fe2](bd37fe2) * add `BeforeUserCreated` method to `v0hooks.Manager` struct * add `AfterUserCreated` method to `v0hooks.Manager` struct * add tests to reach 100% coverage * add pkg `internal/e2e/e2ehooks` [903e623](903e623) * add `HookCall` to record calls to hooks * add `Hook` struct to hold `[]*HookCall` for a given hook name * add `HookRecorder` to hold one `Hook` object per hook name * add `Instance` struct to hold the `httptest.Server` and `HookRecorder` * add `AfterUserCreated` method to `v0hooks.Manager` struct * add tests to reach 100% coverage in all `internal/e2e` packages * update pkg `internal/hooks/v0hooks` [829aec6](829aec6) * fix struct and json tag to match to match the Metadata type * update pkg `internal/hooks/v0hooks` [ca67be0](ca67be0) * remove `BeforeUserCreated` and `AfterUserCreated` methods * add Before & After user created hooks in `InvokeHook` * update pkg `internal/e2e/e2eapi` [46c144e](46c144e) * add comments in IOError tests involving `http.RoundTripper` * update calls to `t.Fatal` to use `require` Co-authored-by: Chris Stockton <chris.stockton@supabase.io>
1 parent a6b2e5e commit afa4f42

File tree

6 files changed

+206
-352
lines changed

6 files changed

+206
-352
lines changed

‎internal/e2e/e2e_test.go‎

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,8 @@ func TestUtils(t *testing.T) {
3434
configPath = "abc"
3535

3636
globalCfg, err := Config()
37-
if err == nil {
38-
t.Fatal("exp non-nil err")
39-
}
40-
if globalCfg != nil {
41-
t.Fatal("exp nil conn")
42-
}
37+
require.Error(t, err)
38+
require.Nil(t, globalCfg)
4339
}
4440
}()
4541

@@ -49,9 +45,7 @@ func TestUtils(t *testing.T) {
4945
{
5046
globalCfg := Must(Config())
5147
conn := Must(Conn(globalCfg))
52-
if conn == nil {
53-
t.Fatal("exp non-nil conn")
54-
}
48+
require.NotNil(t, conn)
5549
}
5650

5751
// negative
@@ -60,12 +54,8 @@ func TestUtils(t *testing.T) {
6054
globalCfg.DB.Driver = ""
6155
globalCfg.DB.URL = "invalid"
6256
conn, err := Conn(globalCfg)
63-
if err == nil {
64-
t.Fatal("exp non-nil err")
65-
}
66-
if conn != nil {
67-
t.Fatal("exp nil conn")
68-
}
57+
require.Error(t, err)
58+
require.Nil(t, conn)
6959
}
7060

7161
}()
@@ -89,10 +79,7 @@ func TestUtils(t *testing.T) {
8979
panic(errors.New("globalCfg != nil"))
9080
}
9181
}()
92-
93-
if err == nil {
94-
t.Fatal("exp non-nil err")
95-
}
82+
require.Error(t, err)
9683
}()
9784

9885
// block init from main()
@@ -113,8 +100,6 @@ func TestUtils(t *testing.T) {
113100
}()
114101

115102
exp := "package e2e may not be used in a main package"
116-
if errStr != exp {
117-
t.Fatalf("exp %v; got %v", exp, errStr)
118-
}
103+
require.Equal(t, exp, errStr)
119104
}()
120105
}

‎internal/e2e/e2ehooks/e2ehooks_test.go‎

Lines changed: 21 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,32 @@ import (
99
"testing/iotest"
1010
"time"
1111

12+
"github.com/stretchr/testify/require"
1213
"github.com/supabase/auth/internal/conf"
1314
"github.com/supabase/auth/internal/hooks/v0hooks"
1415
)
1516

1617
func TestInstance(t *testing.T) {
1718
{
1819
globalCfg, err := conf.LoadGlobal("../../../hack/test.env")
19-
if err != nil {
20-
t.Fatalf("exp nil err; got %v", err)
21-
}
20+
require.NoError(t, err)
21+
2222
globalCfg.DB.Driver = ""
2323
globalCfg.DB.URL = "invalid"
2424

2525
inst, err := New(globalCfg)
26-
if err == nil {
27-
t.Fatal("exp non-nil err")
28-
}
29-
if inst != nil {
30-
t.Fatal("exp nil *Instance")
31-
}
26+
require.Error(t, err)
27+
require.Nil(t, inst)
3228
}
3329

3430
{
3531
globalCfg, err := conf.LoadGlobal("../../../hack/test.env")
36-
if err != nil {
37-
t.Fatalf("exp nil err; got %v", err)
38-
}
32+
require.NoError(t, err)
3933

4034
inst, err := New(globalCfg)
41-
if err != nil {
42-
t.Fatalf("exp nil err; got %v", err)
43-
}
44-
if inst == nil {
45-
t.Fatal("exp non-nil *Instance")
46-
}
47-
if err := inst.Close(); err != nil {
48-
t.Fatalf("exp nil err from Close; got %v", err)
49-
}
35+
require.NoError(t, err)
36+
require.NotNil(t, inst)
37+
require.NoError(t, inst.Close())
5038
}
5139
}
5240

@@ -58,9 +46,7 @@ func TestHook(t *testing.T) {
5846

5947
{
6048
calls := hook.GetCalls()
61-
if exp, got := 0, len(calls); exp != got {
62-
t.Fatalf("exp %v; got %v", exp, got)
63-
}
49+
require.Equal(t, 0, len(calls))
6450

6551
u := "http://localhost"
6652
rdr := strings.NewReader("12345")
@@ -70,18 +56,13 @@ func TestHook(t *testing.T) {
7056
hook.ServeHTTP(res, req)
7157

7258
calls = hook.GetCalls()
73-
if exp, got := 1, len(calls); exp != got {
74-
t.Fatalf("exp %v; got %v", exp, got)
75-
}
59+
require.Equal(t, 1, len(calls))
7660
call := calls[0]
7761

7862
var got int
79-
if err := call.Unmarshal(&got); err != nil {
80-
t.Fatalf("exp nil err; got %v", err)
81-
}
82-
if exp := 12345; exp != got {
83-
t.Fatalf("exp %v; got %v", exp, got)
84-
}
63+
err := call.Unmarshal(&got)
64+
require.NoError(t, err)
65+
require.Equal(t, 12345, got)
8566
}
8667

8768
{
@@ -138,9 +119,7 @@ func TestHookRecorder(t *testing.T) {
138119

139120
{
140121
calls := test.hook.GetCalls()
141-
if exp, got := 0, len(calls); exp != got {
142-
t.Fatalf("exp %v; got %v", exp, got)
143-
}
122+
require.Equal(t, 0, len(calls))
144123
}
145124

146125
u := "http://localhost/hooks/" + string(test.name)
@@ -151,23 +130,16 @@ func TestHookRecorder(t *testing.T) {
151130

152131
{
153132
calls := test.hook.GetCalls()
154-
if exp, got := 1, len(calls); exp != got {
155-
t.Fatalf("exp %v; got %v", exp, got)
156-
}
133+
require.Equal(t, 1, len(calls))
157134
call := calls[0]
158135

159136
test.hook.ClearCalls()
160-
if exp, got := 0, len(test.hook.GetCalls()); exp != got {
161-
t.Fatalf("exp %v; got %v", exp, got)
162-
}
137+
require.Equal(t, 0, len(test.hook.GetCalls()))
163138

164139
var got int
165-
if err := call.Unmarshal(&got); err != nil {
166-
t.Fatalf("exp nil err; got %v", err)
167-
}
168-
if exp := 12345; exp != got {
169-
t.Fatalf("exp %v; got %v", exp, got)
170-
}
140+
err := call.Unmarshal(&got)
141+
require.NoError(t, err)
142+
require.Equal(t, 12345, got)
171143
}
172144
}
173145

@@ -179,8 +151,6 @@ func TestHookRecorder(t *testing.T) {
179151
res := httptest.NewRecorder()
180152
hookRec.ServeHTTP(res, req)
181153

182-
if exp, got := 404, res.Result().StatusCode; exp != got {
183-
t.Fatalf("exp %v; got %v", exp, got)
184-
}
154+
require.Equal(t, 404, res.Result().StatusCode)
185155
}
186156
}

0 commit comments

Comments
 (0)