Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1 | # Copyright 2001-2017 by Vinay Sajip. All Rights Reserved. |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2 | # |
| 3 | # Permission to use, copy, modify, and distribute this software and its |
| 4 | # documentation for any purpose and without fee is hereby granted, |
| 5 | # provided that the above copyright notice appear in all copies and that |
| 6 | # both that copyright notice and this permission notice appear in |
| 7 | # supporting documentation, and that the name of Vinay Sajip |
| 8 | # not be used in advertising or publicity pertaining to distribution |
| 9 | # of the software without specific, written prior permission. |
| 10 | # VINAY SAJIP DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING |
| 11 | # ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL |
| 12 | # VINAY SAJIP BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR |
| 13 | # ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER |
| 14 | # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT |
| 15 | # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 16 | |
| 17 | """Test harness for the logging module. Run all tests. |
| 18 | |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 19 | Copyright (C) 2001-2017 Vinay Sajip. All Rights Reserved. |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 20 | """ |
| 21 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 22 | import logging |
| 23 | import logging.handlers |
| 24 | import logging.config |
Christian Heimes | 18c6689 | 2008-02-17 13:31:39 +0000 | [diff] [blame] | 25 | |
Benjamin Peterson | f91df04 | 2009-02-13 02:50:59 +0000 | [diff] [blame] | 26 | import codecs |
Vinay Sajip | cf9e2f2 | 2012-10-09 09:06:03 +0100 | [diff] [blame] | 27 | import configparser |
Pablo Galindo | 137b063 | 2018-10-16 15:17:57 +0100 | [diff] [blame] | 28 | import copy |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 29 | import datetime |
Vinay Sajip | db8f463 | 2016-09-08 01:37:03 +0100 | [diff] [blame] | 30 | import pathlib |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 31 | import pickle |
| 32 | import io |
| 33 | import gc |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 34 | import json |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 35 | import os |
Vinay Sajip | 8552d1f | 2010-09-14 09:34:09 +0000 | [diff] [blame] | 36 | import queue |
Vinay Sajip | 66b8b08 | 2012-04-24 23:25:30 +0100 | [diff] [blame] | 37 | import random |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 38 | import re |
Gregory P. Smith | 1900384 | 2018-09-13 22:08:31 -0700 | [diff] [blame] | 39 | import signal |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 40 | import socket |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 41 | import struct |
| 42 | import sys |
| 43 | import tempfile |
Rémi Lapeyre | 65f64b1 | 2019-03-15 07:53:34 +0100 | [diff] [blame] | 44 | from test.support.script_helper import assert_python_ok, assert_python_failure |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 45 | from test import support |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 46 | import textwrap |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 47 | import threading |
Vinay Sajip | 37eb338 | 2011-04-26 20:26:41 +0100 | [diff] [blame] | 48 | import time |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 49 | import unittest |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 50 | import warnings |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 51 | import weakref |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 52 | |
| 53 | import asyncore |
| 54 | from http.server import HTTPServer, BaseHTTPRequestHandler |
| 55 | import smtpd |
| 56 | from urllib.parse import urlparse, parse_qs |
| 57 | from socketserver import (ThreadingUDPServer, DatagramRequestHandler, |
| 58 | ThreadingTCPServer, StreamRequestHandler) |
| 59 | |
Vinay Sajip | 60ccd82 | 2011-05-09 17:32:09 +0100 | [diff] [blame] | 60 | try: |
Vinay Sajip | 223349c | 2015-10-01 20:37:54 +0100 | [diff] [blame] | 61 | import win32evtlog, win32evtlogutil, pywintypes |
Vinay Sajip | 60ccd82 | 2011-05-09 17:32:09 +0100 | [diff] [blame] | 62 | except ImportError: |
Vinay Sajip | 223349c | 2015-10-01 20:37:54 +0100 | [diff] [blame] | 63 | win32evtlog = win32evtlogutil = pywintypes = None |
| 64 | |
Eric V. Smith | 851cad7 | 2012-03-11 22:46:04 -0700 | [diff] [blame] | 65 | try: |
| 66 | import zlib |
| 67 | except ImportError: |
| 68 | pass |
Christian Heimes | 18c6689 | 2008-02-17 13:31:39 +0000 | [diff] [blame] | 69 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 70 | class BaseTest(unittest.TestCase): |
| 71 | |
| 72 | """Base class for logging tests.""" |
| 73 | |
| 74 | log_format = "%(name)s -> %(levelname)s: %(message)s" |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 75 | expected_log_pat = r"^([\w.]+) -> (\w+): (\d+)$" |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 76 | message_num = 0 |
| 77 | |
| 78 | def setUp(self): |
| 79 | """Setup the default logging stream to an internal StringIO instance, |
| 80 | so that we can examine log output as we want.""" |
Victor Stinner | 6966960 | 2017-08-18 23:47:54 +0200 | [diff] [blame] | 81 | self._threading_key = support.threading_setup() |
| 82 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 83 | logger_dict = logging.getLogger().manager.loggerDict |
Christian Heimes | 18c6689 | 2008-02-17 13:31:39 +0000 | [diff] [blame] | 84 | logging._acquireLock() |
| 85 | try: |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 86 | self.saved_handlers = logging._handlers.copy() |
| 87 | self.saved_handler_list = logging._handlerList[:] |
Vinay Sajip | 7b60f4e | 2010-12-27 14:31:52 +0000 | [diff] [blame] | 88 | self.saved_loggers = saved_loggers = logger_dict.copy() |
Vinay Sajip | 3b84eae | 2013-05-25 03:20:34 -0700 | [diff] [blame] | 89 | self.saved_name_to_level = logging._nameToLevel.copy() |
| 90 | self.saved_level_to_name = logging._levelToName.copy() |
Vinay Sajip | 7b60f4e | 2010-12-27 14:31:52 +0000 | [diff] [blame] | 91 | self.logger_states = logger_states = {} |
| 92 | for name in saved_loggers: |
| 93 | logger_states[name] = getattr(saved_loggers[name], |
| 94 | 'disabled', None) |
Christian Heimes | 18c6689 | 2008-02-17 13:31:39 +0000 | [diff] [blame] | 95 | finally: |
| 96 | logging._releaseLock() |
| 97 | |
Florent Xicluna | 5252f9f | 2011-11-07 19:43:05 +0100 | [diff] [blame] | 98 | # Set two unused loggers |
Vinay Sajip | b4a0809 | 2010-09-20 09:55:00 +0000 | [diff] [blame] | 99 | self.logger1 = logging.getLogger("\xab\xd7\xbb") |
| 100 | self.logger2 = logging.getLogger("\u013f\u00d6\u0047") |
Benjamin Peterson | 22005fc | 2010-04-11 16:25:06 +0000 | [diff] [blame] | 101 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 102 | self.root_logger = logging.getLogger("") |
| 103 | self.original_logging_level = self.root_logger.getEffectiveLevel() |
| 104 | |
| 105 | self.stream = io.StringIO() |
| 106 | self.root_logger.setLevel(logging.DEBUG) |
| 107 | self.root_hdlr = logging.StreamHandler(self.stream) |
| 108 | self.root_formatter = logging.Formatter(self.log_format) |
| 109 | self.root_hdlr.setFormatter(self.root_formatter) |
Vinay Sajip | 7b0e86e | 2010-12-30 23:26:50 +0000 | [diff] [blame] | 110 | if self.logger1.hasHandlers(): |
| 111 | hlist = self.logger1.handlers + self.root_logger.handlers |
| 112 | raise AssertionError('Unexpected handlers: %s' % hlist) |
| 113 | if self.logger2.hasHandlers(): |
| 114 | hlist = self.logger2.handlers + self.root_logger.handlers |
| 115 | raise AssertionError('Unexpected handlers: %s' % hlist) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 116 | self.root_logger.addHandler(self.root_hdlr) |
Vinay Sajip | b4a0809 | 2010-09-20 09:55:00 +0000 | [diff] [blame] | 117 | self.assertTrue(self.logger1.hasHandlers()) |
| 118 | self.assertTrue(self.logger2.hasHandlers()) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 119 | |
| 120 | def tearDown(self): |
| 121 | """Remove our logging stream, and restore the original logging |
| 122 | level.""" |
| 123 | self.stream.close() |
| 124 | self.root_logger.removeHandler(self.root_hdlr) |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 125 | while self.root_logger.handlers: |
| 126 | h = self.root_logger.handlers[0] |
| 127 | self.root_logger.removeHandler(h) |
| 128 | h.close() |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 129 | self.root_logger.setLevel(self.original_logging_level) |
| 130 | logging._acquireLock() |
| 131 | try: |
Vinay Sajip | 3b84eae | 2013-05-25 03:20:34 -0700 | [diff] [blame] | 132 | logging._levelToName.clear() |
| 133 | logging._levelToName.update(self.saved_level_to_name) |
| 134 | logging._nameToLevel.clear() |
| 135 | logging._nameToLevel.update(self.saved_name_to_level) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 136 | logging._handlers.clear() |
| 137 | logging._handlers.update(self.saved_handlers) |
| 138 | logging._handlerList[:] = self.saved_handler_list |
Avram Lubkin | 78c18a9 | 2017-07-30 05:36:33 -0400 | [diff] [blame] | 139 | manager = logging.getLogger().manager |
| 140 | manager.disable = 0 |
| 141 | loggerDict = manager.loggerDict |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 142 | loggerDict.clear() |
| 143 | loggerDict.update(self.saved_loggers) |
Vinay Sajip | 7b60f4e | 2010-12-27 14:31:52 +0000 | [diff] [blame] | 144 | logger_states = self.logger_states |
| 145 | for name in self.logger_states: |
| 146 | if logger_states[name] is not None: |
| 147 | self.saved_loggers[name].disabled = logger_states[name] |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 148 | finally: |
| 149 | logging._releaseLock() |
| 150 | |
Victor Stinner | 6966960 | 2017-08-18 23:47:54 +0200 | [diff] [blame] | 151 | self.doCleanups() |
| 152 | support.threading_cleanup(*self._threading_key) |
| 153 | |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 154 | def assert_log_lines(self, expected_values, stream=None, pat=None): |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 155 | """Match the collected log lines against the regular expression |
| 156 | self.expected_log_pat, and compare the extracted group values to |
| 157 | the expected_values list of tuples.""" |
| 158 | stream = stream or self.stream |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 159 | pat = re.compile(pat or self.expected_log_pat) |
Serhiy Storchaka | 50254c5 | 2013-08-29 11:35:43 +0300 | [diff] [blame] | 160 | actual_lines = stream.getvalue().splitlines() |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 161 | self.assertEqual(len(actual_lines), len(expected_values)) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 162 | for actual, expected in zip(actual_lines, expected_values): |
| 163 | match = pat.search(actual) |
| 164 | if not match: |
| 165 | self.fail("Log line does not match expected pattern:\n" + |
| 166 | actual) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 167 | self.assertEqual(tuple(match.groups()), expected) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 168 | s = stream.read() |
| 169 | if s: |
| 170 | self.fail("Remaining output at end of log stream:\n" + s) |
| 171 | |
| 172 | def next_message(self): |
| 173 | """Generate a message consisting solely of an auto-incrementing |
| 174 | integer.""" |
| 175 | self.message_num += 1 |
| 176 | return "%d" % self.message_num |
| 177 | |
| 178 | |
| 179 | class BuiltinLevelsTest(BaseTest): |
| 180 | """Test builtin levels and their inheritance.""" |
| 181 | |
| 182 | def test_flat(self): |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 183 | # Logging levels in a flat logger namespace. |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 184 | m = self.next_message |
| 185 | |
| 186 | ERR = logging.getLogger("ERR") |
| 187 | ERR.setLevel(logging.ERROR) |
Vinay Sajip | c84f016 | 2010-09-21 11:25:39 +0000 | [diff] [blame] | 188 | INF = logging.LoggerAdapter(logging.getLogger("INF"), {}) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 189 | INF.setLevel(logging.INFO) |
| 190 | DEB = logging.getLogger("DEB") |
| 191 | DEB.setLevel(logging.DEBUG) |
| 192 | |
| 193 | # These should log. |
| 194 | ERR.log(logging.CRITICAL, m()) |
| 195 | ERR.error(m()) |
| 196 | |
| 197 | INF.log(logging.CRITICAL, m()) |
| 198 | INF.error(m()) |
Vinay Sajip | b9e46e9 | 2011-10-26 13:17:20 +0100 | [diff] [blame] | 199 | INF.warning(m()) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 200 | INF.info(m()) |
| 201 | |
| 202 | DEB.log(logging.CRITICAL, m()) |
| 203 | DEB.error(m()) |
Vinay Sajip | b9e46e9 | 2011-10-26 13:17:20 +0100 | [diff] [blame] | 204 | DEB.warning(m()) |
| 205 | DEB.info(m()) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 206 | DEB.debug(m()) |
| 207 | |
| 208 | # These should not log. |
Vinay Sajip | b9e46e9 | 2011-10-26 13:17:20 +0100 | [diff] [blame] | 209 | ERR.warning(m()) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 210 | ERR.info(m()) |
| 211 | ERR.debug(m()) |
| 212 | |
| 213 | INF.debug(m()) |
| 214 | |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 215 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 216 | ('ERR', 'CRITICAL', '1'), |
| 217 | ('ERR', 'ERROR', '2'), |
| 218 | ('INF', 'CRITICAL', '3'), |
| 219 | ('INF', 'ERROR', '4'), |
| 220 | ('INF', 'WARNING', '5'), |
| 221 | ('INF', 'INFO', '6'), |
| 222 | ('DEB', 'CRITICAL', '7'), |
| 223 | ('DEB', 'ERROR', '8'), |
| 224 | ('DEB', 'WARNING', '9'), |
| 225 | ('DEB', 'INFO', '10'), |
| 226 | ('DEB', 'DEBUG', '11'), |
| 227 | ]) |
| 228 | |
| 229 | def test_nested_explicit(self): |
| 230 | # Logging levels in a nested namespace, all explicitly set. |
| 231 | m = self.next_message |
| 232 | |
| 233 | INF = logging.getLogger("INF") |
| 234 | INF.setLevel(logging.INFO) |
| 235 | INF_ERR = logging.getLogger("INF.ERR") |
| 236 | INF_ERR.setLevel(logging.ERROR) |
| 237 | |
| 238 | # These should log. |
| 239 | INF_ERR.log(logging.CRITICAL, m()) |
| 240 | INF_ERR.error(m()) |
| 241 | |
| 242 | # These should not log. |
Vinay Sajip | b9e46e9 | 2011-10-26 13:17:20 +0100 | [diff] [blame] | 243 | INF_ERR.warning(m()) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 244 | INF_ERR.info(m()) |
| 245 | INF_ERR.debug(m()) |
| 246 | |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 247 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 248 | ('INF.ERR', 'CRITICAL', '1'), |
| 249 | ('INF.ERR', 'ERROR', '2'), |
| 250 | ]) |
| 251 | |
| 252 | def test_nested_inherited(self): |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 253 | # Logging levels in a nested namespace, inherited from parent loggers. |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 254 | m = self.next_message |
| 255 | |
| 256 | INF = logging.getLogger("INF") |
| 257 | INF.setLevel(logging.INFO) |
| 258 | INF_ERR = logging.getLogger("INF.ERR") |
| 259 | INF_ERR.setLevel(logging.ERROR) |
| 260 | INF_UNDEF = logging.getLogger("INF.UNDEF") |
| 261 | INF_ERR_UNDEF = logging.getLogger("INF.ERR.UNDEF") |
| 262 | UNDEF = logging.getLogger("UNDEF") |
| 263 | |
| 264 | # These should log. |
| 265 | INF_UNDEF.log(logging.CRITICAL, m()) |
| 266 | INF_UNDEF.error(m()) |
Vinay Sajip | b9e46e9 | 2011-10-26 13:17:20 +0100 | [diff] [blame] | 267 | INF_UNDEF.warning(m()) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 268 | INF_UNDEF.info(m()) |
| 269 | INF_ERR_UNDEF.log(logging.CRITICAL, m()) |
| 270 | INF_ERR_UNDEF.error(m()) |
| 271 | |
| 272 | # These should not log. |
| 273 | INF_UNDEF.debug(m()) |
Vinay Sajip | b9e46e9 | 2011-10-26 13:17:20 +0100 | [diff] [blame] | 274 | INF_ERR_UNDEF.warning(m()) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 275 | INF_ERR_UNDEF.info(m()) |
| 276 | INF_ERR_UNDEF.debug(m()) |
| 277 | |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 278 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 279 | ('INF.UNDEF', 'CRITICAL', '1'), |
| 280 | ('INF.UNDEF', 'ERROR', '2'), |
| 281 | ('INF.UNDEF', 'WARNING', '3'), |
| 282 | ('INF.UNDEF', 'INFO', '4'), |
| 283 | ('INF.ERR.UNDEF', 'CRITICAL', '5'), |
| 284 | ('INF.ERR.UNDEF', 'ERROR', '6'), |
| 285 | ]) |
| 286 | |
| 287 | def test_nested_with_virtual_parent(self): |
| 288 | # Logging levels when some parent does not exist yet. |
| 289 | m = self.next_message |
| 290 | |
| 291 | INF = logging.getLogger("INF") |
| 292 | GRANDCHILD = logging.getLogger("INF.BADPARENT.UNDEF") |
| 293 | CHILD = logging.getLogger("INF.BADPARENT") |
| 294 | INF.setLevel(logging.INFO) |
| 295 | |
| 296 | # These should log. |
| 297 | GRANDCHILD.log(logging.FATAL, m()) |
| 298 | GRANDCHILD.info(m()) |
| 299 | CHILD.log(logging.FATAL, m()) |
| 300 | CHILD.info(m()) |
| 301 | |
| 302 | # These should not log. |
| 303 | GRANDCHILD.debug(m()) |
| 304 | CHILD.debug(m()) |
| 305 | |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 306 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 307 | ('INF.BADPARENT.UNDEF', 'CRITICAL', '1'), |
| 308 | ('INF.BADPARENT.UNDEF', 'INFO', '2'), |
| 309 | ('INF.BADPARENT', 'CRITICAL', '3'), |
| 310 | ('INF.BADPARENT', 'INFO', '4'), |
| 311 | ]) |
| 312 | |
Vinay Sajip | d1d4fbf | 2014-09-11 23:06:09 +0100 | [diff] [blame] | 313 | def test_regression_22386(self): |
| 314 | """See issue #22386 for more information.""" |
| 315 | self.assertEqual(logging.getLevelName('INFO'), logging.INFO) |
| 316 | self.assertEqual(logging.getLevelName(logging.INFO), 'INFO') |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 317 | |
Vinay Sajip | db8f463 | 2016-09-08 01:37:03 +0100 | [diff] [blame] | 318 | def test_issue27935(self): |
| 319 | fatal = logging.getLevelName('FATAL') |
| 320 | self.assertEqual(fatal, logging.FATAL) |
| 321 | |
Vinay Sajip | 924aaae | 2017-01-11 17:35:36 +0000 | [diff] [blame] | 322 | def test_regression_29220(self): |
| 323 | """See issue #29220 for more information.""" |
| 324 | logging.addLevelName(logging.INFO, '') |
| 325 | self.addCleanup(logging.addLevelName, logging.INFO, 'INFO') |
| 326 | self.assertEqual(logging.getLevelName(logging.INFO), '') |
| 327 | self.assertEqual(logging.getLevelName(logging.NOTSET), 'NOTSET') |
| 328 | self.assertEqual(logging.getLevelName('NOTSET'), logging.NOTSET) |
| 329 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 330 | class BasicFilterTest(BaseTest): |
| 331 | |
| 332 | """Test the bundled Filter class.""" |
| 333 | |
| 334 | def test_filter(self): |
| 335 | # Only messages satisfying the specified criteria pass through the |
| 336 | # filter. |
| 337 | filter_ = logging.Filter("spam.eggs") |
| 338 | handler = self.root_logger.handlers[0] |
| 339 | try: |
| 340 | handler.addFilter(filter_) |
| 341 | spam = logging.getLogger("spam") |
| 342 | spam_eggs = logging.getLogger("spam.eggs") |
| 343 | spam_eggs_fish = logging.getLogger("spam.eggs.fish") |
| 344 | spam_bakedbeans = logging.getLogger("spam.bakedbeans") |
| 345 | |
| 346 | spam.info(self.next_message()) |
| 347 | spam_eggs.info(self.next_message()) # Good. |
| 348 | spam_eggs_fish.info(self.next_message()) # Good. |
| 349 | spam_bakedbeans.info(self.next_message()) |
| 350 | |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 351 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 352 | ('spam.eggs', 'INFO', '2'), |
| 353 | ('spam.eggs.fish', 'INFO', '3'), |
| 354 | ]) |
| 355 | finally: |
| 356 | handler.removeFilter(filter_) |
| 357 | |
Vinay Sajip | 6dbed2e | 2010-10-19 20:53:01 +0000 | [diff] [blame] | 358 | def test_callable_filter(self): |
| 359 | # Only messages satisfying the specified criteria pass through the |
| 360 | # filter. |
| 361 | |
| 362 | def filterfunc(record): |
| 363 | parts = record.name.split('.') |
| 364 | prefix = '.'.join(parts[:2]) |
| 365 | return prefix == 'spam.eggs' |
| 366 | |
| 367 | handler = self.root_logger.handlers[0] |
| 368 | try: |
| 369 | handler.addFilter(filterfunc) |
| 370 | spam = logging.getLogger("spam") |
| 371 | spam_eggs = logging.getLogger("spam.eggs") |
| 372 | spam_eggs_fish = logging.getLogger("spam.eggs.fish") |
| 373 | spam_bakedbeans = logging.getLogger("spam.bakedbeans") |
| 374 | |
| 375 | spam.info(self.next_message()) |
| 376 | spam_eggs.info(self.next_message()) # Good. |
| 377 | spam_eggs_fish.info(self.next_message()) # Good. |
| 378 | spam_bakedbeans.info(self.next_message()) |
| 379 | |
| 380 | self.assert_log_lines([ |
| 381 | ('spam.eggs', 'INFO', '2'), |
| 382 | ('spam.eggs.fish', 'INFO', '3'), |
| 383 | ]) |
| 384 | finally: |
| 385 | handler.removeFilter(filterfunc) |
| 386 | |
Vinay Sajip | 985ef87 | 2011-04-26 19:34:04 +0100 | [diff] [blame] | 387 | def test_empty_filter(self): |
| 388 | f = logging.Filter() |
| 389 | r = logging.makeLogRecord({'name': 'spam.eggs'}) |
| 390 | self.assertTrue(f.filter(r)) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 391 | |
| 392 | # |
| 393 | # First, we define our levels. There can be as many as you want - the only |
| 394 | # limitations are that they should be integers, the lowest should be > 0 and |
| 395 | # larger values mean less information being logged. If you need specific |
| 396 | # level values which do not fit into these limitations, you can use a |
| 397 | # mapping dictionary to convert between your application levels and the |
| 398 | # logging system. |
| 399 | # |
| 400 | SILENT = 120 |
| 401 | TACITURN = 119 |
| 402 | TERSE = 118 |
| 403 | EFFUSIVE = 117 |
| 404 | SOCIABLE = 116 |
| 405 | VERBOSE = 115 |
| 406 | TALKATIVE = 114 |
| 407 | GARRULOUS = 113 |
| 408 | CHATTERBOX = 112 |
| 409 | BORING = 111 |
| 410 | |
| 411 | LEVEL_RANGE = range(BORING, SILENT + 1) |
| 412 | |
| 413 | # |
| 414 | # Next, we define names for our levels. You don't need to do this - in which |
| 415 | # case the system will use "Level n" to denote the text for the level. |
| 416 | # |
| 417 | my_logging_levels = { |
| 418 | SILENT : 'Silent', |
| 419 | TACITURN : 'Taciturn', |
| 420 | TERSE : 'Terse', |
| 421 | EFFUSIVE : 'Effusive', |
| 422 | SOCIABLE : 'Sociable', |
| 423 | VERBOSE : 'Verbose', |
| 424 | TALKATIVE : 'Talkative', |
| 425 | GARRULOUS : 'Garrulous', |
| 426 | CHATTERBOX : 'Chatterbox', |
| 427 | BORING : 'Boring', |
| 428 | } |
| 429 | |
| 430 | class GarrulousFilter(logging.Filter): |
| 431 | |
| 432 | """A filter which blocks garrulous messages.""" |
| 433 | |
| 434 | def filter(self, record): |
| 435 | return record.levelno != GARRULOUS |
| 436 | |
| 437 | class VerySpecificFilter(logging.Filter): |
| 438 | |
| 439 | """A filter which blocks sociable and taciturn messages.""" |
| 440 | |
| 441 | def filter(self, record): |
| 442 | return record.levelno not in [SOCIABLE, TACITURN] |
| 443 | |
| 444 | |
| 445 | class CustomLevelsAndFiltersTest(BaseTest): |
| 446 | |
| 447 | """Test various filtering possibilities with custom logging levels.""" |
| 448 | |
| 449 | # Skip the logger name group. |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 450 | expected_log_pat = r"^[\w.]+ -> (\w+): (\d+)$" |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 451 | |
| 452 | def setUp(self): |
| 453 | BaseTest.setUp(self) |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 454 | for k, v in my_logging_levels.items(): |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 455 | logging.addLevelName(k, v) |
| 456 | |
| 457 | def log_at_all_levels(self, logger): |
| 458 | for lvl in LEVEL_RANGE: |
| 459 | logger.log(lvl, self.next_message()) |
| 460 | |
| 461 | def test_logger_filter(self): |
| 462 | # Filter at logger level. |
| 463 | self.root_logger.setLevel(VERBOSE) |
| 464 | # Levels >= 'Verbose' are good. |
| 465 | self.log_at_all_levels(self.root_logger) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 466 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 467 | ('Verbose', '5'), |
| 468 | ('Sociable', '6'), |
| 469 | ('Effusive', '7'), |
| 470 | ('Terse', '8'), |
| 471 | ('Taciturn', '9'), |
| 472 | ('Silent', '10'), |
| 473 | ]) |
| 474 | |
| 475 | def test_handler_filter(self): |
| 476 | # Filter at handler level. |
| 477 | self.root_logger.handlers[0].setLevel(SOCIABLE) |
| 478 | try: |
| 479 | # Levels >= 'Sociable' are good. |
| 480 | self.log_at_all_levels(self.root_logger) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 481 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 482 | ('Sociable', '6'), |
| 483 | ('Effusive', '7'), |
| 484 | ('Terse', '8'), |
| 485 | ('Taciturn', '9'), |
| 486 | ('Silent', '10'), |
| 487 | ]) |
| 488 | finally: |
| 489 | self.root_logger.handlers[0].setLevel(logging.NOTSET) |
| 490 | |
| 491 | def test_specific_filters(self): |
| 492 | # Set a specific filter object on the handler, and then add another |
| 493 | # filter object on the logger itself. |
| 494 | handler = self.root_logger.handlers[0] |
| 495 | specific_filter = None |
| 496 | garr = GarrulousFilter() |
| 497 | handler.addFilter(garr) |
| 498 | try: |
| 499 | self.log_at_all_levels(self.root_logger) |
| 500 | first_lines = [ |
| 501 | # Notice how 'Garrulous' is missing |
| 502 | ('Boring', '1'), |
| 503 | ('Chatterbox', '2'), |
| 504 | ('Talkative', '4'), |
| 505 | ('Verbose', '5'), |
| 506 | ('Sociable', '6'), |
| 507 | ('Effusive', '7'), |
| 508 | ('Terse', '8'), |
| 509 | ('Taciturn', '9'), |
| 510 | ('Silent', '10'), |
| 511 | ] |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 512 | self.assert_log_lines(first_lines) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 513 | |
| 514 | specific_filter = VerySpecificFilter() |
| 515 | self.root_logger.addFilter(specific_filter) |
| 516 | self.log_at_all_levels(self.root_logger) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 517 | self.assert_log_lines(first_lines + [ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 518 | # Not only 'Garrulous' is still missing, but also 'Sociable' |
| 519 | # and 'Taciturn' |
| 520 | ('Boring', '11'), |
| 521 | ('Chatterbox', '12'), |
| 522 | ('Talkative', '14'), |
| 523 | ('Verbose', '15'), |
| 524 | ('Effusive', '17'), |
| 525 | ('Terse', '18'), |
| 526 | ('Silent', '20'), |
| 527 | ]) |
| 528 | finally: |
| 529 | if specific_filter: |
| 530 | self.root_logger.removeFilter(specific_filter) |
| 531 | handler.removeFilter(garr) |
| 532 | |
| 533 | |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 534 | class HandlerTest(BaseTest): |
| 535 | def test_name(self): |
| 536 | h = logging.Handler() |
| 537 | h.name = 'generic' |
| 538 | self.assertEqual(h.name, 'generic') |
| 539 | h.name = 'anothergeneric' |
| 540 | self.assertEqual(h.name, 'anothergeneric') |
| 541 | self.assertRaises(NotImplementedError, h.emit, None) |
| 542 | |
Vinay Sajip | 5a35b06 | 2011-04-27 11:31:14 +0100 | [diff] [blame] | 543 | def test_builtin_handlers(self): |
| 544 | # We can't actually *use* too many handlers in the tests, |
| 545 | # but we can try instantiating them with various options |
Victor Stinner | e674747 | 2011-08-21 00:39:18 +0200 | [diff] [blame] | 546 | if sys.platform in ('linux', 'darwin'): |
Vinay Sajip | 5a35b06 | 2011-04-27 11:31:14 +0100 | [diff] [blame] | 547 | for existing in (True, False): |
| 548 | fd, fn = tempfile.mkstemp() |
| 549 | os.close(fd) |
| 550 | if not existing: |
| 551 | os.unlink(fn) |
| 552 | h = logging.handlers.WatchedFileHandler(fn, delay=True) |
| 553 | if existing: |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 554 | dev, ino = h.dev, h.ino |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 555 | self.assertEqual(dev, -1) |
| 556 | self.assertEqual(ino, -1) |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 557 | r = logging.makeLogRecord({'msg': 'Test'}) |
| 558 | h.handle(r) |
| 559 | # Now remove the file. |
| 560 | os.unlink(fn) |
| 561 | self.assertFalse(os.path.exists(fn)) |
| 562 | # The next call should recreate the file. |
| 563 | h.handle(r) |
| 564 | self.assertTrue(os.path.exists(fn)) |
Vinay Sajip | 5a35b06 | 2011-04-27 11:31:14 +0100 | [diff] [blame] | 565 | else: |
| 566 | self.assertEqual(h.dev, -1) |
| 567 | self.assertEqual(h.ino, -1) |
| 568 | h.close() |
| 569 | if existing: |
| 570 | os.unlink(fn) |
| 571 | if sys.platform == 'darwin': |
Vinay Sajip | 6bba65c | 2011-04-27 14:31:55 +0100 | [diff] [blame] | 572 | sockname = '/var/run/syslog' |
Vinay Sajip | 5a35b06 | 2011-04-27 11:31:14 +0100 | [diff] [blame] | 573 | else: |
| 574 | sockname = '/dev/log' |
Vinay Sajip | dbeb274 | 2011-04-27 14:18:06 +0100 | [diff] [blame] | 575 | try: |
| 576 | h = logging.handlers.SysLogHandler(sockname) |
| 577 | self.assertEqual(h.facility, h.LOG_USER) |
| 578 | self.assertTrue(h.unixsocket) |
| 579 | h.close() |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 580 | except OSError: # syslogd might not be available |
Vinay Sajip | dbeb274 | 2011-04-27 14:18:06 +0100 | [diff] [blame] | 581 | pass |
Vinay Sajip | 5a35b06 | 2011-04-27 11:31:14 +0100 | [diff] [blame] | 582 | for method in ('GET', 'POST', 'PUT'): |
| 583 | if method == 'PUT': |
| 584 | self.assertRaises(ValueError, logging.handlers.HTTPHandler, |
| 585 | 'localhost', '/log', method) |
| 586 | else: |
| 587 | h = logging.handlers.HTTPHandler('localhost', '/log', method) |
| 588 | h.close() |
| 589 | h = logging.handlers.BufferingHandler(0) |
| 590 | r = logging.makeLogRecord({}) |
| 591 | self.assertTrue(h.shouldFlush(r)) |
| 592 | h.close() |
| 593 | h = logging.handlers.BufferingHandler(1) |
| 594 | self.assertFalse(h.shouldFlush(r)) |
| 595 | h.close() |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 596 | |
Vinay Sajip | db8f463 | 2016-09-08 01:37:03 +0100 | [diff] [blame] | 597 | def test_path_objects(self): |
| 598 | """ |
| 599 | Test that Path objects are accepted as filename arguments to handlers. |
| 600 | |
| 601 | See Issue #27493. |
| 602 | """ |
| 603 | fd, fn = tempfile.mkstemp() |
| 604 | os.close(fd) |
| 605 | os.unlink(fn) |
| 606 | pfn = pathlib.Path(fn) |
| 607 | cases = ( |
| 608 | (logging.FileHandler, (pfn, 'w')), |
| 609 | (logging.handlers.RotatingFileHandler, (pfn, 'a')), |
| 610 | (logging.handlers.TimedRotatingFileHandler, (pfn, 'h')), |
| 611 | ) |
| 612 | if sys.platform in ('linux', 'darwin'): |
| 613 | cases += ((logging.handlers.WatchedFileHandler, (pfn, 'w')),) |
| 614 | for cls, args in cases: |
| 615 | h = cls(*args) |
| 616 | self.assertTrue(os.path.exists(fn)) |
| 617 | h.close() |
| 618 | os.unlink(fn) |
| 619 | |
Vinay Sajip | 5e86eed | 2012-05-29 22:48:10 +0100 | [diff] [blame] | 620 | @unittest.skipIf(os.name == 'nt', 'WatchedFileHandler not appropriate for Windows.') |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 621 | def test_race(self): |
| 622 | # Issue #14632 refers. |
| 623 | def remove_loop(fname, tries): |
| 624 | for _ in range(tries): |
| 625 | try: |
| 626 | os.unlink(fname) |
Vinay Sajip | dc96ca2 | 2013-12-03 12:31:23 +0000 | [diff] [blame] | 627 | self.deletion_time = time.time() |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 628 | except OSError: |
| 629 | pass |
| 630 | time.sleep(0.004 * random.randint(0, 4)) |
| 631 | |
Vinay Sajip | c94871a | 2012-04-25 10:51:35 +0100 | [diff] [blame] | 632 | del_count = 500 |
| 633 | log_count = 500 |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 634 | |
Vinay Sajip | dc96ca2 | 2013-12-03 12:31:23 +0000 | [diff] [blame] | 635 | self.handle_time = None |
| 636 | self.deletion_time = None |
| 637 | |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 638 | for delay in (False, True): |
Vinay Sajip | c94871a | 2012-04-25 10:51:35 +0100 | [diff] [blame] | 639 | fd, fn = tempfile.mkstemp('.log', 'test_logging-3-') |
| 640 | os.close(fd) |
| 641 | remover = threading.Thread(target=remove_loop, args=(fn, del_count)) |
| 642 | remover.daemon = True |
| 643 | remover.start() |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 644 | h = logging.handlers.WatchedFileHandler(fn, delay=delay) |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 645 | f = logging.Formatter('%(asctime)s: %(levelname)s: %(message)s') |
| 646 | h.setFormatter(f) |
Vinay Sajip | c94871a | 2012-04-25 10:51:35 +0100 | [diff] [blame] | 647 | try: |
| 648 | for _ in range(log_count): |
| 649 | time.sleep(0.005) |
| 650 | r = logging.makeLogRecord({'msg': 'testing' }) |
Vinay Sajip | dc96ca2 | 2013-12-03 12:31:23 +0000 | [diff] [blame] | 651 | try: |
| 652 | self.handle_time = time.time() |
| 653 | h.handle(r) |
| 654 | except Exception: |
| 655 | print('Deleted at %s, ' |
| 656 | 'opened at %s' % (self.deletion_time, |
| 657 | self.handle_time)) |
| 658 | raise |
Vinay Sajip | c94871a | 2012-04-25 10:51:35 +0100 | [diff] [blame] | 659 | finally: |
Vinay Sajip | c94871a | 2012-04-25 10:51:35 +0100 | [diff] [blame] | 660 | remover.join() |
Vinay Sajip | ac20f46 | 2012-05-03 12:09:38 +0100 | [diff] [blame] | 661 | h.close() |
Vinay Sajip | c94871a | 2012-04-25 10:51:35 +0100 | [diff] [blame] | 662 | if os.path.exists(fn): |
| 663 | os.unlink(fn) |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 664 | |
Gregory P. Smith | 1900384 | 2018-09-13 22:08:31 -0700 | [diff] [blame] | 665 | # The implementation relies on os.register_at_fork existing, but we test |
| 666 | # based on os.fork existing because that is what users and this test use. |
| 667 | # This helps ensure that when fork exists (the important concept) that the |
| 668 | # register_at_fork mechanism is also present and used. |
| 669 | @unittest.skipIf(not hasattr(os, 'fork'), 'Test requires os.fork().') |
| 670 | def test_post_fork_child_no_deadlock(self): |
Gregory P. Smith | 64aa6d2 | 2019-05-07 12:18:20 -0400 | [diff] [blame] | 671 | """Ensure child logging locks are not held; bpo-6721 & bpo-36533.""" |
| 672 | class _OurHandler(logging.Handler): |
| 673 | def __init__(self): |
| 674 | super().__init__() |
| 675 | self.sub_handler = logging.StreamHandler( |
| 676 | stream=open('/dev/null', 'wt')) |
| 677 | |
| 678 | def emit(self, record): |
| 679 | self.sub_handler.acquire() |
| 680 | try: |
| 681 | self.sub_handler.emit(record) |
| 682 | finally: |
| 683 | self.sub_handler.release() |
| 684 | |
| 685 | self.assertEqual(len(logging._handlers), 0) |
| 686 | refed_h = _OurHandler() |
Xtreak | 2c10538 | 2019-05-13 20:18:52 +0530 | [diff] [blame] | 687 | self.addCleanup(refed_h.sub_handler.stream.close) |
Gregory P. Smith | 1900384 | 2018-09-13 22:08:31 -0700 | [diff] [blame] | 688 | refed_h.name = 'because we need at least one for this test' |
| 689 | self.assertGreater(len(logging._handlers), 0) |
Gregory P. Smith | 64aa6d2 | 2019-05-07 12:18:20 -0400 | [diff] [blame] | 690 | self.assertGreater(len(logging._at_fork_reinit_lock_weakset), 1) |
| 691 | test_logger = logging.getLogger('test_post_fork_child_no_deadlock') |
| 692 | test_logger.addHandler(refed_h) |
| 693 | test_logger.setLevel(logging.DEBUG) |
Gregory P. Smith | 1900384 | 2018-09-13 22:08:31 -0700 | [diff] [blame] | 694 | |
| 695 | locks_held__ready_to_fork = threading.Event() |
| 696 | fork_happened__release_locks_and_end_thread = threading.Event() |
| 697 | |
| 698 | def lock_holder_thread_fn(): |
| 699 | logging._acquireLock() |
| 700 | try: |
| 701 | refed_h.acquire() |
| 702 | try: |
| 703 | # Tell the main thread to do the fork. |
| 704 | locks_held__ready_to_fork.set() |
| 705 | |
| 706 | # If the deadlock bug exists, the fork will happen |
| 707 | # without dealing with the locks we hold, deadlocking |
| 708 | # the child. |
| 709 | |
| 710 | # Wait for a successful fork or an unreasonable amount of |
| 711 | # time before releasing our locks. To avoid a timing based |
| 712 | # test we'd need communication from os.fork() as to when it |
| 713 | # has actually happened. Given this is a regression test |
| 714 | # for a fixed issue, potentially less reliably detecting |
| 715 | # regression via timing is acceptable for simplicity. |
| 716 | # The test will always take at least this long. :( |
| 717 | fork_happened__release_locks_and_end_thread.wait(0.5) |
| 718 | finally: |
| 719 | refed_h.release() |
| 720 | finally: |
| 721 | logging._releaseLock() |
| 722 | |
| 723 | lock_holder_thread = threading.Thread( |
| 724 | target=lock_holder_thread_fn, |
| 725 | name='test_post_fork_child_no_deadlock lock holder') |
| 726 | lock_holder_thread.start() |
| 727 | |
| 728 | locks_held__ready_to_fork.wait() |
| 729 | pid = os.fork() |
| 730 | if pid == 0: # Child. |
Gregory P. Smith | 64aa6d2 | 2019-05-07 12:18:20 -0400 | [diff] [blame] | 731 | try: |
| 732 | test_logger.info(r'Child process did not deadlock. \o/') |
| 733 | finally: |
| 734 | os._exit(0) |
Gregory P. Smith | 1900384 | 2018-09-13 22:08:31 -0700 | [diff] [blame] | 735 | else: # Parent. |
Gregory P. Smith | 64aa6d2 | 2019-05-07 12:18:20 -0400 | [diff] [blame] | 736 | test_logger.info(r'Parent process returned from fork. \o/') |
Gregory P. Smith | 1900384 | 2018-09-13 22:08:31 -0700 | [diff] [blame] | 737 | fork_happened__release_locks_and_end_thread.set() |
| 738 | lock_holder_thread.join() |
| 739 | start_time = time.monotonic() |
| 740 | while True: |
Gregory P. Smith | 64aa6d2 | 2019-05-07 12:18:20 -0400 | [diff] [blame] | 741 | test_logger.debug('Waiting for child process.') |
Gregory P. Smith | 1900384 | 2018-09-13 22:08:31 -0700 | [diff] [blame] | 742 | waited_pid, status = os.waitpid(pid, os.WNOHANG) |
| 743 | if waited_pid == pid: |
| 744 | break # child process exited. |
| 745 | if time.monotonic() - start_time > 7: |
| 746 | break # so long? implies child deadlock. |
| 747 | time.sleep(0.05) |
Gregory P. Smith | 64aa6d2 | 2019-05-07 12:18:20 -0400 | [diff] [blame] | 748 | test_logger.debug('Done waiting.') |
Gregory P. Smith | 1900384 | 2018-09-13 22:08:31 -0700 | [diff] [blame] | 749 | if waited_pid != pid: |
| 750 | os.kill(pid, signal.SIGKILL) |
| 751 | waited_pid, status = os.waitpid(pid, 0) |
| 752 | self.fail("child process deadlocked.") |
| 753 | self.assertEqual(status, 0, msg="child process error") |
| 754 | |
Vinay Sajip | a5798de | 2012-04-24 23:33:33 +0100 | [diff] [blame] | 755 | |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 756 | class BadStream(object): |
| 757 | def write(self, data): |
| 758 | raise RuntimeError('deliberate mistake') |
| 759 | |
| 760 | class TestStreamHandler(logging.StreamHandler): |
| 761 | def handleError(self, record): |
| 762 | self.error_record = record |
| 763 | |
Riccardo Magliocchetti | ca87eeb | 2019-05-07 23:36:39 +0200 | [diff] [blame] | 764 | class StreamWithIntName(object): |
| 765 | level = logging.NOTSET |
| 766 | name = 2 |
| 767 | |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 768 | class StreamHandlerTest(BaseTest): |
| 769 | def test_error_handling(self): |
| 770 | h = TestStreamHandler(BadStream()) |
| 771 | r = logging.makeLogRecord({}) |
| 772 | old_raise = logging.raiseExceptions |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 773 | |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 774 | try: |
| 775 | h.handle(r) |
| 776 | self.assertIs(h.error_record, r) |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 777 | |
Vinay Sajip | 985ef87 | 2011-04-26 19:34:04 +0100 | [diff] [blame] | 778 | h = logging.StreamHandler(BadStream()) |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 779 | with support.captured_stderr() as stderr: |
| 780 | h.handle(r) |
| 781 | msg = '\nRuntimeError: deliberate mistake\n' |
| 782 | self.assertIn(msg, stderr.getvalue()) |
| 783 | |
Vinay Sajip | 985ef87 | 2011-04-26 19:34:04 +0100 | [diff] [blame] | 784 | logging.raiseExceptions = False |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 785 | with support.captured_stderr() as stderr: |
| 786 | h.handle(r) |
| 787 | self.assertEqual('', stderr.getvalue()) |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 788 | finally: |
| 789 | logging.raiseExceptions = old_raise |
| 790 | |
Vinay Sajip | 2543f50 | 2017-07-30 10:41:45 +0100 | [diff] [blame] | 791 | def test_stream_setting(self): |
| 792 | """ |
| 793 | Test setting the handler's stream |
| 794 | """ |
| 795 | h = logging.StreamHandler() |
| 796 | stream = io.StringIO() |
| 797 | old = h.setStream(stream) |
| 798 | self.assertIs(old, sys.stderr) |
| 799 | actual = h.setStream(old) |
| 800 | self.assertIs(actual, stream) |
| 801 | # test that setting to existing value returns None |
| 802 | actual = h.setStream(old) |
| 803 | self.assertIsNone(actual) |
| 804 | |
Riccardo Magliocchetti | ca87eeb | 2019-05-07 23:36:39 +0200 | [diff] [blame] | 805 | def test_can_represent_stream_with_int_name(self): |
| 806 | h = logging.StreamHandler(StreamWithIntName()) |
| 807 | self.assertEqual(repr(h), '<StreamHandler 2 (NOTSET)>') |
| 808 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 809 | # -- The following section could be moved into a server_helper.py module |
| 810 | # -- if it proves to be of wider utility than just test_logging |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 811 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 812 | class TestSMTPServer(smtpd.SMTPServer): |
| 813 | """ |
| 814 | This class implements a test SMTP server. |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 815 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 816 | :param addr: A (host, port) tuple which the server listens on. |
| 817 | You can specify a port value of zero: the server's |
| 818 | *port* attribute will hold the actual port number |
| 819 | used, which can be used in client connections. |
| 820 | :param handler: A callable which will be called to process |
| 821 | incoming messages. The handler will be passed |
| 822 | the client address tuple, who the message is from, |
| 823 | a list of recipients and the message data. |
| 824 | :param poll_interval: The interval, in seconds, used in the underlying |
| 825 | :func:`select` or :func:`poll` call by |
| 826 | :func:`asyncore.loop`. |
| 827 | :param sockmap: A dictionary which will be used to hold |
| 828 | :class:`asyncore.dispatcher` instances used by |
| 829 | :func:`asyncore.loop`. This avoids changing the |
| 830 | :mod:`asyncore` module's global state. |
| 831 | """ |
| 832 | |
| 833 | def __init__(self, addr, handler, poll_interval, sockmap): |
| 834 | smtpd.SMTPServer.__init__(self, addr, None, map=sockmap, |
| 835 | decode_data=True) |
| 836 | self.port = self.socket.getsockname()[1] |
| 837 | self._handler = handler |
| 838 | self._thread = None |
| 839 | self.poll_interval = poll_interval |
| 840 | |
| 841 | def process_message(self, peer, mailfrom, rcpttos, data): |
| 842 | """ |
| 843 | Delegates to the handler passed in to the server's constructor. |
| 844 | |
| 845 | Typically, this will be a test case method. |
| 846 | :param peer: The client (host, port) tuple. |
| 847 | :param mailfrom: The address of the sender. |
| 848 | :param rcpttos: The addresses of the recipients. |
| 849 | :param data: The message. |
| 850 | """ |
| 851 | self._handler(peer, mailfrom, rcpttos, data) |
| 852 | |
| 853 | def start(self): |
| 854 | """ |
| 855 | Start the server running on a separate daemon thread. |
| 856 | """ |
| 857 | self._thread = t = threading.Thread(target=self.serve_forever, |
| 858 | args=(self.poll_interval,)) |
| 859 | t.setDaemon(True) |
| 860 | t.start() |
| 861 | |
| 862 | def serve_forever(self, poll_interval): |
| 863 | """ |
| 864 | Run the :mod:`asyncore` loop until normal termination |
| 865 | conditions arise. |
Vinay Sajip | 314b92b | 2011-05-02 14:31:16 +0100 | [diff] [blame] | 866 | :param poll_interval: The interval, in seconds, used in the underlying |
| 867 | :func:`select` or :func:`poll` call by |
| 868 | :func:`asyncore.loop`. |
| 869 | """ |
Victor Stinner | 13ff245 | 2018-01-22 18:32:50 +0100 | [diff] [blame] | 870 | asyncore.loop(poll_interval, map=self._map) |
Vinay Sajip | ce7c978 | 2011-05-17 07:15:53 +0100 | [diff] [blame] | 871 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 872 | def stop(self, timeout=None): |
| 873 | """ |
| 874 | Stop the thread by closing the server instance. |
| 875 | Wait for the server thread to terminate. |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 876 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 877 | :param timeout: How long to wait for the server thread |
| 878 | to terminate. |
| 879 | """ |
| 880 | self.close() |
Victor Stinner | b9b6900 | 2017-09-14 14:40:56 -0700 | [diff] [blame] | 881 | support.join_thread(self._thread, timeout) |
| 882 | self._thread = None |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 883 | asyncore.close_all(map=self._map, ignore_all=True) |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 884 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 885 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 886 | class ControlMixin(object): |
| 887 | """ |
| 888 | This mixin is used to start a server on a separate thread, and |
| 889 | shut it down programmatically. Request handling is simplified - instead |
| 890 | of needing to derive a suitable RequestHandler subclass, you just |
| 891 | provide a callable which will be passed each received request to be |
| 892 | processed. |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 893 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 894 | :param handler: A handler callable which will be called with a |
| 895 | single parameter - the request - in order to |
| 896 | process the request. This handler is called on the |
| 897 | server thread, effectively meaning that requests are |
| 898 | processed serially. While not quite Web scale ;-), |
| 899 | this should be fine for testing applications. |
| 900 | :param poll_interval: The polling interval in seconds. |
| 901 | """ |
| 902 | def __init__(self, handler, poll_interval): |
| 903 | self._thread = None |
| 904 | self.poll_interval = poll_interval |
| 905 | self._handler = handler |
| 906 | self.ready = threading.Event() |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 907 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 908 | def start(self): |
| 909 | """ |
| 910 | Create a daemon thread to run the server, and start it. |
| 911 | """ |
| 912 | self._thread = t = threading.Thread(target=self.serve_forever, |
| 913 | args=(self.poll_interval,)) |
| 914 | t.setDaemon(True) |
| 915 | t.start() |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 916 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 917 | def serve_forever(self, poll_interval): |
| 918 | """ |
| 919 | Run the server. Set the ready flag before entering the |
| 920 | service loop. |
| 921 | """ |
| 922 | self.ready.set() |
| 923 | super(ControlMixin, self).serve_forever(poll_interval) |
| 924 | |
| 925 | def stop(self, timeout=None): |
| 926 | """ |
| 927 | Tell the server thread to stop, and wait for it to do so. |
| 928 | |
| 929 | :param timeout: How long to wait for the server thread |
| 930 | to terminate. |
| 931 | """ |
| 932 | self.shutdown() |
| 933 | if self._thread is not None: |
Victor Stinner | b9b6900 | 2017-09-14 14:40:56 -0700 | [diff] [blame] | 934 | support.join_thread(self._thread, timeout) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 935 | self._thread = None |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 936 | self.server_close() |
| 937 | self.ready.clear() |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 938 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 939 | class TestHTTPServer(ControlMixin, HTTPServer): |
| 940 | """ |
| 941 | An HTTP server which is controllable using :class:`ControlMixin`. |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 942 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 943 | :param addr: A tuple with the IP address and port to listen on. |
| 944 | :param handler: A handler callable which will be called with a |
| 945 | single parameter - the request - in order to |
| 946 | process the request. |
| 947 | :param poll_interval: The polling interval in seconds. |
| 948 | :param log: Pass ``True`` to enable log messages. |
| 949 | """ |
| 950 | def __init__(self, addr, handler, poll_interval=0.5, |
| 951 | log=False, sslctx=None): |
| 952 | class DelegatingHTTPRequestHandler(BaseHTTPRequestHandler): |
| 953 | def __getattr__(self, name, default=None): |
| 954 | if name.startswith('do_'): |
| 955 | return self.process_request |
| 956 | raise AttributeError(name) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 957 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 958 | def process_request(self): |
| 959 | self.server._handler(self) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 960 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 961 | def log_message(self, format, *args): |
| 962 | if log: |
| 963 | super(DelegatingHTTPRequestHandler, |
| 964 | self).log_message(format, *args) |
| 965 | HTTPServer.__init__(self, addr, DelegatingHTTPRequestHandler) |
| 966 | ControlMixin.__init__(self, handler, poll_interval) |
| 967 | self.sslctx = sslctx |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 968 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 969 | def get_request(self): |
| 970 | try: |
| 971 | sock, addr = self.socket.accept() |
| 972 | if self.sslctx: |
| 973 | sock = self.sslctx.wrap_socket(sock, server_side=True) |
| 974 | except OSError as e: |
| 975 | # socket errors are silenced by the caller, print them here |
| 976 | sys.stderr.write("Got an error:\n%s\n" % e) |
| 977 | raise |
| 978 | return sock, addr |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 979 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 980 | class TestTCPServer(ControlMixin, ThreadingTCPServer): |
| 981 | """ |
| 982 | A TCP server which is controllable using :class:`ControlMixin`. |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 983 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 984 | :param addr: A tuple with the IP address and port to listen on. |
| 985 | :param handler: A handler callable which will be called with a single |
| 986 | parameter - the request - in order to process the request. |
| 987 | :param poll_interval: The polling interval in seconds. |
| 988 | :bind_and_activate: If True (the default), binds the server and starts it |
| 989 | listening. If False, you need to call |
| 990 | :meth:`server_bind` and :meth:`server_activate` at |
| 991 | some later time before calling :meth:`start`, so that |
| 992 | the server will set up the socket and listen on it. |
| 993 | """ |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 994 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 995 | allow_reuse_address = True |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 996 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 997 | def __init__(self, addr, handler, poll_interval=0.5, |
| 998 | bind_and_activate=True): |
| 999 | class DelegatingTCPRequestHandler(StreamRequestHandler): |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1000 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1001 | def handle(self): |
| 1002 | self.server._handler(self) |
| 1003 | ThreadingTCPServer.__init__(self, addr, DelegatingTCPRequestHandler, |
| 1004 | bind_and_activate) |
| 1005 | ControlMixin.__init__(self, handler, poll_interval) |
Vinay Sajip | 32565b6 | 2011-05-21 00:34:51 +0100 | [diff] [blame] | 1006 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1007 | def server_bind(self): |
| 1008 | super(TestTCPServer, self).server_bind() |
| 1009 | self.port = self.socket.getsockname()[1] |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1010 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1011 | class TestUDPServer(ControlMixin, ThreadingUDPServer): |
| 1012 | """ |
| 1013 | A UDP server which is controllable using :class:`ControlMixin`. |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1014 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1015 | :param addr: A tuple with the IP address and port to listen on. |
| 1016 | :param handler: A handler callable which will be called with a |
| 1017 | single parameter - the request - in order to |
| 1018 | process the request. |
| 1019 | :param poll_interval: The polling interval for shutdown requests, |
| 1020 | in seconds. |
| 1021 | :bind_and_activate: If True (the default), binds the server and |
| 1022 | starts it listening. If False, you need to |
| 1023 | call :meth:`server_bind` and |
| 1024 | :meth:`server_activate` at some later time |
| 1025 | before calling :meth:`start`, so that the server will |
| 1026 | set up the socket and listen on it. |
| 1027 | """ |
| 1028 | def __init__(self, addr, handler, poll_interval=0.5, |
| 1029 | bind_and_activate=True): |
| 1030 | class DelegatingUDPRequestHandler(DatagramRequestHandler): |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1031 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1032 | def handle(self): |
| 1033 | self.server._handler(self) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1034 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1035 | def finish(self): |
| 1036 | data = self.wfile.getvalue() |
| 1037 | if data: |
| 1038 | try: |
| 1039 | super(DelegatingUDPRequestHandler, self).finish() |
| 1040 | except OSError: |
| 1041 | if not self.server._closed: |
| 1042 | raise |
Vinay Sajip | ce7c978 | 2011-05-17 07:15:53 +0100 | [diff] [blame] | 1043 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1044 | ThreadingUDPServer.__init__(self, addr, |
| 1045 | DelegatingUDPRequestHandler, |
| 1046 | bind_and_activate) |
| 1047 | ControlMixin.__init__(self, handler, poll_interval) |
| 1048 | self._closed = False |
Vinay Sajip | ce7c978 | 2011-05-17 07:15:53 +0100 | [diff] [blame] | 1049 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1050 | def server_bind(self): |
| 1051 | super(TestUDPServer, self).server_bind() |
| 1052 | self.port = self.socket.getsockname()[1] |
Vinay Sajip | ce7c978 | 2011-05-17 07:15:53 +0100 | [diff] [blame] | 1053 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1054 | def server_close(self): |
| 1055 | super(TestUDPServer, self).server_close() |
| 1056 | self._closed = True |
Vinay Sajip | ce7c978 | 2011-05-17 07:15:53 +0100 | [diff] [blame] | 1057 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1058 | if hasattr(socket, "AF_UNIX"): |
| 1059 | class TestUnixStreamServer(TestTCPServer): |
| 1060 | address_family = socket.AF_UNIX |
Vinay Sajip | ce7c978 | 2011-05-17 07:15:53 +0100 | [diff] [blame] | 1061 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1062 | class TestUnixDatagramServer(TestUDPServer): |
| 1063 | address_family = socket.AF_UNIX |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1064 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1065 | # - end of server_helper section |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 1066 | |
| 1067 | class SMTPHandlerTest(BaseTest): |
Victor Stinner | 31b50b8 | 2018-07-11 12:35:38 +0200 | [diff] [blame] | 1068 | # bpo-14314, bpo-19665, bpo-34092: don't wait forever, timeout of 1 minute |
| 1069 | TIMEOUT = 60.0 |
Victor Stinner | 4bcfa3a | 2017-04-25 00:41:36 +0200 | [diff] [blame] | 1070 | |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 1071 | def test_basic(self): |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1072 | sockmap = {} |
Ned Deily | 1e012e6 | 2015-01-17 16:57:19 -0800 | [diff] [blame] | 1073 | server = TestSMTPServer((support.HOST, 0), self.process_message, 0.001, |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1074 | sockmap) |
| 1075 | server.start() |
Ned Deily | 1e012e6 | 2015-01-17 16:57:19 -0800 | [diff] [blame] | 1076 | addr = (support.HOST, server.port) |
Vinay Sajip | 827f5d3 | 2013-12-03 11:28:55 +0000 | [diff] [blame] | 1077 | h = logging.handlers.SMTPHandler(addr, 'me', 'you', 'Log', |
| 1078 | timeout=self.TIMEOUT) |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 1079 | self.assertEqual(h.toaddrs, ['you']) |
| 1080 | self.messages = [] |
Vinay Sajip | 277640a | 2015-10-17 16:13:10 +0100 | [diff] [blame] | 1081 | r = logging.makeLogRecord({'msg': 'Hello \u2713'}) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1082 | self.handled = threading.Event() |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 1083 | h.handle(r) |
Victor Stinner | 31b50b8 | 2018-07-11 12:35:38 +0200 | [diff] [blame] | 1084 | self.handled.wait(self.TIMEOUT) |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 1085 | server.stop() |
Vinay Sajip | 17160fd | 2012-03-15 12:02:08 +0000 | [diff] [blame] | 1086 | self.assertTrue(self.handled.is_set()) |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 1087 | self.assertEqual(len(self.messages), 1) |
| 1088 | peer, mailfrom, rcpttos, data = self.messages[0] |
| 1089 | self.assertEqual(mailfrom, 'me') |
| 1090 | self.assertEqual(rcpttos, ['you']) |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 1091 | self.assertIn('\nSubject: Log\n', data) |
Vinay Sajip | 277640a | 2015-10-17 16:13:10 +0100 | [diff] [blame] | 1092 | self.assertTrue(data.endswith('\n\nHello \u2713')) |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 1093 | h.close() |
| 1094 | |
| 1095 | def process_message(self, *args): |
| 1096 | self.messages.append(args) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1097 | self.handled.set() |
Vinay Sajip | a463d25 | 2011-04-30 21:52:48 +0100 | [diff] [blame] | 1098 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1099 | class MemoryHandlerTest(BaseTest): |
| 1100 | |
| 1101 | """Tests for the MemoryHandler.""" |
| 1102 | |
| 1103 | # Do not bother with a logger name group. |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 1104 | expected_log_pat = r"^[\w.]+ -> (\w+): (\d+)$" |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1105 | |
| 1106 | def setUp(self): |
| 1107 | BaseTest.setUp(self) |
| 1108 | self.mem_hdlr = logging.handlers.MemoryHandler(10, logging.WARNING, |
Vinay Sajip | db8f463 | 2016-09-08 01:37:03 +0100 | [diff] [blame] | 1109 | self.root_hdlr) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1110 | self.mem_logger = logging.getLogger('mem') |
| 1111 | self.mem_logger.propagate = 0 |
| 1112 | self.mem_logger.addHandler(self.mem_hdlr) |
| 1113 | |
| 1114 | def tearDown(self): |
| 1115 | self.mem_hdlr.close() |
Benjamin Peterson | 2a691a8 | 2008-03-31 01:51:45 +0000 | [diff] [blame] | 1116 | BaseTest.tearDown(self) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1117 | |
| 1118 | def test_flush(self): |
| 1119 | # The memory handler flushes to its target handler based on specific |
| 1120 | # criteria (message count and message level). |
| 1121 | self.mem_logger.debug(self.next_message()) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1122 | self.assert_log_lines([]) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1123 | self.mem_logger.info(self.next_message()) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1124 | self.assert_log_lines([]) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1125 | # This will flush because the level is >= logging.WARNING |
Vinay Sajip | b9e46e9 | 2011-10-26 13:17:20 +0100 | [diff] [blame] | 1126 | self.mem_logger.warning(self.next_message()) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1127 | lines = [ |
| 1128 | ('DEBUG', '1'), |
| 1129 | ('INFO', '2'), |
| 1130 | ('WARNING', '3'), |
| 1131 | ] |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1132 | self.assert_log_lines(lines) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1133 | for n in (4, 14): |
| 1134 | for i in range(9): |
| 1135 | self.mem_logger.debug(self.next_message()) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1136 | self.assert_log_lines(lines) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1137 | # This will flush because it's the 10th message since the last |
| 1138 | # flush. |
| 1139 | self.mem_logger.debug(self.next_message()) |
| 1140 | lines = lines + [('DEBUG', str(i)) for i in range(n, n + 10)] |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1141 | self.assert_log_lines(lines) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1142 | |
| 1143 | self.mem_logger.debug(self.next_message()) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1144 | self.assert_log_lines(lines) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1145 | |
Vinay Sajip | db8f463 | 2016-09-08 01:37:03 +0100 | [diff] [blame] | 1146 | def test_flush_on_close(self): |
| 1147 | """ |
| 1148 | Test that the flush-on-close configuration works as expected. |
| 1149 | """ |
| 1150 | self.mem_logger.debug(self.next_message()) |
| 1151 | self.assert_log_lines([]) |
| 1152 | self.mem_logger.info(self.next_message()) |
| 1153 | self.assert_log_lines([]) |
| 1154 | self.mem_logger.removeHandler(self.mem_hdlr) |
| 1155 | # Default behaviour is to flush on close. Check that it happens. |
| 1156 | self.mem_hdlr.close() |
| 1157 | lines = [ |
| 1158 | ('DEBUG', '1'), |
| 1159 | ('INFO', '2'), |
| 1160 | ] |
| 1161 | self.assert_log_lines(lines) |
| 1162 | # Now configure for flushing not to be done on close. |
| 1163 | self.mem_hdlr = logging.handlers.MemoryHandler(10, logging.WARNING, |
| 1164 | self.root_hdlr, |
| 1165 | False) |
| 1166 | self.mem_logger.addHandler(self.mem_hdlr) |
| 1167 | self.mem_logger.debug(self.next_message()) |
| 1168 | self.assert_log_lines(lines) # no change |
| 1169 | self.mem_logger.info(self.next_message()) |
| 1170 | self.assert_log_lines(lines) # no change |
| 1171 | self.mem_logger.removeHandler(self.mem_hdlr) |
| 1172 | self.mem_hdlr.close() |
| 1173 | # assert that no new lines have been added |
| 1174 | self.assert_log_lines(lines) # no change |
| 1175 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1176 | |
| 1177 | class ExceptionFormatter(logging.Formatter): |
| 1178 | """A special exception formatter.""" |
| 1179 | def formatException(self, ei): |
| 1180 | return "Got a [%s]" % ei[0].__name__ |
| 1181 | |
| 1182 | |
| 1183 | class ConfigFileTest(BaseTest): |
| 1184 | |
| 1185 | """Reading logging config from a .ini-style config file.""" |
| 1186 | |
Xtreak | 087570a | 2018-07-02 14:27:46 +0530 | [diff] [blame] | 1187 | check_no_resource_warning = support.check_no_resource_warning |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 1188 | expected_log_pat = r"^(\w+) \+\+ (\w+)$" |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1189 | |
| 1190 | # config0 is a standard configuration. |
| 1191 | config0 = """ |
| 1192 | [loggers] |
| 1193 | keys=root |
| 1194 | |
| 1195 | [handlers] |
| 1196 | keys=hand1 |
| 1197 | |
| 1198 | [formatters] |
| 1199 | keys=form1 |
| 1200 | |
| 1201 | [logger_root] |
| 1202 | level=WARNING |
| 1203 | handlers=hand1 |
| 1204 | |
| 1205 | [handler_hand1] |
| 1206 | class=StreamHandler |
| 1207 | level=NOTSET |
| 1208 | formatter=form1 |
| 1209 | args=(sys.stdout,) |
| 1210 | |
| 1211 | [formatter_form1] |
| 1212 | format=%(levelname)s ++ %(message)s |
| 1213 | datefmt= |
| 1214 | """ |
| 1215 | |
| 1216 | # config1 adds a little to the standard configuration. |
| 1217 | config1 = """ |
| 1218 | [loggers] |
| 1219 | keys=root,parser |
| 1220 | |
| 1221 | [handlers] |
| 1222 | keys=hand1 |
| 1223 | |
| 1224 | [formatters] |
| 1225 | keys=form1 |
| 1226 | |
| 1227 | [logger_root] |
| 1228 | level=WARNING |
| 1229 | handlers= |
| 1230 | |
| 1231 | [logger_parser] |
| 1232 | level=DEBUG |
| 1233 | handlers=hand1 |
| 1234 | propagate=1 |
| 1235 | qualname=compiler.parser |
| 1236 | |
| 1237 | [handler_hand1] |
| 1238 | class=StreamHandler |
| 1239 | level=NOTSET |
| 1240 | formatter=form1 |
| 1241 | args=(sys.stdout,) |
| 1242 | |
| 1243 | [formatter_form1] |
| 1244 | format=%(levelname)s ++ %(message)s |
| 1245 | datefmt= |
| 1246 | """ |
| 1247 | |
Vinay Sajip | 3f84b07 | 2011-03-07 17:49:33 +0000 | [diff] [blame] | 1248 | # config1a moves the handler to the root. |
| 1249 | config1a = """ |
| 1250 | [loggers] |
| 1251 | keys=root,parser |
| 1252 | |
| 1253 | [handlers] |
| 1254 | keys=hand1 |
| 1255 | |
| 1256 | [formatters] |
| 1257 | keys=form1 |
| 1258 | |
| 1259 | [logger_root] |
| 1260 | level=WARNING |
| 1261 | handlers=hand1 |
| 1262 | |
| 1263 | [logger_parser] |
| 1264 | level=DEBUG |
| 1265 | handlers= |
| 1266 | propagate=1 |
| 1267 | qualname=compiler.parser |
| 1268 | |
| 1269 | [handler_hand1] |
| 1270 | class=StreamHandler |
| 1271 | level=NOTSET |
| 1272 | formatter=form1 |
| 1273 | args=(sys.stdout,) |
| 1274 | |
| 1275 | [formatter_form1] |
| 1276 | format=%(levelname)s ++ %(message)s |
| 1277 | datefmt= |
| 1278 | """ |
| 1279 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1280 | # config2 has a subtle configuration error that should be reported |
| 1281 | config2 = config1.replace("sys.stdout", "sys.stbout") |
| 1282 | |
| 1283 | # config3 has a less subtle configuration error |
| 1284 | config3 = config1.replace("formatter=form1", "formatter=misspelled_name") |
| 1285 | |
| 1286 | # config4 specifies a custom formatter class to be loaded |
| 1287 | config4 = """ |
| 1288 | [loggers] |
| 1289 | keys=root |
| 1290 | |
| 1291 | [handlers] |
| 1292 | keys=hand1 |
| 1293 | |
| 1294 | [formatters] |
| 1295 | keys=form1 |
| 1296 | |
| 1297 | [logger_root] |
| 1298 | level=NOTSET |
| 1299 | handlers=hand1 |
| 1300 | |
| 1301 | [handler_hand1] |
| 1302 | class=StreamHandler |
| 1303 | level=NOTSET |
| 1304 | formatter=form1 |
| 1305 | args=(sys.stdout,) |
| 1306 | |
| 1307 | [formatter_form1] |
| 1308 | class=""" + __name__ + """.ExceptionFormatter |
| 1309 | format=%(levelname)s:%(name)s:%(message)s |
| 1310 | datefmt= |
| 1311 | """ |
| 1312 | |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 1313 | # config5 specifies a custom handler class to be loaded |
| 1314 | config5 = config1.replace('class=StreamHandler', 'class=logging.StreamHandler') |
| 1315 | |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 1316 | # config6 uses ', ' delimiters in the handlers and formatters sections |
| 1317 | config6 = """ |
| 1318 | [loggers] |
| 1319 | keys=root,parser |
| 1320 | |
| 1321 | [handlers] |
| 1322 | keys=hand1, hand2 |
| 1323 | |
| 1324 | [formatters] |
| 1325 | keys=form1, form2 |
| 1326 | |
| 1327 | [logger_root] |
| 1328 | level=WARNING |
| 1329 | handlers= |
| 1330 | |
| 1331 | [logger_parser] |
| 1332 | level=DEBUG |
| 1333 | handlers=hand1 |
| 1334 | propagate=1 |
| 1335 | qualname=compiler.parser |
| 1336 | |
| 1337 | [handler_hand1] |
| 1338 | class=StreamHandler |
| 1339 | level=NOTSET |
| 1340 | formatter=form1 |
| 1341 | args=(sys.stdout,) |
| 1342 | |
| 1343 | [handler_hand2] |
Benjamin Peterson | 9aa4299 | 2008-09-10 21:57:34 +0000 | [diff] [blame] | 1344 | class=StreamHandler |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 1345 | level=NOTSET |
| 1346 | formatter=form1 |
Benjamin Peterson | 9aa4299 | 2008-09-10 21:57:34 +0000 | [diff] [blame] | 1347 | args=(sys.stderr,) |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 1348 | |
| 1349 | [formatter_form1] |
| 1350 | format=%(levelname)s ++ %(message)s |
| 1351 | datefmt= |
| 1352 | |
| 1353 | [formatter_form2] |
| 1354 | format=%(message)s |
| 1355 | datefmt= |
| 1356 | """ |
| 1357 | |
Preston Landers | 6ea56d2 | 2017-08-02 15:44:28 -0500 | [diff] [blame] | 1358 | # config7 adds a compiler logger, and uses kwargs instead of args. |
Vinay Sajip | 3f84b07 | 2011-03-07 17:49:33 +0000 | [diff] [blame] | 1359 | config7 = """ |
| 1360 | [loggers] |
| 1361 | keys=root,parser,compiler |
| 1362 | |
| 1363 | [handlers] |
| 1364 | keys=hand1 |
| 1365 | |
| 1366 | [formatters] |
| 1367 | keys=form1 |
| 1368 | |
| 1369 | [logger_root] |
| 1370 | level=WARNING |
| 1371 | handlers=hand1 |
| 1372 | |
| 1373 | [logger_compiler] |
| 1374 | level=DEBUG |
| 1375 | handlers= |
| 1376 | propagate=1 |
| 1377 | qualname=compiler |
| 1378 | |
| 1379 | [logger_parser] |
| 1380 | level=DEBUG |
| 1381 | handlers= |
| 1382 | propagate=1 |
| 1383 | qualname=compiler.parser |
| 1384 | |
| 1385 | [handler_hand1] |
| 1386 | class=StreamHandler |
| 1387 | level=NOTSET |
| 1388 | formatter=form1 |
Preston Landers | 6ea56d2 | 2017-08-02 15:44:28 -0500 | [diff] [blame] | 1389 | kwargs={'stream': sys.stdout,} |
Vinay Sajip | 3f84b07 | 2011-03-07 17:49:33 +0000 | [diff] [blame] | 1390 | |
| 1391 | [formatter_form1] |
| 1392 | format=%(levelname)s ++ %(message)s |
| 1393 | datefmt= |
| 1394 | """ |
| 1395 | |
Xtreak | 087570a | 2018-07-02 14:27:46 +0530 | [diff] [blame] | 1396 | # config 8, check for resource warning |
| 1397 | config8 = r""" |
| 1398 | [loggers] |
| 1399 | keys=root |
| 1400 | |
| 1401 | [handlers] |
| 1402 | keys=file |
| 1403 | |
| 1404 | [formatters] |
| 1405 | keys= |
| 1406 | |
| 1407 | [logger_root] |
| 1408 | level=DEBUG |
| 1409 | handlers=file |
| 1410 | |
| 1411 | [handler_file] |
| 1412 | class=FileHandler |
| 1413 | level=DEBUG |
| 1414 | args=("{tempfile}",) |
| 1415 | """ |
| 1416 | |
Vinay Sajip | 68b4cc8 | 2013-03-23 11:18:45 +0000 | [diff] [blame] | 1417 | disable_test = """ |
| 1418 | [loggers] |
| 1419 | keys=root |
| 1420 | |
| 1421 | [handlers] |
| 1422 | keys=screen |
| 1423 | |
| 1424 | [formatters] |
| 1425 | keys= |
| 1426 | |
| 1427 | [logger_root] |
| 1428 | level=DEBUG |
| 1429 | handlers=screen |
| 1430 | |
| 1431 | [handler_screen] |
| 1432 | level=DEBUG |
| 1433 | class=StreamHandler |
| 1434 | args=(sys.stdout,) |
| 1435 | formatter= |
| 1436 | """ |
| 1437 | |
| 1438 | def apply_config(self, conf, **kwargs): |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 1439 | file = io.StringIO(textwrap.dedent(conf)) |
Vinay Sajip | 68b4cc8 | 2013-03-23 11:18:45 +0000 | [diff] [blame] | 1440 | logging.config.fileConfig(file, **kwargs) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1441 | |
| 1442 | def test_config0_ok(self): |
| 1443 | # A simple config file which overrides the default settings. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 1444 | with support.captured_stdout() as output: |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1445 | self.apply_config(self.config0) |
| 1446 | logger = logging.getLogger() |
| 1447 | # Won't output anything |
| 1448 | logger.info(self.next_message()) |
| 1449 | # Outputs a message |
| 1450 | logger.error(self.next_message()) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1451 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1452 | ('ERROR', '2'), |
| 1453 | ], stream=output) |
| 1454 | # Original logger output is empty. |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1455 | self.assert_log_lines([]) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1456 | |
Vinay Sajip | cf9e2f2 | 2012-10-09 09:06:03 +0100 | [diff] [blame] | 1457 | def test_config0_using_cp_ok(self): |
| 1458 | # A simple config file which overrides the default settings. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 1459 | with support.captured_stdout() as output: |
Vinay Sajip | cf9e2f2 | 2012-10-09 09:06:03 +0100 | [diff] [blame] | 1460 | file = io.StringIO(textwrap.dedent(self.config0)) |
| 1461 | cp = configparser.ConfigParser() |
| 1462 | cp.read_file(file) |
| 1463 | logging.config.fileConfig(cp) |
| 1464 | logger = logging.getLogger() |
| 1465 | # Won't output anything |
| 1466 | logger.info(self.next_message()) |
| 1467 | # Outputs a message |
| 1468 | logger.error(self.next_message()) |
| 1469 | self.assert_log_lines([ |
| 1470 | ('ERROR', '2'), |
| 1471 | ], stream=output) |
| 1472 | # Original logger output is empty. |
| 1473 | self.assert_log_lines([]) |
| 1474 | |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 1475 | def test_config1_ok(self, config=config1): |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1476 | # A config file defining a sub-parser as well. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 1477 | with support.captured_stdout() as output: |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 1478 | self.apply_config(config) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1479 | logger = logging.getLogger("compiler.parser") |
| 1480 | # Both will output a message |
| 1481 | logger.info(self.next_message()) |
| 1482 | logger.error(self.next_message()) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1483 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1484 | ('INFO', '1'), |
| 1485 | ('ERROR', '2'), |
| 1486 | ], stream=output) |
| 1487 | # Original logger output is empty. |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1488 | self.assert_log_lines([]) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1489 | |
| 1490 | def test_config2_failure(self): |
| 1491 | # A simple config file which overrides the default settings. |
| 1492 | self.assertRaises(Exception, self.apply_config, self.config2) |
| 1493 | |
| 1494 | def test_config3_failure(self): |
| 1495 | # A simple config file which overrides the default settings. |
| 1496 | self.assertRaises(Exception, self.apply_config, self.config3) |
| 1497 | |
| 1498 | def test_config4_ok(self): |
| 1499 | # A config file specifying a custom formatter class. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 1500 | with support.captured_stdout() as output: |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1501 | self.apply_config(self.config4) |
| 1502 | logger = logging.getLogger() |
| 1503 | try: |
| 1504 | raise RuntimeError() |
| 1505 | except RuntimeError: |
| 1506 | logging.exception("just testing") |
| 1507 | sys.stdout.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1508 | self.assertEqual(output.getvalue(), |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1509 | "ERROR:root:just testing\nGot a [RuntimeError]\n") |
| 1510 | # Original logger output is empty |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 1511 | self.assert_log_lines([]) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1512 | |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 1513 | def test_config5_ok(self): |
| 1514 | self.test_config1_ok(config=self.config5) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1515 | |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 1516 | def test_config6_ok(self): |
| 1517 | self.test_config1_ok(config=self.config6) |
| 1518 | |
Vinay Sajip | 3f84b07 | 2011-03-07 17:49:33 +0000 | [diff] [blame] | 1519 | def test_config7_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 1520 | with support.captured_stdout() as output: |
Vinay Sajip | 3f84b07 | 2011-03-07 17:49:33 +0000 | [diff] [blame] | 1521 | self.apply_config(self.config1a) |
| 1522 | logger = logging.getLogger("compiler.parser") |
| 1523 | # See issue #11424. compiler-hyphenated sorts |
| 1524 | # between compiler and compiler.xyz and this |
| 1525 | # was preventing compiler.xyz from being included |
| 1526 | # in the child loggers of compiler because of an |
| 1527 | # overzealous loop termination condition. |
| 1528 | hyphenated = logging.getLogger('compiler-hyphenated') |
| 1529 | # All will output a message |
| 1530 | logger.info(self.next_message()) |
| 1531 | logger.error(self.next_message()) |
| 1532 | hyphenated.critical(self.next_message()) |
| 1533 | self.assert_log_lines([ |
| 1534 | ('INFO', '1'), |
| 1535 | ('ERROR', '2'), |
| 1536 | ('CRITICAL', '3'), |
| 1537 | ], stream=output) |
| 1538 | # Original logger output is empty. |
| 1539 | self.assert_log_lines([]) |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 1540 | with support.captured_stdout() as output: |
Vinay Sajip | 3f84b07 | 2011-03-07 17:49:33 +0000 | [diff] [blame] | 1541 | self.apply_config(self.config7) |
| 1542 | logger = logging.getLogger("compiler.parser") |
| 1543 | self.assertFalse(logger.disabled) |
| 1544 | # Both will output a message |
| 1545 | logger.info(self.next_message()) |
| 1546 | logger.error(self.next_message()) |
| 1547 | logger = logging.getLogger("compiler.lexer") |
| 1548 | # Both will output a message |
| 1549 | logger.info(self.next_message()) |
| 1550 | logger.error(self.next_message()) |
| 1551 | # Will not appear |
| 1552 | hyphenated.critical(self.next_message()) |
| 1553 | self.assert_log_lines([ |
| 1554 | ('INFO', '4'), |
| 1555 | ('ERROR', '5'), |
| 1556 | ('INFO', '6'), |
| 1557 | ('ERROR', '7'), |
| 1558 | ], stream=output) |
| 1559 | # Original logger output is empty. |
| 1560 | self.assert_log_lines([]) |
| 1561 | |
Xtreak | 087570a | 2018-07-02 14:27:46 +0530 | [diff] [blame] | 1562 | def test_config8_ok(self): |
| 1563 | |
| 1564 | def cleanup(h1, fn): |
| 1565 | h1.close() |
| 1566 | os.remove(fn) |
| 1567 | |
| 1568 | with self.check_no_resource_warning(): |
| 1569 | fd, fn = tempfile.mkstemp(".log", "test_logging-X-") |
| 1570 | os.close(fd) |
| 1571 | |
| 1572 | # Replace single backslash with double backslash in windows |
| 1573 | # to avoid unicode error during string formatting |
| 1574 | if os.name == "nt": |
| 1575 | fn = fn.replace("\\", "\\\\") |
| 1576 | |
| 1577 | config8 = self.config8.format(tempfile=fn) |
| 1578 | |
| 1579 | self.apply_config(config8) |
| 1580 | self.apply_config(config8) |
| 1581 | |
| 1582 | handler = logging.root.handlers[0] |
| 1583 | self.addCleanup(cleanup, handler, fn) |
| 1584 | |
Vinay Sajip | 68b4cc8 | 2013-03-23 11:18:45 +0000 | [diff] [blame] | 1585 | def test_logger_disabling(self): |
| 1586 | self.apply_config(self.disable_test) |
Antoine Pitrou | 04d4d6a | 2013-09-14 21:16:39 +0200 | [diff] [blame] | 1587 | logger = logging.getLogger('some_pristine_logger') |
Vinay Sajip | 68b4cc8 | 2013-03-23 11:18:45 +0000 | [diff] [blame] | 1588 | self.assertFalse(logger.disabled) |
| 1589 | self.apply_config(self.disable_test) |
| 1590 | self.assertTrue(logger.disabled) |
| 1591 | self.apply_config(self.disable_test, disable_existing_loggers=False) |
| 1592 | self.assertFalse(logger.disabled) |
| 1593 | |
Łukasz Langa | 214f18e | 2018-06-08 04:02:48 -0700 | [diff] [blame] | 1594 | def test_defaults_do_no_interpolation(self): |
| 1595 | """bpo-33802 defaults should not get interpolated""" |
| 1596 | ini = textwrap.dedent(""" |
| 1597 | [formatters] |
| 1598 | keys=default |
| 1599 | |
| 1600 | [formatter_default] |
| 1601 | |
| 1602 | [handlers] |
| 1603 | keys=console |
| 1604 | |
| 1605 | [handler_console] |
| 1606 | class=logging.StreamHandler |
| 1607 | args=tuple() |
| 1608 | |
| 1609 | [loggers] |
| 1610 | keys=root |
| 1611 | |
| 1612 | [logger_root] |
| 1613 | formatter=default |
| 1614 | handlers=console |
| 1615 | """).strip() |
| 1616 | fd, fn = tempfile.mkstemp(prefix='test_logging_', suffix='.ini') |
| 1617 | try: |
| 1618 | os.write(fd, ini.encode('ascii')) |
| 1619 | os.close(fd) |
| 1620 | logging.config.fileConfig( |
| 1621 | fn, |
| 1622 | defaults=dict( |
| 1623 | version=1, |
| 1624 | disable_existing_loggers=False, |
| 1625 | formatters={ |
| 1626 | "generic": { |
| 1627 | "format": "%(asctime)s [%(process)d] [%(levelname)s] %(message)s", |
| 1628 | "datefmt": "[%Y-%m-%d %H:%M:%S %z]", |
| 1629 | "class": "logging.Formatter" |
| 1630 | }, |
| 1631 | }, |
| 1632 | ) |
| 1633 | ) |
| 1634 | finally: |
| 1635 | os.unlink(fn) |
| 1636 | |
Guido van Rossum | 2a1d516 | 2003-01-21 21:05:22 +0000 | [diff] [blame] | 1637 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1638 | class SocketHandlerTest(BaseTest): |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 1639 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1640 | """Test for SocketHandler objects.""" |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 1641 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1642 | server_class = TestTCPServer |
| 1643 | address = ('localhost', 0) |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1644 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1645 | def setUp(self): |
| 1646 | """Set up a TCP server to receive log messages, and a SocketHandler |
| 1647 | pointing to that server's address and port.""" |
| 1648 | BaseTest.setUp(self) |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1649 | # Issue #29177: deal with errors that happen during setup |
| 1650 | self.server = self.sock_hdlr = self.server_exception = None |
| 1651 | try: |
| 1652 | self.server = server = self.server_class(self.address, |
| 1653 | self.handle_socket, 0.01) |
| 1654 | server.start() |
| 1655 | # Uncomment next line to test error recovery in setUp() |
| 1656 | # raise OSError('dummy error raised') |
| 1657 | except OSError as e: |
| 1658 | self.server_exception = e |
| 1659 | return |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1660 | server.ready.wait() |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1661 | hcls = logging.handlers.SocketHandler |
| 1662 | if isinstance(server.server_address, tuple): |
| 1663 | self.sock_hdlr = hcls('localhost', server.port) |
| 1664 | else: |
| 1665 | self.sock_hdlr = hcls(server.server_address, None) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1666 | self.log_output = '' |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1667 | self.root_logger.removeHandler(self.root_logger.handlers[0]) |
| 1668 | self.root_logger.addHandler(self.sock_hdlr) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1669 | self.handled = threading.Semaphore(0) |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 1670 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1671 | def tearDown(self): |
| 1672 | """Shutdown the TCP server.""" |
| 1673 | try: |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1674 | if self.sock_hdlr: |
| 1675 | self.root_logger.removeHandler(self.sock_hdlr) |
| 1676 | self.sock_hdlr.close() |
Victor Stinner | b8f4163 | 2017-09-13 01:47:22 -0700 | [diff] [blame] | 1677 | if self.server: |
| 1678 | self.server.stop(2.0) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1679 | finally: |
| 1680 | BaseTest.tearDown(self) |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 1681 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1682 | def handle_socket(self, request): |
| 1683 | conn = request.connection |
| 1684 | while True: |
| 1685 | chunk = conn.recv(4) |
| 1686 | if len(chunk) < 4: |
| 1687 | break |
| 1688 | slen = struct.unpack(">L", chunk)[0] |
| 1689 | chunk = conn.recv(slen) |
| 1690 | while len(chunk) < slen: |
| 1691 | chunk = chunk + conn.recv(slen - len(chunk)) |
| 1692 | obj = pickle.loads(chunk) |
| 1693 | record = logging.makeLogRecord(obj) |
| 1694 | self.log_output += record.msg + '\n' |
| 1695 | self.handled.release() |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 1696 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1697 | def test_output(self): |
| 1698 | # The log message sent to the SocketHandler is properly received. |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1699 | if self.server_exception: |
| 1700 | self.skipTest(self.server_exception) |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1701 | logger = logging.getLogger("tcp") |
| 1702 | logger.error("spam") |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1703 | self.handled.acquire() |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 1704 | logger.debug("eggs") |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1705 | self.handled.acquire() |
| 1706 | self.assertEqual(self.log_output, "spam\neggs\n") |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 1707 | |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 1708 | def test_noserver(self): |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1709 | if self.server_exception: |
| 1710 | self.skipTest(self.server_exception) |
Antoine Pitrou | da201fa | 2012-10-21 17:18:27 +0200 | [diff] [blame] | 1711 | # Avoid timing-related failures due to SocketHandler's own hard-wired |
| 1712 | # one-second timeout on socket.create_connection() (issue #16264). |
| 1713 | self.sock_hdlr.retryStart = 2.5 |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 1714 | # Kill the server |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1715 | self.server.stop(2.0) |
Antoine Pitrou | da201fa | 2012-10-21 17:18:27 +0200 | [diff] [blame] | 1716 | # The logging call should try to connect, which should fail |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 1717 | try: |
| 1718 | raise RuntimeError('Deliberate mistake') |
| 1719 | except RuntimeError: |
| 1720 | self.root_logger.exception('Never sent') |
| 1721 | self.root_logger.error('Never sent, either') |
| 1722 | now = time.time() |
Giampaolo Rodola' | 284529d | 2012-10-17 13:24:27 +0200 | [diff] [blame] | 1723 | self.assertGreater(self.sock_hdlr.retryTime, now) |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 1724 | time.sleep(self.sock_hdlr.retryTime - now + 0.001) |
| 1725 | self.root_logger.error('Nor this') |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 1726 | |
Vinay Sajip | f6cdffe | 2013-09-27 18:41:12 +0100 | [diff] [blame] | 1727 | def _get_temp_domain_socket(): |
| 1728 | fd, fn = tempfile.mkstemp(prefix='test_logging_', suffix='.sock') |
| 1729 | os.close(fd) |
| 1730 | # just need a name - file can't be present, or we'll get an |
| 1731 | # 'address already in use' error. |
| 1732 | os.remove(fn) |
| 1733 | return fn |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1734 | |
Victor Stinner | ec5a860 | 2014-06-02 14:41:51 +0200 | [diff] [blame] | 1735 | @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required") |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1736 | class UnixSocketHandlerTest(SocketHandlerTest): |
| 1737 | |
| 1738 | """Test for SocketHandler with unix sockets.""" |
| 1739 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1740 | if hasattr(socket, "AF_UNIX"): |
Vinay Sajip | cb2c4fe | 2013-09-27 19:08:24 +0100 | [diff] [blame] | 1741 | server_class = TestUnixStreamServer |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1742 | |
| 1743 | def setUp(self): |
| 1744 | # override the definition in the base class |
Vinay Sajip | f6cdffe | 2013-09-27 18:41:12 +0100 | [diff] [blame] | 1745 | self.address = _get_temp_domain_socket() |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1746 | SocketHandlerTest.setUp(self) |
| 1747 | |
| 1748 | def tearDown(self): |
| 1749 | SocketHandlerTest.tearDown(self) |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1750 | support.unlink(self.address) |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1751 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1752 | class DatagramHandlerTest(BaseTest): |
| 1753 | |
| 1754 | """Test for DatagramHandler.""" |
| 1755 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1756 | server_class = TestUDPServer |
| 1757 | address = ('localhost', 0) |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1758 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1759 | def setUp(self): |
| 1760 | """Set up a UDP server to receive log messages, and a DatagramHandler |
| 1761 | pointing to that server's address and port.""" |
| 1762 | BaseTest.setUp(self) |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1763 | # Issue #29177: deal with errors that happen during setup |
| 1764 | self.server = self.sock_hdlr = self.server_exception = None |
| 1765 | try: |
| 1766 | self.server = server = self.server_class(self.address, |
| 1767 | self.handle_datagram, 0.01) |
| 1768 | server.start() |
| 1769 | # Uncomment next line to test error recovery in setUp() |
| 1770 | # raise OSError('dummy error raised') |
| 1771 | except OSError as e: |
| 1772 | self.server_exception = e |
| 1773 | return |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1774 | server.ready.wait() |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1775 | hcls = logging.handlers.DatagramHandler |
| 1776 | if isinstance(server.server_address, tuple): |
| 1777 | self.sock_hdlr = hcls('localhost', server.port) |
| 1778 | else: |
| 1779 | self.sock_hdlr = hcls(server.server_address, None) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1780 | self.log_output = '' |
| 1781 | self.root_logger.removeHandler(self.root_logger.handlers[0]) |
| 1782 | self.root_logger.addHandler(self.sock_hdlr) |
| 1783 | self.handled = threading.Event() |
| 1784 | |
| 1785 | def tearDown(self): |
| 1786 | """Shutdown the UDP server.""" |
| 1787 | try: |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1788 | if self.server: |
| 1789 | self.server.stop(2.0) |
| 1790 | if self.sock_hdlr: |
| 1791 | self.root_logger.removeHandler(self.sock_hdlr) |
| 1792 | self.sock_hdlr.close() |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1793 | finally: |
| 1794 | BaseTest.tearDown(self) |
| 1795 | |
| 1796 | def handle_datagram(self, request): |
| 1797 | slen = struct.pack('>L', 0) # length of prefix |
| 1798 | packet = request.packet[len(slen):] |
| 1799 | obj = pickle.loads(packet) |
| 1800 | record = logging.makeLogRecord(obj) |
| 1801 | self.log_output += record.msg + '\n' |
| 1802 | self.handled.set() |
| 1803 | |
| 1804 | def test_output(self): |
| 1805 | # The log message sent to the DatagramHandler is properly received. |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1806 | if self.server_exception: |
| 1807 | self.skipTest(self.server_exception) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1808 | logger = logging.getLogger("udp") |
| 1809 | logger.error("spam") |
| 1810 | self.handled.wait() |
Vinay Sajip | 714b8dc | 2011-05-02 14:43:00 +0100 | [diff] [blame] | 1811 | self.handled.clear() |
| 1812 | logger.error("eggs") |
| 1813 | self.handled.wait() |
| 1814 | self.assertEqual(self.log_output, "spam\neggs\n") |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1815 | |
Victor Stinner | ec5a860 | 2014-06-02 14:41:51 +0200 | [diff] [blame] | 1816 | @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required") |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1817 | class UnixDatagramHandlerTest(DatagramHandlerTest): |
| 1818 | |
| 1819 | """Test for DatagramHandler using Unix sockets.""" |
| 1820 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1821 | if hasattr(socket, "AF_UNIX"): |
Vinay Sajip | cb2c4fe | 2013-09-27 19:08:24 +0100 | [diff] [blame] | 1822 | server_class = TestUnixDatagramServer |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1823 | |
| 1824 | def setUp(self): |
| 1825 | # override the definition in the base class |
Vinay Sajip | f6cdffe | 2013-09-27 18:41:12 +0100 | [diff] [blame] | 1826 | self.address = _get_temp_domain_socket() |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1827 | DatagramHandlerTest.setUp(self) |
| 1828 | |
| 1829 | def tearDown(self): |
| 1830 | DatagramHandlerTest.tearDown(self) |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1831 | support.unlink(self.address) |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1832 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1833 | class SysLogHandlerTest(BaseTest): |
| 1834 | |
| 1835 | """Test for SysLogHandler using UDP.""" |
| 1836 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1837 | server_class = TestUDPServer |
| 1838 | address = ('localhost', 0) |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1839 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1840 | def setUp(self): |
| 1841 | """Set up a UDP server to receive log messages, and a SysLogHandler |
| 1842 | pointing to that server's address and port.""" |
| 1843 | BaseTest.setUp(self) |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1844 | # Issue #29177: deal with errors that happen during setup |
| 1845 | self.server = self.sl_hdlr = self.server_exception = None |
| 1846 | try: |
| 1847 | self.server = server = self.server_class(self.address, |
| 1848 | self.handle_datagram, 0.01) |
| 1849 | server.start() |
| 1850 | # Uncomment next line to test error recovery in setUp() |
| 1851 | # raise OSError('dummy error raised') |
| 1852 | except OSError as e: |
| 1853 | self.server_exception = e |
| 1854 | return |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1855 | server.ready.wait() |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1856 | hcls = logging.handlers.SysLogHandler |
| 1857 | if isinstance(server.server_address, tuple): |
Xiang Zhang | 0b4b57d | 2017-06-01 21:11:56 +0800 | [diff] [blame] | 1858 | self.sl_hdlr = hcls((server.server_address[0], server.port)) |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1859 | else: |
| 1860 | self.sl_hdlr = hcls(server.server_address) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1861 | self.log_output = '' |
| 1862 | self.root_logger.removeHandler(self.root_logger.handlers[0]) |
| 1863 | self.root_logger.addHandler(self.sl_hdlr) |
| 1864 | self.handled = threading.Event() |
| 1865 | |
| 1866 | def tearDown(self): |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1867 | """Shutdown the server.""" |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1868 | try: |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1869 | if self.server: |
| 1870 | self.server.stop(2.0) |
| 1871 | if self.sl_hdlr: |
| 1872 | self.root_logger.removeHandler(self.sl_hdlr) |
| 1873 | self.sl_hdlr.close() |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1874 | finally: |
| 1875 | BaseTest.tearDown(self) |
| 1876 | |
| 1877 | def handle_datagram(self, request): |
| 1878 | self.log_output = request.packet |
| 1879 | self.handled.set() |
| 1880 | |
| 1881 | def test_output(self): |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1882 | if self.server_exception: |
| 1883 | self.skipTest(self.server_exception) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1884 | # The log message sent to the SysLogHandler is properly received. |
| 1885 | logger = logging.getLogger("slh") |
| 1886 | logger.error("sp\xe4m") |
| 1887 | self.handled.wait() |
Vinay Sajip | 7706d9a | 2012-04-16 16:22:38 +0100 | [diff] [blame] | 1888 | self.assertEqual(self.log_output, b'<11>sp\xc3\xa4m\x00') |
Vinay Sajip | 8dd8d58 | 2011-06-09 16:55:23 +0100 | [diff] [blame] | 1889 | self.handled.clear() |
| 1890 | self.sl_hdlr.append_nul = False |
| 1891 | logger.error("sp\xe4m") |
| 1892 | self.handled.wait() |
Vinay Sajip | 7706d9a | 2012-04-16 16:22:38 +0100 | [diff] [blame] | 1893 | self.assertEqual(self.log_output, b'<11>sp\xc3\xa4m') |
Vinay Sajip | 2353e35 | 2011-06-27 15:40:06 +0100 | [diff] [blame] | 1894 | self.handled.clear() |
| 1895 | self.sl_hdlr.ident = "h\xe4m-" |
| 1896 | logger.error("sp\xe4m") |
| 1897 | self.handled.wait() |
Vinay Sajip | 7706d9a | 2012-04-16 16:22:38 +0100 | [diff] [blame] | 1898 | self.assertEqual(self.log_output, b'<11>h\xc3\xa4m-sp\xc3\xa4m') |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1899 | |
Victor Stinner | ec5a860 | 2014-06-02 14:41:51 +0200 | [diff] [blame] | 1900 | @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required") |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1901 | class UnixSysLogHandlerTest(SysLogHandlerTest): |
| 1902 | |
| 1903 | """Test for SysLogHandler with Unix sockets.""" |
| 1904 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 1905 | if hasattr(socket, "AF_UNIX"): |
Vinay Sajip | cb2c4fe | 2013-09-27 19:08:24 +0100 | [diff] [blame] | 1906 | server_class = TestUnixDatagramServer |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1907 | |
| 1908 | def setUp(self): |
| 1909 | # override the definition in the base class |
Vinay Sajip | f6cdffe | 2013-09-27 18:41:12 +0100 | [diff] [blame] | 1910 | self.address = _get_temp_domain_socket() |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1911 | SysLogHandlerTest.setUp(self) |
| 1912 | |
| 1913 | def tearDown(self): |
| 1914 | SysLogHandlerTest.tearDown(self) |
Vinay Sajip | 1e6499c | 2017-01-09 16:54:12 +0000 | [diff] [blame] | 1915 | support.unlink(self.address) |
Vinay Sajip | 5421f35 | 2013-09-27 18:18:28 +0100 | [diff] [blame] | 1916 | |
Xiang Zhang | 0b4b57d | 2017-06-01 21:11:56 +0800 | [diff] [blame] | 1917 | @unittest.skipUnless(support.IPV6_ENABLED, |
| 1918 | 'IPv6 support required for this test.') |
Xiang Zhang | 0b4b57d | 2017-06-01 21:11:56 +0800 | [diff] [blame] | 1919 | class IPv6SysLogHandlerTest(SysLogHandlerTest): |
| 1920 | |
| 1921 | """Test for SysLogHandler with IPv6 host.""" |
| 1922 | |
| 1923 | server_class = TestUDPServer |
| 1924 | address = ('::1', 0) |
| 1925 | |
| 1926 | def setUp(self): |
| 1927 | self.server_class.address_family = socket.AF_INET6 |
| 1928 | super(IPv6SysLogHandlerTest, self).setUp() |
| 1929 | |
| 1930 | def tearDown(self): |
| 1931 | self.server_class.address_family = socket.AF_INET |
| 1932 | super(IPv6SysLogHandlerTest, self).tearDown() |
| 1933 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1934 | class HTTPHandlerTest(BaseTest): |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1935 | """Test for HTTPHandler.""" |
| 1936 | |
| 1937 | def setUp(self): |
| 1938 | """Set up an HTTP server to receive log messages, and a HTTPHandler |
| 1939 | pointing to that server's address and port.""" |
| 1940 | BaseTest.setUp(self) |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1941 | self.handled = threading.Event() |
| 1942 | |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1943 | def handle_request(self, request): |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 1944 | self.command = request.command |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1945 | self.log_data = urlparse(request.path) |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 1946 | if self.command == 'POST': |
| 1947 | try: |
| 1948 | rlen = int(request.headers['Content-Length']) |
| 1949 | self.post_data = request.rfile.read(rlen) |
| 1950 | except: |
| 1951 | self.post_data = None |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1952 | request.send_response(200) |
Vinay Sajip | 463ac51 | 2011-05-10 09:10:08 +0100 | [diff] [blame] | 1953 | request.end_headers() |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1954 | self.handled.set() |
| 1955 | |
| 1956 | def test_output(self): |
Vinay Sajip | f223116 | 2011-05-09 22:05:50 +0100 | [diff] [blame] | 1957 | # The log message sent to the HTTPHandler is properly received. |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 1958 | logger = logging.getLogger("http") |
Vinay Sajip | 9ba8761 | 2011-05-21 11:32:15 +0100 | [diff] [blame] | 1959 | root_logger = self.root_logger |
| 1960 | root_logger.removeHandler(self.root_logger.handlers[0]) |
| 1961 | for secure in (False, True): |
| 1962 | addr = ('localhost', 0) |
| 1963 | if secure: |
Vinay Sajip | 39e3528 | 2011-05-21 16:46:41 +0100 | [diff] [blame] | 1964 | try: |
| 1965 | import ssl |
Vinay Sajip | 39e3528 | 2011-05-21 16:46:41 +0100 | [diff] [blame] | 1966 | except ImportError: |
| 1967 | sslctx = None |
Benjamin Peterson | 4ffb075 | 2014-11-03 14:29:33 -0500 | [diff] [blame] | 1968 | else: |
| 1969 | here = os.path.dirname(__file__) |
| 1970 | localhost_cert = os.path.join(here, "keycert.pem") |
Christian Heimes | a170fa1 | 2017-09-15 20:27:30 +0200 | [diff] [blame] | 1971 | sslctx = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER) |
Benjamin Peterson | 4ffb075 | 2014-11-03 14:29:33 -0500 | [diff] [blame] | 1972 | sslctx.load_cert_chain(localhost_cert) |
Benjamin Peterson | 43052a1 | 2014-11-23 20:36:44 -0600 | [diff] [blame] | 1973 | |
| 1974 | context = ssl.create_default_context(cafile=localhost_cert) |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 1975 | else: |
Vinay Sajip | 9ba8761 | 2011-05-21 11:32:15 +0100 | [diff] [blame] | 1976 | sslctx = None |
Benjamin Peterson | 43052a1 | 2014-11-23 20:36:44 -0600 | [diff] [blame] | 1977 | context = None |
Vinay Sajip | 9ba8761 | 2011-05-21 11:32:15 +0100 | [diff] [blame] | 1978 | self.server = server = TestHTTPServer(addr, self.handle_request, |
| 1979 | 0.01, sslctx=sslctx) |
| 1980 | server.start() |
| 1981 | server.ready.wait() |
| 1982 | host = 'localhost:%d' % server.server_port |
Vinay Sajip | 39e3528 | 2011-05-21 16:46:41 +0100 | [diff] [blame] | 1983 | secure_client = secure and sslctx |
| 1984 | self.h_hdlr = logging.handlers.HTTPHandler(host, '/frob', |
Benjamin Peterson | 43052a1 | 2014-11-23 20:36:44 -0600 | [diff] [blame] | 1985 | secure=secure_client, |
Vinay Sajip | 1bf197e | 2016-06-07 21:19:55 +0100 | [diff] [blame] | 1986 | context=context, |
| 1987 | credentials=('foo', 'bar')) |
Vinay Sajip | 9ba8761 | 2011-05-21 11:32:15 +0100 | [diff] [blame] | 1988 | self.log_data = None |
| 1989 | root_logger.addHandler(self.h_hdlr) |
| 1990 | |
| 1991 | for method in ('GET', 'POST'): |
| 1992 | self.h_hdlr.method = method |
| 1993 | self.handled.clear() |
| 1994 | msg = "sp\xe4m" |
| 1995 | logger.error(msg) |
| 1996 | self.handled.wait() |
| 1997 | self.assertEqual(self.log_data.path, '/frob') |
| 1998 | self.assertEqual(self.command, method) |
| 1999 | if method == 'GET': |
| 2000 | d = parse_qs(self.log_data.query) |
| 2001 | else: |
| 2002 | d = parse_qs(self.post_data.decode('utf-8')) |
| 2003 | self.assertEqual(d['name'], ['http']) |
| 2004 | self.assertEqual(d['funcName'], ['test_output']) |
| 2005 | self.assertEqual(d['msg'], [msg]) |
| 2006 | |
| 2007 | self.server.stop(2.0) |
| 2008 | self.root_logger.removeHandler(self.h_hdlr) |
| 2009 | self.h_hdlr.close() |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 2010 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2011 | class MemoryTest(BaseTest): |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 2012 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2013 | """Test memory persistence of logger objects.""" |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 2014 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2015 | def setUp(self): |
| 2016 | """Create a dict to remember potentially destroyed objects.""" |
| 2017 | BaseTest.setUp(self) |
| 2018 | self._survivors = {} |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 2019 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2020 | def _watch_for_survival(self, *args): |
| 2021 | """Watch the given objects for survival, by creating weakrefs to |
| 2022 | them.""" |
| 2023 | for obj in args: |
| 2024 | key = id(obj), repr(obj) |
| 2025 | self._survivors[key] = weakref.ref(obj) |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 2026 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 2027 | def _assertTruesurvival(self): |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2028 | """Assert that all objects watched for survival have survived.""" |
| 2029 | # Trigger cycle breaking. |
| 2030 | gc.collect() |
| 2031 | dead = [] |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2032 | for (id_, repr_), ref in self._survivors.items(): |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2033 | if ref() is None: |
| 2034 | dead.append(repr_) |
| 2035 | if dead: |
| 2036 | self.fail("%d objects should have survived " |
| 2037 | "but have been destroyed: %s" % (len(dead), ", ".join(dead))) |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 2038 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2039 | def test_persistent_loggers(self): |
| 2040 | # Logger objects are persistent and retain their configuration, even |
| 2041 | # if visible references are destroyed. |
| 2042 | self.root_logger.setLevel(logging.INFO) |
| 2043 | foo = logging.getLogger("foo") |
| 2044 | self._watch_for_survival(foo) |
| 2045 | foo.setLevel(logging.DEBUG) |
| 2046 | self.root_logger.debug(self.next_message()) |
| 2047 | foo.debug(self.next_message()) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 2048 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2049 | ('foo', 'DEBUG', '2'), |
| 2050 | ]) |
| 2051 | del foo |
| 2052 | # foo has survived. |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 2053 | self._assertTruesurvival() |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2054 | # foo has retained its settings. |
| 2055 | bar = logging.getLogger("foo") |
| 2056 | bar.debug(self.next_message()) |
Benjamin Peterson | 77108eb | 2009-07-01 00:43:10 +0000 | [diff] [blame] | 2057 | self.assert_log_lines([ |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 2058 | ('foo', 'DEBUG', '2'), |
| 2059 | ('foo', 'DEBUG', '3'), |
| 2060 | ]) |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 2061 | |
Benjamin Peterson | f91df04 | 2009-02-13 02:50:59 +0000 | [diff] [blame] | 2062 | |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 2063 | class EncodingTest(BaseTest): |
| 2064 | def test_encoding_plain_file(self): |
| 2065 | # In Python 2.x, a plain file object is treated as having no encoding. |
| 2066 | log = logging.getLogger("test") |
Vinay Sajip | 60b4df1 | 2010-12-27 11:18:52 +0000 | [diff] [blame] | 2067 | fd, fn = tempfile.mkstemp(".log", "test_logging-1-") |
| 2068 | os.close(fd) |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 2069 | # the non-ascii data we write to the log. |
| 2070 | data = "foo\x80" |
| 2071 | try: |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2072 | handler = logging.FileHandler(fn, encoding="utf-8") |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 2073 | log.addHandler(handler) |
| 2074 | try: |
| 2075 | # write non-ascii data to the log. |
| 2076 | log.warning(data) |
| 2077 | finally: |
| 2078 | log.removeHandler(handler) |
| 2079 | handler.close() |
| 2080 | # check we wrote exactly those bytes, ignoring trailing \n etc |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2081 | f = open(fn, encoding="utf-8") |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 2082 | try: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 2083 | self.assertEqual(f.read().rstrip(), data) |
Benjamin Peterson | ae5360b | 2008-09-08 23:05:23 +0000 | [diff] [blame] | 2084 | finally: |
| 2085 | f.close() |
| 2086 | finally: |
| 2087 | if os.path.isfile(fn): |
| 2088 | os.remove(fn) |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 2089 | |
Benjamin Peterson | f91df04 | 2009-02-13 02:50:59 +0000 | [diff] [blame] | 2090 | def test_encoding_cyrillic_unicode(self): |
| 2091 | log = logging.getLogger("test") |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2092 | # Get a message in Unicode: Do svidanya in Cyrillic (meaning goodbye) |
Benjamin Peterson | f91df04 | 2009-02-13 02:50:59 +0000 | [diff] [blame] | 2093 | message = '\u0434\u043e \u0441\u0432\u0438\u0434\u0430\u043d\u0438\u044f' |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2094 | # Ensure it's written in a Cyrillic encoding |
Benjamin Peterson | f91df04 | 2009-02-13 02:50:59 +0000 | [diff] [blame] | 2095 | writer_class = codecs.getwriter('cp1251') |
Benjamin Peterson | 25c95f1 | 2009-05-08 20:42:26 +0000 | [diff] [blame] | 2096 | writer_class.encoding = 'cp1251' |
Benjamin Peterson | f91df04 | 2009-02-13 02:50:59 +0000 | [diff] [blame] | 2097 | stream = io.BytesIO() |
| 2098 | writer = writer_class(stream, 'strict') |
| 2099 | handler = logging.StreamHandler(writer) |
| 2100 | log.addHandler(handler) |
| 2101 | try: |
| 2102 | log.warning(message) |
| 2103 | finally: |
| 2104 | log.removeHandler(handler) |
| 2105 | handler.close() |
| 2106 | # check we wrote exactly those bytes, ignoring trailing \n etc |
| 2107 | s = stream.getvalue() |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2108 | # Compare against what the data should be when encoded in CP-1251 |
Benjamin Peterson | f91df04 | 2009-02-13 02:50:59 +0000 | [diff] [blame] | 2109 | self.assertEqual(s, b'\xe4\xee \xf1\xe2\xe8\xe4\xe0\xed\xe8\xff\n') |
| 2110 | |
| 2111 | |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 2112 | class WarningsTest(BaseTest): |
Brett Cannon | df8709d | 2009-04-01 20:01:47 +0000 | [diff] [blame] | 2113 | |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 2114 | def test_warnings(self): |
Brett Cannon | df8709d | 2009-04-01 20:01:47 +0000 | [diff] [blame] | 2115 | with warnings.catch_warnings(): |
Brett Cannon | 5b9082a | 2009-04-05 18:57:32 +0000 | [diff] [blame] | 2116 | logging.captureWarnings(True) |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 2117 | self.addCleanup(logging.captureWarnings, False) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 2118 | warnings.filterwarnings("always", category=UserWarning) |
| 2119 | stream = io.StringIO() |
| 2120 | h = logging.StreamHandler(stream) |
| 2121 | logger = logging.getLogger("py.warnings") |
| 2122 | logger.addHandler(h) |
| 2123 | warnings.warn("I'm warning you...") |
| 2124 | logger.removeHandler(h) |
| 2125 | s = stream.getvalue() |
| 2126 | h.close() |
Giampaolo Rodola' | 284529d | 2012-10-17 13:24:27 +0200 | [diff] [blame] | 2127 | self.assertGreater(s.find("UserWarning: I'm warning you...\n"), 0) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 2128 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2129 | # See if an explicit file uses the original implementation |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 2130 | a_file = io.StringIO() |
| 2131 | warnings.showwarning("Explicit", UserWarning, "dummy.py", 42, |
| 2132 | a_file, "Dummy line") |
| 2133 | s = a_file.getvalue() |
| 2134 | a_file.close() |
| 2135 | self.assertEqual(s, |
| 2136 | "dummy.py:42: UserWarning: Explicit\n Dummy line\n") |
| 2137 | |
| 2138 | def test_warnings_no_handlers(self): |
| 2139 | with warnings.catch_warnings(): |
| 2140 | logging.captureWarnings(True) |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 2141 | self.addCleanup(logging.captureWarnings, False) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 2142 | |
| 2143 | # confirm our assumption: no loggers are set |
| 2144 | logger = logging.getLogger("py.warnings") |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 2145 | self.assertEqual(logger.handlers, []) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 2146 | |
| 2147 | warnings.showwarning("Explicit", UserWarning, "dummy.py", 42) |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 2148 | self.assertEqual(len(logger.handlers), 1) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 2149 | self.assertIsInstance(logger.handlers[0], logging.NullHandler) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 2150 | |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2151 | |
| 2152 | def formatFunc(format, datefmt=None): |
| 2153 | return logging.Formatter(format, datefmt) |
| 2154 | |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 2155 | class myCustomFormatter: |
| 2156 | def __init__(self, fmt, datefmt=None): |
| 2157 | pass |
| 2158 | |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2159 | def handlerFunc(): |
| 2160 | return logging.StreamHandler() |
| 2161 | |
| 2162 | class CustomHandler(logging.StreamHandler): |
| 2163 | pass |
| 2164 | |
| 2165 | class ConfigDictTest(BaseTest): |
| 2166 | |
| 2167 | """Reading logging config from a dictionary.""" |
| 2168 | |
Xtreak | 087570a | 2018-07-02 14:27:46 +0530 | [diff] [blame] | 2169 | check_no_resource_warning = support.check_no_resource_warning |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 2170 | expected_log_pat = r"^(\w+) \+\+ (\w+)$" |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2171 | |
| 2172 | # config0 is a standard configuration. |
| 2173 | config0 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2174 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2175 | 'formatters': { |
| 2176 | 'form1' : { |
| 2177 | 'format' : '%(levelname)s ++ %(message)s', |
| 2178 | }, |
| 2179 | }, |
| 2180 | 'handlers' : { |
| 2181 | 'hand1' : { |
| 2182 | 'class' : 'logging.StreamHandler', |
| 2183 | 'formatter' : 'form1', |
| 2184 | 'level' : 'NOTSET', |
| 2185 | 'stream' : 'ext://sys.stdout', |
| 2186 | }, |
| 2187 | }, |
| 2188 | 'root' : { |
| 2189 | 'level' : 'WARNING', |
| 2190 | 'handlers' : ['hand1'], |
| 2191 | }, |
| 2192 | } |
| 2193 | |
| 2194 | # config1 adds a little to the standard configuration. |
| 2195 | config1 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2196 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2197 | 'formatters': { |
| 2198 | 'form1' : { |
| 2199 | 'format' : '%(levelname)s ++ %(message)s', |
| 2200 | }, |
| 2201 | }, |
| 2202 | 'handlers' : { |
| 2203 | 'hand1' : { |
| 2204 | 'class' : 'logging.StreamHandler', |
| 2205 | 'formatter' : 'form1', |
| 2206 | 'level' : 'NOTSET', |
| 2207 | 'stream' : 'ext://sys.stdout', |
| 2208 | }, |
| 2209 | }, |
| 2210 | 'loggers' : { |
| 2211 | 'compiler.parser' : { |
| 2212 | 'level' : 'DEBUG', |
| 2213 | 'handlers' : ['hand1'], |
| 2214 | }, |
| 2215 | }, |
| 2216 | 'root' : { |
| 2217 | 'level' : 'WARNING', |
| 2218 | }, |
| 2219 | } |
| 2220 | |
Vinay Sajip | 9f9991c | 2011-03-07 18:02:57 +0000 | [diff] [blame] | 2221 | # config1a moves the handler to the root. Used with config8a |
| 2222 | config1a = { |
| 2223 | 'version': 1, |
| 2224 | 'formatters': { |
| 2225 | 'form1' : { |
| 2226 | 'format' : '%(levelname)s ++ %(message)s', |
| 2227 | }, |
| 2228 | }, |
| 2229 | 'handlers' : { |
| 2230 | 'hand1' : { |
| 2231 | 'class' : 'logging.StreamHandler', |
| 2232 | 'formatter' : 'form1', |
| 2233 | 'level' : 'NOTSET', |
| 2234 | 'stream' : 'ext://sys.stdout', |
| 2235 | }, |
| 2236 | }, |
| 2237 | 'loggers' : { |
| 2238 | 'compiler.parser' : { |
| 2239 | 'level' : 'DEBUG', |
| 2240 | }, |
| 2241 | }, |
| 2242 | 'root' : { |
| 2243 | 'level' : 'WARNING', |
| 2244 | 'handlers' : ['hand1'], |
| 2245 | }, |
| 2246 | } |
| 2247 | |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2248 | # config2 has a subtle configuration error that should be reported |
| 2249 | config2 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2250 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2251 | 'formatters': { |
| 2252 | 'form1' : { |
| 2253 | 'format' : '%(levelname)s ++ %(message)s', |
| 2254 | }, |
| 2255 | }, |
| 2256 | 'handlers' : { |
| 2257 | 'hand1' : { |
| 2258 | 'class' : 'logging.StreamHandler', |
| 2259 | 'formatter' : 'form1', |
| 2260 | 'level' : 'NOTSET', |
| 2261 | 'stream' : 'ext://sys.stdbout', |
| 2262 | }, |
| 2263 | }, |
| 2264 | 'loggers' : { |
| 2265 | 'compiler.parser' : { |
| 2266 | 'level' : 'DEBUG', |
| 2267 | 'handlers' : ['hand1'], |
| 2268 | }, |
| 2269 | }, |
| 2270 | 'root' : { |
| 2271 | 'level' : 'WARNING', |
| 2272 | }, |
| 2273 | } |
| 2274 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2275 | # As config1 but with a misspelt level on a handler |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2276 | config2a = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2277 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2278 | 'formatters': { |
| 2279 | 'form1' : { |
| 2280 | 'format' : '%(levelname)s ++ %(message)s', |
| 2281 | }, |
| 2282 | }, |
| 2283 | 'handlers' : { |
| 2284 | 'hand1' : { |
| 2285 | 'class' : 'logging.StreamHandler', |
| 2286 | 'formatter' : 'form1', |
| 2287 | 'level' : 'NTOSET', |
| 2288 | 'stream' : 'ext://sys.stdout', |
| 2289 | }, |
| 2290 | }, |
| 2291 | 'loggers' : { |
| 2292 | 'compiler.parser' : { |
| 2293 | 'level' : 'DEBUG', |
| 2294 | 'handlers' : ['hand1'], |
| 2295 | }, |
| 2296 | }, |
| 2297 | 'root' : { |
| 2298 | 'level' : 'WARNING', |
| 2299 | }, |
| 2300 | } |
| 2301 | |
| 2302 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2303 | # As config1 but with a misspelt level on a logger |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2304 | config2b = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2305 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2306 | 'formatters': { |
| 2307 | 'form1' : { |
| 2308 | 'format' : '%(levelname)s ++ %(message)s', |
| 2309 | }, |
| 2310 | }, |
| 2311 | 'handlers' : { |
| 2312 | 'hand1' : { |
| 2313 | 'class' : 'logging.StreamHandler', |
| 2314 | 'formatter' : 'form1', |
| 2315 | 'level' : 'NOTSET', |
| 2316 | 'stream' : 'ext://sys.stdout', |
| 2317 | }, |
| 2318 | }, |
| 2319 | 'loggers' : { |
| 2320 | 'compiler.parser' : { |
| 2321 | 'level' : 'DEBUG', |
| 2322 | 'handlers' : ['hand1'], |
| 2323 | }, |
| 2324 | }, |
| 2325 | 'root' : { |
| 2326 | 'level' : 'WRANING', |
| 2327 | }, |
| 2328 | } |
| 2329 | |
| 2330 | # config3 has a less subtle configuration error |
| 2331 | config3 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2332 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2333 | 'formatters': { |
| 2334 | 'form1' : { |
| 2335 | 'format' : '%(levelname)s ++ %(message)s', |
| 2336 | }, |
| 2337 | }, |
| 2338 | 'handlers' : { |
| 2339 | 'hand1' : { |
| 2340 | 'class' : 'logging.StreamHandler', |
| 2341 | 'formatter' : 'misspelled_name', |
| 2342 | 'level' : 'NOTSET', |
| 2343 | 'stream' : 'ext://sys.stdout', |
| 2344 | }, |
| 2345 | }, |
| 2346 | 'loggers' : { |
| 2347 | 'compiler.parser' : { |
| 2348 | 'level' : 'DEBUG', |
| 2349 | 'handlers' : ['hand1'], |
| 2350 | }, |
| 2351 | }, |
| 2352 | 'root' : { |
| 2353 | 'level' : 'WARNING', |
| 2354 | }, |
| 2355 | } |
| 2356 | |
| 2357 | # config4 specifies a custom formatter class to be loaded |
| 2358 | config4 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2359 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2360 | 'formatters': { |
| 2361 | 'form1' : { |
| 2362 | '()' : __name__ + '.ExceptionFormatter', |
| 2363 | 'format' : '%(levelname)s:%(name)s:%(message)s', |
| 2364 | }, |
| 2365 | }, |
| 2366 | 'handlers' : { |
| 2367 | 'hand1' : { |
| 2368 | 'class' : 'logging.StreamHandler', |
| 2369 | 'formatter' : 'form1', |
| 2370 | 'level' : 'NOTSET', |
| 2371 | 'stream' : 'ext://sys.stdout', |
| 2372 | }, |
| 2373 | }, |
| 2374 | 'root' : { |
| 2375 | 'level' : 'NOTSET', |
| 2376 | 'handlers' : ['hand1'], |
| 2377 | }, |
| 2378 | } |
| 2379 | |
| 2380 | # As config4 but using an actual callable rather than a string |
| 2381 | config4a = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2382 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2383 | 'formatters': { |
| 2384 | 'form1' : { |
| 2385 | '()' : ExceptionFormatter, |
| 2386 | 'format' : '%(levelname)s:%(name)s:%(message)s', |
| 2387 | }, |
| 2388 | 'form2' : { |
| 2389 | '()' : __name__ + '.formatFunc', |
| 2390 | 'format' : '%(levelname)s:%(name)s:%(message)s', |
| 2391 | }, |
| 2392 | 'form3' : { |
| 2393 | '()' : formatFunc, |
| 2394 | 'format' : '%(levelname)s:%(name)s:%(message)s', |
| 2395 | }, |
| 2396 | }, |
| 2397 | 'handlers' : { |
| 2398 | 'hand1' : { |
| 2399 | 'class' : 'logging.StreamHandler', |
| 2400 | 'formatter' : 'form1', |
| 2401 | 'level' : 'NOTSET', |
| 2402 | 'stream' : 'ext://sys.stdout', |
| 2403 | }, |
| 2404 | 'hand2' : { |
| 2405 | '()' : handlerFunc, |
| 2406 | }, |
| 2407 | }, |
| 2408 | 'root' : { |
| 2409 | 'level' : 'NOTSET', |
| 2410 | 'handlers' : ['hand1'], |
| 2411 | }, |
| 2412 | } |
| 2413 | |
| 2414 | # config5 specifies a custom handler class to be loaded |
| 2415 | config5 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2416 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2417 | 'formatters': { |
| 2418 | 'form1' : { |
| 2419 | 'format' : '%(levelname)s ++ %(message)s', |
| 2420 | }, |
| 2421 | }, |
| 2422 | 'handlers' : { |
| 2423 | 'hand1' : { |
| 2424 | 'class' : __name__ + '.CustomHandler', |
| 2425 | 'formatter' : 'form1', |
| 2426 | 'level' : 'NOTSET', |
| 2427 | 'stream' : 'ext://sys.stdout', |
| 2428 | }, |
| 2429 | }, |
| 2430 | 'loggers' : { |
| 2431 | 'compiler.parser' : { |
| 2432 | 'level' : 'DEBUG', |
| 2433 | 'handlers' : ['hand1'], |
| 2434 | }, |
| 2435 | }, |
| 2436 | 'root' : { |
| 2437 | 'level' : 'WARNING', |
| 2438 | }, |
| 2439 | } |
| 2440 | |
| 2441 | # config6 specifies a custom handler class to be loaded |
| 2442 | # but has bad arguments |
| 2443 | config6 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2444 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2445 | 'formatters': { |
| 2446 | 'form1' : { |
| 2447 | 'format' : '%(levelname)s ++ %(message)s', |
| 2448 | }, |
| 2449 | }, |
| 2450 | 'handlers' : { |
| 2451 | 'hand1' : { |
| 2452 | 'class' : __name__ + '.CustomHandler', |
| 2453 | 'formatter' : 'form1', |
| 2454 | 'level' : 'NOTSET', |
| 2455 | 'stream' : 'ext://sys.stdout', |
| 2456 | '9' : 'invalid parameter name', |
| 2457 | }, |
| 2458 | }, |
| 2459 | 'loggers' : { |
| 2460 | 'compiler.parser' : { |
| 2461 | 'level' : 'DEBUG', |
| 2462 | 'handlers' : ['hand1'], |
| 2463 | }, |
| 2464 | }, |
| 2465 | 'root' : { |
| 2466 | 'level' : 'WARNING', |
| 2467 | }, |
| 2468 | } |
| 2469 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2470 | # config 7 does not define compiler.parser but defines compiler.lexer |
| 2471 | # so compiler.parser should be disabled after applying it |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2472 | config7 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2473 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2474 | 'formatters': { |
| 2475 | 'form1' : { |
| 2476 | 'format' : '%(levelname)s ++ %(message)s', |
| 2477 | }, |
| 2478 | }, |
| 2479 | 'handlers' : { |
| 2480 | 'hand1' : { |
| 2481 | 'class' : 'logging.StreamHandler', |
| 2482 | 'formatter' : 'form1', |
| 2483 | 'level' : 'NOTSET', |
| 2484 | 'stream' : 'ext://sys.stdout', |
| 2485 | }, |
| 2486 | }, |
| 2487 | 'loggers' : { |
| 2488 | 'compiler.lexer' : { |
| 2489 | 'level' : 'DEBUG', |
| 2490 | 'handlers' : ['hand1'], |
| 2491 | }, |
| 2492 | }, |
| 2493 | 'root' : { |
| 2494 | 'level' : 'WARNING', |
| 2495 | }, |
| 2496 | } |
| 2497 | |
Vinay Sajip | 9f9991c | 2011-03-07 18:02:57 +0000 | [diff] [blame] | 2498 | # config8 defines both compiler and compiler.lexer |
| 2499 | # so compiler.parser should not be disabled (since |
| 2500 | # compiler is defined) |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2501 | config8 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2502 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2503 | 'disable_existing_loggers' : False, |
| 2504 | 'formatters': { |
| 2505 | 'form1' : { |
| 2506 | 'format' : '%(levelname)s ++ %(message)s', |
| 2507 | }, |
| 2508 | }, |
| 2509 | 'handlers' : { |
| 2510 | 'hand1' : { |
| 2511 | 'class' : 'logging.StreamHandler', |
| 2512 | 'formatter' : 'form1', |
| 2513 | 'level' : 'NOTSET', |
| 2514 | 'stream' : 'ext://sys.stdout', |
| 2515 | }, |
| 2516 | }, |
| 2517 | 'loggers' : { |
| 2518 | 'compiler' : { |
| 2519 | 'level' : 'DEBUG', |
| 2520 | 'handlers' : ['hand1'], |
| 2521 | }, |
| 2522 | 'compiler.lexer' : { |
| 2523 | }, |
| 2524 | }, |
| 2525 | 'root' : { |
| 2526 | 'level' : 'WARNING', |
| 2527 | }, |
| 2528 | } |
| 2529 | |
Vinay Sajip | 9f9991c | 2011-03-07 18:02:57 +0000 | [diff] [blame] | 2530 | # config8a disables existing loggers |
| 2531 | config8a = { |
| 2532 | 'version': 1, |
| 2533 | 'disable_existing_loggers' : True, |
| 2534 | 'formatters': { |
| 2535 | 'form1' : { |
| 2536 | 'format' : '%(levelname)s ++ %(message)s', |
| 2537 | }, |
| 2538 | }, |
| 2539 | 'handlers' : { |
| 2540 | 'hand1' : { |
| 2541 | 'class' : 'logging.StreamHandler', |
| 2542 | 'formatter' : 'form1', |
| 2543 | 'level' : 'NOTSET', |
| 2544 | 'stream' : 'ext://sys.stdout', |
| 2545 | }, |
| 2546 | }, |
| 2547 | 'loggers' : { |
| 2548 | 'compiler' : { |
| 2549 | 'level' : 'DEBUG', |
| 2550 | 'handlers' : ['hand1'], |
| 2551 | }, |
| 2552 | 'compiler.lexer' : { |
| 2553 | }, |
| 2554 | }, |
| 2555 | 'root' : { |
| 2556 | 'level' : 'WARNING', |
| 2557 | }, |
| 2558 | } |
| 2559 | |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2560 | config9 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2561 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2562 | 'formatters': { |
| 2563 | 'form1' : { |
| 2564 | 'format' : '%(levelname)s ++ %(message)s', |
| 2565 | }, |
| 2566 | }, |
| 2567 | 'handlers' : { |
| 2568 | 'hand1' : { |
| 2569 | 'class' : 'logging.StreamHandler', |
| 2570 | 'formatter' : 'form1', |
| 2571 | 'level' : 'WARNING', |
| 2572 | 'stream' : 'ext://sys.stdout', |
| 2573 | }, |
| 2574 | }, |
| 2575 | 'loggers' : { |
| 2576 | 'compiler.parser' : { |
| 2577 | 'level' : 'WARNING', |
| 2578 | 'handlers' : ['hand1'], |
| 2579 | }, |
| 2580 | }, |
| 2581 | 'root' : { |
| 2582 | 'level' : 'NOTSET', |
| 2583 | }, |
| 2584 | } |
| 2585 | |
| 2586 | config9a = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2587 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2588 | 'incremental' : True, |
| 2589 | 'handlers' : { |
| 2590 | 'hand1' : { |
| 2591 | 'level' : 'WARNING', |
| 2592 | }, |
| 2593 | }, |
| 2594 | 'loggers' : { |
| 2595 | 'compiler.parser' : { |
| 2596 | 'level' : 'INFO', |
| 2597 | }, |
| 2598 | }, |
| 2599 | } |
| 2600 | |
| 2601 | config9b = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2602 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2603 | 'incremental' : True, |
| 2604 | 'handlers' : { |
| 2605 | 'hand1' : { |
| 2606 | 'level' : 'INFO', |
| 2607 | }, |
| 2608 | }, |
| 2609 | 'loggers' : { |
| 2610 | 'compiler.parser' : { |
| 2611 | 'level' : 'INFO', |
| 2612 | }, |
| 2613 | }, |
| 2614 | } |
| 2615 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2616 | # As config1 but with a filter added |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2617 | config10 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2618 | 'version': 1, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2619 | 'formatters': { |
| 2620 | 'form1' : { |
| 2621 | 'format' : '%(levelname)s ++ %(message)s', |
| 2622 | }, |
| 2623 | }, |
| 2624 | 'filters' : { |
| 2625 | 'filt1' : { |
| 2626 | 'name' : 'compiler.parser', |
| 2627 | }, |
| 2628 | }, |
| 2629 | 'handlers' : { |
| 2630 | 'hand1' : { |
| 2631 | 'class' : 'logging.StreamHandler', |
| 2632 | 'formatter' : 'form1', |
| 2633 | 'level' : 'NOTSET', |
| 2634 | 'stream' : 'ext://sys.stdout', |
| 2635 | 'filters' : ['filt1'], |
| 2636 | }, |
| 2637 | }, |
| 2638 | 'loggers' : { |
| 2639 | 'compiler.parser' : { |
| 2640 | 'level' : 'DEBUG', |
| 2641 | 'filters' : ['filt1'], |
| 2642 | }, |
| 2643 | }, |
| 2644 | 'root' : { |
| 2645 | 'level' : 'WARNING', |
| 2646 | 'handlers' : ['hand1'], |
| 2647 | }, |
| 2648 | } |
| 2649 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2650 | # As config1 but using cfg:// references |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2651 | config11 = { |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2652 | 'version': 1, |
| 2653 | 'true_formatters': { |
| 2654 | 'form1' : { |
| 2655 | 'format' : '%(levelname)s ++ %(message)s', |
| 2656 | }, |
| 2657 | }, |
| 2658 | 'handler_configs': { |
| 2659 | 'hand1' : { |
| 2660 | 'class' : 'logging.StreamHandler', |
| 2661 | 'formatter' : 'form1', |
| 2662 | 'level' : 'NOTSET', |
| 2663 | 'stream' : 'ext://sys.stdout', |
| 2664 | }, |
| 2665 | }, |
| 2666 | 'formatters' : 'cfg://true_formatters', |
| 2667 | 'handlers' : { |
| 2668 | 'hand1' : 'cfg://handler_configs[hand1]', |
| 2669 | }, |
| 2670 | 'loggers' : { |
| 2671 | 'compiler.parser' : { |
| 2672 | 'level' : 'DEBUG', |
| 2673 | 'handlers' : ['hand1'], |
| 2674 | }, |
| 2675 | }, |
| 2676 | 'root' : { |
| 2677 | 'level' : 'WARNING', |
| 2678 | }, |
| 2679 | } |
| 2680 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2681 | # As config11 but missing the version key |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2682 | config12 = { |
| 2683 | 'true_formatters': { |
| 2684 | 'form1' : { |
| 2685 | 'format' : '%(levelname)s ++ %(message)s', |
| 2686 | }, |
| 2687 | }, |
| 2688 | 'handler_configs': { |
| 2689 | 'hand1' : { |
| 2690 | 'class' : 'logging.StreamHandler', |
| 2691 | 'formatter' : 'form1', |
| 2692 | 'level' : 'NOTSET', |
| 2693 | 'stream' : 'ext://sys.stdout', |
| 2694 | }, |
| 2695 | }, |
| 2696 | 'formatters' : 'cfg://true_formatters', |
| 2697 | 'handlers' : { |
| 2698 | 'hand1' : 'cfg://handler_configs[hand1]', |
| 2699 | }, |
| 2700 | 'loggers' : { |
| 2701 | 'compiler.parser' : { |
| 2702 | 'level' : 'DEBUG', |
| 2703 | 'handlers' : ['hand1'], |
| 2704 | }, |
| 2705 | }, |
| 2706 | 'root' : { |
| 2707 | 'level' : 'WARNING', |
| 2708 | }, |
| 2709 | } |
| 2710 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 2711 | # As config11 but using an unsupported version |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2712 | config13 = { |
| 2713 | 'version': 2, |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2714 | 'true_formatters': { |
| 2715 | 'form1' : { |
| 2716 | 'format' : '%(levelname)s ++ %(message)s', |
| 2717 | }, |
| 2718 | }, |
| 2719 | 'handler_configs': { |
| 2720 | 'hand1' : { |
| 2721 | 'class' : 'logging.StreamHandler', |
| 2722 | 'formatter' : 'form1', |
| 2723 | 'level' : 'NOTSET', |
| 2724 | 'stream' : 'ext://sys.stdout', |
| 2725 | }, |
| 2726 | }, |
| 2727 | 'formatters' : 'cfg://true_formatters', |
| 2728 | 'handlers' : { |
| 2729 | 'hand1' : 'cfg://handler_configs[hand1]', |
| 2730 | }, |
| 2731 | 'loggers' : { |
| 2732 | 'compiler.parser' : { |
| 2733 | 'level' : 'DEBUG', |
| 2734 | 'handlers' : ['hand1'], |
| 2735 | }, |
| 2736 | }, |
| 2737 | 'root' : { |
| 2738 | 'level' : 'WARNING', |
| 2739 | }, |
| 2740 | } |
| 2741 | |
Vinay Sajip | 8d27023 | 2012-11-15 14:20:18 +0000 | [diff] [blame] | 2742 | # As config0, but with properties |
| 2743 | config14 = { |
| 2744 | 'version': 1, |
| 2745 | 'formatters': { |
| 2746 | 'form1' : { |
| 2747 | 'format' : '%(levelname)s ++ %(message)s', |
| 2748 | }, |
| 2749 | }, |
| 2750 | 'handlers' : { |
| 2751 | 'hand1' : { |
| 2752 | 'class' : 'logging.StreamHandler', |
| 2753 | 'formatter' : 'form1', |
| 2754 | 'level' : 'NOTSET', |
| 2755 | 'stream' : 'ext://sys.stdout', |
| 2756 | '.': { |
| 2757 | 'foo': 'bar', |
| 2758 | 'terminator': '!\n', |
| 2759 | } |
| 2760 | }, |
| 2761 | }, |
| 2762 | 'root' : { |
| 2763 | 'level' : 'WARNING', |
| 2764 | 'handlers' : ['hand1'], |
| 2765 | }, |
| 2766 | } |
| 2767 | |
Vinay Sajip | 3f885b5 | 2013-03-22 15:19:54 +0000 | [diff] [blame] | 2768 | out_of_order = { |
| 2769 | "version": 1, |
| 2770 | "formatters": { |
| 2771 | "mySimpleFormatter": { |
Vinay Sajip | 28421c6 | 2013-03-29 17:56:54 +0000 | [diff] [blame] | 2772 | "format": "%(asctime)s (%(name)s) %(levelname)s: %(message)s", |
| 2773 | "style": "$" |
Vinay Sajip | 3f885b5 | 2013-03-22 15:19:54 +0000 | [diff] [blame] | 2774 | } |
| 2775 | }, |
| 2776 | "handlers": { |
| 2777 | "fileGlobal": { |
| 2778 | "class": "logging.StreamHandler", |
| 2779 | "level": "DEBUG", |
| 2780 | "formatter": "mySimpleFormatter" |
| 2781 | }, |
| 2782 | "bufferGlobal": { |
| 2783 | "class": "logging.handlers.MemoryHandler", |
| 2784 | "capacity": 5, |
| 2785 | "formatter": "mySimpleFormatter", |
| 2786 | "target": "fileGlobal", |
| 2787 | "level": "DEBUG" |
| 2788 | } |
| 2789 | }, |
| 2790 | "loggers": { |
| 2791 | "mymodule": { |
| 2792 | "level": "DEBUG", |
| 2793 | "handlers": ["bufferGlobal"], |
| 2794 | "propagate": "true" |
| 2795 | } |
| 2796 | } |
| 2797 | } |
| 2798 | |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 2799 | # Configuration with custom logging.Formatter subclass as '()' key and 'validate' set to False |
| 2800 | custom_formatter_class_validate = { |
| 2801 | 'version': 1, |
| 2802 | 'formatters': { |
| 2803 | 'form1': { |
| 2804 | '()': __name__ + '.ExceptionFormatter', |
| 2805 | 'format': '%(levelname)s:%(name)s:%(message)s', |
| 2806 | 'validate': False, |
| 2807 | }, |
| 2808 | }, |
| 2809 | 'handlers' : { |
| 2810 | 'hand1' : { |
| 2811 | 'class': 'logging.StreamHandler', |
| 2812 | 'formatter': 'form1', |
| 2813 | 'level': 'NOTSET', |
| 2814 | 'stream': 'ext://sys.stdout', |
| 2815 | }, |
| 2816 | }, |
| 2817 | "loggers": { |
| 2818 | "my_test_logger_custom_formatter": { |
| 2819 | "level": "DEBUG", |
| 2820 | "handlers": ["hand1"], |
| 2821 | "propagate": "true" |
| 2822 | } |
| 2823 | } |
| 2824 | } |
| 2825 | |
| 2826 | # Configuration with custom logging.Formatter subclass as 'class' key and 'validate' set to False |
| 2827 | custom_formatter_class_validate2 = { |
| 2828 | 'version': 1, |
| 2829 | 'formatters': { |
| 2830 | 'form1': { |
| 2831 | 'class': __name__ + '.ExceptionFormatter', |
| 2832 | 'format': '%(levelname)s:%(name)s:%(message)s', |
| 2833 | 'validate': False, |
| 2834 | }, |
| 2835 | }, |
| 2836 | 'handlers' : { |
| 2837 | 'hand1' : { |
| 2838 | 'class': 'logging.StreamHandler', |
| 2839 | 'formatter': 'form1', |
| 2840 | 'level': 'NOTSET', |
| 2841 | 'stream': 'ext://sys.stdout', |
| 2842 | }, |
| 2843 | }, |
| 2844 | "loggers": { |
| 2845 | "my_test_logger_custom_formatter": { |
| 2846 | "level": "DEBUG", |
| 2847 | "handlers": ["hand1"], |
| 2848 | "propagate": "true" |
| 2849 | } |
| 2850 | } |
| 2851 | } |
| 2852 | |
| 2853 | # Configuration with custom class that is not inherited from logging.Formatter |
| 2854 | custom_formatter_class_validate3 = { |
| 2855 | 'version': 1, |
| 2856 | 'formatters': { |
| 2857 | 'form1': { |
| 2858 | 'class': __name__ + '.myCustomFormatter', |
| 2859 | 'format': '%(levelname)s:%(name)s:%(message)s', |
| 2860 | 'validate': False, |
| 2861 | }, |
| 2862 | }, |
| 2863 | 'handlers' : { |
| 2864 | 'hand1' : { |
| 2865 | 'class': 'logging.StreamHandler', |
| 2866 | 'formatter': 'form1', |
| 2867 | 'level': 'NOTSET', |
| 2868 | 'stream': 'ext://sys.stdout', |
| 2869 | }, |
| 2870 | }, |
| 2871 | "loggers": { |
| 2872 | "my_test_logger_custom_formatter": { |
| 2873 | "level": "DEBUG", |
| 2874 | "handlers": ["hand1"], |
| 2875 | "propagate": "true" |
| 2876 | } |
| 2877 | } |
| 2878 | } |
| 2879 | |
| 2880 | # Configuration with custom function and 'validate' set to False |
| 2881 | custom_formatter_with_function = { |
| 2882 | 'version': 1, |
| 2883 | 'formatters': { |
| 2884 | 'form1': { |
| 2885 | '()': formatFunc, |
| 2886 | 'format': '%(levelname)s:%(name)s:%(message)s', |
| 2887 | 'validate': False, |
| 2888 | }, |
| 2889 | }, |
| 2890 | 'handlers' : { |
| 2891 | 'hand1' : { |
| 2892 | 'class': 'logging.StreamHandler', |
| 2893 | 'formatter': 'form1', |
| 2894 | 'level': 'NOTSET', |
| 2895 | 'stream': 'ext://sys.stdout', |
| 2896 | }, |
| 2897 | }, |
| 2898 | "loggers": { |
| 2899 | "my_test_logger_custom_formatter": { |
| 2900 | "level": "DEBUG", |
| 2901 | "handlers": ["hand1"], |
| 2902 | "propagate": "true" |
| 2903 | } |
| 2904 | } |
| 2905 | } |
| 2906 | |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2907 | def apply_config(self, conf): |
| 2908 | logging.config.dictConfig(conf) |
| 2909 | |
| 2910 | def test_config0_ok(self): |
| 2911 | # A simple config which overrides the default settings. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 2912 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2913 | self.apply_config(self.config0) |
| 2914 | logger = logging.getLogger() |
| 2915 | # Won't output anything |
| 2916 | logger.info(self.next_message()) |
| 2917 | # Outputs a message |
| 2918 | logger.error(self.next_message()) |
| 2919 | self.assert_log_lines([ |
| 2920 | ('ERROR', '2'), |
| 2921 | ], stream=output) |
| 2922 | # Original logger output is empty. |
| 2923 | self.assert_log_lines([]) |
| 2924 | |
| 2925 | def test_config1_ok(self, config=config1): |
| 2926 | # A config defining a sub-parser as well. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 2927 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2928 | self.apply_config(config) |
| 2929 | logger = logging.getLogger("compiler.parser") |
| 2930 | # Both will output a message |
| 2931 | logger.info(self.next_message()) |
| 2932 | logger.error(self.next_message()) |
| 2933 | self.assert_log_lines([ |
| 2934 | ('INFO', '1'), |
| 2935 | ('ERROR', '2'), |
| 2936 | ], stream=output) |
| 2937 | # Original logger output is empty. |
| 2938 | self.assert_log_lines([]) |
| 2939 | |
| 2940 | def test_config2_failure(self): |
| 2941 | # A simple config which overrides the default settings. |
| 2942 | self.assertRaises(Exception, self.apply_config, self.config2) |
| 2943 | |
| 2944 | def test_config2a_failure(self): |
| 2945 | # A simple config which overrides the default settings. |
| 2946 | self.assertRaises(Exception, self.apply_config, self.config2a) |
| 2947 | |
| 2948 | def test_config2b_failure(self): |
| 2949 | # A simple config which overrides the default settings. |
| 2950 | self.assertRaises(Exception, self.apply_config, self.config2b) |
| 2951 | |
| 2952 | def test_config3_failure(self): |
| 2953 | # A simple config which overrides the default settings. |
| 2954 | self.assertRaises(Exception, self.apply_config, self.config3) |
| 2955 | |
| 2956 | def test_config4_ok(self): |
| 2957 | # A config specifying a custom formatter class. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 2958 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2959 | self.apply_config(self.config4) |
| 2960 | #logger = logging.getLogger() |
| 2961 | try: |
| 2962 | raise RuntimeError() |
| 2963 | except RuntimeError: |
| 2964 | logging.exception("just testing") |
| 2965 | sys.stdout.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2966 | self.assertEqual(output.getvalue(), |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2967 | "ERROR:root:just testing\nGot a [RuntimeError]\n") |
| 2968 | # Original logger output is empty |
| 2969 | self.assert_log_lines([]) |
| 2970 | |
| 2971 | def test_config4a_ok(self): |
| 2972 | # A config specifying a custom formatter class. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 2973 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2974 | self.apply_config(self.config4a) |
| 2975 | #logger = logging.getLogger() |
| 2976 | try: |
| 2977 | raise RuntimeError() |
| 2978 | except RuntimeError: |
| 2979 | logging.exception("just testing") |
| 2980 | sys.stdout.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 2981 | self.assertEqual(output.getvalue(), |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2982 | "ERROR:root:just testing\nGot a [RuntimeError]\n") |
| 2983 | # Original logger output is empty |
| 2984 | self.assert_log_lines([]) |
| 2985 | |
| 2986 | def test_config5_ok(self): |
| 2987 | self.test_config1_ok(config=self.config5) |
| 2988 | |
| 2989 | def test_config6_failure(self): |
| 2990 | self.assertRaises(Exception, self.apply_config, self.config6) |
| 2991 | |
| 2992 | def test_config7_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 2993 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 2994 | self.apply_config(self.config1) |
| 2995 | logger = logging.getLogger("compiler.parser") |
| 2996 | # Both will output a message |
| 2997 | logger.info(self.next_message()) |
| 2998 | logger.error(self.next_message()) |
| 2999 | self.assert_log_lines([ |
| 3000 | ('INFO', '1'), |
| 3001 | ('ERROR', '2'), |
| 3002 | ], stream=output) |
| 3003 | # Original logger output is empty. |
| 3004 | self.assert_log_lines([]) |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3005 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3006 | self.apply_config(self.config7) |
| 3007 | logger = logging.getLogger("compiler.parser") |
| 3008 | self.assertTrue(logger.disabled) |
| 3009 | logger = logging.getLogger("compiler.lexer") |
| 3010 | # Both will output a message |
| 3011 | logger.info(self.next_message()) |
| 3012 | logger.error(self.next_message()) |
| 3013 | self.assert_log_lines([ |
| 3014 | ('INFO', '3'), |
| 3015 | ('ERROR', '4'), |
| 3016 | ], stream=output) |
| 3017 | # Original logger output is empty. |
| 3018 | self.assert_log_lines([]) |
| 3019 | |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3020 | # Same as test_config_7_ok but don't disable old loggers. |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3021 | def test_config_8_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3022 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3023 | self.apply_config(self.config1) |
| 3024 | logger = logging.getLogger("compiler.parser") |
Vinay Sajip | 9f9991c | 2011-03-07 18:02:57 +0000 | [diff] [blame] | 3025 | # All will output a message |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3026 | logger.info(self.next_message()) |
| 3027 | logger.error(self.next_message()) |
| 3028 | self.assert_log_lines([ |
| 3029 | ('INFO', '1'), |
| 3030 | ('ERROR', '2'), |
| 3031 | ], stream=output) |
| 3032 | # Original logger output is empty. |
| 3033 | self.assert_log_lines([]) |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3034 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3035 | self.apply_config(self.config8) |
| 3036 | logger = logging.getLogger("compiler.parser") |
| 3037 | self.assertFalse(logger.disabled) |
| 3038 | # Both will output a message |
| 3039 | logger.info(self.next_message()) |
| 3040 | logger.error(self.next_message()) |
| 3041 | logger = logging.getLogger("compiler.lexer") |
| 3042 | # Both will output a message |
| 3043 | logger.info(self.next_message()) |
| 3044 | logger.error(self.next_message()) |
| 3045 | self.assert_log_lines([ |
| 3046 | ('INFO', '3'), |
| 3047 | ('ERROR', '4'), |
| 3048 | ('INFO', '5'), |
| 3049 | ('ERROR', '6'), |
| 3050 | ], stream=output) |
| 3051 | # Original logger output is empty. |
| 3052 | self.assert_log_lines([]) |
| 3053 | |
Vinay Sajip | 9f9991c | 2011-03-07 18:02:57 +0000 | [diff] [blame] | 3054 | def test_config_8a_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3055 | with support.captured_stdout() as output: |
Vinay Sajip | 9f9991c | 2011-03-07 18:02:57 +0000 | [diff] [blame] | 3056 | self.apply_config(self.config1a) |
| 3057 | logger = logging.getLogger("compiler.parser") |
| 3058 | # See issue #11424. compiler-hyphenated sorts |
| 3059 | # between compiler and compiler.xyz and this |
| 3060 | # was preventing compiler.xyz from being included |
| 3061 | # in the child loggers of compiler because of an |
| 3062 | # overzealous loop termination condition. |
| 3063 | hyphenated = logging.getLogger('compiler-hyphenated') |
| 3064 | # All will output a message |
| 3065 | logger.info(self.next_message()) |
| 3066 | logger.error(self.next_message()) |
| 3067 | hyphenated.critical(self.next_message()) |
| 3068 | self.assert_log_lines([ |
| 3069 | ('INFO', '1'), |
| 3070 | ('ERROR', '2'), |
| 3071 | ('CRITICAL', '3'), |
| 3072 | ], stream=output) |
| 3073 | # Original logger output is empty. |
| 3074 | self.assert_log_lines([]) |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3075 | with support.captured_stdout() as output: |
Vinay Sajip | 9f9991c | 2011-03-07 18:02:57 +0000 | [diff] [blame] | 3076 | self.apply_config(self.config8a) |
| 3077 | logger = logging.getLogger("compiler.parser") |
| 3078 | self.assertFalse(logger.disabled) |
| 3079 | # Both will output a message |
| 3080 | logger.info(self.next_message()) |
| 3081 | logger.error(self.next_message()) |
| 3082 | logger = logging.getLogger("compiler.lexer") |
| 3083 | # Both will output a message |
| 3084 | logger.info(self.next_message()) |
| 3085 | logger.error(self.next_message()) |
| 3086 | # Will not appear |
| 3087 | hyphenated.critical(self.next_message()) |
| 3088 | self.assert_log_lines([ |
| 3089 | ('INFO', '4'), |
| 3090 | ('ERROR', '5'), |
| 3091 | ('INFO', '6'), |
| 3092 | ('ERROR', '7'), |
| 3093 | ], stream=output) |
| 3094 | # Original logger output is empty. |
| 3095 | self.assert_log_lines([]) |
| 3096 | |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3097 | def test_config_9_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3098 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3099 | self.apply_config(self.config9) |
| 3100 | logger = logging.getLogger("compiler.parser") |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3101 | # Nothing will be output since both handler and logger are set to WARNING |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3102 | logger.info(self.next_message()) |
| 3103 | self.assert_log_lines([], stream=output) |
| 3104 | self.apply_config(self.config9a) |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3105 | # Nothing will be output since handler is still set to WARNING |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3106 | logger.info(self.next_message()) |
| 3107 | self.assert_log_lines([], stream=output) |
| 3108 | self.apply_config(self.config9b) |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3109 | # Message should now be output |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3110 | logger.info(self.next_message()) |
| 3111 | self.assert_log_lines([ |
| 3112 | ('INFO', '3'), |
| 3113 | ], stream=output) |
| 3114 | |
| 3115 | def test_config_10_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3116 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3117 | self.apply_config(self.config10) |
| 3118 | logger = logging.getLogger("compiler.parser") |
| 3119 | logger.warning(self.next_message()) |
| 3120 | logger = logging.getLogger('compiler') |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3121 | # Not output, because filtered |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3122 | logger.warning(self.next_message()) |
| 3123 | logger = logging.getLogger('compiler.lexer') |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3124 | # Not output, because filtered |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3125 | logger.warning(self.next_message()) |
| 3126 | logger = logging.getLogger("compiler.parser.codegen") |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3127 | # Output, as not filtered |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3128 | logger.error(self.next_message()) |
| 3129 | self.assert_log_lines([ |
| 3130 | ('WARNING', '1'), |
| 3131 | ('ERROR', '4'), |
| 3132 | ], stream=output) |
| 3133 | |
| 3134 | def test_config11_ok(self): |
| 3135 | self.test_config1_ok(self.config11) |
| 3136 | |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 3137 | def test_config12_failure(self): |
| 3138 | self.assertRaises(Exception, self.apply_config, self.config12) |
| 3139 | |
| 3140 | def test_config13_failure(self): |
| 3141 | self.assertRaises(Exception, self.apply_config, self.config13) |
| 3142 | |
Vinay Sajip | 8d27023 | 2012-11-15 14:20:18 +0000 | [diff] [blame] | 3143 | def test_config14_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3144 | with support.captured_stdout() as output: |
Vinay Sajip | 8d27023 | 2012-11-15 14:20:18 +0000 | [diff] [blame] | 3145 | self.apply_config(self.config14) |
| 3146 | h = logging._handlers['hand1'] |
| 3147 | self.assertEqual(h.foo, 'bar') |
| 3148 | self.assertEqual(h.terminator, '!\n') |
| 3149 | logging.warning('Exclamation') |
| 3150 | self.assertTrue(output.getvalue().endswith('Exclamation!\n')) |
| 3151 | |
Xtreak | 087570a | 2018-07-02 14:27:46 +0530 | [diff] [blame] | 3152 | def test_config15_ok(self): |
| 3153 | |
| 3154 | def cleanup(h1, fn): |
| 3155 | h1.close() |
| 3156 | os.remove(fn) |
| 3157 | |
| 3158 | with self.check_no_resource_warning(): |
| 3159 | fd, fn = tempfile.mkstemp(".log", "test_logging-X-") |
| 3160 | os.close(fd) |
| 3161 | |
| 3162 | config = { |
| 3163 | "version": 1, |
| 3164 | "handlers": { |
| 3165 | "file": { |
| 3166 | "class": "logging.FileHandler", |
| 3167 | "filename": fn |
| 3168 | } |
| 3169 | }, |
| 3170 | "root": { |
| 3171 | "handlers": ["file"] |
| 3172 | } |
| 3173 | } |
| 3174 | |
| 3175 | self.apply_config(config) |
| 3176 | self.apply_config(config) |
| 3177 | |
| 3178 | handler = logging.root.handlers[0] |
| 3179 | self.addCleanup(cleanup, handler, fn) |
| 3180 | |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3181 | def setup_via_listener(self, text, verify=None): |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 3182 | text = text.encode("utf-8") |
Florent Xicluna | dc69274 | 2010-08-15 20:16:27 +0000 | [diff] [blame] | 3183 | # Ask for a randomly assigned port (by using port 0) |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3184 | t = logging.config.listen(0, verify) |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3185 | t.start() |
| 3186 | t.ready.wait() |
Benjamin Peterson | a82addb | 2010-06-27 20:54:28 +0000 | [diff] [blame] | 3187 | # Now get the port allocated |
| 3188 | port = t.port |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3189 | t.ready.clear() |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3190 | try: |
| 3191 | sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
| 3192 | sock.settimeout(2.0) |
| 3193 | sock.connect(('localhost', port)) |
| 3194 | |
| 3195 | slen = struct.pack('>L', len(text)) |
| 3196 | s = slen + text |
| 3197 | sentsofar = 0 |
| 3198 | left = len(s) |
| 3199 | while left > 0: |
| 3200 | sent = sock.send(s[sentsofar:]) |
| 3201 | sentsofar += sent |
| 3202 | left -= sent |
| 3203 | sock.close() |
| 3204 | finally: |
| 3205 | t.ready.wait(2.0) |
| 3206 | logging.config.stopListening() |
Victor Stinner | b9b6900 | 2017-09-14 14:40:56 -0700 | [diff] [blame] | 3207 | support.join_thread(t, 2.0) |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3208 | |
| 3209 | def test_listen_config_10_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3210 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3211 | self.setup_via_listener(json.dumps(self.config10)) |
| 3212 | logger = logging.getLogger("compiler.parser") |
| 3213 | logger.warning(self.next_message()) |
| 3214 | logger = logging.getLogger('compiler') |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3215 | # Not output, because filtered |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3216 | logger.warning(self.next_message()) |
| 3217 | logger = logging.getLogger('compiler.lexer') |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3218 | # Not output, because filtered |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3219 | logger.warning(self.next_message()) |
| 3220 | logger = logging.getLogger("compiler.parser.codegen") |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 3221 | # Output, as not filtered |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3222 | logger.error(self.next_message()) |
| 3223 | self.assert_log_lines([ |
| 3224 | ('WARNING', '1'), |
| 3225 | ('ERROR', '4'), |
| 3226 | ], stream=output) |
| 3227 | |
| 3228 | def test_listen_config_1_ok(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3229 | with support.captured_stdout() as output: |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3230 | self.setup_via_listener(textwrap.dedent(ConfigFileTest.config1)) |
| 3231 | logger = logging.getLogger("compiler.parser") |
| 3232 | # Both will output a message |
| 3233 | logger.info(self.next_message()) |
| 3234 | logger.error(self.next_message()) |
| 3235 | self.assert_log_lines([ |
| 3236 | ('INFO', '1'), |
| 3237 | ('ERROR', '2'), |
| 3238 | ], stream=output) |
| 3239 | # Original logger output is empty. |
| 3240 | self.assert_log_lines([]) |
| 3241 | |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3242 | def test_listen_verify(self): |
| 3243 | |
| 3244 | def verify_fail(stuff): |
| 3245 | return None |
| 3246 | |
| 3247 | def verify_reverse(stuff): |
| 3248 | return stuff[::-1] |
| 3249 | |
| 3250 | logger = logging.getLogger("compiler.parser") |
| 3251 | to_send = textwrap.dedent(ConfigFileTest.config1) |
| 3252 | # First, specify a verification function that will fail. |
| 3253 | # We expect to see no output, since our configuration |
| 3254 | # never took effect. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3255 | with support.captured_stdout() as output: |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3256 | self.setup_via_listener(to_send, verify_fail) |
| 3257 | # Both will output a message |
| 3258 | logger.info(self.next_message()) |
| 3259 | logger.error(self.next_message()) |
| 3260 | self.assert_log_lines([], stream=output) |
| 3261 | # Original logger output has the stuff we logged. |
| 3262 | self.assert_log_lines([ |
| 3263 | ('INFO', '1'), |
| 3264 | ('ERROR', '2'), |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 3265 | ], pat=r"^[\w.]+ -> (\w+): (\d+)$") |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3266 | |
| 3267 | # Now, perform no verification. Our configuration |
| 3268 | # should take effect. |
| 3269 | |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3270 | with support.captured_stdout() as output: |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3271 | self.setup_via_listener(to_send) # no verify callable specified |
| 3272 | logger = logging.getLogger("compiler.parser") |
| 3273 | # Both will output a message |
| 3274 | logger.info(self.next_message()) |
| 3275 | logger.error(self.next_message()) |
| 3276 | self.assert_log_lines([ |
| 3277 | ('INFO', '3'), |
| 3278 | ('ERROR', '4'), |
| 3279 | ], stream=output) |
| 3280 | # Original logger output still has the stuff we logged before. |
| 3281 | self.assert_log_lines([ |
| 3282 | ('INFO', '1'), |
| 3283 | ('ERROR', '2'), |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 3284 | ], pat=r"^[\w.]+ -> (\w+): (\d+)$") |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3285 | |
| 3286 | # Now, perform verification which transforms the bytes. |
| 3287 | |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3288 | with support.captured_stdout() as output: |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3289 | self.setup_via_listener(to_send[::-1], verify_reverse) |
| 3290 | logger = logging.getLogger("compiler.parser") |
| 3291 | # Both will output a message |
| 3292 | logger.info(self.next_message()) |
| 3293 | logger.error(self.next_message()) |
| 3294 | self.assert_log_lines([ |
| 3295 | ('INFO', '5'), |
| 3296 | ('ERROR', '6'), |
| 3297 | ], stream=output) |
| 3298 | # Original logger output still has the stuff we logged before. |
| 3299 | self.assert_log_lines([ |
| 3300 | ('INFO', '1'), |
| 3301 | ('ERROR', '2'), |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 3302 | ], pat=r"^[\w.]+ -> (\w+): (\d+)$") |
Vinay Sajip | 4ded551 | 2012-10-02 15:56:16 +0100 | [diff] [blame] | 3303 | |
Vinay Sajip | 3f885b5 | 2013-03-22 15:19:54 +0000 | [diff] [blame] | 3304 | def test_out_of_order(self): |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3305 | self.assertRaises(ValueError, self.apply_config, self.out_of_order) |
| 3306 | |
| 3307 | def test_out_of_order_with_dollar_style(self): |
Pablo Galindo | 137b063 | 2018-10-16 15:17:57 +0100 | [diff] [blame] | 3308 | config = copy.deepcopy(self.out_of_order) |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3309 | config['formatters']['mySimpleFormatter']['format'] = "${asctime} (${name}) ${levelname}: ${message}" |
| 3310 | |
| 3311 | self.apply_config(config) |
Vinay Sajip | 3f885b5 | 2013-03-22 15:19:54 +0000 | [diff] [blame] | 3312 | handler = logging.getLogger('mymodule').handlers[0] |
| 3313 | self.assertIsInstance(handler.target, logging.Handler) |
Vinay Sajip | 28421c6 | 2013-03-29 17:56:54 +0000 | [diff] [blame] | 3314 | self.assertIsInstance(handler.formatter._style, |
| 3315 | logging.StringTemplateStyle) |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3316 | |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3317 | def test_custom_formatter_class_with_validate(self): |
| 3318 | self.apply_config(self.custom_formatter_class_validate) |
| 3319 | handler = logging.getLogger("my_test_logger_custom_formatter").handlers[0] |
| 3320 | self.assertIsInstance(handler.formatter, ExceptionFormatter) |
| 3321 | |
| 3322 | def test_custom_formatter_class_with_validate2(self): |
| 3323 | self.apply_config(self.custom_formatter_class_validate2) |
| 3324 | handler = logging.getLogger("my_test_logger_custom_formatter").handlers[0] |
| 3325 | self.assertIsInstance(handler.formatter, ExceptionFormatter) |
| 3326 | |
| 3327 | def test_custom_formatter_class_with_validate2_with_wrong_fmt(self): |
| 3328 | config = self.custom_formatter_class_validate.copy() |
| 3329 | config['formatters']['form1']['style'] = "$" |
| 3330 | |
| 3331 | # Exception should not be raise as we have configured 'validate' to False |
| 3332 | self.apply_config(config) |
| 3333 | handler = logging.getLogger("my_test_logger_custom_formatter").handlers[0] |
| 3334 | self.assertIsInstance(handler.formatter, ExceptionFormatter) |
| 3335 | |
| 3336 | def test_custom_formatter_class_with_validate3(self): |
| 3337 | self.assertRaises(ValueError, self.apply_config, self.custom_formatter_class_validate3) |
| 3338 | |
| 3339 | def test_custom_formatter_function_with_validate(self): |
| 3340 | self.assertRaises(ValueError, self.apply_config, self.custom_formatter_with_function) |
| 3341 | |
Vinay Sajip | 373baef | 2011-04-26 20:05:24 +0100 | [diff] [blame] | 3342 | def test_baseconfig(self): |
| 3343 | d = { |
| 3344 | 'atuple': (1, 2, 3), |
| 3345 | 'alist': ['a', 'b', 'c'], |
| 3346 | 'adict': {'d': 'e', 'f': 3 }, |
| 3347 | 'nest1': ('g', ('h', 'i'), 'j'), |
| 3348 | 'nest2': ['k', ['l', 'm'], 'n'], |
| 3349 | 'nest3': ['o', 'cfg://alist', 'p'], |
| 3350 | } |
| 3351 | bc = logging.config.BaseConfigurator(d) |
| 3352 | self.assertEqual(bc.convert('cfg://atuple[1]'), 2) |
| 3353 | self.assertEqual(bc.convert('cfg://alist[1]'), 'b') |
| 3354 | self.assertEqual(bc.convert('cfg://nest1[1][0]'), 'h') |
| 3355 | self.assertEqual(bc.convert('cfg://nest2[1][1]'), 'm') |
| 3356 | self.assertEqual(bc.convert('cfg://adict.d'), 'e') |
| 3357 | self.assertEqual(bc.convert('cfg://adict[f]'), 3) |
| 3358 | v = bc.convert('cfg://nest3') |
| 3359 | self.assertEqual(v.pop(1), ['a', 'b', 'c']) |
| 3360 | self.assertRaises(KeyError, bc.convert, 'cfg://nosuch') |
| 3361 | self.assertRaises(ValueError, bc.convert, 'cfg://!') |
| 3362 | self.assertRaises(KeyError, bc.convert, 'cfg://adict[2]') |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3363 | |
| 3364 | class ManagerTest(BaseTest): |
| 3365 | def test_manager_loggerclass(self): |
| 3366 | logged = [] |
| 3367 | |
| 3368 | class MyLogger(logging.Logger): |
| 3369 | def _log(self, level, msg, args, exc_info=None, extra=None): |
| 3370 | logged.append(msg) |
| 3371 | |
| 3372 | man = logging.Manager(None) |
| 3373 | self.assertRaises(TypeError, man.setLoggerClass, int) |
| 3374 | man.setLoggerClass(MyLogger) |
| 3375 | logger = man.getLogger('test') |
| 3376 | logger.warning('should appear in logged') |
| 3377 | logging.warning('should not appear in logged') |
| 3378 | |
| 3379 | self.assertEqual(logged, ['should appear in logged']) |
| 3380 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 3381 | def test_set_log_record_factory(self): |
| 3382 | man = logging.Manager(None) |
| 3383 | expected = object() |
| 3384 | man.setLogRecordFactory(expected) |
| 3385 | self.assertEqual(man.logRecordFactory, expected) |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 3386 | |
Benjamin Peterson | 22005fc | 2010-04-11 16:25:06 +0000 | [diff] [blame] | 3387 | class ChildLoggerTest(BaseTest): |
| 3388 | def test_child_loggers(self): |
| 3389 | r = logging.getLogger() |
| 3390 | l1 = logging.getLogger('abc') |
| 3391 | l2 = logging.getLogger('def.ghi') |
| 3392 | c1 = r.getChild('xyz') |
| 3393 | c2 = r.getChild('uvw.xyz') |
Giampaolo Rodola' | 284529d | 2012-10-17 13:24:27 +0200 | [diff] [blame] | 3394 | self.assertIs(c1, logging.getLogger('xyz')) |
| 3395 | self.assertIs(c2, logging.getLogger('uvw.xyz')) |
Benjamin Peterson | 22005fc | 2010-04-11 16:25:06 +0000 | [diff] [blame] | 3396 | c1 = l1.getChild('def') |
| 3397 | c2 = c1.getChild('ghi') |
| 3398 | c3 = l1.getChild('def.ghi') |
Giampaolo Rodola' | 284529d | 2012-10-17 13:24:27 +0200 | [diff] [blame] | 3399 | self.assertIs(c1, logging.getLogger('abc.def')) |
| 3400 | self.assertIs(c2, logging.getLogger('abc.def.ghi')) |
| 3401 | self.assertIs(c2, c3) |
Benjamin Peterson | 22005fc | 2010-04-11 16:25:06 +0000 | [diff] [blame] | 3402 | |
| 3403 | |
Vinay Sajip | 6fac817 | 2010-10-19 20:44:14 +0000 | [diff] [blame] | 3404 | class DerivedLogRecord(logging.LogRecord): |
| 3405 | pass |
| 3406 | |
Vinay Sajip | 6156152 | 2010-12-03 11:50:38 +0000 | [diff] [blame] | 3407 | class LogRecordFactoryTest(BaseTest): |
Vinay Sajip | 6fac817 | 2010-10-19 20:44:14 +0000 | [diff] [blame] | 3408 | |
| 3409 | def setUp(self): |
| 3410 | class CheckingFilter(logging.Filter): |
| 3411 | def __init__(self, cls): |
| 3412 | self.cls = cls |
| 3413 | |
| 3414 | def filter(self, record): |
| 3415 | t = type(record) |
| 3416 | if t is not self.cls: |
| 3417 | msg = 'Unexpected LogRecord type %s, expected %s' % (t, |
| 3418 | self.cls) |
| 3419 | raise TypeError(msg) |
| 3420 | return True |
| 3421 | |
| 3422 | BaseTest.setUp(self) |
| 3423 | self.filter = CheckingFilter(DerivedLogRecord) |
| 3424 | self.root_logger.addFilter(self.filter) |
Vinay Sajip | 6156152 | 2010-12-03 11:50:38 +0000 | [diff] [blame] | 3425 | self.orig_factory = logging.getLogRecordFactory() |
Vinay Sajip | 6fac817 | 2010-10-19 20:44:14 +0000 | [diff] [blame] | 3426 | |
| 3427 | def tearDown(self): |
| 3428 | self.root_logger.removeFilter(self.filter) |
| 3429 | BaseTest.tearDown(self) |
Vinay Sajip | 6156152 | 2010-12-03 11:50:38 +0000 | [diff] [blame] | 3430 | logging.setLogRecordFactory(self.orig_factory) |
Vinay Sajip | 6fac817 | 2010-10-19 20:44:14 +0000 | [diff] [blame] | 3431 | |
| 3432 | def test_logrecord_class(self): |
| 3433 | self.assertRaises(TypeError, self.root_logger.warning, |
| 3434 | self.next_message()) |
Vinay Sajip | 6156152 | 2010-12-03 11:50:38 +0000 | [diff] [blame] | 3435 | logging.setLogRecordFactory(DerivedLogRecord) |
Vinay Sajip | 6fac817 | 2010-10-19 20:44:14 +0000 | [diff] [blame] | 3436 | self.root_logger.error(self.next_message()) |
| 3437 | self.assert_log_lines([ |
| 3438 | ('root', 'ERROR', '2'), |
| 3439 | ]) |
| 3440 | |
| 3441 | |
Vinay Sajip | 8552d1f | 2010-09-14 09:34:09 +0000 | [diff] [blame] | 3442 | class QueueHandlerTest(BaseTest): |
| 3443 | # Do not bother with a logger name group. |
Ezio Melotti | 3ffd29b | 2012-10-02 19:45:00 +0300 | [diff] [blame] | 3444 | expected_log_pat = r"^[\w.]+ -> (\w+): (\d+)$" |
Vinay Sajip | 8552d1f | 2010-09-14 09:34:09 +0000 | [diff] [blame] | 3445 | |
| 3446 | def setUp(self): |
| 3447 | BaseTest.setUp(self) |
| 3448 | self.queue = queue.Queue(-1) |
| 3449 | self.que_hdlr = logging.handlers.QueueHandler(self.queue) |
favll | adfe344 | 2017-08-01 20:12:26 +0200 | [diff] [blame] | 3450 | self.name = 'que' |
Vinay Sajip | 8552d1f | 2010-09-14 09:34:09 +0000 | [diff] [blame] | 3451 | self.que_logger = logging.getLogger('que') |
| 3452 | self.que_logger.propagate = False |
| 3453 | self.que_logger.setLevel(logging.WARNING) |
| 3454 | self.que_logger.addHandler(self.que_hdlr) |
| 3455 | |
| 3456 | def tearDown(self): |
| 3457 | self.que_hdlr.close() |
| 3458 | BaseTest.tearDown(self) |
| 3459 | |
| 3460 | def test_queue_handler(self): |
| 3461 | self.que_logger.debug(self.next_message()) |
| 3462 | self.assertRaises(queue.Empty, self.queue.get_nowait) |
| 3463 | self.que_logger.info(self.next_message()) |
| 3464 | self.assertRaises(queue.Empty, self.queue.get_nowait) |
| 3465 | msg = self.next_message() |
| 3466 | self.que_logger.warning(msg) |
| 3467 | data = self.queue.get_nowait() |
| 3468 | self.assertTrue(isinstance(data, logging.LogRecord)) |
| 3469 | self.assertEqual(data.name, self.que_logger.name) |
| 3470 | self.assertEqual((data.msg, data.args), (msg, None)) |
| 3471 | |
favll | adfe344 | 2017-08-01 20:12:26 +0200 | [diff] [blame] | 3472 | def test_formatting(self): |
| 3473 | msg = self.next_message() |
| 3474 | levelname = logging.getLevelName(logging.WARNING) |
| 3475 | log_format_str = '{name} -> {levelname}: {message}' |
| 3476 | formatted_msg = log_format_str.format(name=self.name, |
| 3477 | levelname=levelname, message=msg) |
| 3478 | formatter = logging.Formatter(self.log_format) |
| 3479 | self.que_hdlr.setFormatter(formatter) |
| 3480 | self.que_logger.warning(msg) |
| 3481 | log_record = self.queue.get_nowait() |
| 3482 | self.assertEqual(formatted_msg, log_record.msg) |
| 3483 | self.assertEqual(formatted_msg, log_record.message) |
| 3484 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 3485 | @unittest.skipUnless(hasattr(logging.handlers, 'QueueListener'), |
| 3486 | 'logging.handlers.QueueListener required for this test') |
Vinay Sajip | e723e96 | 2011-04-15 22:27:17 +0100 | [diff] [blame] | 3487 | def test_queue_listener(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3488 | handler = support.TestHandler(support.Matcher()) |
Vinay Sajip | e723e96 | 2011-04-15 22:27:17 +0100 | [diff] [blame] | 3489 | listener = logging.handlers.QueueListener(self.queue, handler) |
| 3490 | listener.start() |
| 3491 | try: |
| 3492 | self.que_logger.warning(self.next_message()) |
| 3493 | self.que_logger.error(self.next_message()) |
| 3494 | self.que_logger.critical(self.next_message()) |
| 3495 | finally: |
| 3496 | listener.stop() |
| 3497 | self.assertTrue(handler.matches(levelno=logging.WARNING, message='1')) |
| 3498 | self.assertTrue(handler.matches(levelno=logging.ERROR, message='2')) |
| 3499 | self.assertTrue(handler.matches(levelno=logging.CRITICAL, message='3')) |
Vinay Sajip | 365701a | 2015-02-09 19:49:00 +0000 | [diff] [blame] | 3500 | handler.close() |
| 3501 | |
| 3502 | # Now test with respect_handler_level set |
| 3503 | |
| 3504 | handler = support.TestHandler(support.Matcher()) |
| 3505 | handler.setLevel(logging.CRITICAL) |
| 3506 | listener = logging.handlers.QueueListener(self.queue, handler, |
| 3507 | respect_handler_level=True) |
| 3508 | listener.start() |
| 3509 | try: |
| 3510 | self.que_logger.warning(self.next_message()) |
| 3511 | self.que_logger.error(self.next_message()) |
| 3512 | self.que_logger.critical(self.next_message()) |
| 3513 | finally: |
| 3514 | listener.stop() |
| 3515 | self.assertFalse(handler.matches(levelno=logging.WARNING, message='4')) |
| 3516 | self.assertFalse(handler.matches(levelno=logging.ERROR, message='5')) |
| 3517 | self.assertTrue(handler.matches(levelno=logging.CRITICAL, message='6')) |
Cheryl Sabella | d345bb4 | 2018-09-25 19:00:08 -0400 | [diff] [blame] | 3518 | handler.close() |
| 3519 | |
| 3520 | @unittest.skipUnless(hasattr(logging.handlers, 'QueueListener'), |
| 3521 | 'logging.handlers.QueueListener required for this test') |
| 3522 | def test_queue_listener_with_StreamHandler(self): |
| 3523 | # Test that traceback only appends once (bpo-34334). |
| 3524 | listener = logging.handlers.QueueListener(self.queue, self.root_hdlr) |
| 3525 | listener.start() |
| 3526 | try: |
| 3527 | 1 / 0 |
| 3528 | except ZeroDivisionError as e: |
| 3529 | exc = e |
| 3530 | self.que_logger.exception(self.next_message(), exc_info=exc) |
| 3531 | listener.stop() |
| 3532 | self.assertEqual(self.stream.getvalue().strip().count('Traceback'), 1) |
Vinay Sajip | 365701a | 2015-02-09 19:49:00 +0000 | [diff] [blame] | 3533 | |
Xtreak | 2dad960 | 2019-04-07 13:21:27 +0530 | [diff] [blame] | 3534 | @unittest.skipUnless(hasattr(logging.handlers, 'QueueListener'), |
| 3535 | 'logging.handlers.QueueListener required for this test') |
| 3536 | def test_queue_listener_with_multiple_handlers(self): |
| 3537 | # Test that queue handler format doesn't affect other handler formats (bpo-35726). |
| 3538 | self.que_hdlr.setFormatter(self.root_formatter) |
| 3539 | self.que_logger.addHandler(self.root_hdlr) |
| 3540 | |
| 3541 | listener = logging.handlers.QueueListener(self.queue, self.que_hdlr) |
| 3542 | listener.start() |
| 3543 | self.que_logger.error("error") |
| 3544 | listener.stop() |
| 3545 | self.assertEqual(self.stream.getvalue().strip(), "que -> ERROR: error") |
| 3546 | |
Vinay Sajip | d61910c | 2016-09-08 01:13:39 +0100 | [diff] [blame] | 3547 | if hasattr(logging.handlers, 'QueueListener'): |
| 3548 | import multiprocessing |
| 3549 | from unittest.mock import patch |
| 3550 | |
| 3551 | class QueueListenerTest(BaseTest): |
| 3552 | """ |
| 3553 | Tests based on patch submitted for issue #27930. Ensure that |
| 3554 | QueueListener handles all log messages. |
| 3555 | """ |
| 3556 | |
| 3557 | repeat = 20 |
| 3558 | |
| 3559 | @staticmethod |
| 3560 | def setup_and_log(log_queue, ident): |
| 3561 | """ |
| 3562 | Creates a logger with a QueueHandler that logs to a queue read by a |
| 3563 | QueueListener. Starts the listener, logs five messages, and stops |
| 3564 | the listener. |
| 3565 | """ |
| 3566 | logger = logging.getLogger('test_logger_with_id_%s' % ident) |
| 3567 | logger.setLevel(logging.DEBUG) |
| 3568 | handler = logging.handlers.QueueHandler(log_queue) |
| 3569 | logger.addHandler(handler) |
| 3570 | listener = logging.handlers.QueueListener(log_queue) |
| 3571 | listener.start() |
| 3572 | |
| 3573 | logger.info('one') |
| 3574 | logger.info('two') |
| 3575 | logger.info('three') |
| 3576 | logger.info('four') |
| 3577 | logger.info('five') |
| 3578 | |
| 3579 | listener.stop() |
| 3580 | logger.removeHandler(handler) |
| 3581 | handler.close() |
| 3582 | |
| 3583 | @patch.object(logging.handlers.QueueListener, 'handle') |
| 3584 | def test_handle_called_with_queue_queue(self, mock_handle): |
| 3585 | for i in range(self.repeat): |
| 3586 | log_queue = queue.Queue() |
| 3587 | self.setup_and_log(log_queue, '%s_%s' % (self.id(), i)) |
| 3588 | self.assertEqual(mock_handle.call_count, 5 * self.repeat, |
| 3589 | 'correct number of handled log messages') |
| 3590 | |
| 3591 | @patch.object(logging.handlers.QueueListener, 'handle') |
| 3592 | def test_handle_called_with_mp_queue(self, mock_handle): |
xdegaye | bf2b65e | 2017-12-01 08:08:49 +0100 | [diff] [blame] | 3593 | # Issue 28668: The multiprocessing (mp) module is not functional |
| 3594 | # when the mp.synchronize module cannot be imported. |
| 3595 | support.import_module('multiprocessing.synchronize') |
Vinay Sajip | d61910c | 2016-09-08 01:13:39 +0100 | [diff] [blame] | 3596 | for i in range(self.repeat): |
| 3597 | log_queue = multiprocessing.Queue() |
| 3598 | self.setup_and_log(log_queue, '%s_%s' % (self.id(), i)) |
Victor Stinner | 8ca2f2f | 2017-04-26 15:56:25 +0200 | [diff] [blame] | 3599 | log_queue.close() |
| 3600 | log_queue.join_thread() |
Vinay Sajip | d61910c | 2016-09-08 01:13:39 +0100 | [diff] [blame] | 3601 | self.assertEqual(mock_handle.call_count, 5 * self.repeat, |
| 3602 | 'correct number of handled log messages') |
| 3603 | |
| 3604 | @staticmethod |
| 3605 | def get_all_from_queue(log_queue): |
| 3606 | try: |
| 3607 | while True: |
| 3608 | yield log_queue.get_nowait() |
| 3609 | except queue.Empty: |
| 3610 | return [] |
| 3611 | |
| 3612 | def test_no_messages_in_queue_after_stop(self): |
| 3613 | """ |
| 3614 | Five messages are logged then the QueueListener is stopped. This |
| 3615 | test then gets everything off the queue. Failure of this test |
| 3616 | indicates that messages were not registered on the queue until |
| 3617 | _after_ the QueueListener stopped. |
| 3618 | """ |
xdegaye | bf2b65e | 2017-12-01 08:08:49 +0100 | [diff] [blame] | 3619 | # Issue 28668: The multiprocessing (mp) module is not functional |
| 3620 | # when the mp.synchronize module cannot be imported. |
| 3621 | support.import_module('multiprocessing.synchronize') |
Vinay Sajip | d61910c | 2016-09-08 01:13:39 +0100 | [diff] [blame] | 3622 | for i in range(self.repeat): |
| 3623 | queue = multiprocessing.Queue() |
| 3624 | self.setup_and_log(queue, '%s_%s' %(self.id(), i)) |
| 3625 | # time.sleep(1) |
| 3626 | items = list(self.get_all_from_queue(queue)) |
Victor Stinner | 8ca2f2f | 2017-04-26 15:56:25 +0200 | [diff] [blame] | 3627 | queue.close() |
| 3628 | queue.join_thread() |
| 3629 | |
Vinay Sajip | d61910c | 2016-09-08 01:13:39 +0100 | [diff] [blame] | 3630 | expected = [[], [logging.handlers.QueueListener._sentinel]] |
| 3631 | self.assertIn(items, expected, |
| 3632 | 'Found unexpected messages in queue: %s' % ( |
| 3633 | [m.msg if isinstance(m, logging.LogRecord) |
| 3634 | else m for m in items])) |
| 3635 | |
Vinay Sajip | e723e96 | 2011-04-15 22:27:17 +0100 | [diff] [blame] | 3636 | |
Vinay Sajip | 37eb338 | 2011-04-26 20:26:41 +0100 | [diff] [blame] | 3637 | ZERO = datetime.timedelta(0) |
| 3638 | |
| 3639 | class UTC(datetime.tzinfo): |
| 3640 | def utcoffset(self, dt): |
| 3641 | return ZERO |
| 3642 | |
| 3643 | dst = utcoffset |
| 3644 | |
| 3645 | def tzname(self, dt): |
| 3646 | return 'UTC' |
| 3647 | |
| 3648 | utc = UTC() |
Vinay Sajip | e723e96 | 2011-04-15 22:27:17 +0100 | [diff] [blame] | 3649 | |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3650 | class FormatterTest(unittest.TestCase): |
| 3651 | def setUp(self): |
| 3652 | self.common = { |
| 3653 | 'name': 'formatter.test', |
| 3654 | 'level': logging.DEBUG, |
| 3655 | 'pathname': os.path.join('path', 'to', 'dummy.ext'), |
| 3656 | 'lineno': 42, |
| 3657 | 'exc_info': None, |
| 3658 | 'func': None, |
| 3659 | 'msg': 'Message with %d %s', |
| 3660 | 'args': (2, 'placeholders'), |
| 3661 | } |
| 3662 | self.variants = { |
| 3663 | } |
| 3664 | |
| 3665 | def get_record(self, name=None): |
| 3666 | result = dict(self.common) |
| 3667 | if name is not None: |
| 3668 | result.update(self.variants[name]) |
| 3669 | return logging.makeLogRecord(result) |
| 3670 | |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3671 | def assert_error_message(self, exception, message, *args, **kwargs): |
| 3672 | try: |
| 3673 | self.assertRaises(exception, *args, **kwargs) |
| 3674 | except exception as e: |
| 3675 | self.assertEqual(message, e.message) |
| 3676 | |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3677 | def test_percent(self): |
Vinay Sajip | 60b4df1 | 2010-12-27 11:18:52 +0000 | [diff] [blame] | 3678 | # Test %-formatting |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3679 | r = self.get_record() |
| 3680 | f = logging.Formatter('${%(message)s}') |
| 3681 | self.assertEqual(f.format(r), '${Message with 2 placeholders}') |
| 3682 | f = logging.Formatter('%(random)s') |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3683 | self.assertRaises(ValueError, f.format, r) |
Vinay Sajip | 6a65c5d | 2010-10-26 13:16:11 +0000 | [diff] [blame] | 3684 | self.assertFalse(f.usesTime()) |
| 3685 | f = logging.Formatter('%(asctime)s') |
| 3686 | self.assertTrue(f.usesTime()) |
Vinay Sajip | 89807a5 | 2011-02-26 16:06:02 +0000 | [diff] [blame] | 3687 | f = logging.Formatter('%(asctime)-15s') |
| 3688 | self.assertTrue(f.usesTime()) |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3689 | f = logging.Formatter('%(asctime)#15s') |
| 3690 | self.assertTrue(f.usesTime()) |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3691 | |
| 3692 | def test_braces(self): |
Vinay Sajip | 60b4df1 | 2010-12-27 11:18:52 +0000 | [diff] [blame] | 3693 | # Test {}-formatting |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3694 | r = self.get_record() |
| 3695 | f = logging.Formatter('$%{message}%$', style='{') |
| 3696 | self.assertEqual(f.format(r), '$%Message with 2 placeholders%$') |
| 3697 | f = logging.Formatter('{random}', style='{') |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3698 | self.assertRaises(ValueError, f.format, r) |
| 3699 | f = logging.Formatter("{message}", style='{') |
Vinay Sajip | 6a65c5d | 2010-10-26 13:16:11 +0000 | [diff] [blame] | 3700 | self.assertFalse(f.usesTime()) |
| 3701 | f = logging.Formatter('{asctime}', style='{') |
| 3702 | self.assertTrue(f.usesTime()) |
Vinay Sajip | 89807a5 | 2011-02-26 16:06:02 +0000 | [diff] [blame] | 3703 | f = logging.Formatter('{asctime!s:15}', style='{') |
| 3704 | self.assertTrue(f.usesTime()) |
| 3705 | f = logging.Formatter('{asctime:15}', style='{') |
| 3706 | self.assertTrue(f.usesTime()) |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3707 | |
| 3708 | def test_dollars(self): |
Vinay Sajip | 60b4df1 | 2010-12-27 11:18:52 +0000 | [diff] [blame] | 3709 | # Test $-formatting |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3710 | r = self.get_record() |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3711 | f = logging.Formatter('${message}', style='$') |
| 3712 | self.assertEqual(f.format(r), 'Message with 2 placeholders') |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3713 | f = logging.Formatter('$message', style='$') |
| 3714 | self.assertEqual(f.format(r), 'Message with 2 placeholders') |
| 3715 | f = logging.Formatter('$$%${message}%$$', style='$') |
| 3716 | self.assertEqual(f.format(r), '$%Message with 2 placeholders%$') |
| 3717 | f = logging.Formatter('${random}', style='$') |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3718 | self.assertRaises(ValueError, f.format, r) |
Vinay Sajip | 6a65c5d | 2010-10-26 13:16:11 +0000 | [diff] [blame] | 3719 | self.assertFalse(f.usesTime()) |
| 3720 | f = logging.Formatter('${asctime}', style='$') |
| 3721 | self.assertTrue(f.usesTime()) |
| 3722 | f = logging.Formatter('$asctime', style='$') |
| 3723 | self.assertTrue(f.usesTime()) |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3724 | f = logging.Formatter('${message}', style='$') |
Vinay Sajip | 6a65c5d | 2010-10-26 13:16:11 +0000 | [diff] [blame] | 3725 | self.assertFalse(f.usesTime()) |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 3726 | f = logging.Formatter('${asctime}--', style='$') |
| 3727 | self.assertTrue(f.usesTime()) |
| 3728 | |
| 3729 | def test_format_validate(self): |
| 3730 | # Check correct formatting |
| 3731 | # Percentage style |
| 3732 | f = logging.Formatter("%(levelname)-15s - %(message) 5s - %(process)03d - %(module) - %(asctime)*.3s") |
| 3733 | self.assertEqual(f._fmt, "%(levelname)-15s - %(message) 5s - %(process)03d - %(module) - %(asctime)*.3s") |
| 3734 | f = logging.Formatter("%(asctime)*s - %(asctime)*.3s - %(process)-34.33o") |
| 3735 | self.assertEqual(f._fmt, "%(asctime)*s - %(asctime)*.3s - %(process)-34.33o") |
| 3736 | f = logging.Formatter("%(process)#+027.23X") |
| 3737 | self.assertEqual(f._fmt, "%(process)#+027.23X") |
| 3738 | f = logging.Formatter("%(foo)#.*g") |
| 3739 | self.assertEqual(f._fmt, "%(foo)#.*g") |
| 3740 | |
| 3741 | # StrFormat Style |
| 3742 | f = logging.Formatter("$%{message}%$ - {asctime!a:15} - {customfield['key']}", style="{") |
| 3743 | self.assertEqual(f._fmt, "$%{message}%$ - {asctime!a:15} - {customfield['key']}") |
| 3744 | f = logging.Formatter("{process:.2f} - {custom.f:.4f}", style="{") |
| 3745 | self.assertEqual(f._fmt, "{process:.2f} - {custom.f:.4f}") |
| 3746 | f = logging.Formatter("{customfield!s:#<30}", style="{") |
| 3747 | self.assertEqual(f._fmt, "{customfield!s:#<30}") |
| 3748 | f = logging.Formatter("{message!r}", style="{") |
| 3749 | self.assertEqual(f._fmt, "{message!r}") |
| 3750 | f = logging.Formatter("{message!s}", style="{") |
| 3751 | self.assertEqual(f._fmt, "{message!s}") |
| 3752 | f = logging.Formatter("{message!a}", style="{") |
| 3753 | self.assertEqual(f._fmt, "{message!a}") |
| 3754 | f = logging.Formatter("{process!r:4.2}", style="{") |
| 3755 | self.assertEqual(f._fmt, "{process!r:4.2}") |
| 3756 | f = logging.Formatter("{process!s:<#30,.12f}- {custom:=+#30,.1d} - {module:^30}", style="{") |
| 3757 | self.assertEqual(f._fmt, "{process!s:<#30,.12f}- {custom:=+#30,.1d} - {module:^30}") |
| 3758 | f = logging.Formatter("{process!s:{w},.{p}}", style="{") |
| 3759 | self.assertEqual(f._fmt, "{process!s:{w},.{p}}") |
| 3760 | f = logging.Formatter("{foo:12.{p}}", style="{") |
| 3761 | self.assertEqual(f._fmt, "{foo:12.{p}}") |
| 3762 | f = logging.Formatter("{foo:{w}.6}", style="{") |
| 3763 | self.assertEqual(f._fmt, "{foo:{w}.6}") |
| 3764 | f = logging.Formatter("{foo[0].bar[1].baz}", style="{") |
| 3765 | self.assertEqual(f._fmt, "{foo[0].bar[1].baz}") |
| 3766 | f = logging.Formatter("{foo[k1].bar[k2].baz}", style="{") |
| 3767 | self.assertEqual(f._fmt, "{foo[k1].bar[k2].baz}") |
| 3768 | f = logging.Formatter("{12[k1].bar[k2].baz}", style="{") |
| 3769 | self.assertEqual(f._fmt, "{12[k1].bar[k2].baz}") |
| 3770 | |
| 3771 | # Dollar style |
| 3772 | f = logging.Formatter("${asctime} - $message", style="$") |
| 3773 | self.assertEqual(f._fmt, "${asctime} - $message") |
| 3774 | f = logging.Formatter("$bar $$", style="$") |
| 3775 | self.assertEqual(f._fmt, "$bar $$") |
| 3776 | f = logging.Formatter("$bar $$$$", style="$") |
| 3777 | self.assertEqual(f._fmt, "$bar $$$$") # this would print two $($$) |
| 3778 | |
| 3779 | # Testing when ValueError being raised from incorrect format |
| 3780 | # Percentage Style |
| 3781 | self.assertRaises(ValueError, logging.Formatter, "%(asctime)Z") |
| 3782 | self.assertRaises(ValueError, logging.Formatter, "%(asctime)b") |
| 3783 | self.assertRaises(ValueError, logging.Formatter, "%(asctime)*") |
| 3784 | self.assertRaises(ValueError, logging.Formatter, "%(asctime)*3s") |
| 3785 | self.assertRaises(ValueError, logging.Formatter, "%(asctime)_") |
| 3786 | self.assertRaises(ValueError, logging.Formatter, '{asctime}') |
| 3787 | self.assertRaises(ValueError, logging.Formatter, '${message}') |
| 3788 | self.assertRaises(ValueError, logging.Formatter, '%(foo)#12.3*f') # with both * and decimal number as precision |
| 3789 | self.assertRaises(ValueError, logging.Formatter, '%(foo)0*.8*f') |
| 3790 | |
| 3791 | # StrFormat Style |
| 3792 | # Testing failure for '-' in field name |
| 3793 | self.assert_error_message( |
| 3794 | ValueError, |
| 3795 | "invalid field name/expression: 'name-thing'", |
| 3796 | logging.Formatter, "{name-thing}", style="{" |
| 3797 | ) |
| 3798 | # Testing failure for style mismatch |
| 3799 | self.assert_error_message( |
| 3800 | ValueError, |
| 3801 | "invalid format: no fields", |
| 3802 | logging.Formatter, '%(asctime)s', style='{' |
| 3803 | ) |
| 3804 | # Testing failure for invalid conversion |
| 3805 | self.assert_error_message( |
| 3806 | ValueError, |
| 3807 | "invalid conversion: 'Z'" |
| 3808 | ) |
| 3809 | self.assertRaises(ValueError, logging.Formatter, '{asctime!s:#30,15f}', style='{') |
| 3810 | self.assert_error_message( |
| 3811 | ValueError, |
| 3812 | "invalid format: expected ':' after conversion specifier", |
| 3813 | logging.Formatter, '{asctime!aa:15}', style='{' |
| 3814 | ) |
| 3815 | # Testing failure for invalid spec |
| 3816 | self.assert_error_message( |
| 3817 | ValueError, |
| 3818 | "bad specifier: '.2ff'", |
| 3819 | logging.Formatter, '{process:.2ff}', style='{' |
| 3820 | ) |
| 3821 | self.assertRaises(ValueError, logging.Formatter, '{process:.2Z}', style='{') |
| 3822 | self.assertRaises(ValueError, logging.Formatter, '{process!s:<##30,12g}', style='{') |
| 3823 | self.assertRaises(ValueError, logging.Formatter, '{process!s:<#30#,12g}', style='{') |
| 3824 | self.assertRaises(ValueError, logging.Formatter, '{process!s:{{w}},{{p}}}', style='{') |
| 3825 | # Testing failure for mismatch braces |
| 3826 | self.assert_error_message( |
| 3827 | ValueError, |
| 3828 | "invalid format: unmatched '{' in format spec", |
| 3829 | logging.Formatter, '{process', style='{' |
| 3830 | ) |
| 3831 | self.assert_error_message( |
| 3832 | ValueError, |
| 3833 | "invalid format: unmatched '{' in format spec", |
| 3834 | logging.Formatter, 'process}', style='{' |
| 3835 | ) |
| 3836 | self.assertRaises(ValueError, logging.Formatter, '{{foo!r:4.2}', style='{') |
| 3837 | self.assertRaises(ValueError, logging.Formatter, '{{foo!r:4.2}}', style='{') |
| 3838 | self.assertRaises(ValueError, logging.Formatter, '{foo/bar}', style='{') |
| 3839 | self.assertRaises(ValueError, logging.Formatter, '{foo:{{w}}.{{p}}}}', style='{') |
| 3840 | self.assertRaises(ValueError, logging.Formatter, '{foo!X:{{w}}.{{p}}}', style='{') |
| 3841 | self.assertRaises(ValueError, logging.Formatter, '{foo!a:random}', style='{') |
| 3842 | self.assertRaises(ValueError, logging.Formatter, '{foo!a:ran{dom}', style='{') |
| 3843 | self.assertRaises(ValueError, logging.Formatter, '{foo!a:ran{d}om}', style='{') |
| 3844 | self.assertRaises(ValueError, logging.Formatter, '{foo.!a:d}', style='{') |
| 3845 | |
| 3846 | # Dollar style |
| 3847 | # Testing failure for mismatch bare $ |
| 3848 | self.assert_error_message( |
| 3849 | ValueError, |
| 3850 | "invalid format: bare \'$\' not allowed", |
| 3851 | logging.Formatter, '$bar $$$', style='$' |
| 3852 | ) |
| 3853 | self.assert_error_message( |
| 3854 | ValueError, |
| 3855 | "invalid format: bare \'$\' not allowed", |
| 3856 | logging.Formatter, 'bar $', style='$' |
| 3857 | ) |
| 3858 | self.assert_error_message( |
| 3859 | ValueError, |
| 3860 | "invalid format: bare \'$\' not allowed", |
| 3861 | logging.Formatter, 'foo $.', style='$' |
| 3862 | ) |
| 3863 | # Testing failure for mismatch style |
| 3864 | self.assert_error_message( |
| 3865 | ValueError, |
| 3866 | "invalid format: no fields", |
| 3867 | logging.Formatter, '{asctime}', style='$' |
| 3868 | ) |
| 3869 | self.assertRaises(ValueError, logging.Formatter, '%(asctime)s', style='$') |
| 3870 | |
| 3871 | # Testing failure for incorrect fields |
| 3872 | self.assert_error_message( |
| 3873 | ValueError, |
| 3874 | "invalid format: no fields", |
| 3875 | logging.Formatter, 'foo', style='$' |
| 3876 | ) |
| 3877 | self.assertRaises(ValueError, logging.Formatter, '${asctime', style='$') |
Vinay Sajip | a39c571 | 2010-10-25 13:57:39 +0000 | [diff] [blame] | 3878 | |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 3879 | def test_invalid_style(self): |
| 3880 | self.assertRaises(ValueError, logging.Formatter, None, None, 'x') |
| 3881 | |
Vinay Sajip | 86a96ce | 2011-04-27 08:30:30 +0100 | [diff] [blame] | 3882 | def test_time(self): |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 3883 | r = self.get_record() |
Vinay Sajip | ed1f7c8 | 2012-07-03 21:36:36 +0100 | [diff] [blame] | 3884 | dt = datetime.datetime(1993, 4, 21, 8, 3, 0, 0, utc) |
| 3885 | # We use None to indicate we want the local timezone |
| 3886 | # We're essentially converting a UTC time to local time |
| 3887 | r.created = time.mktime(dt.astimezone(None).timetuple()) |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 3888 | r.msecs = 123 |
| 3889 | f = logging.Formatter('%(asctime)s %(message)s') |
Vinay Sajip | 37eb338 | 2011-04-26 20:26:41 +0100 | [diff] [blame] | 3890 | f.converter = time.gmtime |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 3891 | self.assertEqual(f.formatTime(r), '1993-04-21 08:03:00,123') |
| 3892 | self.assertEqual(f.formatTime(r, '%Y:%d'), '1993:21') |
Vinay Sajip | 985ef87 | 2011-04-26 19:34:04 +0100 | [diff] [blame] | 3893 | f.format(r) |
| 3894 | self.assertEqual(r.asctime, '1993-04-21 08:03:00,123') |
| 3895 | |
| 3896 | class TestBufferingFormatter(logging.BufferingFormatter): |
| 3897 | def formatHeader(self, records): |
| 3898 | return '[(%d)' % len(records) |
| 3899 | |
| 3900 | def formatFooter(self, records): |
| 3901 | return '(%d)]' % len(records) |
| 3902 | |
| 3903 | class BufferingFormatterTest(unittest.TestCase): |
| 3904 | def setUp(self): |
| 3905 | self.records = [ |
| 3906 | logging.makeLogRecord({'msg': 'one'}), |
| 3907 | logging.makeLogRecord({'msg': 'two'}), |
| 3908 | ] |
| 3909 | |
| 3910 | def test_default(self): |
| 3911 | f = logging.BufferingFormatter() |
| 3912 | self.assertEqual('', f.format([])) |
| 3913 | self.assertEqual('onetwo', f.format(self.records)) |
| 3914 | |
| 3915 | def test_custom(self): |
| 3916 | f = TestBufferingFormatter() |
| 3917 | self.assertEqual('[(2)onetwo(2)]', f.format(self.records)) |
| 3918 | lf = logging.Formatter('<%(message)s>') |
| 3919 | f = TestBufferingFormatter(lf) |
| 3920 | self.assertEqual('[(2)<one><two>(2)]', f.format(self.records)) |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 3921 | |
| 3922 | class ExceptionTest(BaseTest): |
| 3923 | def test_formatting(self): |
| 3924 | r = self.root_logger |
| 3925 | h = RecordingHandler() |
| 3926 | r.addHandler(h) |
| 3927 | try: |
| 3928 | raise RuntimeError('deliberate mistake') |
| 3929 | except: |
| 3930 | logging.exception('failed', stack_info=True) |
| 3931 | r.removeHandler(h) |
| 3932 | h.close() |
| 3933 | r = h.records[0] |
| 3934 | self.assertTrue(r.exc_text.startswith('Traceback (most recent ' |
| 3935 | 'call last):\n')) |
| 3936 | self.assertTrue(r.exc_text.endswith('\nRuntimeError: ' |
| 3937 | 'deliberate mistake')) |
| 3938 | self.assertTrue(r.stack_info.startswith('Stack (most recent ' |
| 3939 | 'call last):\n')) |
| 3940 | self.assertTrue(r.stack_info.endswith('logging.exception(\'failed\', ' |
| 3941 | 'stack_info=True)')) |
| 3942 | |
| 3943 | |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3944 | class LastResortTest(BaseTest): |
| 3945 | def test_last_resort(self): |
Vinay Sajip | 60b4df1 | 2010-12-27 11:18:52 +0000 | [diff] [blame] | 3946 | # Test the last resort handler |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3947 | root = self.root_logger |
| 3948 | root.removeHandler(self.root_hdlr) |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3949 | old_lastresort = logging.lastResort |
| 3950 | old_raise_exceptions = logging.raiseExceptions |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3951 | |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3952 | try: |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3953 | with support.captured_stderr() as stderr: |
| 3954 | root.debug('This should not appear') |
| 3955 | self.assertEqual(stderr.getvalue(), '') |
| 3956 | root.warning('Final chance!') |
| 3957 | self.assertEqual(stderr.getvalue(), 'Final chance!\n') |
| 3958 | |
| 3959 | # No handlers and no last resort, so 'No handlers' message |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3960 | logging.lastResort = None |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3961 | with support.captured_stderr() as stderr: |
| 3962 | root.warning('Final chance!') |
| 3963 | msg = 'No handlers could be found for logger "root"\n' |
| 3964 | self.assertEqual(stderr.getvalue(), msg) |
| 3965 | |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3966 | # 'No handlers' message only printed once |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3967 | with support.captured_stderr() as stderr: |
| 3968 | root.warning('Final chance!') |
| 3969 | self.assertEqual(stderr.getvalue(), '') |
| 3970 | |
| 3971 | # If raiseExceptions is False, no message is printed |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3972 | root.manager.emittedNoHandlerWarning = False |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3973 | logging.raiseExceptions = False |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 3974 | with support.captured_stderr() as stderr: |
| 3975 | root.warning('Final chance!') |
| 3976 | self.assertEqual(stderr.getvalue(), '') |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3977 | finally: |
Vinay Sajip | 5a27d40 | 2010-12-10 11:42:57 +0000 | [diff] [blame] | 3978 | root.addHandler(self.root_hdlr) |
| 3979 | logging.lastResort = old_lastresort |
| 3980 | logging.raiseExceptions = old_raise_exceptions |
| 3981 | |
| 3982 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 3983 | class FakeHandler: |
| 3984 | |
| 3985 | def __init__(self, identifier, called): |
| 3986 | for method in ('acquire', 'flush', 'close', 'release'): |
| 3987 | setattr(self, method, self.record_call(identifier, method, called)) |
| 3988 | |
| 3989 | def record_call(self, identifier, method_name, called): |
| 3990 | def inner(): |
| 3991 | called.append('{} - {}'.format(identifier, method_name)) |
| 3992 | return inner |
| 3993 | |
| 3994 | |
| 3995 | class RecordingHandler(logging.NullHandler): |
| 3996 | |
| 3997 | def __init__(self, *args, **kwargs): |
| 3998 | super(RecordingHandler, self).__init__(*args, **kwargs) |
| 3999 | self.records = [] |
| 4000 | |
| 4001 | def handle(self, record): |
| 4002 | """Keep track of all the emitted records.""" |
| 4003 | self.records.append(record) |
| 4004 | |
| 4005 | |
| 4006 | class ShutdownTest(BaseTest): |
| 4007 | |
Vinay Sajip | 5e66b16 | 2011-04-20 15:41:14 +0100 | [diff] [blame] | 4008 | """Test suite for the shutdown method.""" |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4009 | |
| 4010 | def setUp(self): |
| 4011 | super(ShutdownTest, self).setUp() |
| 4012 | self.called = [] |
| 4013 | |
| 4014 | raise_exceptions = logging.raiseExceptions |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4015 | self.addCleanup(setattr, logging, 'raiseExceptions', raise_exceptions) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4016 | |
| 4017 | def raise_error(self, error): |
| 4018 | def inner(): |
| 4019 | raise error() |
| 4020 | return inner |
| 4021 | |
| 4022 | def test_no_failure(self): |
| 4023 | # create some fake handlers |
| 4024 | handler0 = FakeHandler(0, self.called) |
| 4025 | handler1 = FakeHandler(1, self.called) |
| 4026 | handler2 = FakeHandler(2, self.called) |
| 4027 | |
| 4028 | # create live weakref to those handlers |
| 4029 | handlers = map(logging.weakref.ref, [handler0, handler1, handler2]) |
| 4030 | |
| 4031 | logging.shutdown(handlerList=list(handlers)) |
| 4032 | |
| 4033 | expected = ['2 - acquire', '2 - flush', '2 - close', '2 - release', |
| 4034 | '1 - acquire', '1 - flush', '1 - close', '1 - release', |
| 4035 | '0 - acquire', '0 - flush', '0 - close', '0 - release'] |
| 4036 | self.assertEqual(expected, self.called) |
| 4037 | |
| 4038 | def _test_with_failure_in_method(self, method, error): |
| 4039 | handler = FakeHandler(0, self.called) |
| 4040 | setattr(handler, method, self.raise_error(error)) |
| 4041 | handlers = [logging.weakref.ref(handler)] |
| 4042 | |
| 4043 | logging.shutdown(handlerList=list(handlers)) |
| 4044 | |
| 4045 | self.assertEqual('0 - release', self.called[-1]) |
| 4046 | |
| 4047 | def test_with_ioerror_in_acquire(self): |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 4048 | self._test_with_failure_in_method('acquire', OSError) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4049 | |
| 4050 | def test_with_ioerror_in_flush(self): |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 4051 | self._test_with_failure_in_method('flush', OSError) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4052 | |
| 4053 | def test_with_ioerror_in_close(self): |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 4054 | self._test_with_failure_in_method('close', OSError) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4055 | |
| 4056 | def test_with_valueerror_in_acquire(self): |
| 4057 | self._test_with_failure_in_method('acquire', ValueError) |
| 4058 | |
| 4059 | def test_with_valueerror_in_flush(self): |
| 4060 | self._test_with_failure_in_method('flush', ValueError) |
| 4061 | |
| 4062 | def test_with_valueerror_in_close(self): |
| 4063 | self._test_with_failure_in_method('close', ValueError) |
| 4064 | |
| 4065 | def test_with_other_error_in_acquire_without_raise(self): |
| 4066 | logging.raiseExceptions = False |
| 4067 | self._test_with_failure_in_method('acquire', IndexError) |
| 4068 | |
| 4069 | def test_with_other_error_in_flush_without_raise(self): |
| 4070 | logging.raiseExceptions = False |
| 4071 | self._test_with_failure_in_method('flush', IndexError) |
| 4072 | |
| 4073 | def test_with_other_error_in_close_without_raise(self): |
| 4074 | logging.raiseExceptions = False |
| 4075 | self._test_with_failure_in_method('close', IndexError) |
| 4076 | |
| 4077 | def test_with_other_error_in_acquire_with_raise(self): |
| 4078 | logging.raiseExceptions = True |
| 4079 | self.assertRaises(IndexError, self._test_with_failure_in_method, |
| 4080 | 'acquire', IndexError) |
| 4081 | |
| 4082 | def test_with_other_error_in_flush_with_raise(self): |
| 4083 | logging.raiseExceptions = True |
| 4084 | self.assertRaises(IndexError, self._test_with_failure_in_method, |
| 4085 | 'flush', IndexError) |
| 4086 | |
| 4087 | def test_with_other_error_in_close_with_raise(self): |
| 4088 | logging.raiseExceptions = True |
| 4089 | self.assertRaises(IndexError, self._test_with_failure_in_method, |
| 4090 | 'close', IndexError) |
| 4091 | |
| 4092 | |
| 4093 | class ModuleLevelMiscTest(BaseTest): |
| 4094 | |
Vinay Sajip | 5e66b16 | 2011-04-20 15:41:14 +0100 | [diff] [blame] | 4095 | """Test suite for some module level methods.""" |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4096 | |
| 4097 | def test_disable(self): |
| 4098 | old_disable = logging.root.manager.disable |
| 4099 | # confirm our assumptions are correct |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4100 | self.assertEqual(old_disable, 0) |
| 4101 | self.addCleanup(logging.disable, old_disable) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4102 | |
| 4103 | logging.disable(83) |
| 4104 | self.assertEqual(logging.root.manager.disable, 83) |
| 4105 | |
Vinay Sajip | d489ac9 | 2016-12-31 11:40:11 +0000 | [diff] [blame] | 4106 | # test the default value introduced in 3.7 |
| 4107 | # (Issue #28524) |
| 4108 | logging.disable() |
| 4109 | self.assertEqual(logging.root.manager.disable, logging.CRITICAL) |
| 4110 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4111 | def _test_log(self, method, level=None): |
| 4112 | called = [] |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 4113 | support.patch(self, logging, 'basicConfig', |
| 4114 | lambda *a, **kw: called.append((a, kw))) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4115 | |
| 4116 | recording = RecordingHandler() |
| 4117 | logging.root.addHandler(recording) |
| 4118 | |
| 4119 | log_method = getattr(logging, method) |
| 4120 | if level is not None: |
| 4121 | log_method(level, "test me: %r", recording) |
| 4122 | else: |
| 4123 | log_method("test me: %r", recording) |
| 4124 | |
| 4125 | self.assertEqual(len(recording.records), 1) |
| 4126 | record = recording.records[0] |
| 4127 | self.assertEqual(record.getMessage(), "test me: %r" % recording) |
| 4128 | |
| 4129 | expected_level = level if level is not None else getattr(logging, method.upper()) |
| 4130 | self.assertEqual(record.levelno, expected_level) |
| 4131 | |
| 4132 | # basicConfig was not called! |
| 4133 | self.assertEqual(called, []) |
| 4134 | |
| 4135 | def test_log(self): |
| 4136 | self._test_log('log', logging.ERROR) |
| 4137 | |
| 4138 | def test_debug(self): |
| 4139 | self._test_log('debug') |
| 4140 | |
| 4141 | def test_info(self): |
| 4142 | self._test_log('info') |
| 4143 | |
| 4144 | def test_warning(self): |
| 4145 | self._test_log('warning') |
| 4146 | |
| 4147 | def test_error(self): |
| 4148 | self._test_log('error') |
| 4149 | |
| 4150 | def test_critical(self): |
| 4151 | self._test_log('critical') |
| 4152 | |
| 4153 | def test_set_logger_class(self): |
| 4154 | self.assertRaises(TypeError, logging.setLoggerClass, object) |
| 4155 | |
| 4156 | class MyLogger(logging.Logger): |
| 4157 | pass |
| 4158 | |
| 4159 | logging.setLoggerClass(MyLogger) |
| 4160 | self.assertEqual(logging.getLoggerClass(), MyLogger) |
| 4161 | |
| 4162 | logging.setLoggerClass(logging.Logger) |
| 4163 | self.assertEqual(logging.getLoggerClass(), logging.Logger) |
| 4164 | |
Serhiy Storchaka | a793037 | 2016-07-03 22:27:26 +0300 | [diff] [blame] | 4165 | @support.requires_type_collecting |
Antoine Pitrou | 712cb73 | 2013-12-21 15:51:54 +0100 | [diff] [blame] | 4166 | def test_logging_at_shutdown(self): |
| 4167 | # Issue #20037 |
| 4168 | code = """if 1: |
| 4169 | import logging |
| 4170 | |
| 4171 | class A: |
| 4172 | def __del__(self): |
| 4173 | try: |
| 4174 | raise ValueError("some error") |
| 4175 | except Exception: |
| 4176 | logging.exception("exception in __del__") |
| 4177 | |
| 4178 | a = A()""" |
| 4179 | rc, out, err = assert_python_ok("-c", code) |
| 4180 | err = err.decode() |
| 4181 | self.assertIn("exception in __del__", err) |
| 4182 | self.assertIn("ValueError: some error", err) |
| 4183 | |
Rémi Lapeyre | 65f64b1 | 2019-03-15 07:53:34 +0100 | [diff] [blame] | 4184 | def test_recursion_error(self): |
| 4185 | # Issue 36272 |
| 4186 | code = """if 1: |
| 4187 | import logging |
| 4188 | |
| 4189 | def rec(): |
| 4190 | logging.error("foo") |
| 4191 | rec() |
| 4192 | |
| 4193 | rec()""" |
| 4194 | rc, out, err = assert_python_failure("-c", code) |
| 4195 | err = err.decode() |
| 4196 | self.assertNotIn("Cannot recover from stack overflow.", err) |
| 4197 | self.assertEqual(rc, 1) |
| 4198 | |
Antoine Pitrou | 712cb73 | 2013-12-21 15:51:54 +0100 | [diff] [blame] | 4199 | |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 4200 | class LogRecordTest(BaseTest): |
| 4201 | def test_str_rep(self): |
| 4202 | r = logging.makeLogRecord({}) |
| 4203 | s = str(r) |
| 4204 | self.assertTrue(s.startswith('<LogRecord: ')) |
| 4205 | self.assertTrue(s.endswith('>')) |
| 4206 | |
| 4207 | def test_dict_arg(self): |
| 4208 | h = RecordingHandler() |
| 4209 | r = logging.getLogger() |
| 4210 | r.addHandler(h) |
| 4211 | d = {'less' : 'more' } |
| 4212 | logging.warning('less is %(less)s', d) |
| 4213 | self.assertIs(h.records[0].args, d) |
| 4214 | self.assertEqual(h.records[0].message, 'less is more') |
| 4215 | r.removeHandler(h) |
| 4216 | h.close() |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4217 | |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 4218 | def test_multiprocessing(self): |
| 4219 | r = logging.makeLogRecord({}) |
| 4220 | self.assertEqual(r.processName, 'MainProcess') |
Vinay Sajip | bd3d5cf | 2011-05-17 07:41:18 +0100 | [diff] [blame] | 4221 | try: |
| 4222 | import multiprocessing as mp |
| 4223 | r = logging.makeLogRecord({}) |
| 4224 | self.assertEqual(r.processName, mp.current_process().name) |
| 4225 | except ImportError: |
| 4226 | pass |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 4227 | |
| 4228 | def test_optional(self): |
| 4229 | r = logging.makeLogRecord({}) |
| 4230 | NOT_NONE = self.assertIsNotNone |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 4231 | NOT_NONE(r.thread) |
| 4232 | NOT_NONE(r.threadName) |
Vinay Sajip | 7fe1d51 | 2011-04-28 12:04:58 +0100 | [diff] [blame] | 4233 | NOT_NONE(r.process) |
| 4234 | NOT_NONE(r.processName) |
| 4235 | log_threads = logging.logThreads |
| 4236 | log_processes = logging.logProcesses |
| 4237 | log_multiprocessing = logging.logMultiprocessing |
| 4238 | try: |
| 4239 | logging.logThreads = False |
| 4240 | logging.logProcesses = False |
| 4241 | logging.logMultiprocessing = False |
| 4242 | r = logging.makeLogRecord({}) |
| 4243 | NONE = self.assertIsNone |
| 4244 | NONE(r.thread) |
| 4245 | NONE(r.threadName) |
| 4246 | NONE(r.process) |
| 4247 | NONE(r.processName) |
| 4248 | finally: |
| 4249 | logging.logThreads = log_threads |
| 4250 | logging.logProcesses = log_processes |
| 4251 | logging.logMultiprocessing = log_multiprocessing |
| 4252 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4253 | class BasicConfigTest(unittest.TestCase): |
| 4254 | |
Vinay Sajip | 95bf504 | 2011-04-20 11:50:56 +0100 | [diff] [blame] | 4255 | """Test suite for logging.basicConfig.""" |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4256 | |
| 4257 | def setUp(self): |
| 4258 | super(BasicConfigTest, self).setUp() |
Vinay Sajip | 3def7e0 | 2011-04-20 10:58:06 +0100 | [diff] [blame] | 4259 | self.handlers = logging.root.handlers |
Vinay Sajip | 95bf504 | 2011-04-20 11:50:56 +0100 | [diff] [blame] | 4260 | self.saved_handlers = logging._handlers.copy() |
| 4261 | self.saved_handler_list = logging._handlerList[:] |
Vinay Sajip | 1e42f9e | 2011-04-20 12:20:44 +0100 | [diff] [blame] | 4262 | self.original_logging_level = logging.root.level |
Vinay Sajip | 3def7e0 | 2011-04-20 10:58:06 +0100 | [diff] [blame] | 4263 | self.addCleanup(self.cleanup) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4264 | logging.root.handlers = [] |
| 4265 | |
| 4266 | def tearDown(self): |
Vinay Sajip | 3def7e0 | 2011-04-20 10:58:06 +0100 | [diff] [blame] | 4267 | for h in logging.root.handlers[:]: |
| 4268 | logging.root.removeHandler(h) |
| 4269 | h.close() |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4270 | super(BasicConfigTest, self).tearDown() |
| 4271 | |
Vinay Sajip | 3def7e0 | 2011-04-20 10:58:06 +0100 | [diff] [blame] | 4272 | def cleanup(self): |
| 4273 | setattr(logging.root, 'handlers', self.handlers) |
Vinay Sajip | 95bf504 | 2011-04-20 11:50:56 +0100 | [diff] [blame] | 4274 | logging._handlers.clear() |
| 4275 | logging._handlers.update(self.saved_handlers) |
| 4276 | logging._handlerList[:] = self.saved_handler_list |
Vinay Sajip | 1e42f9e | 2011-04-20 12:20:44 +0100 | [diff] [blame] | 4277 | logging.root.level = self.original_logging_level |
Vinay Sajip | 3def7e0 | 2011-04-20 10:58:06 +0100 | [diff] [blame] | 4278 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4279 | def test_no_kwargs(self): |
| 4280 | logging.basicConfig() |
| 4281 | |
| 4282 | # handler defaults to a StreamHandler to sys.stderr |
| 4283 | self.assertEqual(len(logging.root.handlers), 1) |
| 4284 | handler = logging.root.handlers[0] |
| 4285 | self.assertIsInstance(handler, logging.StreamHandler) |
| 4286 | self.assertEqual(handler.stream, sys.stderr) |
| 4287 | |
| 4288 | formatter = handler.formatter |
| 4289 | # format defaults to logging.BASIC_FORMAT |
| 4290 | self.assertEqual(formatter._style._fmt, logging.BASIC_FORMAT) |
| 4291 | # datefmt defaults to None |
| 4292 | self.assertIsNone(formatter.datefmt) |
| 4293 | # style defaults to % |
| 4294 | self.assertIsInstance(formatter._style, logging.PercentStyle) |
| 4295 | |
Florent Xicluna | e41f0de | 2011-11-11 19:39:25 +0100 | [diff] [blame] | 4296 | # level is not explicitly set |
Vinay Sajip | 5b9eecf | 2011-04-20 12:50:42 +0100 | [diff] [blame] | 4297 | self.assertEqual(logging.root.level, self.original_logging_level) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4298 | |
Vinay Sajip | 1fd1202 | 2014-01-13 21:59:56 +0000 | [diff] [blame] | 4299 | def test_strformatstyle(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 4300 | with support.captured_stdout() as output: |
Vinay Sajip | 1fd1202 | 2014-01-13 21:59:56 +0000 | [diff] [blame] | 4301 | logging.basicConfig(stream=sys.stdout, style="{") |
| 4302 | logging.error("Log an error") |
| 4303 | sys.stdout.seek(0) |
| 4304 | self.assertEqual(output.getvalue().strip(), |
| 4305 | "ERROR:root:Log an error") |
| 4306 | |
| 4307 | def test_stringtemplatestyle(self): |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 4308 | with support.captured_stdout() as output: |
Vinay Sajip | 1fd1202 | 2014-01-13 21:59:56 +0000 | [diff] [blame] | 4309 | logging.basicConfig(stream=sys.stdout, style="$") |
| 4310 | logging.error("Log an error") |
| 4311 | sys.stdout.seek(0) |
| 4312 | self.assertEqual(output.getvalue().strip(), |
| 4313 | "ERROR:root:Log an error") |
| 4314 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4315 | def test_filename(self): |
Vinay Sajip | becf5c6 | 2013-03-08 09:50:57 +0000 | [diff] [blame] | 4316 | |
| 4317 | def cleanup(h1, h2, fn): |
| 4318 | h1.close() |
| 4319 | h2.close() |
| 4320 | os.remove(fn) |
| 4321 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4322 | logging.basicConfig(filename='test.log') |
| 4323 | |
| 4324 | self.assertEqual(len(logging.root.handlers), 1) |
| 4325 | handler = logging.root.handlers[0] |
| 4326 | self.assertIsInstance(handler, logging.FileHandler) |
| 4327 | |
| 4328 | expected = logging.FileHandler('test.log', 'a') |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4329 | self.assertEqual(handler.stream.mode, expected.stream.mode) |
| 4330 | self.assertEqual(handler.stream.name, expected.stream.name) |
Vinay Sajip | becf5c6 | 2013-03-08 09:50:57 +0000 | [diff] [blame] | 4331 | self.addCleanup(cleanup, handler, expected, 'test.log') |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4332 | |
| 4333 | def test_filemode(self): |
Vinay Sajip | becf5c6 | 2013-03-08 09:50:57 +0000 | [diff] [blame] | 4334 | |
| 4335 | def cleanup(h1, h2, fn): |
| 4336 | h1.close() |
| 4337 | h2.close() |
| 4338 | os.remove(fn) |
| 4339 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4340 | logging.basicConfig(filename='test.log', filemode='wb') |
| 4341 | |
| 4342 | handler = logging.root.handlers[0] |
| 4343 | expected = logging.FileHandler('test.log', 'wb') |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4344 | self.assertEqual(handler.stream.mode, expected.stream.mode) |
Vinay Sajip | becf5c6 | 2013-03-08 09:50:57 +0000 | [diff] [blame] | 4345 | self.addCleanup(cleanup, handler, expected, 'test.log') |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4346 | |
| 4347 | def test_stream(self): |
| 4348 | stream = io.StringIO() |
| 4349 | self.addCleanup(stream.close) |
| 4350 | logging.basicConfig(stream=stream) |
| 4351 | |
| 4352 | self.assertEqual(len(logging.root.handlers), 1) |
| 4353 | handler = logging.root.handlers[0] |
| 4354 | self.assertIsInstance(handler, logging.StreamHandler) |
| 4355 | self.assertEqual(handler.stream, stream) |
| 4356 | |
| 4357 | def test_format(self): |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 4358 | logging.basicConfig(format='%(asctime)s - %(message)s') |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4359 | |
| 4360 | formatter = logging.root.handlers[0].formatter |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 4361 | self.assertEqual(formatter._style._fmt, '%(asctime)s - %(message)s') |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4362 | |
| 4363 | def test_datefmt(self): |
| 4364 | logging.basicConfig(datefmt='bar') |
| 4365 | |
| 4366 | formatter = logging.root.handlers[0].formatter |
| 4367 | self.assertEqual(formatter.datefmt, 'bar') |
| 4368 | |
| 4369 | def test_style(self): |
| 4370 | logging.basicConfig(style='$') |
| 4371 | |
| 4372 | formatter = logging.root.handlers[0].formatter |
| 4373 | self.assertIsInstance(formatter._style, logging.StringTemplateStyle) |
| 4374 | |
| 4375 | def test_level(self): |
| 4376 | old_level = logging.root.level |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4377 | self.addCleanup(logging.root.setLevel, old_level) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4378 | |
| 4379 | logging.basicConfig(level=57) |
| 4380 | self.assertEqual(logging.root.level, 57) |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 4381 | # Test that second call has no effect |
| 4382 | logging.basicConfig(level=58) |
| 4383 | self.assertEqual(logging.root.level, 57) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4384 | |
Vinay Sajip | 4a0a31d | 2011-04-11 08:42:07 +0100 | [diff] [blame] | 4385 | def test_incompatible(self): |
| 4386 | assertRaises = self.assertRaises |
| 4387 | handlers = [logging.StreamHandler()] |
| 4388 | stream = sys.stderr |
| 4389 | assertRaises(ValueError, logging.basicConfig, filename='test.log', |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 4390 | stream=stream) |
Vinay Sajip | 4a0a31d | 2011-04-11 08:42:07 +0100 | [diff] [blame] | 4391 | assertRaises(ValueError, logging.basicConfig, filename='test.log', |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 4392 | handlers=handlers) |
Vinay Sajip | 4a0a31d | 2011-04-11 08:42:07 +0100 | [diff] [blame] | 4393 | assertRaises(ValueError, logging.basicConfig, stream=stream, |
BNMetrics | 18fb1fb | 2018-10-15 19:41:36 +0100 | [diff] [blame] | 4394 | handlers=handlers) |
Vinay Sajip | d55436a | 2015-03-18 08:47:58 +0000 | [diff] [blame] | 4395 | # Issue 23207: test for invalid kwargs |
| 4396 | assertRaises(ValueError, logging.basicConfig, loglevel=logging.INFO) |
| 4397 | # Should pop both filename and filemode even if filename is None |
| 4398 | logging.basicConfig(filename=None, filemode='a') |
Vinay Sajip | 4a0a31d | 2011-04-11 08:42:07 +0100 | [diff] [blame] | 4399 | |
| 4400 | def test_handlers(self): |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 4401 | handlers = [ |
| 4402 | logging.StreamHandler(), |
| 4403 | logging.StreamHandler(sys.stdout), |
| 4404 | logging.StreamHandler(), |
| 4405 | ] |
| 4406 | f = logging.Formatter() |
| 4407 | handlers[2].setFormatter(f) |
Vinay Sajip | 4a0a31d | 2011-04-11 08:42:07 +0100 | [diff] [blame] | 4408 | logging.basicConfig(handlers=handlers) |
| 4409 | self.assertIs(handlers[0], logging.root.handlers[0]) |
| 4410 | self.assertIs(handlers[1], logging.root.handlers[1]) |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 4411 | self.assertIs(handlers[2], logging.root.handlers[2]) |
Vinay Sajip | 4a0a31d | 2011-04-11 08:42:07 +0100 | [diff] [blame] | 4412 | self.assertIsNotNone(handlers[0].formatter) |
| 4413 | self.assertIsNotNone(handlers[1].formatter) |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 4414 | self.assertIs(handlers[2].formatter, f) |
Vinay Sajip | 4a0a31d | 2011-04-11 08:42:07 +0100 | [diff] [blame] | 4415 | self.assertIs(handlers[0].formatter, handlers[1].formatter) |
| 4416 | |
Dong-hee Na | cf67d6a | 2018-06-25 13:11:09 +0900 | [diff] [blame] | 4417 | def test_force(self): |
| 4418 | old_string_io = io.StringIO() |
| 4419 | new_string_io = io.StringIO() |
| 4420 | old_handlers = [logging.StreamHandler(old_string_io)] |
| 4421 | new_handlers = [logging.StreamHandler(new_string_io)] |
| 4422 | logging.basicConfig(level=logging.WARNING, handlers=old_handlers) |
| 4423 | logging.warning('warn') |
| 4424 | logging.info('info') |
| 4425 | logging.debug('debug') |
| 4426 | self.assertEqual(len(logging.root.handlers), 1) |
| 4427 | logging.basicConfig(level=logging.INFO, handlers=new_handlers, |
| 4428 | force=True) |
| 4429 | logging.warning('warn') |
| 4430 | logging.info('info') |
| 4431 | logging.debug('debug') |
| 4432 | self.assertEqual(len(logging.root.handlers), 1) |
| 4433 | self.assertEqual(old_string_io.getvalue().strip(), |
| 4434 | 'WARNING:root:warn') |
| 4435 | self.assertEqual(new_string_io.getvalue().strip(), |
| 4436 | 'WARNING:root:warn\nINFO:root:info') |
| 4437 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4438 | def _test_log(self, method, level=None): |
| 4439 | # logging.root has no handlers so basicConfig should be called |
| 4440 | called = [] |
| 4441 | |
| 4442 | old_basic_config = logging.basicConfig |
| 4443 | def my_basic_config(*a, **kw): |
| 4444 | old_basic_config() |
| 4445 | old_level = logging.root.level |
| 4446 | logging.root.setLevel(100) # avoid having messages in stderr |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4447 | self.addCleanup(logging.root.setLevel, old_level) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4448 | called.append((a, kw)) |
| 4449 | |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 4450 | support.patch(self, logging, 'basicConfig', my_basic_config) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4451 | |
| 4452 | log_method = getattr(logging, method) |
| 4453 | if level is not None: |
| 4454 | log_method(level, "test me") |
| 4455 | else: |
| 4456 | log_method("test me") |
| 4457 | |
| 4458 | # basicConfig was called with no arguments |
| 4459 | self.assertEqual(called, [((), {})]) |
| 4460 | |
| 4461 | def test_log(self): |
| 4462 | self._test_log('log', logging.WARNING) |
| 4463 | |
| 4464 | def test_debug(self): |
| 4465 | self._test_log('debug') |
| 4466 | |
| 4467 | def test_info(self): |
| 4468 | self._test_log('info') |
| 4469 | |
| 4470 | def test_warning(self): |
| 4471 | self._test_log('warning') |
| 4472 | |
| 4473 | def test_error(self): |
| 4474 | self._test_log('error') |
| 4475 | |
| 4476 | def test_critical(self): |
| 4477 | self._test_log('critical') |
| 4478 | |
| 4479 | |
| 4480 | class LoggerAdapterTest(unittest.TestCase): |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4481 | def setUp(self): |
| 4482 | super(LoggerAdapterTest, self).setUp() |
| 4483 | old_handler_list = logging._handlerList[:] |
| 4484 | |
| 4485 | self.recording = RecordingHandler() |
| 4486 | self.logger = logging.root |
| 4487 | self.logger.addHandler(self.recording) |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4488 | self.addCleanup(self.logger.removeHandler, self.recording) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4489 | self.addCleanup(self.recording.close) |
| 4490 | |
| 4491 | def cleanup(): |
| 4492 | logging._handlerList[:] = old_handler_list |
| 4493 | |
| 4494 | self.addCleanup(cleanup) |
| 4495 | self.addCleanup(logging.shutdown) |
| 4496 | self.adapter = logging.LoggerAdapter(logger=self.logger, extra=None) |
| 4497 | |
| 4498 | def test_exception(self): |
| 4499 | msg = 'testing exception: %r' |
| 4500 | exc = None |
| 4501 | try: |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4502 | 1 / 0 |
| 4503 | except ZeroDivisionError as e: |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4504 | exc = e |
| 4505 | self.adapter.exception(msg, self.recording) |
| 4506 | |
| 4507 | self.assertEqual(len(self.recording.records), 1) |
| 4508 | record = self.recording.records[0] |
| 4509 | self.assertEqual(record.levelno, logging.ERROR) |
| 4510 | self.assertEqual(record.msg, msg) |
| 4511 | self.assertEqual(record.args, (self.recording,)) |
| 4512 | self.assertEqual(record.exc_info, |
| 4513 | (exc.__class__, exc, exc.__traceback__)) |
| 4514 | |
Vinay Sajip | 02a8f9e | 2014-09-14 21:29:11 +0100 | [diff] [blame] | 4515 | def test_exception_excinfo(self): |
| 4516 | try: |
| 4517 | 1 / 0 |
| 4518 | except ZeroDivisionError as e: |
| 4519 | exc = e |
| 4520 | |
| 4521 | self.adapter.exception('exc_info test', exc_info=exc) |
| 4522 | |
| 4523 | self.assertEqual(len(self.recording.records), 1) |
| 4524 | record = self.recording.records[0] |
| 4525 | self.assertEqual(record.exc_info, |
| 4526 | (exc.__class__, exc, exc.__traceback__)) |
| 4527 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4528 | def test_critical(self): |
| 4529 | msg = 'critical test! %r' |
| 4530 | self.adapter.critical(msg, self.recording) |
| 4531 | |
| 4532 | self.assertEqual(len(self.recording.records), 1) |
| 4533 | record = self.recording.records[0] |
| 4534 | self.assertEqual(record.levelno, logging.CRITICAL) |
| 4535 | self.assertEqual(record.msg, msg) |
| 4536 | self.assertEqual(record.args, (self.recording,)) |
| 4537 | |
| 4538 | def test_is_enabled_for(self): |
| 4539 | old_disable = self.adapter.logger.manager.disable |
| 4540 | self.adapter.logger.manager.disable = 33 |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4541 | self.addCleanup(setattr, self.adapter.logger.manager, 'disable', |
| 4542 | old_disable) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4543 | self.assertFalse(self.adapter.isEnabledFor(32)) |
| 4544 | |
| 4545 | def test_has_handlers(self): |
| 4546 | self.assertTrue(self.adapter.hasHandlers()) |
| 4547 | |
| 4548 | for handler in self.logger.handlers: |
| 4549 | self.logger.removeHandler(handler) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4550 | |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4551 | self.assertFalse(self.logger.hasHandlers()) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4552 | self.assertFalse(self.adapter.hasHandlers()) |
| 4553 | |
Łukasz Langa | 1bbd482 | 2017-09-14 11:34:47 -0400 | [diff] [blame] | 4554 | def test_nested(self): |
Łukasz Langa | ce9e625 | 2017-10-19 10:24:55 -0700 | [diff] [blame] | 4555 | class Adapter(logging.LoggerAdapter): |
| 4556 | prefix = 'Adapter' |
| 4557 | |
| 4558 | def process(self, msg, kwargs): |
| 4559 | return f"{self.prefix} {msg}", kwargs |
| 4560 | |
Łukasz Langa | 1bbd482 | 2017-09-14 11:34:47 -0400 | [diff] [blame] | 4561 | msg = 'Adapters can be nested, yo.' |
Łukasz Langa | ce9e625 | 2017-10-19 10:24:55 -0700 | [diff] [blame] | 4562 | adapter = Adapter(logger=self.logger, extra=None) |
| 4563 | adapter_adapter = Adapter(logger=adapter, extra=None) |
| 4564 | adapter_adapter.prefix = 'AdapterAdapter' |
| 4565 | self.assertEqual(repr(adapter), repr(adapter_adapter)) |
Łukasz Langa | 1bbd482 | 2017-09-14 11:34:47 -0400 | [diff] [blame] | 4566 | adapter_adapter.log(logging.CRITICAL, msg, self.recording) |
Łukasz Langa | 1bbd482 | 2017-09-14 11:34:47 -0400 | [diff] [blame] | 4567 | self.assertEqual(len(self.recording.records), 1) |
| 4568 | record = self.recording.records[0] |
| 4569 | self.assertEqual(record.levelno, logging.CRITICAL) |
Łukasz Langa | ce9e625 | 2017-10-19 10:24:55 -0700 | [diff] [blame] | 4570 | self.assertEqual(record.msg, f"Adapter AdapterAdapter {msg}") |
Łukasz Langa | 1bbd482 | 2017-09-14 11:34:47 -0400 | [diff] [blame] | 4571 | self.assertEqual(record.args, (self.recording,)) |
Łukasz Langa | 0b6a118 | 2017-10-18 17:28:51 -0700 | [diff] [blame] | 4572 | orig_manager = adapter_adapter.manager |
Łukasz Langa | ce9e625 | 2017-10-19 10:24:55 -0700 | [diff] [blame] | 4573 | self.assertIs(adapter.manager, orig_manager) |
Łukasz Langa | 0b6a118 | 2017-10-18 17:28:51 -0700 | [diff] [blame] | 4574 | self.assertIs(self.logger.manager, orig_manager) |
| 4575 | temp_manager = object() |
| 4576 | try: |
| 4577 | adapter_adapter.manager = temp_manager |
| 4578 | self.assertIs(adapter_adapter.manager, temp_manager) |
Łukasz Langa | ce9e625 | 2017-10-19 10:24:55 -0700 | [diff] [blame] | 4579 | self.assertIs(adapter.manager, temp_manager) |
Łukasz Langa | 0b6a118 | 2017-10-18 17:28:51 -0700 | [diff] [blame] | 4580 | self.assertIs(self.logger.manager, temp_manager) |
| 4581 | finally: |
| 4582 | adapter_adapter.manager = orig_manager |
| 4583 | self.assertIs(adapter_adapter.manager, orig_manager) |
Łukasz Langa | ce9e625 | 2017-10-19 10:24:55 -0700 | [diff] [blame] | 4584 | self.assertIs(adapter.manager, orig_manager) |
Łukasz Langa | 0b6a118 | 2017-10-18 17:28:51 -0700 | [diff] [blame] | 4585 | self.assertIs(self.logger.manager, orig_manager) |
Łukasz Langa | 1bbd482 | 2017-09-14 11:34:47 -0400 | [diff] [blame] | 4586 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4587 | |
| 4588 | class LoggerTest(BaseTest): |
| 4589 | |
| 4590 | def setUp(self): |
| 4591 | super(LoggerTest, self).setUp() |
| 4592 | self.recording = RecordingHandler() |
| 4593 | self.logger = logging.Logger(name='blah') |
| 4594 | self.logger.addHandler(self.recording) |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4595 | self.addCleanup(self.logger.removeHandler, self.recording) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4596 | self.addCleanup(self.recording.close) |
| 4597 | self.addCleanup(logging.shutdown) |
| 4598 | |
| 4599 | def test_set_invalid_level(self): |
| 4600 | self.assertRaises(TypeError, self.logger.setLevel, object()) |
| 4601 | |
| 4602 | def test_exception(self): |
| 4603 | msg = 'testing exception: %r' |
| 4604 | exc = None |
| 4605 | try: |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4606 | 1 / 0 |
| 4607 | except ZeroDivisionError as e: |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4608 | exc = e |
| 4609 | self.logger.exception(msg, self.recording) |
| 4610 | |
| 4611 | self.assertEqual(len(self.recording.records), 1) |
| 4612 | record = self.recording.records[0] |
| 4613 | self.assertEqual(record.levelno, logging.ERROR) |
| 4614 | self.assertEqual(record.msg, msg) |
| 4615 | self.assertEqual(record.args, (self.recording,)) |
| 4616 | self.assertEqual(record.exc_info, |
| 4617 | (exc.__class__, exc, exc.__traceback__)) |
| 4618 | |
| 4619 | def test_log_invalid_level_with_raise(self): |
Serhiy Storchaka | 296b347 | 2015-07-21 22:40:18 +0300 | [diff] [blame] | 4620 | with support.swap_attr(logging, 'raiseExceptions', True): |
Serhiy Storchaka | 750eae1 | 2015-07-21 22:39:26 +0300 | [diff] [blame] | 4621 | self.assertRaises(TypeError, self.logger.log, '10', 'test message') |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4622 | |
| 4623 | def test_log_invalid_level_no_raise(self): |
Serhiy Storchaka | 296b347 | 2015-07-21 22:40:18 +0300 | [diff] [blame] | 4624 | with support.swap_attr(logging, 'raiseExceptions', False): |
Serhiy Storchaka | 750eae1 | 2015-07-21 22:39:26 +0300 | [diff] [blame] | 4625 | self.logger.log('10', 'test message') # no exception happens |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4626 | |
| 4627 | def test_find_caller_with_stack_info(self): |
| 4628 | called = [] |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 4629 | support.patch(self, logging.traceback, 'print_stack', |
| 4630 | lambda f, file: called.append(file.getvalue())) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4631 | |
| 4632 | self.logger.findCaller(stack_info=True) |
| 4633 | |
| 4634 | self.assertEqual(len(called), 1) |
| 4635 | self.assertEqual('Stack (most recent call last):\n', called[0]) |
| 4636 | |
Vinay Sajip | dde9fdb | 2018-06-05 17:24:18 +0100 | [diff] [blame] | 4637 | def test_find_caller_with_stacklevel(self): |
| 4638 | the_level = 1 |
| 4639 | |
| 4640 | def innermost(): |
| 4641 | self.logger.warning('test', stacklevel=the_level) |
| 4642 | |
| 4643 | def inner(): |
| 4644 | innermost() |
| 4645 | |
| 4646 | def outer(): |
| 4647 | inner() |
| 4648 | |
| 4649 | records = self.recording.records |
| 4650 | outer() |
| 4651 | self.assertEqual(records[-1].funcName, 'innermost') |
| 4652 | lineno = records[-1].lineno |
| 4653 | the_level += 1 |
| 4654 | outer() |
| 4655 | self.assertEqual(records[-1].funcName, 'inner') |
| 4656 | self.assertGreater(records[-1].lineno, lineno) |
| 4657 | lineno = records[-1].lineno |
| 4658 | the_level += 1 |
| 4659 | outer() |
| 4660 | self.assertEqual(records[-1].funcName, 'outer') |
| 4661 | self.assertGreater(records[-1].lineno, lineno) |
| 4662 | lineno = records[-1].lineno |
| 4663 | the_level += 1 |
| 4664 | outer() |
| 4665 | self.assertEqual(records[-1].funcName, 'test_find_caller_with_stacklevel') |
| 4666 | self.assertGreater(records[-1].lineno, lineno) |
| 4667 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4668 | def test_make_record_with_extra_overwrite(self): |
| 4669 | name = 'my record' |
| 4670 | level = 13 |
| 4671 | fn = lno = msg = args = exc_info = func = sinfo = None |
| 4672 | rv = logging._logRecordFactory(name, level, fn, lno, msg, args, |
| 4673 | exc_info, func, sinfo) |
| 4674 | |
| 4675 | for key in ('message', 'asctime') + tuple(rv.__dict__.keys()): |
| 4676 | extra = {key: 'some value'} |
| 4677 | self.assertRaises(KeyError, self.logger.makeRecord, name, level, |
| 4678 | fn, lno, msg, args, exc_info, |
| 4679 | extra=extra, sinfo=sinfo) |
| 4680 | |
| 4681 | def test_make_record_with_extra_no_overwrite(self): |
| 4682 | name = 'my record' |
| 4683 | level = 13 |
| 4684 | fn = lno = msg = args = exc_info = func = sinfo = None |
| 4685 | extra = {'valid_key': 'some value'} |
| 4686 | result = self.logger.makeRecord(name, level, fn, lno, msg, args, |
| 4687 | exc_info, extra=extra, sinfo=sinfo) |
| 4688 | self.assertIn('valid_key', result.__dict__) |
| 4689 | |
| 4690 | def test_has_handlers(self): |
| 4691 | self.assertTrue(self.logger.hasHandlers()) |
| 4692 | |
| 4693 | for handler in self.logger.handlers: |
| 4694 | self.logger.removeHandler(handler) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4695 | self.assertFalse(self.logger.hasHandlers()) |
| 4696 | |
| 4697 | def test_has_handlers_no_propagate(self): |
| 4698 | child_logger = logging.getLogger('blah.child') |
| 4699 | child_logger.propagate = False |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4700 | self.assertFalse(child_logger.hasHandlers()) |
| 4701 | |
| 4702 | def test_is_enabled_for(self): |
| 4703 | old_disable = self.logger.manager.disable |
| 4704 | self.logger.manager.disable = 23 |
Vinay Sajip | 5056c8c | 2011-06-05 09:31:34 +0100 | [diff] [blame] | 4705 | self.addCleanup(setattr, self.logger.manager, 'disable', old_disable) |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4706 | self.assertFalse(self.logger.isEnabledFor(22)) |
| 4707 | |
Timo Furrer | 6e3ca64 | 2018-06-01 09:29:46 +0200 | [diff] [blame] | 4708 | def test_is_enabled_for_disabled_logger(self): |
| 4709 | old_disabled = self.logger.disabled |
| 4710 | old_disable = self.logger.manager.disable |
| 4711 | |
| 4712 | self.logger.disabled = True |
| 4713 | self.logger.manager.disable = 21 |
| 4714 | |
| 4715 | self.addCleanup(setattr, self.logger, 'disabled', old_disabled) |
| 4716 | self.addCleanup(setattr, self.logger.manager, 'disable', old_disable) |
| 4717 | |
| 4718 | self.assertFalse(self.logger.isEnabledFor(22)) |
| 4719 | |
Florent Xicluna | 5252f9f | 2011-11-07 19:43:05 +0100 | [diff] [blame] | 4720 | def test_root_logger_aliases(self): |
| 4721 | root = logging.getLogger() |
| 4722 | self.assertIs(root, logging.root) |
| 4723 | self.assertIs(root, logging.getLogger(None)) |
| 4724 | self.assertIs(root, logging.getLogger('')) |
| 4725 | self.assertIs(root, logging.getLogger('foo').root) |
| 4726 | self.assertIs(root, logging.getLogger('foo.bar').root) |
| 4727 | self.assertIs(root, logging.getLogger('foo').parent) |
| 4728 | |
| 4729 | self.assertIsNot(root, logging.getLogger('\0')) |
| 4730 | self.assertIsNot(root, logging.getLogger('foo.bar').parent) |
| 4731 | |
| 4732 | def test_invalid_names(self): |
| 4733 | self.assertRaises(TypeError, logging.getLogger, any) |
| 4734 | self.assertRaises(TypeError, logging.getLogger, b'foo') |
| 4735 | |
Vinay Sajip | 6260d9f | 2017-06-06 16:34:29 +0100 | [diff] [blame] | 4736 | def test_pickling(self): |
| 4737 | for proto in range(pickle.HIGHEST_PROTOCOL + 1): |
| 4738 | for name in ('', 'root', 'foo', 'foo.bar', 'baz.bar'): |
| 4739 | logger = logging.getLogger(name) |
| 4740 | s = pickle.dumps(logger, proto) |
| 4741 | unpickled = pickle.loads(s) |
| 4742 | self.assertIs(unpickled, logger) |
| 4743 | |
Avram Lubkin | 78c18a9 | 2017-07-30 05:36:33 -0400 | [diff] [blame] | 4744 | def test_caching(self): |
| 4745 | root = self.root_logger |
| 4746 | logger1 = logging.getLogger("abc") |
| 4747 | logger2 = logging.getLogger("abc.def") |
| 4748 | |
| 4749 | # Set root logger level and ensure cache is empty |
| 4750 | root.setLevel(logging.ERROR) |
| 4751 | self.assertEqual(logger2.getEffectiveLevel(), logging.ERROR) |
| 4752 | self.assertEqual(logger2._cache, {}) |
| 4753 | |
| 4754 | # Ensure cache is populated and calls are consistent |
| 4755 | self.assertTrue(logger2.isEnabledFor(logging.ERROR)) |
| 4756 | self.assertFalse(logger2.isEnabledFor(logging.DEBUG)) |
| 4757 | self.assertEqual(logger2._cache, {logging.ERROR: True, logging.DEBUG: False}) |
| 4758 | self.assertEqual(root._cache, {}) |
| 4759 | self.assertTrue(logger2.isEnabledFor(logging.ERROR)) |
| 4760 | |
| 4761 | # Ensure root cache gets populated |
| 4762 | self.assertEqual(root._cache, {}) |
| 4763 | self.assertTrue(root.isEnabledFor(logging.ERROR)) |
| 4764 | self.assertEqual(root._cache, {logging.ERROR: True}) |
| 4765 | |
| 4766 | # Set parent logger level and ensure caches are emptied |
| 4767 | logger1.setLevel(logging.CRITICAL) |
| 4768 | self.assertEqual(logger2.getEffectiveLevel(), logging.CRITICAL) |
| 4769 | self.assertEqual(logger2._cache, {}) |
| 4770 | |
| 4771 | # Ensure logger2 uses parent logger's effective level |
| 4772 | self.assertFalse(logger2.isEnabledFor(logging.ERROR)) |
| 4773 | |
| 4774 | # Set level to NOTSET and ensure caches are empty |
| 4775 | logger2.setLevel(logging.NOTSET) |
| 4776 | self.assertEqual(logger2.getEffectiveLevel(), logging.CRITICAL) |
| 4777 | self.assertEqual(logger2._cache, {}) |
| 4778 | self.assertEqual(logger1._cache, {}) |
| 4779 | self.assertEqual(root._cache, {}) |
| 4780 | |
| 4781 | # Verify logger2 follows parent and not root |
| 4782 | self.assertFalse(logger2.isEnabledFor(logging.ERROR)) |
| 4783 | self.assertTrue(logger2.isEnabledFor(logging.CRITICAL)) |
| 4784 | self.assertFalse(logger1.isEnabledFor(logging.ERROR)) |
| 4785 | self.assertTrue(logger1.isEnabledFor(logging.CRITICAL)) |
| 4786 | self.assertTrue(root.isEnabledFor(logging.ERROR)) |
| 4787 | |
| 4788 | # Disable logging in manager and ensure caches are clear |
| 4789 | logging.disable() |
| 4790 | self.assertEqual(logger2.getEffectiveLevel(), logging.CRITICAL) |
| 4791 | self.assertEqual(logger2._cache, {}) |
| 4792 | self.assertEqual(logger1._cache, {}) |
| 4793 | self.assertEqual(root._cache, {}) |
| 4794 | |
| 4795 | # Ensure no loggers are enabled |
| 4796 | self.assertFalse(logger1.isEnabledFor(logging.CRITICAL)) |
| 4797 | self.assertFalse(logger2.isEnabledFor(logging.CRITICAL)) |
| 4798 | self.assertFalse(root.isEnabledFor(logging.CRITICAL)) |
| 4799 | |
Vinay Sajip | e6c1eb9 | 2011-03-29 17:20:34 +0100 | [diff] [blame] | 4800 | |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4801 | class BaseFileTest(BaseTest): |
| 4802 | "Base class for handler tests that write log files" |
| 4803 | |
| 4804 | def setUp(self): |
| 4805 | BaseTest.setUp(self) |
Vinay Sajip | 60b4df1 | 2010-12-27 11:18:52 +0000 | [diff] [blame] | 4806 | fd, self.fn = tempfile.mkstemp(".log", "test_logging-2-") |
| 4807 | os.close(fd) |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4808 | self.rmfiles = [] |
| 4809 | |
| 4810 | def tearDown(self): |
| 4811 | for fn in self.rmfiles: |
| 4812 | os.unlink(fn) |
Vinay Sajip | 60b4df1 | 2010-12-27 11:18:52 +0000 | [diff] [blame] | 4813 | if os.path.exists(self.fn): |
| 4814 | os.unlink(self.fn) |
Hirokazu Yamamoto | 2cdacd7 | 2010-09-18 03:54:32 +0000 | [diff] [blame] | 4815 | BaseTest.tearDown(self) |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4816 | |
| 4817 | def assertLogFile(self, filename): |
| 4818 | "Assert a log file is there and register it for deletion" |
| 4819 | self.assertTrue(os.path.exists(filename), |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 4820 | msg="Log file %r does not exist" % filename) |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4821 | self.rmfiles.append(filename) |
| 4822 | |
| 4823 | |
Vinay Sajip | 26fe4b7 | 2011-04-26 18:43:05 +0100 | [diff] [blame] | 4824 | class FileHandlerTest(BaseFileTest): |
| 4825 | def test_delay(self): |
| 4826 | os.unlink(self.fn) |
| 4827 | fh = logging.FileHandler(self.fn, delay=True) |
| 4828 | self.assertIsNone(fh.stream) |
| 4829 | self.assertFalse(os.path.exists(self.fn)) |
| 4830 | fh.handle(logging.makeLogRecord({})) |
| 4831 | self.assertIsNotNone(fh.stream) |
| 4832 | self.assertTrue(os.path.exists(self.fn)) |
| 4833 | fh.close() |
| 4834 | |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4835 | class RotatingFileHandlerTest(BaseFileTest): |
| 4836 | def next_rec(self): |
| 4837 | return logging.LogRecord('n', logging.DEBUG, 'p', 1, |
| 4838 | self.next_message(), None, None, None) |
| 4839 | |
| 4840 | def test_should_not_rollover(self): |
| 4841 | # If maxbytes is zero rollover never occurs |
| 4842 | rh = logging.handlers.RotatingFileHandler(self.fn, maxBytes=0) |
| 4843 | self.assertFalse(rh.shouldRollover(None)) |
Vinay Sajip | b046b80 | 2010-10-30 09:50:18 +0000 | [diff] [blame] | 4844 | rh.close() |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4845 | |
| 4846 | def test_should_rollover(self): |
| 4847 | rh = logging.handlers.RotatingFileHandler(self.fn, maxBytes=1) |
| 4848 | self.assertTrue(rh.shouldRollover(self.next_rec())) |
Vinay Sajip | b046b80 | 2010-10-30 09:50:18 +0000 | [diff] [blame] | 4849 | rh.close() |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4850 | |
| 4851 | def test_file_created(self): |
| 4852 | # checks that the file is created and assumes it was created |
| 4853 | # by us |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4854 | rh = logging.handlers.RotatingFileHandler(self.fn) |
| 4855 | rh.emit(self.next_rec()) |
| 4856 | self.assertLogFile(self.fn) |
Vinay Sajip | b046b80 | 2010-10-30 09:50:18 +0000 | [diff] [blame] | 4857 | rh.close() |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4858 | |
| 4859 | def test_rollover_filenames(self): |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4860 | def namer(name): |
| 4861 | return name + ".test" |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4862 | rh = logging.handlers.RotatingFileHandler( |
| 4863 | self.fn, backupCount=2, maxBytes=1) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4864 | rh.namer = namer |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4865 | rh.emit(self.next_rec()) |
| 4866 | self.assertLogFile(self.fn) |
| 4867 | rh.emit(self.next_rec()) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4868 | self.assertLogFile(namer(self.fn + ".1")) |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4869 | rh.emit(self.next_rec()) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4870 | self.assertLogFile(namer(self.fn + ".2")) |
| 4871 | self.assertFalse(os.path.exists(namer(self.fn + ".3"))) |
| 4872 | rh.close() |
| 4873 | |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 4874 | @support.requires_zlib |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4875 | def test_rotator(self): |
| 4876 | def namer(name): |
| 4877 | return name + ".gz" |
| 4878 | |
| 4879 | def rotator(source, dest): |
| 4880 | with open(source, "rb") as sf: |
| 4881 | data = sf.read() |
| 4882 | compressed = zlib.compress(data, 9) |
| 4883 | with open(dest, "wb") as df: |
| 4884 | df.write(compressed) |
| 4885 | os.remove(source) |
| 4886 | |
| 4887 | rh = logging.handlers.RotatingFileHandler( |
| 4888 | self.fn, backupCount=2, maxBytes=1) |
| 4889 | rh.rotator = rotator |
| 4890 | rh.namer = namer |
| 4891 | m1 = self.next_rec() |
| 4892 | rh.emit(m1) |
| 4893 | self.assertLogFile(self.fn) |
| 4894 | m2 = self.next_rec() |
| 4895 | rh.emit(m2) |
| 4896 | fn = namer(self.fn + ".1") |
| 4897 | self.assertLogFile(fn) |
Vinay Sajip | 2c94cdd | 2012-01-07 23:26:17 +0000 | [diff] [blame] | 4898 | newline = os.linesep |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4899 | with open(fn, "rb") as f: |
| 4900 | compressed = f.read() |
| 4901 | data = zlib.decompress(compressed) |
Vinay Sajip | 2c94cdd | 2012-01-07 23:26:17 +0000 | [diff] [blame] | 4902 | self.assertEqual(data.decode("ascii"), m1.msg + newline) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4903 | rh.emit(self.next_rec()) |
| 4904 | fn = namer(self.fn + ".2") |
| 4905 | self.assertLogFile(fn) |
| 4906 | with open(fn, "rb") as f: |
| 4907 | compressed = f.read() |
| 4908 | data = zlib.decompress(compressed) |
Vinay Sajip | 2c94cdd | 2012-01-07 23:26:17 +0000 | [diff] [blame] | 4909 | self.assertEqual(data.decode("ascii"), m1.msg + newline) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4910 | rh.emit(self.next_rec()) |
| 4911 | fn = namer(self.fn + ".2") |
| 4912 | with open(fn, "rb") as f: |
| 4913 | compressed = f.read() |
| 4914 | data = zlib.decompress(compressed) |
Vinay Sajip | 2c94cdd | 2012-01-07 23:26:17 +0000 | [diff] [blame] | 4915 | self.assertEqual(data.decode("ascii"), m2.msg + newline) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 4916 | self.assertFalse(os.path.exists(namer(self.fn + ".3"))) |
Vinay Sajip | b046b80 | 2010-10-30 09:50:18 +0000 | [diff] [blame] | 4917 | rh.close() |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4918 | |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4919 | class TimedRotatingFileHandlerTest(BaseFileTest): |
Vinay Sajip | 7367d08 | 2011-05-02 13:17:27 +0100 | [diff] [blame] | 4920 | # other test methods added below |
| 4921 | def test_rollover(self): |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 4922 | fh = logging.handlers.TimedRotatingFileHandler(self.fn, 'S', |
| 4923 | backupCount=1) |
Vinay Sajip | b6f6670 | 2012-03-05 09:43:47 +0000 | [diff] [blame] | 4924 | fmt = logging.Formatter('%(asctime)s %(message)s') |
| 4925 | fh.setFormatter(fmt) |
Vinay Sajip | 8d217c6 | 2012-03-05 12:45:51 +0000 | [diff] [blame] | 4926 | r1 = logging.makeLogRecord({'msg': 'testing - initial'}) |
Vinay Sajip | 8d217c6 | 2012-03-05 12:45:51 +0000 | [diff] [blame] | 4927 | fh.emit(r1) |
Vinay Sajip | fd28502 | 2011-05-07 17:01:22 +0100 | [diff] [blame] | 4928 | self.assertLogFile(self.fn) |
Vinay Sajip | 8d217c6 | 2012-03-05 12:45:51 +0000 | [diff] [blame] | 4929 | time.sleep(1.1) # a little over a second ... |
Vinay Sajip | b2fcd3a | 2012-03-05 20:02:53 +0000 | [diff] [blame] | 4930 | r2 = logging.makeLogRecord({'msg': 'testing - after delay'}) |
Vinay Sajip | 8d217c6 | 2012-03-05 12:45:51 +0000 | [diff] [blame] | 4931 | fh.emit(r2) |
Vinay Sajip | fd28502 | 2011-05-07 17:01:22 +0100 | [diff] [blame] | 4932 | fh.close() |
| 4933 | # At this point, we should have a recent rotated file which we |
| 4934 | # can test for the existence of. However, in practice, on some |
| 4935 | # machines which run really slowly, we don't know how far back |
Vinay Sajip | 672c581 | 2011-05-13 07:09:40 +0100 | [diff] [blame] | 4936 | # in time to go to look for the log file. So, we go back a fair |
| 4937 | # bit, and stop as soon as we see a rotated file. In theory this |
| 4938 | # could of course still fail, but the chances are lower. |
Vinay Sajip | fd28502 | 2011-05-07 17:01:22 +0100 | [diff] [blame] | 4939 | found = False |
| 4940 | now = datetime.datetime.now() |
Vinay Sajip | 252048c | 2011-05-13 16:41:57 +0100 | [diff] [blame] | 4941 | GO_BACK = 5 * 60 # seconds |
Vinay Sajip | 672c581 | 2011-05-13 07:09:40 +0100 | [diff] [blame] | 4942 | for secs in range(GO_BACK): |
| 4943 | prev = now - datetime.timedelta(seconds=secs) |
Vinay Sajip | fd28502 | 2011-05-07 17:01:22 +0100 | [diff] [blame] | 4944 | fn = self.fn + prev.strftime(".%Y-%m-%d_%H-%M-%S") |
| 4945 | found = os.path.exists(fn) |
| 4946 | if found: |
| 4947 | self.rmfiles.append(fn) |
| 4948 | break |
Vinay Sajip | 672c581 | 2011-05-13 07:09:40 +0100 | [diff] [blame] | 4949 | msg = 'No rotated files found, went back %d seconds' % GO_BACK |
| 4950 | if not found: |
Mike | 53f7a7c | 2017-12-14 14:04:53 +0300 | [diff] [blame] | 4951 | # print additional diagnostics |
Vinay Sajip | a171f9c | 2011-05-13 14:45:08 +0100 | [diff] [blame] | 4952 | dn, fn = os.path.split(self.fn) |
| 4953 | files = [f for f in os.listdir(dn) if f.startswith(fn)] |
Victor Stinner | 949c890 | 2011-05-23 01:16:44 +0200 | [diff] [blame] | 4954 | print('Test time: %s' % now.strftime("%Y-%m-%d %H-%M-%S"), file=sys.stderr) |
| 4955 | print('The only matching files are: %s' % files, file=sys.stderr) |
Vinay Sajip | 19b1d50 | 2012-02-28 19:02:43 +0000 | [diff] [blame] | 4956 | for f in files: |
| 4957 | print('Contents of %s:' % f) |
Vinay Sajip | d263d18 | 2012-03-03 16:20:37 +0000 | [diff] [blame] | 4958 | path = os.path.join(dn, f) |
| 4959 | with open(path, 'r') as tf: |
Vinay Sajip | 19b1d50 | 2012-02-28 19:02:43 +0000 | [diff] [blame] | 4960 | print(tf.read()) |
Vinay Sajip | fd28502 | 2011-05-07 17:01:22 +0100 | [diff] [blame] | 4961 | self.assertTrue(found, msg=msg) |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 4962 | |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 4963 | def test_invalid(self): |
| 4964 | assertRaises = self.assertRaises |
| 4965 | assertRaises(ValueError, logging.handlers.TimedRotatingFileHandler, |
Vinay Sajip | fd28502 | 2011-05-07 17:01:22 +0100 | [diff] [blame] | 4966 | self.fn, 'X', delay=True) |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 4967 | assertRaises(ValueError, logging.handlers.TimedRotatingFileHandler, |
Vinay Sajip | fd28502 | 2011-05-07 17:01:22 +0100 | [diff] [blame] | 4968 | self.fn, 'W', delay=True) |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 4969 | assertRaises(ValueError, logging.handlers.TimedRotatingFileHandler, |
Vinay Sajip | fd28502 | 2011-05-07 17:01:22 +0100 | [diff] [blame] | 4970 | self.fn, 'W7', delay=True) |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 4971 | |
Vinay Sajip | a713079 | 2013-04-12 17:04:23 +0100 | [diff] [blame] | 4972 | def test_compute_rollover_daily_attime(self): |
| 4973 | currentTime = 0 |
| 4974 | atTime = datetime.time(12, 0, 0) |
| 4975 | rh = logging.handlers.TimedRotatingFileHandler( |
| 4976 | self.fn, when='MIDNIGHT', interval=1, backupCount=0, utc=True, |
| 4977 | atTime=atTime) |
Vinay Sajip | d86ac96 | 2013-04-14 12:20:46 +0100 | [diff] [blame] | 4978 | try: |
| 4979 | actual = rh.computeRollover(currentTime) |
| 4980 | self.assertEqual(actual, currentTime + 12 * 60 * 60) |
Vinay Sajip | a713079 | 2013-04-12 17:04:23 +0100 | [diff] [blame] | 4981 | |
Vinay Sajip | d86ac96 | 2013-04-14 12:20:46 +0100 | [diff] [blame] | 4982 | actual = rh.computeRollover(currentTime + 13 * 60 * 60) |
| 4983 | self.assertEqual(actual, currentTime + 36 * 60 * 60) |
| 4984 | finally: |
| 4985 | rh.close() |
Vinay Sajip | a713079 | 2013-04-12 17:04:23 +0100 | [diff] [blame] | 4986 | |
Vinay Sajip | 10e8c49 | 2013-05-18 10:19:54 -0700 | [diff] [blame] | 4987 | #@unittest.skipIf(True, 'Temporarily skipped while failures investigated.') |
Vinay Sajip | a713079 | 2013-04-12 17:04:23 +0100 | [diff] [blame] | 4988 | def test_compute_rollover_weekly_attime(self): |
Vinay Sajip | d86ac96 | 2013-04-14 12:20:46 +0100 | [diff] [blame] | 4989 | currentTime = int(time.time()) |
| 4990 | today = currentTime - currentTime % 86400 |
| 4991 | |
Vinay Sajip | a713079 | 2013-04-12 17:04:23 +0100 | [diff] [blame] | 4992 | atTime = datetime.time(12, 0, 0) |
| 4993 | |
Vinay Sajip | 10e8c49 | 2013-05-18 10:19:54 -0700 | [diff] [blame] | 4994 | wday = time.gmtime(today).tm_wday |
Vinay Sajip | a713079 | 2013-04-12 17:04:23 +0100 | [diff] [blame] | 4995 | for day in range(7): |
| 4996 | rh = logging.handlers.TimedRotatingFileHandler( |
| 4997 | self.fn, when='W%d' % day, interval=1, backupCount=0, utc=True, |
| 4998 | atTime=atTime) |
Vinay Sajip | d86ac96 | 2013-04-14 12:20:46 +0100 | [diff] [blame] | 4999 | try: |
| 5000 | if wday > day: |
| 5001 | # The rollover day has already passed this week, so we |
| 5002 | # go over into next week |
| 5003 | expected = (7 - wday + day) |
| 5004 | else: |
| 5005 | expected = (day - wday) |
| 5006 | # At this point expected is in days from now, convert to seconds |
| 5007 | expected *= 24 * 60 * 60 |
| 5008 | # Add in the rollover time |
| 5009 | expected += 12 * 60 * 60 |
| 5010 | # Add in adjustment for today |
| 5011 | expected += today |
Vinay Sajip | 66940a1 | 2013-04-15 11:59:35 +0100 | [diff] [blame] | 5012 | actual = rh.computeRollover(today) |
| 5013 | if actual != expected: |
| 5014 | print('failed in timezone: %d' % time.timezone) |
Vinay Sajip | caf9eb8 | 2013-05-12 00:04:58 +0100 | [diff] [blame] | 5015 | print('local vars: %s' % locals()) |
Vinay Sajip | d86ac96 | 2013-04-14 12:20:46 +0100 | [diff] [blame] | 5016 | self.assertEqual(actual, expected) |
| 5017 | if day == wday: |
| 5018 | # goes into following week |
| 5019 | expected += 7 * 24 * 60 * 60 |
Vinay Sajip | 8b4c719 | 2013-04-14 12:25:25 +0100 | [diff] [blame] | 5020 | actual = rh.computeRollover(today + 13 * 60 * 60) |
Vinay Sajip | 66940a1 | 2013-04-15 11:59:35 +0100 | [diff] [blame] | 5021 | if actual != expected: |
| 5022 | print('failed in timezone: %d' % time.timezone) |
Vinay Sajip | caf9eb8 | 2013-05-12 00:04:58 +0100 | [diff] [blame] | 5023 | print('local vars: %s' % locals()) |
Vinay Sajip | d86ac96 | 2013-04-14 12:20:46 +0100 | [diff] [blame] | 5024 | self.assertEqual(actual, expected) |
| 5025 | finally: |
| 5026 | rh.close() |
Vinay Sajip | a713079 | 2013-04-12 17:04:23 +0100 | [diff] [blame] | 5027 | |
| 5028 | |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 5029 | def secs(**kw): |
| 5030 | return datetime.timedelta(**kw) // datetime.timedelta(seconds=1) |
| 5031 | |
| 5032 | for when, exp in (('S', 1), |
| 5033 | ('M', 60), |
| 5034 | ('H', 60 * 60), |
| 5035 | ('D', 60 * 60 * 24), |
Vinay Sajip | ed0473c | 2011-02-26 15:35:38 +0000 | [diff] [blame] | 5036 | ('MIDNIGHT', 60 * 60 * 24), |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 5037 | # current time (epoch start) is a Thursday, W0 means Monday |
Vinay Sajip | ed0473c | 2011-02-26 15:35:38 +0000 | [diff] [blame] | 5038 | ('W0', secs(days=4, hours=24)), |
| 5039 | ): |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 5040 | def test_compute_rollover(self, when=when, exp=exp): |
| 5041 | rh = logging.handlers.TimedRotatingFileHandler( |
Vinay Sajip | ed0473c | 2011-02-26 15:35:38 +0000 | [diff] [blame] | 5042 | self.fn, when=when, interval=1, backupCount=0, utc=True) |
| 5043 | currentTime = 0.0 |
| 5044 | actual = rh.computeRollover(currentTime) |
| 5045 | if exp != actual: |
| 5046 | # Failures occur on some systems for MIDNIGHT and W0. |
| 5047 | # Print detailed calculation for MIDNIGHT so we can try to see |
| 5048 | # what's going on |
Vinay Sajip | ed0473c | 2011-02-26 15:35:38 +0000 | [diff] [blame] | 5049 | if when == 'MIDNIGHT': |
| 5050 | try: |
| 5051 | if rh.utc: |
| 5052 | t = time.gmtime(currentTime) |
| 5053 | else: |
| 5054 | t = time.localtime(currentTime) |
| 5055 | currentHour = t[3] |
| 5056 | currentMinute = t[4] |
| 5057 | currentSecond = t[5] |
| 5058 | # r is the number of seconds left between now and midnight |
| 5059 | r = logging.handlers._MIDNIGHT - ((currentHour * 60 + |
| 5060 | currentMinute) * 60 + |
| 5061 | currentSecond) |
| 5062 | result = currentTime + r |
| 5063 | print('t: %s (%s)' % (t, rh.utc), file=sys.stderr) |
| 5064 | print('currentHour: %s' % currentHour, file=sys.stderr) |
| 5065 | print('currentMinute: %s' % currentMinute, file=sys.stderr) |
| 5066 | print('currentSecond: %s' % currentSecond, file=sys.stderr) |
| 5067 | print('r: %s' % r, file=sys.stderr) |
| 5068 | print('result: %s' % result, file=sys.stderr) |
| 5069 | except Exception: |
| 5070 | print('exception in diagnostic code: %s' % sys.exc_info()[1], file=sys.stderr) |
| 5071 | self.assertEqual(exp, actual) |
Vinay Sajip | b046b80 | 2010-10-30 09:50:18 +0000 | [diff] [blame] | 5072 | rh.close() |
Vinay Sajip | 19ec67a | 2010-09-17 18:57:36 +0000 | [diff] [blame] | 5073 | setattr(TimedRotatingFileHandlerTest, "test_compute_rollover_%s" % when, test_compute_rollover) |
| 5074 | |
Vinay Sajip | 60ccd82 | 2011-05-09 17:32:09 +0100 | [diff] [blame] | 5075 | |
Vinay Sajip | 223349c | 2015-10-01 20:37:54 +0100 | [diff] [blame] | 5076 | @unittest.skipUnless(win32evtlog, 'win32evtlog/win32evtlogutil/pywintypes required for this test.') |
Vinay Sajip | 60ccd82 | 2011-05-09 17:32:09 +0100 | [diff] [blame] | 5077 | class NTEventLogHandlerTest(BaseTest): |
| 5078 | def test_basic(self): |
| 5079 | logtype = 'Application' |
| 5080 | elh = win32evtlog.OpenEventLog(None, logtype) |
| 5081 | num_recs = win32evtlog.GetNumberOfEventLogRecords(elh) |
Vinay Sajip | 223349c | 2015-10-01 20:37:54 +0100 | [diff] [blame] | 5082 | |
| 5083 | try: |
| 5084 | h = logging.handlers.NTEventLogHandler('test_logging') |
| 5085 | except pywintypes.error as e: |
Zachary Ware | 22226c5 | 2015-10-06 15:22:13 -0500 | [diff] [blame] | 5086 | if e.winerror == 5: # access denied |
Vinay Sajip | 223349c | 2015-10-01 20:37:54 +0100 | [diff] [blame] | 5087 | raise unittest.SkipTest('Insufficient privileges to run test') |
Zachary Ware | 106ddf0 | 2015-10-06 15:28:43 -0500 | [diff] [blame] | 5088 | raise |
Vinay Sajip | 223349c | 2015-10-01 20:37:54 +0100 | [diff] [blame] | 5089 | |
Vinay Sajip | 60ccd82 | 2011-05-09 17:32:09 +0100 | [diff] [blame] | 5090 | r = logging.makeLogRecord({'msg': 'Test Log Message'}) |
| 5091 | h.handle(r) |
| 5092 | h.close() |
| 5093 | # Now see if the event is recorded |
Giampaolo Rodola' | 284529d | 2012-10-17 13:24:27 +0200 | [diff] [blame] | 5094 | self.assertLess(num_recs, win32evtlog.GetNumberOfEventLogRecords(elh)) |
Vinay Sajip | 60ccd82 | 2011-05-09 17:32:09 +0100 | [diff] [blame] | 5095 | flags = win32evtlog.EVENTLOG_BACKWARDS_READ | \ |
| 5096 | win32evtlog.EVENTLOG_SEQUENTIAL_READ |
| 5097 | found = False |
| 5098 | GO_BACK = 100 |
| 5099 | events = win32evtlog.ReadEventLog(elh, flags, GO_BACK) |
| 5100 | for e in events: |
| 5101 | if e.SourceName != 'test_logging': |
| 5102 | continue |
| 5103 | msg = win32evtlogutil.SafeFormatMessage(e, logtype) |
| 5104 | if msg != 'Test Log Message\r\n': |
| 5105 | continue |
| 5106 | found = True |
| 5107 | break |
| 5108 | msg = 'Record not found in event log, went back %d records' % GO_BACK |
| 5109 | self.assertTrue(found, msg=msg) |
| 5110 | |
Vinay Sajip | db8f463 | 2016-09-08 01:37:03 +0100 | [diff] [blame] | 5111 | |
| 5112 | class MiscTestCase(unittest.TestCase): |
| 5113 | def test__all__(self): |
| 5114 | blacklist = {'logThreads', 'logMultiprocessing', |
| 5115 | 'logProcesses', 'currentframe', |
| 5116 | 'PercentStyle', 'StrFormatStyle', 'StringTemplateStyle', |
| 5117 | 'Filterer', 'PlaceHolder', 'Manager', 'RootLogger', |
Martin Panter | 94332cb | 2016-10-20 05:10:44 +0000 | [diff] [blame] | 5118 | 'root', 'threading'} |
Vinay Sajip | db8f463 | 2016-09-08 01:37:03 +0100 | [diff] [blame] | 5119 | support.check__all__(self, logging, blacklist=blacklist) |
| 5120 | |
| 5121 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 5122 | # Set the locale to the platform-dependent default. I have no idea |
| 5123 | # why the test does this, but in any case we save the current locale |
| 5124 | # first and restore it at the end. |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 5125 | @support.run_with_locale('LC_ALL', '') |
Tim Peters | 36f7e93 | 2003-07-23 00:05:07 +0000 | [diff] [blame] | 5126 | def test_main(): |
Vinay Sajip | d61910c | 2016-09-08 01:13:39 +0100 | [diff] [blame] | 5127 | tests = [ |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 5128 | BuiltinLevelsTest, BasicFilterTest, CustomLevelsAndFiltersTest, |
| 5129 | HandlerTest, MemoryHandlerTest, ConfigFileTest, SocketHandlerTest, |
| 5130 | DatagramHandlerTest, MemoryTest, EncodingTest, WarningsTest, |
| 5131 | ConfigDictTest, ManagerTest, FormatterTest, BufferingFormatterTest, |
| 5132 | StreamHandlerTest, LogRecordFactoryTest, ChildLoggerTest, |
| 5133 | QueueHandlerTest, ShutdownTest, ModuleLevelMiscTest, BasicConfigTest, |
| 5134 | LoggerAdapterTest, LoggerTest, SMTPHandlerTest, FileHandlerTest, |
| 5135 | RotatingFileHandlerTest, LastResortTest, LogRecordTest, |
Xiang Zhang | 0b4b57d | 2017-06-01 21:11:56 +0800 | [diff] [blame] | 5136 | ExceptionTest, SysLogHandlerTest, IPv6SysLogHandlerTest, HTTPHandlerTest, |
Vinay Sajip | 1feedb4 | 2014-05-31 08:19:12 +0100 | [diff] [blame] | 5137 | NTEventLogHandlerTest, TimedRotatingFileHandlerTest, |
Vinay Sajip | d61910c | 2016-09-08 01:13:39 +0100 | [diff] [blame] | 5138 | UnixSocketHandlerTest, UnixDatagramHandlerTest, UnixSysLogHandlerTest, |
Vinay Sajip | db8f463 | 2016-09-08 01:37:03 +0100 | [diff] [blame] | 5139 | MiscTestCase |
Vinay Sajip | d61910c | 2016-09-08 01:13:39 +0100 | [diff] [blame] | 5140 | ] |
| 5141 | if hasattr(logging.handlers, 'QueueListener'): |
| 5142 | tests.append(QueueListenerTest) |
| 5143 | support.run_unittest(*tests) |
Jeremy Hylton | 096d986 | 2003-07-18 03:19:20 +0000 | [diff] [blame] | 5144 | |
Christian Heimes | 180510d | 2008-03-03 19:15:45 +0000 | [diff] [blame] | 5145 | if __name__ == "__main__": |
Neal Norwitz | b4a2df0 | 2003-01-02 14:56:39 +0000 | [diff] [blame] | 5146 | test_main() |