summaryrefslogtreecommitdiff
path: root/tests/test_dictconfig.py
blob: 42647a29c58744477a1cb01bf4122f09fe814905 (plain)
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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
# Copyright 2009-2010 by Vinay Sajip. All Rights Reserved.
#
# Permission to use, copy, modify, and distribute this software and its
# documentation for any purpose and without fee is hereby granted,
# provided that the above copyright notice appear in all copies and that
# both that copyright notice and this permission notice appear in
# supporting documentation, and that the name of Vinay Sajip
# not be used in advertising or publicity pertaining to distribution
# of the software without specific, written prior permission.
# VINAY SAJIP DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
# ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
# VINAY SAJIP BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
# ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
# IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

import logging
from logutils.adapter import LoggerAdapter
from logutils.dictconfig import dictConfig, named_handlers_supported
from logutils.testing import TestHandler, Matcher
import sys
import unittest

try:
    StandardError
except NameError:
    StandardError = Exception

class ExceptionFormatter(logging.Formatter):
    """A special exception formatter."""
    def formatException(self, ei):
        return "Got a [%s]" % ei[0].__name__

def formatFunc(format, datefmt=None):
    return logging.Formatter(format, datefmt)

def testHandler():
    return TestHandler(Matcher())

def handlerFunc():
    return logging.StreamHandler()

class CustomHandler(logging.StreamHandler):
    pass

class ConfigDictTest(unittest.TestCase):

    """Reading logging config from a dictionary."""

    def setUp(self):
        self.logger = l = logging.getLogger()
        self.adapter = LoggerAdapter(l, {})

        logger_dict = logging.getLogger().manager.loggerDict
        logging._acquireLock()
        try:
            self.saved_handlers = logging._handlers.copy()
            self.saved_handler_list = logging._handlerList[:]
            self.saved_loggers = logger_dict.copy()
            self.saved_level_names = logging._levelNames.copy()
        finally:
            logging._releaseLock()

        self.root_logger = logging.getLogger("")
        self.original_logging_level = self.root_logger.getEffectiveLevel()


    def tearDown(self):
        self.root_logger.setLevel(self.original_logging_level)
        logging._acquireLock()
        try:
            logging._levelNames.clear()
            logging._levelNames.update(self.saved_level_names)
            logging._handlers.clear()
            logging._handlers.update(self.saved_handlers)
            logging._handlerList[:] = self.saved_handler_list
            loggerDict = logging.getLogger().manager.loggerDict
            loggerDict.clear()
            loggerDict.update(self.saved_loggers)
        finally:
            logging._releaseLock()

    message_num = 0

    def next_message(self):
        """Generate a message consisting solely of an auto-incrementing
        integer."""
        self.message_num += 1
        return "%d" % self.message_num

    # config0 is a standard configuration.
    config0 = {
        'version': 1,
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
            }
        },
        'root' : {
            'level' : 'WARNING',
            'handlers' : ['hand1'],
        },
    }

    # config1 adds a little to the standard configuration.
    config1 = {
        'version': 1,
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
            }
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
        },
    } 

    # config2 has a subtle configuration error that should be reported
    config2 = {
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                'class' : 'logging.StreamHandler',
                'formatter' : 'form1',
                'level' : 'NOTSET',
                'stream'  : 'ext://sys.stdbout',
            },
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
        },
    } 

    #As config1 but with a misspelt level on a handler
    config2a = {
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                'class' : 'logging.StreamHandler',
                'formatter' : 'form1',
                'level' : 'NTOSET',
                'stream'  : 'ext://sys.stdout',
            },
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
        },
    } 


    #As config1 but with a misspelt level on a logger
    config2b = {
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                'class' : 'logging.StreamHandler',
                'formatter' : 'form1',
                'level' : 'NOTSET',
                'stream'  : 'ext://sys.stdout',
            },
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'WRANING',
        },
    } 

    # config3 has a less subtle configuration error
    config3 = {
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                'class' : 'logging.StreamHandler',
                'formatter' : 'misspelled_name',
                'level' : 'NOTSET',
                'stream'  : 'ext://sys.stdout',
            },
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
        },
    } 

    # config4 specifies a custom formatter class to be loaded
    config4 = {
        'version': 1,
        'formatters': {
            'form1' : {
                '()' : __name__ + '.ExceptionFormatter',
                'format' : '%(levelname)s:%(name)s:%(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
            }
        },
        'root' : {
            'level' : 'NOTSET',
                'handlers' : ['hand1'],
        },
    } 

    # As config4 but using an actual callable rather than a string
    config4a = {
        'version': 1,
        'formatters': {
            'form1' : {
                '()' : ExceptionFormatter,
                'format' : '%(levelname)s:%(name)s:%(message)s',
            },
            'form2' : {
                '()' : __name__ + '.formatFunc',
                'format' : '%(levelname)s:%(name)s:%(message)s',
            },
            'form3' : {
                '()' : formatFunc,
                'format' : '%(levelname)s:%(name)s:%(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
            },
            'hand2' : {
                '()' : handlerFunc,
            },
        },
        'root' : {
            'level' : 'NOTSET',
                'handlers' : ['hand1'],
        },
    } 

    # config5 specifies a custom handler class to be loaded
    config5 = {
        'version': 1,
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
            }
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
        },
    } 

    # config6 specifies a custom handler class to be loaded
    # but has bad arguments
    config6 = {
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                'class' : __name__ + '.CustomHandler',
                'formatter' : 'form1',
                'level' : 'NOTSET',
                'stream'  : 'ext://sys.stdout',
                '9' : 'invalid parameter name',
            },
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
        },
    } 

    #config 7 does not define compiler.parser but defines compiler.lexer
    #so compiler.parser should be disabled after applying it
    config7 = {
        'version': 1,
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
            }
        },
        'loggers' : {
            'compiler.lexer' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
        },
    } 

    config8 = {
        'version': 1,
        'disable_existing_loggers' : False,
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
            }
        },
        'loggers' : {
            'compiler' : {
                'level' : 'DEBUG',
                'handlers' : ['hand1'],
            },
            'compiler.lexer' : {
            },
        },
        'root' : {
            'level' : 'WARNING',
        },
    } 

    config9 = {
        'version': 1,
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
            }
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'WARNING',
                'handlers' : ['hand1'],
            },
        },
        'root' : {
            'level' : 'NOTSET',
        },
    } 

    config9a = {
        'version': 1,
        'incremental' : True,
        'handlers' : {
            'hand1' : {
                'level' : 'WARNING',
            },
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'INFO',
            },
        },
    } 

    config9b = {
        'version': 1,
        'incremental' : True,
        'handlers' : {
            'hand1' : {
                'level' : 'INFO',
            },
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'INFO',
            },
        },
    } 

    #As config1 but with a filter added
    config10 = {
        'version': 1,
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'filters' : {
            'filt1' : {
                'name' : 'compiler.parser',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': testHandler,
                'formatter': 'form1',
                'filters' : ['filt1'],
            }
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'filters' : ['filt1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
            'handlers' : ['hand1'],
        },
    } 

    # As config10, but declaring a handler in a module using
    # absolute imports
    config11 = {
        'version': 1,
        'formatters': {
            'form1' : {
                'format' : '%(levelname)s ++ %(message)s',
            },
        },
        'filters' : {
            'filt1' : {
                'name' : 'compiler.parser',
            },
        },
        'handlers' : {
            'hand1' : {
                '()': 'mytest.MyTestHandler',
                'formatter': 'form1',
                'filters' : ['filt1'],
            }
        },
        'loggers' : {
            'compiler.parser' : {
                'level' : 'DEBUG',
                'filters' : ['filt1'],
            },
        },
        'root' : {
            'level' : 'WARNING',
            'handlers' : ['hand1'],
        },
    } 

    def apply_config(self, conf):
        dictConfig(conf)

    def test_config0_ok(self):
        # A simple config which overrides the default settings.
        self.apply_config(self.config0)
        logger = logging.getLogger()
        # Won't output anything
        logger.info(self.next_message())
        # Outputs a message
        logger.error(self.next_message())
        h = logger.handlers[0]
        self.assertEqual(1, h.count)
        self.assertTrue(h.matchall([
                            dict(levelname='ERROR', message='2')
                        ]))

    def test_config1_ok(self, config=config1):
        # A config defining a sub-parser as well.
        self.apply_config(config)
        logger = logging.getLogger("compiler.parser")
        # Both will output a message
        logger.info(self.next_message())
        logger.error(self.next_message())
        h = logger.handlers[0]
        self.assertTrue(h.matchall([
                            dict(levelname='INFO', message='1'),
                            dict(levelname='ERROR', message='2'),
                        ]))

    def test_config2_failure(self):
        # A simple config which overrides the default settings.
        self.assertRaises(StandardError, self.apply_config, self.config2)

    def test_config2a_failure(self):
        # A simple config which overrides the default settings.
        self.assertRaises(StandardError, self.apply_config, self.config2a)

    def test_config2b_failure(self):
        # A simple config which overrides the default settings.
        self.assertRaises(StandardError, self.apply_config, self.config2b)

    def test_config3_failure(self):
        # A simple config which overrides the default settings.
        self.assertRaises(StandardError, self.apply_config, self.config3)

    def test_config4_ok(self):
        # A config specifying a custom formatter class.
        self.apply_config(self.config4)
        logger = logging.getLogger()
        h = logger.handlers[0]
        try:
            raise RuntimeError()
        except RuntimeError:
            logging.exception("just testing")
        self.assertEquals(h.formatted[0],
            "ERROR:root:just testing\nGot a [RuntimeError]")

    def test_config4a_ok(self):
        # A config specifying a custom formatter class.
        self.apply_config(self.config4a)
        logger = logging.getLogger()
        h = logger.handlers[0]
        try:
            raise RuntimeError()
        except RuntimeError:
            logging.exception("just testing")
        self.assertEquals(h.formatted[0],
            "ERROR:root:just testing\nGot a [RuntimeError]")

    def test_config5_ok(self):
        self.test_config1_ok(config=self.config5)

    def test_config6_failure(self):
        self.assertRaises(StandardError, self.apply_config, self.config6)

    def test_config7_ok(self):
        self.apply_config(self.config1)
        logger = logging.getLogger("compiler.parser")
        # Both will output a message
        logger.info(self.next_message())
        logger.error(self.next_message())
        h = logger.handlers[0]
        self.assertTrue(h.matchall([
                            dict(levelname='INFO', message='1'),
                            dict(levelname='ERROR', message='2'),
                        ]))
        self.apply_config(self.config7)
        logger = logging.getLogger("compiler.parser")
        self.assertTrue(logger.disabled)
        logger = logging.getLogger("compiler.lexer")
        # Both will output a message
        h = logger.handlers[0]
        logger.info(self.next_message())
        logger.error(self.next_message())
        self.assertTrue(h.matchall([
                            dict(levelname='INFO', message='3'),
                            dict(levelname='ERROR', message='4'),
                        ]))

    #Same as test_config_7_ok but don't disable old loggers.
    def test_config_8_ok(self):
        self.apply_config(self.config1)
        logger = logging.getLogger("compiler.parser")
        # Both will output a message
        logger.info(self.next_message())
        logger.error(self.next_message())
        h = logger.handlers[0]
        self.assertTrue(h.matchall([
                            dict(levelname='INFO', message='1'),
                            dict(levelname='ERROR', message='2'),
                        ]))
        self.apply_config(self.config8)
        logger = logging.getLogger("compiler.parser")
        self.assertFalse(logger.disabled)
        toplogger = logging.getLogger("compiler")
        # Both will output a message
        logger.info(self.next_message())
        logger.error(self.next_message())
        logger = logging.getLogger("compiler.lexer")
        # Both will output a message
        logger.info(self.next_message())
        logger.error(self.next_message())
        h = toplogger.handlers[0]
        self.assertTrue(h.matchall([
                            dict(levelname='INFO', message='3'),
                            dict(levelname='ERROR', message='4'),
                            dict(levelname='INFO', message='5'),
                            dict(levelname='ERROR', message='6'),
                        ]))

    def test_config_9_ok(self):
        self.apply_config(self.config9)
        logger = logging.getLogger("compiler.parser")
        #Nothing will be output since both handler and logger are set to WARNING
        logger.info(self.next_message())
        h = logger.handlers[0]
        self.assertEqual(0, h.count)
        self.apply_config(self.config9a)
        #Nothing will be output since both handler is still set to WARNING
        logger.info(self.next_message())
        h = logger.handlers[0]
        nhs = named_handlers_supported()
        if nhs:
            self.assertEqual(0, h.count)
        else:
            self.assertEqual(1, h.count)
        self.apply_config(self.config9b)
        #Message should now be output
        logger.info(self.next_message())
        if nhs:
            h = logger.handlers[0]
            self.assertTrue(h.matchall([
                                dict(levelname='INFO', message='3'),
                            ]))
        else:
            self.assertEqual(2, h.count)

    def test_config_10_ok(self):
        self.apply_config(self.config10)
        logger = logging.getLogger("compiler.parser")
        logger.warning(self.next_message())
        logger = logging.getLogger('compiler')
        #Not output, because filtered
        logger.warning(self.next_message())
        logger = logging.getLogger('compiler.lexer')
        #Not output, because filtered
        logger.warning(self.next_message())
        logger = logging.getLogger("compiler.parser.codegen")
        #Output, as not filtered
        logger.error(self.next_message())
        h = logging.getLogger().handlers[0]
        self.assertTrue(h.matchall([
                            dict(levelname='WARNING', message='1'),
                            dict(levelname='ERROR', message='4'),
                        ]))
 
    def test_config_11_ok(self):
        self.apply_config(self.config11)
        h = logging.getLogger().handlers[0]
        self.assertEqual(h.__module__, 'mytest')
        self.assertEqual(h.__class__.__name__, 'MyTestHandler')