-
Notifications
You must be signed in to change notification settings - Fork 751
/
mysqld_exporter_test.go
396 lines (362 loc) · 8.89 KB
/
mysqld_exporter_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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
// Copyright 2018 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package main
import (
"context"
"fmt"
"io"
"net"
"net/http"
"net/url"
"os"
"os/exec"
"reflect"
"runtime"
"strings"
"syscall"
"testing"
"time"
"github.com/google/go-cmp/cmp"
"github.com/prometheus/mysqld_exporter/collector"
)
// bin stores information about path of executable and attached port
type bin struct {
path string
port int
}
// TestBin builds, runs and tests binary.
func TestBin(t *testing.T) {
var err error
binName := "mysqld_exporter"
binDir, err := os.MkdirTemp("/tmp", binName+"-test-bindir-")
if err != nil {
t.Fatal(err)
}
defer func() {
err := os.RemoveAll(binDir)
if err != nil {
t.Fatal(err)
}
}()
importpath := "github.com/prometheus/common"
path := binDir + "/" + binName
xVariables := map[string]string{
importpath + "/version.Version": "gotest-version",
importpath + "/version.Branch": "gotest-branch",
importpath + "/version.Revision": "gotest-revision",
}
var ldflags []string
for x, value := range xVariables {
ldflags = append(ldflags, fmt.Sprintf("-X %s=%s", x, value))
}
cmd := exec.Command(
"go",
"build",
"-o",
path,
"-ldflags",
strings.Join(ldflags, " "),
)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
err = cmd.Run()
if err != nil {
t.Fatalf("Failed to build: %s", err)
}
tests := []func(*testing.T, bin){
testLanding,
testProbe,
}
portStart := 56000
t.Run(binName, func(t *testing.T) {
for _, f := range tests {
f := f // capture range variable
fName := runtime.FuncForPC(reflect.ValueOf(f).Pointer()).Name()
portStart++
data := bin{
path: path,
port: portStart,
}
t.Run(fName, func(t *testing.T) {
t.Parallel()
f(t, data)
})
}
})
}
func testLanding(t *testing.T, data bin) {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
// Run exporter.
cmd := exec.CommandContext(
ctx,
data.path,
"--web.listen-address", fmt.Sprintf(":%d", data.port),
"--config.my-cnf=test_exporter.cnf",
)
if err := cmd.Start(); err != nil {
t.Fatal(err)
}
defer cmd.Wait()
defer cmd.Process.Kill()
// Get the main page.
urlToGet := fmt.Sprintf("http://127.0.0.1:%d", data.port)
body, err := waitForBody(urlToGet)
if err != nil {
t.Fatal(err)
}
got := string(body)
expected := `<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>MySQLd Exporter</title>
<style>body {
font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,Liberation Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;
margin: 0;
}
header {
background-color: #e6522c;
color: #fff;
font-size: 1rem;
padding: 1rem;
}
main {
padding: 1rem;
}
label {
display: inline-block;
width: 0.5em;
}
#pprof {
border: black 2px solid;
padding: 1rem;
width: fit-content;
}
</style>
</head>
<body>
<header>
<h1>MySQLd Exporter</h1>
</header>
<main>
<h2>Prometheus Exporter for MySQL servers</h2>
<div>Version: (version=gotest-version, branch=gotest-branch, revision=gotest-revision)</div>
<div>
<ul>
<li><a href="/metrics">Metrics</a></li>
</ul>
</div>
<div id="pprof">
Download a detailed report of resource usage (pprof format, from the Go runtime):
<ul>
<li><a href="debug/pprof/heap">heap usage (memory)</a>
<li><a href="debug/pprof/profile?seconds=60">CPU usage (60 second profile)</a>
</ul>
To visualize and share profiles you can upload to <a href="https://pprof.me" target="_blank">pprof.me</a>
</div>
</main>
</body>
</html>
`
if diff := cmp.Diff(expected, got); diff != "" {
t.Fatalf("expected != got \n%v\n", diff)
}
}
func testProbe(t *testing.T, data bin) {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
// Run exporter.
cmd := exec.CommandContext(
ctx,
data.path,
"--web.listen-address", fmt.Sprintf(":%d", data.port),
"--config.my-cnf=test_exporter.cnf",
)
if err := cmd.Start(); err != nil {
t.Fatal(err)
}
defer cmd.Wait()
defer cmd.Process.Kill()
// Get the main page.
urlToGet := fmt.Sprintf("http://127.0.0.1:%d/probe", data.port)
body, err := waitForBody(urlToGet)
if err != nil {
t.Fatal(err)
}
got := strings.TrimSpace(string(body))
expected := `target is required`
if got != expected {
t.Fatalf("got '%s' but expected '%s'", got, expected)
}
}
// waitForBody is a helper function which makes http calls until http server is up
// and then returns body of the successful call.
func waitForBody(urlToGet string) (body []byte, err error) {
tries := 60
// Get data, but we need to wait a bit for http server.
for i := 0; i <= tries; i++ {
// Try to get web page.
body, err = getBody(urlToGet)
if err == nil {
return body, err
}
// If there is a syscall.ECONNREFUSED error (web server not available) then retry.
if urlError, ok := err.(*url.Error); ok {
if opError, ok := urlError.Err.(*net.OpError); ok {
if osSyscallError, ok := opError.Err.(*os.SyscallError); ok {
if osSyscallError.Err == syscall.ECONNREFUSED {
time.Sleep(1 * time.Second)
continue
}
}
}
}
// There was an error, and it wasn't syscall.ECONNREFUSED.
return nil, err
}
return nil, fmt.Errorf("failed to GET %s after %d tries: %s", urlToGet, tries, err)
}
// getBody is a helper function which retrieves http body from given address.
func getBody(urlToGet string) ([]byte, error) {
resp, err := http.Get(urlToGet)
if err != nil {
return nil, err
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
return body, nil
}
func Test_filterScrapers(t *testing.T) {
type args struct {
scrapers []collector.Scraper
collectParams []string
}
tests := []struct {
name string
args args
want []collector.Scraper
}{
{"args_appears_in_collector",
args{
[]collector.Scraper{collector.ScrapeGlobalStatus{}},
[]string{collector.ScrapeGlobalStatus{}.Name()},
},
[]collector.Scraper{
collector.ScrapeGlobalStatus{},
}},
{"args_absent_in_collector",
args{
[]collector.Scraper{collector.ScrapeGlobalStatus{}},
[]string{collector.ScrapeGlobalVariables{}.Name()},
},
[]collector.Scraper{collector.ScrapeGlobalStatus{}}},
{"respect_params",
args{
[]collector.Scraper{
collector.ScrapeGlobalStatus{},
collector.ScrapeGlobalVariables{},
},
[]string{collector.ScrapeGlobalStatus{}.Name()},
},
[]collector.Scraper{
collector.ScrapeGlobalStatus{},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := filterScrapers(tt.args.scrapers, tt.args.collectParams); !reflect.DeepEqual(got, tt.want) {
t.Errorf("filterScrapers() = %v, want %v", got, tt.want)
}
})
}
}
func Test_getScrapeTimeoutSeconds(t *testing.T) {
type args struct {
timeoutHeader string
offset float64
}
tests := []struct {
name string
args args
wantTimeout float64
wantErr bool
}{
{"no_timeout_header",
args{},
0, false,
},
{"zero_timeout_header",
args{
timeoutHeader: "0",
},
0, false,
},
{"negative_timeout_header",
args{
timeoutHeader: "-5",
},
0, true,
},
{"offset_greater_than_timeout",
args{
timeoutHeader: "5",
offset: 6,
},
0, true,
},
{"offset_equal_timeout",
args{
timeoutHeader: "5",
offset: 5,
},
0, true,
},
{"offset_less_than_timeout",
args{
timeoutHeader: "5",
offset: 1,
},
4, false,
},
{"no_offset",
args{
timeoutHeader: "5",
},
5, false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
request, err := http.NewRequest(http.MethodGet, "", nil)
if err != nil {
t.Fatalf("unexpected error creating http request: %v", err)
}
request.Header.Set("X-Prometheus-Scrape-Timeout-Seconds", tt.args.timeoutHeader)
timeout, err := getScrapeTimeoutSeconds(request, tt.args.offset)
if err != nil && !tt.wantErr {
t.Fatalf("unexpected error: %v", err)
}
if err == nil && tt.wantErr {
t.Fatal("expecting an error, got nil")
}
if timeout != tt.wantTimeout {
t.Fatalf("unexpected timeout, got '%f' but expected '%f'", timeout, tt.wantTimeout)
}
})
}
}