Repository navigation
Expand file tree
/
Copy pathfollowparser_test.go
More file actions
483 lines (424 loc) · 16.2 KB
/
Copy pathfollowparser_test.go
File metadata and controls
483 lines (424 loc) · 16.2 KB
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
package followparser
import (
"bytes"
"fmt"
"io"
"log"
"os"
"path/filepath"
"strings"
"testing"
"time"
"github.com/stretchr/testify/require"
)
func init() {
log.SetOutput(io.Discard)
}
type testParser struct {
buf *bytes.Buffer
duration float64
}
// Helper to write a test file with repeated lines
func writeTestFile(path string, line string, count int) error {
fh, err := os.Create(path)
if err != nil {
return err
}
defer fh.Close()
for range count {
if _, err := fh.WriteString(line); err != nil {
return err
}
}
return fh.Sync()
}
func (p *testParser) Parse(b []byte) error {
p.buf.Write(b)
p.buf.WriteString("\n")
return nil
}
func (p *testParser) Finish(duration float64) {
p.duration = duration
}
func (p *testParser) Slurp() *bytes.Buffer {
return p.buf
}
func TestParse(t *testing.T) {
tmpdir := t.TempDir()
logFileName := filepath.Join(tmpdir, "log")
fh, err := os.Create(logFileName)
require.NoError(t, err, "failed to create log file")
for i := range 2 {
buf := bytes.NewBufferString("")
parser := &testParser{
buf: buf,
duration: 0,
}
msg := fmt.Sprintf("msg msg %08d\n", i)
_, _ = fh.WriteString(msg)
fp := &Parser{
WorkDir: tmpdir,
Callback: parser,
}
r, err := fp.Parse("logPos", logFileName)
require.NoError(t, err, "failed to parse log file")
out := parser.Slurp().String()
require.Equal(t, msg, out, "read output does not match expected")
require.Len(t, r, 1, "result len must be 1")
require.Equal(t, 1, r[0].Rows, "result[0].Rows must be 1")
require.Equal(t, int64(17), r[0].EndPos-r[0].StartPos, "r[0].EndPos - r[0].StartPos must be 17")
}
time.Sleep(time.Second)
msg3 := fmt.Sprintf("msg msg %08d\n", 3)
_, _ = fh.WriteString(msg3)
fh.Close()
_ = os.Rename(logFileName, filepath.Join(tmpdir, "log.1"))
fh, err = os.Create(logFileName)
require.NoError(t, err, "failed to create new log file")
msg4 := fmt.Sprintf("msg msg %08d\n", 4)
_, _ = fh.WriteString(msg4)
buf := bytes.NewBufferString("")
parser := &testParser{
buf: buf,
duration: 0,
}
fp := &Parser{
WorkDir: tmpdir,
Callback: parser,
Silent: true,
}
r, err := fp.Parse("logPos", logFileName)
require.NoError(t, err, "failed to parse log file")
out := parser.Slurp().String()
require.Equal(t, msg3+msg4, out, "read output does not match expected")
require.GreaterOrEqual(t, parser.duration, 1.0, "duration must be at least 1")
require.Len(t, r, 2, "result len must be 2")
require.Equal(t, 1, r[0].Rows, "result[0].Rows must be 1")
require.Equal(t, 1, r[1].Rows, "result[1].Rows must be 1")
// --- Archive directory move test starts here ---
archiveDir := filepath.Join(tmpdir, "archive")
err = os.Mkdir(archiveDir, 0755)
require.NoError(t, err, "failed to create archive directory")
// Append to the log file
fh.Close()
fh, err = os.OpenFile(logFileName, os.O_APPEND|os.O_WRONLY, 0644)
require.NoError(t, err, "failed to open log file for appending")
msg5 := fmt.Sprintf("msg msg %08d\n", 5)
_, _ = fh.WriteString(msg5)
fh.Close()
// Move log file to archive directory
archivedLog := filepath.Join(archiveDir, "log.2")
err = os.Rename(logFileName, archivedLog)
require.NoError(t, err, "failed to move log file to archive directory")
// Create a new log file and write to it
fh, err = os.Create(logFileName)
require.NoError(t, err, "failed to create new log file")
msg6 := fmt.Sprintf("msg msg %08d\n", 6)
_, _ = fh.WriteString(msg6)
fh.Close()
buf = bytes.NewBufferString("")
parser = &testParser{
buf: buf,
duration: 0,
}
fp = &Parser{
WorkDir: tmpdir,
Callback: parser,
ArchiveDir: archiveDir,
Silent: true,
}
r, err = fp.Parse("logPos", logFileName)
require.NoError(t, err, "failed to parse log file after archive move")
out = parser.Slurp().String()
require.Equal(t, msg5+msg6, out, "archive follow read output does not match expected")
require.Len(t, r, 2, "archive follow result len must be 2")
require.Equal(t, 1, r[0].Rows, "archive follow result[0].Rows must be 1")
require.Equal(t, 1, r[1].Rows, "archive follow result[1].Rows must be 1")
}
func TestParseWithNoCommitPosFile(t *testing.T) {
tmpdir := t.TempDir()
logFileName := filepath.Join(tmpdir, "log")
fh, err := os.Create(logFileName)
require.NoError(t, err, "failed to create log file")
lastmsg := strings.Builder{}
var fp *Parser
for i := range 2 {
buf := bytes.NewBufferString("")
parser := &testParser{
buf: buf,
duration: 0,
}
msg := fmt.Sprintf("msg msg %08d\n", i)
lastmsg.WriteString(msg)
_, _ = fh.WriteString(msg)
fp = &Parser{
WorkDir: tmpdir,
Callback: parser,
NoAutoCommitPosFile: true,
}
r, err := fp.Parse("logPos", logFileName)
require.NoError(t, err, "failed to parse log file with NoAutoCommitPosFile")
out := parser.Slurp().String()
require.Equal(t, lastmsg.String(), out, "read output does not match expected")
require.Len(t, r, 1, "result len must be 1")
require.Equal(t, i+1, r[0].Rows, "result[0].Rows must be i+1")
require.Equal(t, int64(17*(i+1)), r[0].EndPos-r[0].StartPos, "r[0].EndPos - r[0].StartPos must be 17*(i+1)")
}
errCommit := fp.CommitPosFile()
require.NoError(t, errCommit, "failed to commit pos file")
{
buf := bytes.NewBufferString("")
parser := &testParser{
buf: buf,
duration: 0,
}
msg3 := fmt.Sprintf("msg msg %08d\n", 3)
_, _ = fh.WriteString(msg3)
fp = &Parser{
WorkDir: tmpdir,
Callback: parser,
NoAutoCommitPosFile: false,
}
r, err := fp.Parse("logPos", logFileName)
require.NoError(t, err, "failed to parse log file after committing pos file")
out := parser.Slurp().String()
require.Equal(t, msg3, out, "read output does not match expected")
require.Len(t, r, 1, "result len must be 1")
require.Equal(t, 1, r[0].Rows, "result[0].Rows must be 1")
require.Equal(t, int64(17), r[0].EndPos-r[0].StartPos, "r[0].EndPos - r[0].StartPos must be 17")
}
}
// Test when the last line in the log file does not end with a newline,
// then the file is appended to. Ensure appended content is followed.
func TestParseAppendAfterNoTrailingNewline(t *testing.T) {
tmpdir := t.TempDir()
logFileName := filepath.Join(tmpdir, "log")
fh, err := os.Create(logFileName)
require.NoError(t, err, "failed to create log file")
// write a line without a trailing newline
previousMsg := fmt.Sprintf("msg msg %08d\n", 7)
previousMsg += fmt.Sprintf("msg msg %08d\n", 8)
previousMsg += fmt.Sprintf("msg msg %08d\n", 9)
msgNoNLBefore := "msg "
_, err = fh.WriteString(previousMsg + msgNoNLBefore)
require.NoError(t, err, "failed to write initial content to log file")
_ = fh.Sync()
// First parse: should read the existing line (even without newline)
buf := bytes.NewBufferString("")
parser := &testParser{buf: buf}
fp := &Parser{
WorkDir: tmpdir,
Callback: parser,
Silent: true,
}
r, err := fp.Parse("logPosNoNL", logFileName)
require.NoError(t, err, "failed to parse log file with no trailing newline")
out := parser.Slurp().String()
require.Equal(t, previousMsg, out, "first read output does not match expected")
require.Len(t, r, 1, "first result len must be 1")
// Append new content (with newline) to the same file
fh, err = os.OpenFile(logFileName, os.O_APPEND|os.O_WRONLY, 0644)
require.NoError(t, err, "failed to open log file for appending")
msgNoNLAfter := fmt.Sprintf("msg %08d\n", 10)
msgAppend := fmt.Sprintf("msg msg %08d\n", 11)
_, err = fh.WriteString(msgNoNLAfter + msgAppend)
require.NoError(t, err, "failed to write appended content to log file")
fh.Close()
// Second parse using same pos file name: should read only appended content
buf2 := bytes.NewBufferString("")
parser2 := &testParser{buf: buf2}
fp2 := &Parser{
WorkDir: tmpdir,
Callback: parser2,
Silent: true,
}
r2, err := fp2.Parse("logPosNoNL", logFileName)
require.NoError(t, err, "failed to parse log file after appending content")
out2 := parser2.Slurp().String()
require.Equal(t, msgNoNLBefore+msgNoNLAfter+msgAppend, out2, "second read output does not match expected")
require.Len(t, r2, 1, "second result len must be 1")
}
// Test a single line longer than DefaultStartBufSize is read properly
func TestParseSingleLongLine(t *testing.T) {
tmpdir := t.TempDir()
logFileName := filepath.Join(tmpdir, "log")
fh, err := os.Create(logFileName)
require.NoError(t, err, "failed to create log file")
// create a single long line > DefaultStartBufSize
longLen := DefaultStartBufSize + 100
data := bytes.Repeat([]byte("A"), longLen)
// ensure newline at end so Scanner treats it as a line
_, err = fh.Write(data)
require.NoError(t, err, "failed to write long line to log file")
_, err = fh.WriteString("\n")
require.NoError(t, err, "failed to write newline to log file")
fh.Close()
buf := bytes.NewBufferString("")
parser := &testParser{buf: buf}
fp := &Parser{
WorkDir: tmpdir,
Callback: parser,
Silent: true,
}
r, err := fp.Parse("logPosLong", logFileName)
require.NoError(t, err, "failed to parse log file with single long line")
out := parser.Slurp().String()
expected := string(data) + "\n"
require.Equal(t, expected, out, "read output does not match expected")
require.Len(t, r, 1, "result len must be 1")
require.Equal(t, 1, r[0].Rows, "result[0].Rows must be 1")
require.Equal(t, int64(len(expected)), r[0].EndPos-r[0].StartPos, "r[0].EndPos - r[0].StartPos must be len(expected)")
}
// Test rotate: old (archived) file's last line has no trailing newline
// and should still be read after rotation.
func TestRotateReadOldFileWithNoTrailingNewline(t *testing.T) {
tmpdir := t.TempDir()
logFileName := filepath.Join(tmpdir, "log")
fh, err := os.Create(logFileName)
require.NoError(t, err, "failed to create log file")
// write first line with newline and parse to set pos file
msg1 := fmt.Sprintf("msg msg %08d\n", 30)
_, err = fh.WriteString(msg1)
require.NoError(t, err, "failed to write first line to log file")
_ = fh.Sync()
buf := bytes.NewBufferString("")
parser := &testParser{buf: buf}
fp := &Parser{WorkDir: tmpdir, Callback: parser, Silent: true}
r, err := fp.Parse("logPosRotateNoNL", logFileName)
require.NoError(t, err, "failed to parse log file after first write")
require.Len(t, r, 1, "initial parse result len must be 1")
// append a line WITHOUT trailing newline
msg2 := fmt.Sprintf("msg msg %08d", 31)
fh, err = os.OpenFile(logFileName, os.O_APPEND|os.O_WRONLY, 0644)
require.NoError(t, err, "failed to open log file for appending")
_, err = fh.WriteString(msg2)
require.NoError(t, err, "failed to write second line to log file")
fh.Close()
// rotate the log (rename to archive)
archived := filepath.Join(tmpdir, "log.1")
err = os.Rename(logFileName, archived)
require.NoError(t, err, "failed to rotate log file")
// create a new log file and write another line
fh, err = os.Create(logFileName)
require.NoError(t, err, "failed to create new log file")
msg3 := fmt.Sprintf("msg msg %08d\n", 32)
_, err = fh.WriteString(msg3)
require.NoError(t, err, "failed to write third line to log file")
fh.Close()
// parse again: it should find the archived file and read msg2 (no newline)
buf2 := bytes.NewBufferString("")
parser2 := &testParser{buf: buf2}
fp2 := &Parser{WorkDir: tmpdir, Callback: parser2, Silent: true}
r2, err := fp2.Parse("logPosRotateNoNL", logFileName)
require.NoError(t, err, "failed to parse log file after rotation")
out := parser2.Slurp().String()
expected := msg2 + "\n" + msg3
require.Equal(t, expected, out, "rotate read output does not match expected")
require.Len(t, r2, 2, "rotate result len must be 2")
require.Equal(t, 1, r2[0].Rows, "rotate result[0].Rows must be 1")
require.Equal(t, 1, r2[1].Rows, "rotate result[1].Rows must be 1")
}
func TestTruncated(t *testing.T) {
tmpdir := t.TempDir()
logFileName := filepath.Join(tmpdir, "truncate-log")
fh, err := os.Create(logFileName)
require.NoError(t, err, "failed to create log file")
// write initial lines
var lines = 10
for i := range lines {
msg := fmt.Sprintf("msg msg %08d\n", i)
_, err = fh.WriteString(msg)
require.NoError(t, err, "failed to write initial content to log file")
}
_ = fh.Sync()
buf := bytes.NewBufferString("")
parser := &testParser{buf: buf}
fp := &Parser{WorkDir: tmpdir, Callback: parser, Silent: true}
r, err := fp.Parse("logPosTruncateNoNL", logFileName)
require.NoError(t, err, "failed to parse log file after initial write")
require.Equal(t, 1, len(r), "initial parse result len must be equal to 1")
require.Equal(t, lines, r[0].Rows, "initial parse result rows must be equal to lines")
fh.Close()
// truncate the log
err = os.Truncate(logFileName, 0)
require.NoError(t, err, "failed to truncate log file")
// reopen and write a new line
fh, err = os.OpenFile(logFileName, os.O_APPEND|os.O_WRONLY, 0644)
require.NoError(t, err, "failed to open log file for appending")
msg3 := fmt.Sprintf("msg msg %08d\n", 32)
_, err = fh.WriteString(msg3)
require.NoError(t, err, "failed to write new line to log file")
fh.Close()
// parse again: it should be truncated and read only the new line
buf2 := bytes.NewBufferString("")
parser2 := &testParser{buf: buf2}
fp2 := &Parser{WorkDir: tmpdir, Callback: parser2, Silent: false}
r2, err := fp2.Parse("logPosTruncateNoNL", logFileName)
require.NoError(t, err, "failed to parse log file after truncation")
out := parser2.Slurp().String()
expected := msg3
require.Equal(t, expected, out, "truncated read output does not match expected")
require.Len(t, r2, 1, "truncated result len must be 1")
require.Equal(t, 1, r2[0].Rows, "truncated result[0].Rows must be 1")
}
// TestParseSymlinkSameDir verifies that parsing works when logFile is a
// symlink pointing to the actual log file in the same directory, including
// rotation detection when the symlink target changes.
func TestParseSymlinkSameDir(t *testing.T) {
tmpdir := t.TempDir()
// Create the initial actual log file and a symlink to it.
actualLog1 := filepath.Join(tmpdir, "access_log.20260828")
symlinkLog := filepath.Join(tmpdir, "access.log")
fh, err := os.Create(actualLog1)
require.NoError(t, err, "failed to create initial actual log file")
err = os.Symlink(actualLog1, symlinkLog)
require.NoError(t, err, "failed to create symlink to initial log file")
msg1 := fmt.Sprintf("msg msg %08d\n", 1)
_, err = fh.WriteString(msg1)
require.NoError(t, err, "failed to write to initial actual log file")
fh.Close()
// First parse: should read through the symlink.
buf := bytes.NewBufferString("")
parser := &testParser{buf: buf}
fp := &Parser{
WorkDir: tmpdir,
Callback: parser,
Silent: true,
}
r, err := fp.Parse("logPosSymlink", symlinkLog)
require.NoError(t, err, "failed to parse symlinked log file")
require.Equal(t, msg1, parser.Slurp().String(), "first read output does not match expected")
require.Len(t, r, 1, "first result len must be 1")
require.Equal(t, 1, r[0].Rows, "first result[0].Rows must be 1")
// Simulate rotation: create a new actual log file and repoint the symlink.
actualLog2 := filepath.Join(tmpdir, "access_log.20260829")
fh, err = os.Create(actualLog2)
require.NoError(t, err, "failed to create rotated actual log file")
msg2 := fmt.Sprintf("msg msg %08d\n", 2)
_, err = fh.WriteString(msg2)
require.NoError(t, err, "failed to write to rotated actual log file")
fh.Close()
err = os.Remove(symlinkLog)
require.NoError(t, err, "failed to remove old symlink")
err = os.Symlink(actualLog2, symlinkLog)
require.NoError(t, err, "failed to create symlink to rotated log file")
// Second parse: should detect rotation and read from the new symlink target.
buf2 := bytes.NewBufferString("")
parser2 := &testParser{buf: buf2}
fp2 := &Parser{
WorkDir: tmpdir,
Callback: parser2,
ArchiveDir: tmpdir,
Silent: true,
}
r2, err := fp2.Parse("logPosSymlink", symlinkLog)
require.NoError(t, err, "failed to parse after symlink rotation")
// Rotation is detected because the symlink now points at a different inode.
// The previous target is still present in ArchiveDir (same as tmpdir here),
// so parseRotated also parses it, but it contributes zero new rows because
// it was already fully read.
require.Equal(t, msg2, parser2.Slurp().String(), "second read output does not match expected")
require.Len(t, r2, 2, "second result len must be 2")
require.Equal(t, 0, r2[0].Rows, "second result[0].Rows must be 0 (old file already fully read)")
require.Equal(t, 1, r2[1].Rows, "second result[1].Rows must be 1")
}