-
Notifications
You must be signed in to change notification settings - Fork 38
/
prom_test.go
226 lines (188 loc) · 6.04 KB
/
prom_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
package ginprom
import (
"fmt"
"net/http"
"sync"
"testing"
"github.com/appleboy/gofight/v2"
"github.com/gin-gonic/gin"
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/assert"
)
func unregister(p *Prometheus) {
prometheus.Unregister(p.reqCnt)
prometheus.Unregister(p.reqDur)
prometheus.Unregister(p.reqSz)
prometheus.Unregister(p.resSz)
}
func init() {
gin.SetMode(gin.TestMode)
}
func TestPrometheus_Use(t *testing.T) {
p := New()
r := gin.New()
p.Use(r)
assert.Equal(t, 1, len(r.Routes()), "only one route should be added")
assert.NotNil(t, p.Engine, "the engine should not be empty")
assert.Equal(t, r, p.Engine, "used router should be the same")
assert.Equal(t, r.Routes()[0].Path, p.MetricsPath, "the path should match the metrics path")
unregister(p)
}
func TestPath(t *testing.T) {
p := New()
assert.Equal(t, p.MetricsPath, defaultPath, "no usage of path should yield default path")
unregister(p)
valid := []string{"/metrics", "/home", "/x/x", ""}
for _, tt := range valid {
p = New(Path(tt))
assert.Equal(t, p.MetricsPath, tt)
unregister(p)
}
}
func TestEngine(t *testing.T) {
r := gin.New()
p := New(Engine(r))
assert.Equal(t, 1, len(r.Routes()), "only one route should be added")
assert.NotNil(t, p.Engine, "engine should not be nil")
assert.Equal(t, r.Routes()[0].Path, p.MetricsPath, "the path should match the metrics path")
assert.Equal(t, p.MetricsPath, defaultPath, "path should be default")
unregister(p)
}
func TestNamespace(t *testing.T) {
p := New()
assert.Equal(t, p.Namespace, defaultNs, "namespace should be default")
unregister(p)
tests := []string{
"test",
"",
"_",
}
for _, test := range tests {
p = New(Namespace(test))
assert.Equal(t, p.Namespace, test, "should match")
unregister(p)
}
}
func TestSubsystem(t *testing.T) {
p := New()
assert.Equal(t, p.Subsystem, defaultSys, "subsystem should be default")
unregister(p)
tests := []string{
"test",
"",
"_",
}
for _, test := range tests {
p = New(Subsystem(test))
assert.Equal(t, p.Subsystem, test, "should match")
unregister(p)
}
}
func TestUse(t *testing.T) {
r := gin.New()
p := New()
g := gofight.New()
g.GET(p.MetricsPath).Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusNotFound, r.Code)
})
p.Use(r)
g.GET(p.MetricsPath).Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
})
unregister(p)
}
func TestInstrument(t *testing.T) {
r := gin.New()
p := New(Engine(r))
r.Use(p.Instrument())
path := "/user/:id"
lpath := fmt.Sprintf(`path="%s"`, path)
r.GET(path, func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"id": c.Param("id")})
})
g := gofight.New()
g.GET(p.MetricsPath).Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
assert.NotContains(t, r.Body.String(), fmt.Sprintf("%s_requests_total", p.Subsystem))
assert.NotContains(t, r.Body.String(), lpath, "path must not be present in the response")
})
g.GET("/user/10").Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) { assert.Equal(t, http.StatusOK, r.Code) })
g.GET(p.MetricsPath).Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
assert.Contains(t, r.Body.String(), fmt.Sprintf("%s_requests_total", p.Subsystem))
assert.Contains(t, r.Body.String(), lpath, "path must be present in the response")
assert.NotContains(t, r.Body.String(), `path="/user/10"`, "raw path must not be present")
})
unregister(p)
}
func TestThreadedInstrument(t *testing.T) {
r := gin.New()
p := New(Engine(r))
r.Use(p.Instrument())
path := "/user/:id"
lpath := fmt.Sprintf(`path="%s"`, path)
r.GET(path, func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"id": c.Param("id")})
})
var wg sync.WaitGroup
for n := 0; n < 10; n++ {
go func(wg *sync.WaitGroup) {
g := gofight.New()
g.GET("/user/10").Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) { assert.Equal(t, http.StatusOK, r.Code) })
g.GET(p.MetricsPath).Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
assert.Contains(t, r.Body.String(), fmt.Sprintf("%s_requests_total", p.Subsystem))
assert.Contains(t, r.Body.String(), lpath, "path must be present in the response")
assert.NotContains(t, r.Body.String(), `path="/user/10"`, "raw path must not be present")
})
wg.Done()
}(&wg)
wg.Add(1)
}
wg.Wait()
unregister(p)
}
func TestEmptyRouter(t *testing.T) {
r := gin.New()
p := New()
r.Use(p.Instrument())
r.GET("/", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{}) })
g := gofight.New()
assert.NotPanics(t, func() {
g.GET("/").Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {})
})
unregister(p)
}
func TestIgnore(t *testing.T) {
r := gin.New()
ipath := "/ping"
lipath := fmt.Sprintf(`path="%s"`, ipath)
p := New(Engine(r), Ignore(ipath))
r.Use(p.Instrument())
r.GET(ipath, func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"status": "ok"})
})
g := gofight.New()
g.GET(p.MetricsPath).Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
assert.NotContains(t, r.Body.String(), fmt.Sprintf("%s_requests_total", p.Subsystem))
})
g.GET("/ping").Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) { assert.Equal(t, http.StatusOK, r.Code) })
g.GET(p.MetricsPath).Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
assert.NotContains(t, r.Body.String(), fmt.Sprintf("%s_requests_total", p.Subsystem))
assert.NotContains(t, r.Body.String(), lipath, "ignored path must not be present")
})
unregister(p)
}
func TestMetricsPathIgnored(t *testing.T) {
r := gin.New()
p := New(Engine(r))
r.Use(p.Instrument())
g := gofight.New()
g.GET(p.MetricsPath).Run(r, func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
assert.NotContains(t, r.Body.String(), fmt.Sprintf("%s_requests_total", p.Subsystem))
})
unregister(p)
}