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