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
|
//go:build !integration
// +build !integration
package trace
import (
"math"
"sync"
"testing"
"unicode/utf8"
url_helpers "gitlab.com/gitlab-org/gitlab-runner/helpers/url"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestVariablesMasking(t *testing.T) {
//nolint:lll
input := "This is the secret message cont@ining :secret duplicateValues ffixx prefix prefix_mask suffix mask_suffix middle dd"
maskedValues := []string{
"is",
"duplicateValue",
"duplicateValue",
":secret",
"cont@ining",
"fix",
"prefix",
"prefix_mask",
"suffix",
"mask_suffix",
"dd",
"middle",
}
buffer, err := New()
require.NoError(t, err)
defer buffer.Close()
buffer.SetMasked(maskedValues)
_, err = buffer.Write([]byte(input))
require.NoError(t, err)
buffer.Finish()
content, err := buffer.Bytes(0, 1000)
require.NoError(t, err)
//nolint:lll
assert.Equal(t, "Th[MASKED] [MASKED] the secret message [MASKED] [MASKED] [MASKED]s f[MASKED]x [MASKED] [MASKED] [MASKED] [MASKED] [MASKED] [MASKED]", string(content))
}
func TestTraceLimit(t *testing.T) {
traceMessage := "This is the long message"
buffer, err := New()
require.NoError(t, err)
defer buffer.Close()
buffer.SetLimit(10)
assert.Equal(t, 0, buffer.Size())
for i := 0; i < 100; i++ {
n, err := buffer.Write([]byte(traceMessage))
require.NoError(t, err)
require.Greater(t, n, 0)
}
buffer.Finish()
content, err := buffer.Bytes(0, 1000)
require.NoError(t, err)
expectedContent := "This is th\n" +
"\x1b[33;1mJob's log exceeded limit of 10 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n"
assert.Equal(t, len(expectedContent), buffer.Size(), "unexpected buffer size")
assert.Equal(t, "crc32:295921ca", buffer.Checksum())
assert.Equal(t, expectedContent, string(content))
}
func TestTraceLimitEnsureValidUTF8(t *testing.T) {
tests := map[string]struct {
traceMessage string
limit int
expectedContent string
expectedChecksum string
}{
"1-byte UTF-8 characters (ASCII text)": {
traceMessage: "0123456789",
limit: 10,
expectedContent: "0123456789\n" +
"\x1b[33;1mJob's log exceeded limit of 10 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n",
expectedChecksum: "crc32:d4b99d81",
},
"2-byte UTF-8 characters": {
traceMessage: "Dz",
limit: 5,
expectedContent: "DzDz\n" +
"\x1b[33;1mJob's log exceeded limit of 5 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n",
expectedChecksum: "crc32:318d2180",
},
"2-byte UTF-8 characters on even boundary": {
traceMessage: "Dz",
limit: 6,
expectedContent: "DzDzDz\n" +
"\x1b[33;1mJob's log exceeded limit of 6 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n",
expectedChecksum: "crc32:8c2a1eda",
},
"3-byte UTF-8 characters": {
traceMessage: "─",
limit: 20,
expectedContent: "──────\n" +
"\x1b[33;1mJob's log exceeded limit of 20 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n",
expectedChecksum: "crc32:f187099c",
},
"3-byte UTF-8 characters with a limit of 1 byte": {
traceMessage: "─",
limit: 1,
expectedContent: "\n" +
"\x1b[33;1mJob's log exceeded limit of 1 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n",
expectedChecksum: "crc32:9e261b5f",
},
"4-byte UTF-8 characters": {
traceMessage: "🐤",
limit: 23,
expectedContent: "🐤🐤🐤🐤🐤\n" +
"\x1b[33;1mJob's log exceeded limit of 23 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n",
expectedChecksum: "crc32:10e32ecd",
},
"4-byte UTF-8 characters on even boundary": {
traceMessage: "🐤",
limit: 24,
expectedContent: "🐤🐤🐤🐤🐤🐤\n" +
"\x1b[33;1mJob's log exceeded limit of 24 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n",
expectedChecksum: "crc32:26e43372",
},
}
for tn, tc := range tests {
t.Run(tn, func(t *testing.T) {
buffer, err := New()
require.NoError(t, err)
defer buffer.Close()
buffer.SetLimit(tc.limit)
assert.Equal(t, 0, buffer.Size())
for i := 0; i < 100; i++ {
n, err := buffer.Write([]byte(tc.traceMessage))
require.NoError(t, err)
require.Greater(t, n, 0)
}
buffer.Finish()
content, err := buffer.Bytes(0, 1000)
require.NoError(t, err)
assert.Equal(t, len(tc.expectedContent), buffer.Size(), "unexpected buffer size")
assert.Equal(t, tc.expectedChecksum, buffer.Checksum())
assert.Equal(t, tc.expectedContent, string(content))
})
}
}
func TestDelayedMask(t *testing.T) {
buffer, err := New()
require.NoError(t, err)
defer buffer.Close()
n, err := buffer.Write([]byte("data before mask\n"))
assert.NoError(t, err)
assert.Greater(t, n, 0)
buffer.SetMasked([]string{"mask_me"})
n, err = buffer.Write([]byte("data mask_me masked\n"))
assert.NoError(t, err)
assert.Greater(t, n, 0)
buffer.Finish()
content, err := buffer.Bytes(0, 1000)
require.NoError(t, err)
expectedContent := "data before mask\ndata [MASKED] masked\n"
assert.Equal(t, len(expectedContent), buffer.Size(), "unexpected buffer size")
assert.Equal(t, "crc32:690f62e1", buffer.Checksum())
assert.Equal(t, expectedContent, string(content))
}
func TestDelayedLimit(t *testing.T) {
buffer, err := New()
require.NoError(t, err)
defer buffer.Close()
n, err := buffer.Write([]byte("data before limit\n"))
assert.NoError(t, err)
assert.Greater(t, n, 0)
buffer.SetLimit(20)
n, err = buffer.Write([]byte("data after limit\n"))
assert.NoError(t, err)
assert.Greater(t, n, 0)
buffer.Finish()
content, err := buffer.Bytes(0, 1000)
require.NoError(t, err)
expectedContent := "data before limit\nda\n\x1b[33;1mJob's log exceeded limit of 20 bytes.\n" +
"Job execution will continue but no more output will be collected.\x1b[0;m\n"
assert.Equal(t, len(expectedContent), buffer.Size(), "unexpected buffer size")
assert.Equal(t, "crc32:559aa46f", buffer.Checksum())
assert.Equal(t, expectedContent, string(content))
}
func TestTraceRace(t *testing.T) {
buffer, err := New()
require.NoError(t, err)
defer buffer.Close()
buffer.SetLimit(1000)
load := []func(){
func() { _, _ = buffer.Write([]byte("x")) },
func() { buffer.SetMasked([]string{"x"}) },
func() { buffer.SetLimit(1000) },
func() { buffer.Checksum() },
func() { buffer.Size() },
}
var wg sync.WaitGroup
for _, fn := range load {
wg.Add(1)
go func(fn func()) {
defer wg.Done()
for i := 0; i < 100; i++ {
fn()
}
}(fn)
}
wg.Wait()
buffer.Finish()
_, err = buffer.Bytes(0, 1000)
require.NoError(t, err)
}
func TestFixupInvalidUTF8(t *testing.T) {
buffer, err := New()
require.NoError(t, err)
defer buffer.Close()
buffer.SetMasked([]string{"hello", "\xfe"})
// \xfe and \xff are both invalid
// \xfe we're masking though, so will be replaced with [MASKED]
// \xff will be replaced by the "unicode replacement character" \ufffd
// this ensures that masking happens prior to the utf8 fix
_, err = buffer.Write([]byte("hello a\xfeb a\xffb\n"))
require.NoError(t, err)
content, err := buffer.Bytes(0, 1000)
require.NoError(t, err)
assert.True(t, utf8.ValidString(string(content)))
assert.Equal(t, "[MASKED] a[MASKED]b a\ufffdb\n", string(content))
}
const logLineStr = "hello world, this is a lengthy log line including secrets such as 'hello', and " +
"https://example.com/?rss_token=foo&rss_token=bar and http://example.com/?authenticity_token=deadbeef and " +
"https://example.com/?rss_token=foobar. it's longer than most log lines, but probably a good test for " +
"anything that's benchmarking how fast it is to write log lines."
var logLineByte = []byte(logLineStr)
func BenchmarkBuffer10k(b *testing.B) {
for i := 0; i < b.N; i++ {
func() {
buffer, err := New()
require.NoError(b, err)
defer buffer.Close()
buffer.SetLimit(math.MaxInt64)
buffer.SetMasked([]string{"hello"})
const N = 10000
b.ReportAllocs()
b.SetBytes(int64(len(logLineByte) * N))
for i := 0; i < N; i++ {
_, _ = buffer.Write(logLineByte)
}
buffer.Finish()
}()
}
}
func BenchmarkBuffer10kWithURLScrub(b *testing.B) {
for i := 0; i < b.N; i++ {
func() {
buffer, err := New()
require.NoError(b, err)
defer buffer.Close()
buffer.SetLimit(math.MaxInt64)
buffer.SetMasked([]string{"hello"})
const N = 10000
b.ReportAllocs()
b.SetBytes(int64(len(logLineByte) * N))
for i := 0; i < N; i++ {
_, _ = buffer.Write([]byte(url_helpers.ScrubSecrets(logLineStr)))
}
buffer.Finish()
}()
}
}
|
