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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
###########################################
# Test Suite for Log::Log4perl::Filter
# Mike Schilli, 2003 (m@perlmeister.com)
###########################################
BEGIN {
if($ENV{INTERNAL_DEBUG}) {
require Log::Log4perl::InternalDebug;
Log::Log4perl::InternalDebug->enable();
}
}
use warnings;
use strict;
use Test::More tests => 36;
use Log::Log4perl;
#############################################
# Use a pattern-matching subroutine as filter
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger.Some = INFO, A1
log4perl.filter.MyFilter = sub { /let this through/ }
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = MyFilter
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
my $buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
my $logger = Log::Log4perl->get_logger("Some.Where");
# Let this through
$logger->info("Here's the info, let this through!");
# Suppress this
$logger->info("Here's the info, suppress this!");
like($buffer->buffer(), qr(let this through), "pattern-match let through");
unlike($buffer->buffer(), qr(suppress), "pattern-match block");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# Block in filter based on message level
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger.Some = INFO, A1
log4perl.filter.MyFilter = sub { \
my %p = @_; \
($p{log4p_level} eq "WARN") ? 1 : 0; \
}
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = MyFilter
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Suppress this
$logger->info("This doesn't make it");
# Let this through
$logger->warn("This passes the hurdle");
like($buffer->buffer(), qr(passes the hurdle), "level-match let through");
unlike($buffer->buffer(), qr(make it), "level-match block");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# Filter combination with Filter::Boolean
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = sub { /let this through/ }
log4perl.filter.Match2 = sub { /and that, too/ }
log4perl.filter.Match3 = Log::Log4perl::Filter::StringMatch
log4perl.filter.Match3.StringToMatch = suppress
log4perl.filter.Match3.AcceptOnMatch = true
log4perl.filter.MyBoolean = Log::Log4perl::Filter::Boolean
log4perl.filter.MyBoolean.logic = !Match3 && (Match1 || Match2)
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = MyBoolean
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Let through
$logger->info("let this through");
like($buffer->buffer(), qr(let this through), "Boolean 1");
$buffer->buffer("");
# Block
$logger->info("suppress, let this through");
is($buffer->buffer(), "", "Boolean 2");
$buffer->buffer("");
# Let through
$logger->info("and that, too");
like($buffer->buffer(), qr(and that, too), "Boolean 3");
$buffer->buffer("");
# Block
$logger->info("and that, too suppress");
is($buffer->buffer(), "", "Boolean 4");
$buffer->buffer("");
# Block
$logger->info("let this through - and that, too - suppress");
is($buffer->buffer(), "", "Boolean 5");
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# LevelMatchFilter
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = Log::Log4perl::Filter::LevelMatch
log4perl.filter.Match1.LevelToMatch = INFO
log4perl.filter.Match1.AcceptOnMatch = true
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Match1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Let through
$logger->info("let this through");
like($buffer->buffer(), qr(let this through), "Matched Level");
$buffer->buffer("");
# Block
$logger->warn("suppress, let this through");
is($buffer->buffer(), "", "Non-Matched Level 1");
$buffer->buffer("");
# Block
$logger->debug("and that, too");
is($buffer->buffer(), "", "Non-Matched Level 2");
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# LevelMatchFilter - negative
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = Log::Log4perl::Filter::LevelMatch
log4perl.filter.Match1.LevelToMatch = INFO
log4perl.filter.Match1.AcceptOnMatch = false
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Match1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Block
$logger->info("let this through");
is($buffer->buffer(), "", "Non-Matched Level 1 - negative");
$buffer->buffer("");
# Pass
$logger->warn("suppress, let this through");
like($buffer->buffer(), qr(let this through), "Matched Level - negative");
$buffer->buffer("");
# Pass
$logger->fatal("and that, too");
like($buffer->buffer(), qr(and that, too), "Matched Level - negative");
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# MDCFilter
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = Log::Log4perl::Filter::MDC
log4perl.filter.Match1.KeyToMatch = foo
log4perl.filter.Match1.RegexToMatch = ^bar$
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Match1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Let through
Log::Log4perl::MDC->put(foo => 'bar');
$logger->info("let this through");
like($buffer->buffer(), qr(let this through), "MDC - passed");
$buffer->buffer("");
Log::Log4perl::MDC->remove;
# Block
$logger->info("block this");
is($buffer->buffer(), "", "MDC - blocked");
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# StringMatchFilter
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = Log::Log4perl::Filter::StringMatch
log4perl.filter.Match1.StringToMatch = block this
log4perl.filter.Match1.AcceptOnMatch = false
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Match1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Let through
$logger->info("let this through");
like($buffer->buffer(), qr(let this through), "StringMatch - passed");
$buffer->buffer("");
# Block
$logger->info("block this");
is($buffer->buffer(), "", "StringMatch - blocked");
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# StringMatchFilter - negative
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = Log::Log4perl::Filter::StringMatch
log4perl.filter.Match1.StringToMatch = let this through
log4perl.filter.Match1.AcceptOnMatch = true
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Match1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Let through
$logger->info("let this through");
like($buffer->buffer(), qr(let this through), "StringMatch - passed");
$buffer->buffer("");
# Block
$logger->info("block this");
is($buffer->buffer(), "", "StringMatch - blocked");
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# Non-existing filter class
#############################################
eval {
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = Log::Log4perl::Filter::GobbleDeGook
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Match1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
};
like($@, qr/Log::Log4perl::Filter::GobbleDeGook/, "Unknown Filter");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# Syntax error in subroutine
#############################################
eval {
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = sub { */+- };
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Match1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
};
like($@, qr/Can't evaluate/, "Detect flawed filter subroutine");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# LevelRangeFilter
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = DEBUG, A1
log4perl.filter.Range1 = Log::Log4perl::Filter::LevelRange
log4perl.filter.Range1.LevelMin = INFO
log4perl.filter.Range1.LevelMax = WARN
log4perl.filter.Range1.AcceptOnMatch = true
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Range1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Block
$logger->debug("blah");
is($buffer->buffer(), "", "Outside Range");
$buffer->buffer("");
# Let through
$logger->info("let this through");
like($buffer->buffer(), qr(let this through), "Matched Range");
$buffer->buffer("");
# Let through
$logger->warn("let this through");
like($buffer->buffer(), qr(let this through), "Matched Range");
$buffer->buffer("");
# Block
$logger->error("blah");
is($buffer->buffer(), "", "Outside Range");
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# LevelRangeFilter - negative
#############################################
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = DEBUG, A1
log4perl.filter.Range1 = Log::Log4perl::Filter::LevelRange
log4perl.filter.Range1.LevelMin = INFO
log4perl.filter.Range1.LevelMax = WARN
log4perl.filter.Range1.AcceptOnMatch = false
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Range1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Let through
$logger->debug("debug msg");
like($buffer->buffer(), qr(debug msg), "Outside Range - negative");
$buffer->buffer("");
# Block
$logger->info("block this");
is($buffer->buffer(), "", "Matched Range - negative");
$buffer->buffer("");
# Block
$logger->warn("block this");
is($buffer->buffer(), "", "Matched Range - negative");
$buffer->buffer("");
# Let through
$logger->error("error msg");
like($buffer->buffer(), qr(error msg), "Outside Range - negative");
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
eval {
Log::Log4perl->init(\ <<'EOT');
log4perl.logger = INFO, A1
log4perl.filter.Match1 = Log::Log4perl::Filter::LevelMatch
log4perl.filter.Match1.LevelToWomper = INFO
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = Match1
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
};
like $@, qr/Unknown parameter: LevelToWomper/, "Unknown parameter check";
#############################################
# AND-Shortcut with boolean filters
#############################################
my $counter = 0;
no warnings qw( redefine );
my $old_level_match_ok = *{ Log::Log4perl::Filter::LevelMatch::ok };
*{ Log::Log4perl::Filter::LevelMatch::ok } = sub {
$counter++; 0 };
Log::Log4perl->init(\ <<'EOT');
log4perl.category.Some.Where = DEBUG, A1
log4perl.filter.Debug = Log::Log4perl::Filter::LevelMatch
log4perl.filter.Debug.LevelToMatch = DEBUG
log4perl.filter.Debug.AcceptOnMatch = true
log4perl.filter.Info = Log::Log4perl::Filter::LevelMatch
log4perl.filter.Info.LevelToMatch = INFO
log4perl.filter.Info.AcceptOnMatch = true
log4perl.filter.MyBoolean = Log::Log4perl::Filter::Boolean
log4perl.filter.MyBoolean.logic = Debug && Info
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = MyBoolean
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Block it
$logger->debug("some message");
is($buffer->buffer(), "", "all blocked");
is( $counter, 1, "shortcut ok" );
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
#############################################
# OR-Shortcut with boolean filters
#############################################
$counter = 0;
*{ Log::Log4perl::Filter::LevelMatch::ok } = sub {
$counter++; 1 };
Log::Log4perl->init(\ <<'EOT');
log4perl.category.Some.Where = DEBUG, A1
log4perl.filter.Debug = Log::Log4perl::Filter::LevelMatch
log4perl.filter.Debug.LevelToMatch = DEBUG
log4perl.filter.Debug.AcceptOnMatch = true
log4perl.filter.Info = Log::Log4perl::Filter::LevelMatch
log4perl.filter.Info.LevelToMatch = INFO
log4perl.filter.Info.AcceptOnMatch = true
log4perl.filter.MyBoolean = Log::Log4perl::Filter::Boolean
log4perl.filter.MyBoolean.logic = Debug || Info
log4perl.appender.A1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.A1.Filter = MyBoolean
log4perl.appender.A1.layout = Log::Log4perl::Layout::SimpleLayout
EOT
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("A1");
# Define a logger
$logger = Log::Log4perl->get_logger("Some.Where");
# Block it
$logger->debug("some message");
like($buffer->buffer(), qr/some message/, "all blocked");
is( $counter, 1, "shortcut ok" );
$buffer->buffer("");
Log::Log4perl->reset();
$buffer->reset();
*{ Log::Log4perl::Filter::LevelMatch::ok } = $old_level_match_ok;
|
