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
|
// SPDX-License-Identifier: GPL-3.0-or-later
package logs
import (
"bufio"
"fmt"
"io"
"os"
"path/filepath"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestReader_Read(t *testing.T) {
reader, teardown := prepareTestReader(t)
defer teardown()
r := testReader{bufio.NewReader(reader)}
filename := reader.CurrentFilename()
numLogs := 5
var sum int
for i := 0; i < 10; i++ {
appendLogs(t, filename, time.Millisecond*10, numLogs)
n, err := r.readUntilEOF()
sum += n
assert.Equal(t, io.EOF, err)
assert.Equal(t, numLogs*(i+1), sum)
}
}
func TestReader_Read_HandleFileRotation(t *testing.T) {
reader, teardown := prepareTestReader(t)
defer teardown()
r := testReader{bufio.NewReader(reader)}
filename := reader.CurrentFilename()
numLogs := 5
rotateFile(t, filename)
appendLogs(t, filename, time.Millisecond*10, numLogs)
n, err := r.readUntilEOFTimes(maxEOF)
assert.Equal(t, io.EOF, err)
assert.Equal(t, 0, n)
appendLogs(t, filename, time.Millisecond*10, numLogs)
n, err = r.readUntilEOF()
assert.Equal(t, io.EOF, err)
assert.Equal(t, numLogs, n)
}
func TestReader_Read_HandleFileRotationWithDelay(t *testing.T) {
reader, teardown := prepareTestReader(t)
defer teardown()
r := testReader{bufio.NewReader(reader)}
filename := reader.CurrentFilename()
_ = os.Remove(filename)
// trigger reopen first time
n, err := r.readUntilEOFTimes(maxEOF)
assert.Equal(t, ErrNoMatchedFile, err)
assert.Equal(t, 0, n)
f, err := os.Create(filename)
require.NoError(t, err)
_ = f.Close()
// trigger reopen 2nd time
n, err = r.readUntilEOF()
assert.Equal(t, io.EOF, err)
assert.Equal(t, 0, n)
numLogs := 5
appendLogs(t, filename, time.Millisecond*10, numLogs)
n, err = r.readUntilEOF()
assert.Equal(t, io.EOF, err)
assert.Equal(t, numLogs, n)
}
func TestReader_Close(t *testing.T) {
reader, teardown := prepareTestReader(t)
defer teardown()
assert.NoError(t, reader.Close())
assert.Nil(t, reader.file)
}
func TestReader_Close_NilFile(t *testing.T) {
var r Reader
assert.NoError(t, r.Close())
}
func TestOpen(t *testing.T) {
tempFileName1 := prepareTempFile(t, "*-web_log-open-test-1.log")
tempFileName2 := prepareTempFile(t, "*-web_log-open-test-2.log")
tempFileName3 := prepareTempFile(t, "*-web_log-open-test-3.log")
defer func() {
_ = os.Remove(tempFileName1)
_ = os.Remove(tempFileName2)
_ = os.Remove(tempFileName3)
}()
makePath := func(s string) string {
return filepath.Join(os.TempDir(), s)
}
tests := []struct {
name string
path string
exclude string
err bool
}{
{
name: "match without exclude",
path: makePath("*-web_log-open-test-[1-3].log"),
},
{
name: "match with exclude",
path: makePath("*-web_log-open-test-[1-3].log"),
exclude: makePath("*-web_log-open-test-[2-3].log"),
},
{
name: "exclude everything",
path: makePath("*-web_log-open-test-[1-3].log"),
exclude: makePath("*"),
err: true,
},
{
name: "no match",
path: makePath("*-web_log-no-match-test-[1-3].log"),
err: true,
},
{
name: "bad path pattern",
path: "[qw",
err: true,
},
{
name: "bad exclude path pattern",
path: "[qw",
err: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
r, err := Open(tt.path, tt.exclude, nil)
if tt.err {
assert.Error(t, err)
} else {
assert.NoError(t, err)
assert.NotNil(t, r.file)
_ = r.Close()
}
})
}
}
func TestReader_CurrentFilename(t *testing.T) {
reader, teardown := prepareTestReader(t)
defer teardown()
assert.Equal(t, reader.file.Name(), reader.CurrentFilename())
}
type testReader struct {
*bufio.Reader
}
func (r *testReader) readUntilEOF() (n int, err error) {
for {
_, err = r.ReadBytes('\n')
if err != nil {
break
}
n++
}
return n, err
}
func (r *testReader) readUntilEOFTimes(times int) (sum int, err error) {
var n int
for i := 0; i < times; i++ {
n, err = r.readUntilEOF()
if err != io.EOF {
break
}
sum += n
}
return sum, err
}
func prepareTempFile(t *testing.T, pattern string) string {
t.Helper()
f, err := os.CreateTemp("", pattern)
require.NoError(t, err)
return f.Name()
}
func prepareTestReader(t *testing.T) (reader *Reader, teardown func()) {
t.Helper()
filename := prepareTempFile(t, "*-web_log-test.log")
f, err := os.Open(filename)
require.NoError(t, err)
teardown = func() {
_ = os.Remove(filename)
_ = reader.file.Close()
}
reader = &Reader{
file: f,
path: filename,
}
return reader, teardown
}
func rotateFile(t *testing.T, filename string) {
t.Helper()
require.NoError(t, os.Remove(filename))
f, err := os.Create(filename)
require.NoError(t, err)
_ = f.Close()
}
func appendLogs(t *testing.T, filename string, interval time.Duration, numOfLogs int) {
t.Helper()
base := filepath.Base(filename)
file, err := os.OpenFile(filename, os.O_RDWR|os.O_APPEND, os.ModeAppend)
require.NoError(t, err)
require.NotNil(t, file)
defer func() { _ = file.Close() }()
for i := 0; i < numOfLogs; i++ {
_, err = fmt.Fprintln(file, "line", i, "filename", base)
require.NoError(t, err)
time.Sleep(interval)
}
}
|
