-
Notifications
You must be signed in to change notification settings - Fork 1
/
logfile_test.go
492 lines (405 loc) · 11 KB
/
logfile_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
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
484
485
486
487
488
489
490
491
492
/*
File summary: logfile testing
Package: logfile
Author: Lee McLoughlin
Copyright (C) 2015 LMMR Tech Ltd All Rights Reserved.
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 logfile
import (
"fmt"
"io/ioutil"
"log"
"os"
"strings"
"testing"
"time"
)
const (
tmpDir = "/tmp"
tmpPrefix = "lftest"
showDebug = true
)
// Return a unique filename or an error
func tempFileName() (string, error) {
f, err := ioutil.TempFile(tmpDir, tmpPrefix)
if err != nil {
return "", err
}
f.Close()
debug("tempFileName " + f.Name())
return f.Name(), nil
}
func debug(msg string) {
if !showDebug {
return
}
fmt.Fprintln(os.Stderr, msg)
}
func Test_FilenameVersions(t *testing.T) {
debug("Test_Filenames start")
defer debug("Test_Filenames end")
logFileName := "example.log"
v0 := FileNameVersion(logFileName, 0)
if logFileName != v0 {
t.Errorf("FileNameVersion wrong expected %s got %s", logFileName, v0)
}
v1 := FileNameVersion(logFileName, 1)
lfv1 := logFileName + ".1"
if lfv1 != v1 {
t.Errorf("FileNameVersion wrong expected %s got %s", lfv1, v1)
}
}
func Test_DefaultCreate(t *testing.T) {
debug("Test_DefaultCreate start")
defer debug("Test_DefaultCreate end")
logFileName, err := tempFileName()
if err != nil {
t.Errorf("Failed to create temporary file: %s\n", err)
return
}
// Pretend the -logfile flag was used
Defaults.FileName = logFileName
logFile, err := New(nil)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
log.SetFlags(0)
log.SetOutput(logFile)
msg := "hello\n"
log.Print(msg)
logFile.Flush()
fi, err := os.Stat(logFileName)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
logFile.Close()
contents, err := ioutil.ReadFile(logFileName)
if err != nil {
t.Errorf("Failed to read log file %s: %s\n", logFileName, err)
return
}
size := int64(len(msg))
if fi.Size() != size {
t.Errorf("Wrong logfile size for %s expected %d got %d\n", logFileName, size, fi.Size())
} else if string(contents) != msg {
t.Errorf("Wrong logfile contents for %s expected %s got %d\n", logFileName, msg, fi.Size())
} else {
t.Log("Log file created and has correct size and contents")
}
os.Remove(logFileName)
}
func Test_BigMessages(t *testing.T) {
debug("Test_BigMessages start")
defer debug("Test_BigMessages end")
logFileName, err := tempFileName()
if err != nil {
t.Errorf("Failed to create temporary file: %s\n", err)
return
}
// Flush and check every second
// Naughty: set the internal error check timer
errorSeconds = 1
logFile, err := New(&LogFile{
FileName: logFileName,
FlushSeconds: 1,
CheckSeconds: 1,
Flags: FileOnly})
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
log.SetFlags(0)
log.SetOutput(logFile)
msg := ""
for i := 0; i < 5; i++ {
line := strings.Repeat(string('0'+i), 70) + "\n"
log.Print(line)
msg = msg + line
}
size := int64(len(msg))
// Check for log being writen
for i := 0; i < 10; i++ {
fi, err := os.Stat(logFileName)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
if fi.Size() == size {
break
}
t.Logf("Log size after %d seconds %d", i, fi.Size())
time.Sleep(time.Second)
}
// Wait a bit so flush and check are run
time.Sleep(time.Second * 3)
logFile.Close()
fi, err := os.Stat(logFileName)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
contents, err := ioutil.ReadFile(logFileName)
if err != nil {
t.Errorf("Failed to read log file %s: %s\n", logFileName, err)
return
}
if fi.Size() != size {
t.Errorf("Wrong logfile size for %s expected %d got %d\n", logFileName, size, fi.Size())
} else if string(contents) != msg {
t.Errorf("Wrong logfile contents for %s expected %s got %d\n", logFileName, msg, fi.Size())
} else {
t.Log("Log file created and has correct size and contents")
}
os.Remove(logFileName)
}
func Test_Rotation(t *testing.T) {
debug("Test_Rotation start")
defer debug("Test_Rotation end")
logFileName, err := tempFileName()
if err != nil {
t.Errorf("Failed to create temporary file: %s\n", err)
return
}
logFile, err := New(&LogFile{
FileName: logFileName,
MaxSize: 71, // Same as size of test lines below
OldVersions: 2,
Flags: FileOnly})
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
log.SetFlags(0)
log.SetOutput(logFile)
msg := ""
for i := 0; i < 5; i++ {
line := strings.Repeat(string('0'+i), 70) + "\n"
log.Print(line)
msg = msg + line
}
logFile.Close()
oldest := 4
for i := 0; i < 3; i++ {
lf := FileNameVersion(logFileName, i)
fi, err := os.Stat(lf)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", lf, err)
return
}
contents, err := ioutil.ReadFile(lf)
if err != nil {
t.Errorf("Failed to read log file %s: %s\n", lf, err)
return
}
line := strings.Repeat(string('0'+oldest), 70) + "\n"
oldest--
size := int64(len(line))
if fi.Size() != size {
t.Errorf("Wrong logfile size for %s expected %d got %d\n", lf, size, fi.Size())
} else if string(contents) != line {
t.Errorf("Wrong logfile contents for %s expected %s got %s\n", lf, line, contents)
} else {
t.Logf("Log file %s created and has correct size and contents", lf)
os.Remove(lf)
}
}
}
func Test_ExplicitRotation(t *testing.T) {
debug("Test_ExplicitRotation start")
defer debug("Test_ExplicitRotation end")
logFileName, err := tempFileName()
if err != nil {
t.Errorf("Failed to create temporary file: %s\n", err)
return
}
// Flush and check every second
logFile, err := New(&LogFile{
FileName: logFileName,
OldVersions: 2,
Flags: FileOnly})
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
log.SetFlags(0)
log.SetOutput(logFile)
line := strings.Repeat(string('0'), 70) + "\n"
log.Print(line)
t.Logf("Forcing rotation")
logFile.RotateFile()
line = strings.Repeat(string('1'), 70) + "\n"
log.Print(line)
logFile.Close()
oldest := 1
for i := 0; i < 2; i++ {
lf := FileNameVersion(logFileName, i)
fi, err := os.Stat(lf)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", lf, err)
return
}
contents, err := ioutil.ReadFile(lf)
if err != nil {
t.Errorf("Failed to read log file %s: %s\n", lf, err)
return
}
line := strings.Repeat(string('0'+oldest), 70) + "\n"
oldest--
size := int64(len(line))
if fi.Size() != size {
t.Errorf("Wrong logfile size for %s expected %d got %d\n", lf, size, fi.Size())
} else if string(contents) != line {
t.Errorf("Wrong logfile contents for %s expected %s got %s\n", lf, line, contents)
} else {
t.Logf("Log file %s created and has correct size and contents", lf)
os.Remove(lf)
}
}
}
func Test_OverWriteOnStart(t *testing.T) {
debug("Test_OverWriteOnStart start")
defer debug("Test_OverWriteOnStart end")
logFileName, err := tempFileName()
if err != nil {
t.Errorf("Failed to create temporary file: %s\n", err)
return
}
f, err := os.Create(logFileName)
if err != nil {
t.Errorf("Failed to create file %s: %s\n", logFileName, err)
return
}
fmt.Fprintf(f, "I AM GOING TO BE OVERWRITEN\n")
f.Close()
logFile, err := New(&LogFile{FileName: logFileName, Flags: OverWriteOnStart})
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
log.SetOutput(logFile)
logFile.Close()
fi, err := os.Stat(logFileName)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
if fi.Size() != 0 {
t.Errorf("Wrong logfile size for %s expected 0 got %d\n", logFileName, fi.Size())
} else {
t.Log("Log file created and has correct size")
}
os.Remove(logFileName)
}
func Test_LogVanish(t *testing.T) {
debug("Test_LogVanish start")
defer debug("Test_LogVanish end")
logFileName, err := tempFileName()
if err != nil {
t.Errorf("Failed to create temporary file: %s\n", err)
return
}
logFile, err := New(&LogFile{
FileName: logFileName,
CheckSeconds: 1,
Flags: OverWriteOnStart})
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
log.SetOutput(logFile)
log.Print("testing")
// Remove the logfile and wait long enough for LogFile to notice (CheckSeconds is 1)
os.Remove(logFileName)
time.Sleep(time.Second * 2)
// This is all that should appear in the logfile
msg := "testing again\n"
log.Print(msg)
logFile.Close()
fi, err := os.Stat(logFileName)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
if fi.Size() != int64(len(msg)) {
t.Errorf("Wrong logfile size for %s expected %d got %d\n", logFileName, len(msg), fi.Size())
} else {
t.Log("Log file created and has correct size")
}
os.Remove(logFileName)
}
func Test_AppendOnStart(t *testing.T) {
debug("Test_AppendOnStart start")
defer debug("Test_AppendOnStart end")
logFileName, err := tempFileName()
if err != nil {
t.Errorf("Failed to create temporary file: %s\n", err)
return
}
contents := "I AM GOING TO BE APPENDED TO\n"
f, err := os.Create(logFileName)
if err != nil {
t.Errorf("Failed to create file %s: %s\n", logFileName, err)
return
}
fmt.Fprint(f, contents)
f.Close()
logFile, err := New(&LogFile{FileName: logFileName})
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
log.SetFlags(0)
log.SetOutput(logFile)
fi, err := os.Stat(logFileName)
if err != nil {
t.Errorf("Failed to create log file %s: %s\n", logFileName, err)
return
}
size := int64(len(contents))
if fi.Size() != size {
t.Errorf("Wrong logfile size for %s expected %d got %d\n", logFileName, size, fi.Size())
} else {
t.Log("Log file created and has correct size")
}
os.Remove(logFileName)
}
func ExampleLogFile() {
debug("ExampleLogFile start")
defer debug("ExampleLogFile end")
logFileName, err := tempFileName()
if err != nil {
fmt.Fprintf(os.Stderr, "Failed to create temporary file: %s\n", err)
return
}
logFile, err := New(
&LogFile{
FileName: logFileName,
MaxSize: 500 * 1024,
Flags: OverWriteOnStart})
if err != nil {
fmt.Fprintf(os.Stderr, "Failed to create log file %s: %s\n", logFileName, err)
os.Exit(1)
}
log.SetOutput(logFile)
log.Print("hello")
logFile.Close()
writen, err := ioutil.ReadFile(logFileName)
if err != nil {
fmt.Fprintf(os.Stderr, "Failed to read log file %s: %s\n", logFileName, err)
os.Exit(1)
}
fmt.Print(string(writen))
// Output: hello
os.Remove(logFileName)
}