-
Notifications
You must be signed in to change notification settings - Fork 7
/
main_test.go
399 lines (327 loc) · 16.5 KB
/
main_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
397
398
399
package main
import (
"os"
"reflect"
"testing"
"time"
"github.com/facundoolano/ngtop/ngtop"
)
func TestDurationParsing(t *testing.T) {
var duration time.Time
var err error
now := NowTimeFun()
assertEqual(t, now, time.Date(2024, time.July, 24, 0, 7, 0, 0, time.UTC))
// default to now
duration, err = parseDuration("now")
assertEqual(t, nil, err)
assertEqual(t, duration, now)
// support each unit s, m, h, d, w, M
duration, err = parseDuration("1s")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 24, 0, 6, 59, 0, time.UTC))
duration, err = parseDuration("10s")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 24, 0, 6, 50, 0, time.UTC))
duration, err = parseDuration("1m")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 24, 0, 6, 0, 0, time.UTC))
duration, err = parseDuration("5m")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 24, 0, 2, 0, 0, time.UTC))
duration, err = parseDuration("1h")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 23, 23, 7, 0, 0, time.UTC))
duration, err = parseDuration("5h")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 23, 19, 7, 0, 0, time.UTC))
duration, err = parseDuration("1d")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 23, 0, 7, 0, 0, time.UTC))
duration, err = parseDuration("5d")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 19, 0, 7, 0, 0, time.UTC))
duration, err = parseDuration("1w")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 17, 0, 7, 0, 0, time.UTC))
duration, err = parseDuration("2w")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.July, 10, 0, 7, 0, 0, time.UTC))
// (months are just 30 days not actual calendar months)
duration, err = parseDuration("1M")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.June, 24, 0, 7, 0, 0, time.UTC))
duration, err = parseDuration("2M")
assertEqual(t, nil, err)
assertEqual(t, duration, time.Date(2024, time.May, 25, 0, 7, 0, 0, time.UTC))
// fail on unknown unit
_, err = parseDuration("1x")
assert(t, err != nil)
// fail on bad syntax
_, err = parseDuration("asdassd")
assert(t, err != nil)
}
func TestWhereConditionParsing(t *testing.T) {
var cond map[string][]string
var err error
cond, err = resolveWhereConditions([]string{"url=/blog", "useragent=Safari", "ua=Firefox", "referer=olano%", "os!=Windows"})
assertEqual(t, err, nil)
assertEqual(t, cond, map[string][]string{
"path": {"/blog"},
"user_agent": {"Safari", "Firefox"},
"referer": {"olano%"},
"os": {"!Windows"},
})
// include error on unknown field
_, err = resolveWhereConditions([]string{"pepe=/blog"})
assert(t, err != nil)
// include bad syntax
_, err = resolveWhereConditions([]string{"url"})
assert(t, err != nil)
}
const SAMPLE_LOGS = `xx.xx.xx.xx - - [24/Jul/2024:00:00:28 +0000] "GET /feed HTTP/1.1" 301 169 "-" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36"
xx.xx.xx.xx - - [24/Jul/2024:00:00:30 +0000] "GET /feed HTTP/1.1" 301 169 "-" "feedi/0.1.0 (+https://github.com/facundoolano/feedi)"
xx.xx.xx.xx - - [24/Jul/2024:00:00:56 +0000] "GET /blog/deconstructing-the-role-playing-videogame/ HTTP/1.1" 200 14224 "-" "feedi/0.1.0 (+https://github.com/facundoolano/feedi)"
xx.xx.xx.xx - - [24/Jul/2024:00:01:18 +0000] "GET /feed.xml HTTP/1.1" 200 9641 "https://olano.dev/feed.xml" "FreshRSS/1.24.0 (Linux; https://freshrss.org)"
xx.xx.xx.xx - facundo [24/Jul/2024:00:01:20 +0000] "GET /feed.xml HTTP/1.1" 200 9641 "https://olano.dev/feed.xml" "FreshRSS/1.24.0 (Linux; https://freshrss.org)"
xx.xx.xx.xx - facundo [24/Jul/2024:00:01:51 +0000] "GET /feed.xml HTTP/1.1" 200 9641 "https://olano.dev/feed.xml" "FreshRSS/1.24.0 (Linux; https://freshrss.org)"
xx.xx.xx.xx - - [24/Jul/2024:00:02:17 +0000] "GET / HTTP/1.1" 200 1120 "https://olano.dev/" "SimplePie/1.8.0 (Feed Parser; http://simplepie.org; Allow like Gecko) Build/1674203855"
xx.xx.xx.xx - - [24/Jul/2024:00:04:49 +0000] "GET /blog/mi-descubrimiento-de-america HTTP/1.1" 301 169 "-" "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 5X Build/MMB29P) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.6478.126 Mobile Safari/537.36 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
xx.xx.xx.xx - - [24/Jul/2024:00:06:41 +0000] "GET /blog/a-few-more-things-you-can-do-on-your-website HTTP/1.1" 301 169 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9"
xx.xx.xx.xx - - [24/Jul/2024:00:06:41 +0000] "GET /blog/a-note-on-essential-complexity HTTP/1.1" 301 169 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9"
xx.xx.xx.xx - - [24/Jul/2024:00:06:41 +0000] "GET /blog/posdata-de-borges-y-bioy HTTP/1.1" 301 169 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9"`
func TestBasicQuery(t *testing.T) {
columns, rows := runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{})
assertEqual(t, columns, []string{"#reqs"})
assertEqual(t, rows[0][0], "11")
columns, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url"})
assertEqual(t, columns, []string{"path", "#reqs"})
assertEqual(t, len(rows), 5)
assertEqual(t, rows[0], []string{"/feed.xml", "3"})
assertEqual(t, rows[1], []string{"/feed", "2"})
assertEqual(t, rows[2][1], "1")
assertEqual(t, rows[3][1], "1")
assertEqual(t, rows[4][1], "1")
}
func TestDateFiltering(t *testing.T) {
_, rows := runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{})
assertEqual(t, rows[0][0], "11")
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"-s", "1m"})
assertEqual(t, rows[0][0], "3")
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"-u", "1m"})
assertEqual(t, rows[0][0], "8")
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"-s", "4m", "-u", "1m"})
assertEqual(t, rows[0][0], "1")
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"-s", "1h"})
assertEqual(t, rows[0][0], "11")
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"-u", "1h"})
assertEqual(t, rows[0][0], "0")
}
func TestLimit(t *testing.T) {
_, rows := runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url"})
assertEqual(t, len(rows), 5)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-l", "3"})
assertEqual(t, len(rows), 3)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-l", "10"})
assertEqual(t, len(rows), 8) // not that many distinct urls
}
func TestMultiField(t *testing.T) {
columns, rows := runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "method"})
assertEqual(t, columns, []string{"path", "method", "#reqs"})
assertEqual(t, len(rows), 5)
assertEqual(t, rows[0], []string{"/feed.xml", "GET", "3"})
assertEqual(t, rows[1], []string{"/feed", "GET", "2"})
assertEqual(t, rows[2][1], "GET")
assertEqual(t, rows[3][1], "GET")
assertEqual(t, rows[4][1], "GET")
columns, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "status"})
assertEqual(t, columns, []string{"path", "status", "#reqs"})
assertEqual(t, len(rows), 5)
assertEqual(t, rows[0], []string{"/feed.xml", "200", "3"})
assertEqual(t, rows[1], []string{"/feed", "301", "2"})
columns, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"method", "status"})
assertEqual(t, columns, []string{"method", "status", "#reqs"})
assertEqual(t, len(rows), 2)
assertEqual(t, rows[0], []string{"GET", "301", "6"})
assertEqual(t, rows[1], []string{"GET", "200", "5"})
columns, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"status", "method"})
assertEqual(t, columns, []string{"status", "method", "#reqs"})
assertEqual(t, len(rows), 2)
assertEqual(t, rows[0], []string{"301", "GET", "6"})
assertEqual(t, rows[1], []string{"200", "GET", "5"})
columns, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"user"})
assertEqual(t, columns, []string{"user", "#reqs"})
assertEqual(t, len(rows), 2)
assertEqual(t, rows[0], []string{"", "9"})
assertEqual(t, rows[1], []string{"facundo", "2"})
}
func TestWhereFilter(t *testing.T) {
columns, rows := runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status=200"})
assertEqual(t, columns, []string{"path", "#reqs"})
assertEqual(t, len(rows), 3)
assertEqual(t, rows[0], []string{"/feed.xml", "3"})
assertEqual(t, rows[1][1], "1")
assertEqual(t, rows[2][1], "1")
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status=301", "-l", "10"})
assertEqual(t, len(rows), 5)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "method=GET"})
assertEqual(t, len(rows), 5)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "method=get"})
assertEqual(t, len(rows), 5)
}
func TestWhereMultipleValues(t *testing.T) {
_, rows := runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status=200", "-w", "status=301"})
assertEqual(t, len(rows), 5)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status=200", "-w", "status=301", "-l", "10"})
assertEqual(t, len(rows), 8)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "ua=feedi"})
assertEqual(t, len(rows), 2)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "ua=feedi", "-w", "status=200"})
assertEqual(t, len(rows), 1)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "ua=feedi", "-w", "status=200", "-w", "status=301"})
assertEqual(t, len(rows), 2)
}
func TestWherePattern(t *testing.T) {
_, rows := runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "url=/feed%"})
assertEqual(t, len(rows), 2)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "url=/blog/%"})
assertEqual(t, len(rows), 5)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status=3%"})
assertEqual(t, len(rows), 5)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status=2%"})
assertEqual(t, len(rows), 3)
}
func TestWhereNegation(t *testing.T) {
_, rows := runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status!=200", "-l", "10"})
assertEqual(t, len(rows), 5)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status!=301", "-l", "10"})
assertEqual(t, len(rows), 3)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status!=2%", "-l", "10"})
assertEqual(t, len(rows), 5)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "status!=3%", "-l", "10"})
assertEqual(t, len(rows), 3)
_, rows = runCommand(t, DEFAULT_LOG_FORMAT, SAMPLE_LOGS, []string{"url", "-w", "url!=/feed%", "-w", "url!=/", "-l", "10"})
assertEqual(t, len(rows), 5)
}
func TestCustomFormat(t *testing.T) {
format := `$remote_addr [$time_iso8601] $server_name $document_root $host $uri $content_type`
sample := `xx.xx.xx.xx [2024-07-24T00:00:49+00:00] jorge.olano.dev /var/www/jorge jorge.olano.dev /index.html -
xx.xx.xx.xx [2024-07-24T00:00:51+00:00] jorge.olano.dev /var/www/jorge jorge.olano.dev /assets/css/main.css -`
columns, rows := runCommand(t, format, sample, []string{})
assertEqual(t, columns, []string{"#reqs"})
assertEqual(t, rows[0][0], "2")
columns, rows = runCommand(t, format, sample, []string{"uri"})
assertEqual(t, columns, []string{"path", "#reqs"})
assertEqual(t, len(rows), 2)
columns, rows = runCommand(t, format, sample, []string{"host"})
assertEqual(t, columns, []string{"host", "#reqs"})
assertEqual(t, len(rows), 1)
assertEqual(t, rows[0][0], "jorge.olano.dev")
}
func TestMismatchedLine(t *testing.T) {
sample := `xx.xx.xx.xx - - [24/Jul/2024:00:00:28 +0000] "GET /feed HTTP/1.1" 301 169 "-" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36"
this has a different format
xx.xx.xx.xx - - [24/Jul/2024:00:00:30 +0000] "GET /feed HTTP/1.1" 301 169 "-" "feedi/0.1.0 (+https://github.com/facundoolano/feedi)"`
_, rows := runCommand(t, DEFAULT_LOG_FORMAT, sample, []string{})
assertEqual(t, rows[0][0], "2")
}
func TestMultipleLogFiles(t *testing.T) {
// TODO implement test
// more than one file in a dir, honoring the glob pattern
// include gzipped value
}
func TestUpdatedLog(t *testing.T) {
// TODO refactor runCommand to reduce duplication here
logFile, err := os.CreateTemp("", "access.log")
assertEqual(t, err, nil)
defer os.Remove(logFile.Name())
dbFile, err := os.CreateTemp("", "ngtop.db")
assertEqual(t, err, nil)
defer os.Remove(dbFile.Name())
parser := ngtop.NewParser(DEFAULT_LOG_FORMAT)
dbs, err := ngtop.InitDB(dbFile.Name(), parser.Fields)
assertEqual(t, err, nil)
defer dbs.Close()
os.Args = []string{"ngtop"}
_, spec := querySpecFromCLI()
bytesWritten, err := logFile.Write([]byte(`xx.xx.xx.xx - - [24/Jul/2024:00:00:28 +0000] "GET /feed HTTP/1.1" 301 169 "-" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36"
xx.xx.xx.xx - - [24/Jul/2024:00:00:30 +0000] "GET /feed HTTP/1.1" 301 169 "-" "feedi/0.1.0 (+https://github.com/facundoolano/feedi)"`))
assertEqual(t, err, nil)
previousOffset := bytesWritten
err = loadLogs(parser, logFile.Name(), dbs)
assertEqual(t, err, nil)
_, rows, err := dbs.QueryTop(spec)
assertEqual(t, err, nil)
assertEqual(t, rows[0][0], "2")
// append more logs to file
bytesWritten, err = logFile.WriteAt([]byte(`
xx.xx.xx.xx - - [24/Jul/2024:00:00:56 +0000] "GET /blog/deconstructing-the-role-playing-videogame/ HTTP/1.1" 200 14224 "-" "feedi/0.1.0 (+https://github.com/facundoolano/feedi)"
xx.xx.xx.xx - - [24/Jul/2024:00:01:18 +0000] "GET /feed.xml HTTP/1.1" 200 9641 "https://olano.dev/feed.xml" "FreshRSS/1.24.0 (Linux; https://freshrss.org)"`), int64(previousOffset))
assertEqual(t, err, nil)
previousOffset += bytesWritten
// run again with more entries and expect to see new requests
err = loadLogs(parser, logFile.Name(), dbs)
assertEqual(t, err, nil)
_, rows, err = dbs.QueryTop(spec)
assertEqual(t, err, nil)
assertEqual(t, rows[0][0], "4")
// run again without more entries, count should be the same
err = loadLogs(parser, logFile.Name(), dbs)
assertEqual(t, err, nil)
_, rows, err = dbs.QueryTop(spec)
assertEqual(t, err, nil)
assertEqual(t, rows[0][0], "4")
// append another one with the same date as the previous last one
_, err = logFile.WriteAt([]byte(`
xx.xx.xx.xx - - [24/Jul/2024:00:01:18 +0000] "GET /blog/deconstructing-the-role-playing-videogame/ HTTP/1.1" 200 14224 "-" "feedi/0.1.0 (+https://github.com/facundoolano/feedi)"`), int64(previousOffset))
assertEqual(t, err, nil)
// check that the new request is added even though it has the same date as the cut out one
err = loadLogs(parser, logFile.Name(), dbs)
assertEqual(t, err, nil)
_, rows, err = dbs.QueryTop(spec)
assertEqual(t, err, nil)
assertEqual(t, rows[0][0], "5")
}
// ------ HELPERS --------
func runCommand(t *testing.T, format string, logs string, cliArgs []string) ([]string, [][]string) {
// write the logs to a temp file, and point the NGTOP_LOGS_PATH env to it
logFile, err := os.CreateTemp("", "access.log")
assertEqual(t, err, nil)
defer os.Remove(logFile.Name())
_, err = logFile.Write([]byte(logs))
assertEqual(t, err, nil)
// create a one-off db file for the test
dbFile, err := os.CreateTemp("", "ngtop.db")
assertEqual(t, err, nil)
defer os.Remove(dbFile.Name())
os.Args = append([]string{"ngtop"}, cliArgs...)
_, spec := querySpecFromCLI()
parser := ngtop.NewParser(format)
dbs, err := ngtop.InitDB(dbFile.Name(), parser.Fields)
assertEqual(t, err, nil)
defer dbs.Close()
err = loadLogs(parser, logFile.Name(), dbs)
assertEqual(t, err, nil)
columnNames, rowValues, err := dbs.QueryTop(spec)
assertEqual(t, err, nil)
return columnNames, rowValues
}
func TestMain(m *testing.M) {
// override the time.Now function to make the since/until durations simpler to calculate
// from the sample log dates
NowTimeFun = func() time.Time {
return time.Date(2024, time.July, 24, 0, 7, 0, 0, time.UTC)
}
m.Run()
}
func assert(t *testing.T, cond bool) {
t.Helper()
if !cond {
t.Fatalf("condition is false")
}
}
func assertEqual(t *testing.T, a interface{}, b interface{}) {
t.Helper()
if !reflect.DeepEqual(a, b) {
t.Fatalf("%v != %v", a, b)
}
}