-
-
Notifications
You must be signed in to change notification settings - Fork 105
/
handler_test.go
191 lines (168 loc) · 5.4 KB
/
handler_test.go
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
// Copyright © 2022 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package healthx
import (
"encoding/json"
"errors"
"io/ioutil"
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/julienschmidt/httprouter"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/ory/herodot"
)
func TestHealth(t *testing.T) {
const mockHeaderKey = "middleware-header"
const mockHeaderValue = "test-header-value"
const mockVersion = "test version"
// middlware to run an assert function on the requested handler
testMiddleware := func(t *testing.T, assertFunc func(*testing.T, http.ResponseWriter, *http.Request)) func(next http.Handler) http.Handler {
return func(h http.Handler) http.Handler {
return http.HandlerFunc(func(writer http.ResponseWriter, req *http.Request) {
writer.Header().Add(mockHeaderKey, mockHeaderValue)
assertFunc(t, writer, req)
h.ServeHTTP(writer, req)
})
}
}
assertAliveCheck := func(t *testing.T, endpoint string, handler *Handler) *http.Response {
var healthBody swaggerHealthStatus
c := http.DefaultClient
response, err := c.Get(endpoint)
require.NoError(t, err)
require.EqualValues(t, http.StatusOK, response.StatusCode)
require.NoError(t, json.NewDecoder(response.Body).Decode(&healthBody))
assert.EqualValues(t, "ok", healthBody.Status)
return response
}
assertVersionResponse := func(t *testing.T, endpoint string, handler *Handler) *http.Response {
var versionBody swaggerVersion
c := http.DefaultClient
response, err := c.Get(endpoint)
require.NoError(t, err)
require.EqualValues(t, http.StatusOK, response.StatusCode)
require.NoError(t, json.NewDecoder(response.Body).Decode(&versionBody))
require.EqualValues(t, mockVersion, versionBody.Version)
return response
}
assertReadyCheckNotAlive := func(t *testing.T, endpoint string, handler *Handler) *http.Response {
handler.ReadyChecks = map[string]ReadyChecker{
"test": func(r *http.Request) error {
return errors.New("not alive")
},
}
c := http.DefaultClient
response, err := c.Get(endpoint)
require.NoError(t, err)
require.EqualValues(t, http.StatusServiceUnavailable, response.StatusCode)
out, err := ioutil.ReadAll(response.Body)
require.NoError(t, err)
assert.Equal(t, "{\"error\":{\"code\":500,\"status\":\"Internal Server Error\",\"message\":\"not alive\"}}", strings.TrimSpace(string(out)))
return response
}
assertReadyCheck := func(t *testing.T, endpoint string, handler *Handler) *http.Response {
var healthCheck swaggerHealthStatus
c := http.DefaultClient
response, err := c.Get(endpoint)
require.NoError(t, err)
require.EqualValues(t, http.StatusOK, response.StatusCode)
require.NoError(t, json.NewDecoder(response.Body).Decode(&healthCheck))
require.EqualValues(t, swaggerHealthStatus{Status: "ok"}, healthCheck)
return response
}
testCases := []struct {
description string
url func(mockServerURL string) string
test func(t *testing.T, endpoint string, handler *Handler) *http.Response
}{
{
description: "ready check should return status ok",
url: func(mockServerURL string) string {
return mockServerURL + ReadyCheckPath
},
test: assertReadyCheck,
},
{
description: "ready check should return error",
url: func(mockServerURL string) string {
return mockServerURL + ReadyCheckPath
},
test: assertReadyCheckNotAlive,
},
{
description: "alive check should return status ok",
url: func(mockServerURL string) string {
return mockServerURL + AliveCheckPath
},
test: assertAliveCheck,
},
{
description: "version should return",
url: func(mockServerURL string) string {
return mockServerURL + VersionPath
},
test: assertVersionResponse,
},
}
t.Run("case=without middleware", func(t *testing.T) {
router := httprouter.New()
handler := &Handler{
H: herodot.NewJSONWriter(nil),
VersionString: mockVersion,
ReadyChecks: map[string]ReadyChecker{
"test": func(r *http.Request) error {
return nil
},
},
}
ts := httptest.NewServer(router)
defer ts.Close()
handler.SetHealthRoutes(router, true)
handler.SetVersionRoutes(router)
for _, tc := range testCases {
t.Run("case="+tc.description, func(t *testing.T) {
tc.test(t, tc.url(ts.URL), handler)
})
}
})
t.Run("case=with middleware", func(t *testing.T) {
router := httprouter.New()
var alive error
handler := &Handler{
H: herodot.NewJSONWriter(nil),
VersionString: mockVersion,
ReadyChecks: map[string]ReadyChecker{
"test": func(r *http.Request) error {
return alive
},
},
}
ts := httptest.NewServer(router)
defer ts.Close()
// set the health handlers with middleware
handler.SetHealthRoutes(router, true, WithMiddleware(
testMiddleware(t, func(t *testing.T, rw http.ResponseWriter, r *http.Request) {
assert.Equal(t, "GET", r.Method)
}),
))
handler.SetVersionRoutes(router, WithMiddleware(
testMiddleware(t, func(t *testing.T, rw http.ResponseWriter, r *http.Request) {
assert.Equal(t, "GET", r.Method)
}),
))
for _, tc := range testCases {
t.Run("case="+tc.description, func(t *testing.T) {
handler.ReadyChecks = map[string]ReadyChecker{
"test": func(r *http.Request) error {
return nil
},
}
response := tc.test(t, tc.url(ts.URL), handler)
assert.EqualValues(t, mockHeaderValue, response.Header.Get(mockHeaderKey))
})
}
})
}