-
Notifications
You must be signed in to change notification settings - Fork 7
/
healthcheck_test.go
272 lines (221 loc) · 6.75 KB
/
healthcheck_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
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
package healthcheck_test
import (
"fmt"
"net"
"net/http"
"runtime"
"time"
"code.cloudfoundry.org/healthcheck"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"github.com/onsi/gomega/ghttp"
)
var _ = Describe("HealthCheck", func() {
itReturnsHealthCheckError := func(healthCheck func() error, code int, reason string) {
err := healthCheck()
Expect(err).To(HaveOccurred())
Expect(err).To(BeAssignableToTypeOf(healthcheck.HealthCheckError{}))
hErr := err.(healthcheck.HealthCheckError)
Expect(hErr.Code).To(Equal(code))
Expect(hErr.Message).To(ContainSubstring(reason))
}
var (
server *ghttp.Server
serverAddr string
ip string
uri string
port string
timeout time.Duration
serverDelay time.Duration
hc healthcheck.HealthCheck
handler func(http.ResponseWriter, *http.Request)
)
BeforeEach(func() {
ip = getNonLoopbackIP()
server = ghttp.NewUnstartedServer()
listener, err := net.Listen("tcp", ip+":0")
Expect(err).NotTo(HaveOccurred())
timeout = 100 * time.Millisecond
serverDelay = 0
server.HTTPTestServer.Listener = listener
serverAddr = listener.Addr().String()
_, port, err = net.SplitHostPort(serverAddr)
Expect(err).NotTo(HaveOccurred())
handler = func(http.ResponseWriter, *http.Request) {
time.Sleep(serverDelay)
}
})
JustBeforeEach(func() {
server.RouteToHandler("GET", "/api/_ping", handler)
server.Start()
hc = healthcheck.NewHealthCheck("tcp", uri, port, timeout)
})
AfterEach(func() {
if server != nil {
server.CloseClientConnections()
server.Close()
}
})
Describe("check interfaces", func() {
It("succeeds when there are healthy interfaces", func() {
interfaces, err := net.Interfaces()
Expect(err).NotTo(HaveOccurred())
err = hc.CheckInterfaces(interfaces)
Expect(err).NotTo(HaveOccurred())
})
Context("when the server is failing", func() {
AfterEach(func() {
server = nil
})
It("fails appropriately when there are unhealthy interfaces", func() {
server.Close()
interfaces, err := net.Interfaces()
Expect(err).NotTo(HaveOccurred())
err = hc.CheckInterfaces(interfaces)
Expect(err).To(HaveOccurred())
Expect(err).To(BeAssignableToTypeOf(healthcheck.HealthCheckError{}))
hErr := err.(healthcheck.HealthCheckError)
// fails with different error codes on Linux (4) or OSX (64)
// check to see it was not the NO interfaces error (3)
Expect(hErr.Code).ToNot(Equal(3))
})
})
It("fails appropriately when there are no interfaces", func() {
err := hc.CheckInterfaces(nil)
Expect(err).To(HaveOccurred())
Expect(err).To(BeAssignableToTypeOf(healthcheck.HealthCheckError{}))
hErr := err.(healthcheck.HealthCheckError)
Expect(hErr.Code).To(Equal(3))
Expect(hErr.Message).To(ContainSubstring("failure to find suitable interface"))
})
})
Describe("port healthcheck", func() {
portHealthCheck := func() error {
return hc.PortHealthCheck(ip)
}
BeforeEach(func() {
uri = ""
})
Context("when the address is listening", func() {
It("succeeds", func() {
Expect(portHealthCheck()).To(Succeed())
})
})
Context("when the address is not listening", func() {
BeforeEach(func() {
port = "-1"
})
It("returns healthcheck error with code 4 with an appropriate message", func() {
errMsg := fmt.Sprintf("failed to make TCP connection to %s:%s: dial tcp: address %s: invalid port", ip, port, port)
itReturnsHealthCheckError(portHealthCheck, 4, errMsg)
})
})
Context("when the server is slow in responding", func() {
BeforeEach(func() {
if runtime.GOOS == "windows" {
Skip("TCP timeout tests are unreliable on Windows")
}
timeout = time.Nanosecond
})
It("returns healthcheck error with code 64 with an appropriate message", func() {
errMsg := fmt.Sprintf("failed to make TCP connection to %s:%s: timed out after 0.00 seconds", ip, port)
itReturnsHealthCheckError(portHealthCheck, 64, errMsg)
})
})
})
Describe("http healthcheck", func() {
httpHealthCheck := func() error {
return hc.HTTPHealthCheck(ip)
}
BeforeEach(func() {
uri = "/api/_ping"
})
Context("when the healthcheck is properly invoked", func() {
Context("when the address is listening", func() {
It("succeeds", func() {
Expect(httpHealthCheck()).To(Succeed())
})
})
Context("when the address returns error http code", func() {
JustBeforeEach(func() {
server.RouteToHandler("GET", "/api/_ping", ghttp.RespondWith(500, ""))
})
It("returns healthcheck error with code 6 with an appropriate message", func() {
errMsg := fmt.Sprintf(
"failed to make HTTP request to '%s' on port %s: received status code 500 in",
uri,
port,
)
itReturnsHealthCheckError(httpHealthCheck, 6, errMsg)
})
})
Context("when the address is not listening", func() {
BeforeEach(func() {
port = "100003"
})
It("returns healthcheck error with code 5 with an appropriate message", func() {
errMsg := fmt.Sprintf(
"failed to make HTTP request to '%s' on port %s: connection refused",
uri,
port,
)
itReturnsHealthCheckError(httpHealthCheck, 5, errMsg)
})
})
Context("when the server is too slow to respond", func() {
BeforeEach(func() {
timeout = time.Nanosecond
serverDelay = time.Second
})
It("returns healthcheck error with code 65 with an appropriate message", func() {
errMsg := fmt.Sprintf(
"failed to make HTTP request to '%s' on port %s: timed out after %.2f seconds",
uri,
port,
timeout.Seconds(),
)
itReturnsHealthCheckError(httpHealthCheck, 65, errMsg)
})
})
Context("with a tls-aware endpoint", func() {
var request *http.Request
BeforeEach(func() {
uri = "/api/_ping"
handler = func(resp http.ResponseWriter, req *http.Request) {
request = req
time.Sleep(serverDelay)
}
})
It("should set the x-Forwarded-proto header", func() {
err := hc.HTTPHealthCheck(ip)
Expect(err).NotTo(HaveOccurred())
Expect(request.Header.Get("X-Forwarded-Proto")).To(Equal("https"))
})
It("should set the User-Agent header", func() {
err := hc.HTTPHealthCheck(ip)
Expect(err).NotTo(HaveOccurred())
Expect(request.Header.Get("User-Agent")).To(Equal("diego-healthcheck"))
})
})
})
})
})
func getNonLoopbackIP() string {
interfaces, err := net.Interfaces()
Expect(err).NotTo(HaveOccurred())
for _, intf := range interfaces {
addrs, err := intf.Addrs()
if err != nil {
continue
}
for _, a := range addrs {
if ipnet, ok := a.(*net.IPNet); ok && !ipnet.IP.IsLoopback() {
if ipnet.IP.To4() != nil {
return ipnet.IP.String()
}
}
}
}
Fail("no non-loopback address found")
panic("non-reachable")
}