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