1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
|
import logging
import sys
from collections import defaultdict
from io import StringIO
from tempfile import mkstemp
from unittest.mock import Mock, patch
import pytest
from celery import signals, uuid
from celery.app.log import TaskFormatter
from celery.utils.log import ColorFormatter, LoggingProxy, get_logger, get_task_logger, in_sighandler
from celery.utils.log import logger as base_logger
from celery.utils.log import logger_isa, task_logger
from t.unit import conftest
class test_TaskFormatter:
def test_no_task(self):
class Record:
msg = 'hello world'
levelname = 'info'
exc_text = exc_info = None
stack_info = None
def getMessage(self):
return self.msg
record = Record()
x = TaskFormatter()
x.format(record)
assert record.task_name == '???'
assert record.task_id == '???'
class test_logger_isa:
def test_isa(self):
x = get_task_logger('Z1george')
assert logger_isa(x, task_logger)
prev_x, x.parent = x.parent, None
try:
assert not logger_isa(x, task_logger)
finally:
x.parent = prev_x
y = get_task_logger('Z1elaine')
y.parent = x
assert logger_isa(y, task_logger)
assert logger_isa(y, x)
assert logger_isa(y, y)
z = get_task_logger('Z1jerry')
z.parent = y
assert logger_isa(z, task_logger)
assert logger_isa(z, y)
assert logger_isa(z, x)
assert logger_isa(z, z)
def test_recursive(self):
x = get_task_logger('X1foo')
prev, x.parent = x.parent, x
try:
with pytest.raises(RuntimeError):
logger_isa(x, task_logger)
finally:
x.parent = prev
y = get_task_logger('X2foo')
z = get_task_logger('X2foo')
prev_y, y.parent = y.parent, z
try:
prev_z, z.parent = z.parent, y
try:
with pytest.raises(RuntimeError):
logger_isa(y, task_logger)
finally:
z.parent = prev_z
finally:
y.parent = prev_y
class test_ColorFormatter:
@patch('celery.utils.log.safe_str')
@patch('logging.Formatter.formatException')
def test_formatException_not_string(self, fe, safe_str):
x = ColorFormatter()
value = KeyError()
fe.return_value = value
assert x.formatException(value) is value
fe.assert_called()
safe_str.assert_not_called()
@patch('logging.Formatter.formatException')
@patch('celery.utils.log.safe_str')
def test_formatException_bytes(self, safe_str, fe):
x = ColorFormatter()
fe.return_value = b'HELLO'
try:
raise Exception()
except Exception:
assert x.formatException(sys.exc_info())
@patch('logging.Formatter.format')
def test_format_object(self, _format):
x = ColorFormatter()
x.use_color = True
record = Mock()
record.levelname = 'ERROR'
record.msg = object()
assert x.format(record)
@patch('celery.utils.log.safe_str')
def test_format_raises(self, safe_str):
x = ColorFormatter()
def on_safe_str(s):
try:
raise ValueError('foo')
finally:
safe_str.side_effect = None
safe_str.side_effect = on_safe_str
class Record:
levelname = 'ERROR'
msg = 'HELLO'
exc_info = 1
exc_text = 'error text'
stack_info = None
def __str__(self):
return on_safe_str('')
def getMessage(self):
return self.msg
record = Record()
safe_str.return_value = record
msg = x.format(record)
assert '<Unrepresentable' in msg
assert safe_str.call_count == 1
class test_default_logger:
def setup_logger(self, *args, **kwargs):
self.app.log.setup_logging_subsystem(*args, **kwargs)
return logging.root
def setup_method(self):
self.get_logger = lambda n=None: get_logger(n) if n else logging.root
signals.setup_logging.receivers[:] = []
self.app.log.already_setup = False
def test_get_logger_sets_parent(self):
logger = get_logger('celery.test_get_logger')
assert logger.parent.name == base_logger.name
def test_get_logger_root(self):
logger = get_logger(base_logger.name)
assert logger.parent is logging.root
def test_setup_logging_subsystem_misc(self, restore_logging):
self.app.log.setup_logging_subsystem(loglevel=None)
def test_setup_logging_subsystem_misc2(self, restore_logging):
self.app.conf.worker_hijack_root_logger = True
self.app.log.setup_logging_subsystem()
def test_get_default_logger(self):
assert self.app.log.get_default_logger()
def test_configure_logger(self):
logger = self.app.log.get_default_logger()
self.app.log._configure_logger(logger, sys.stderr, None, '', False)
self.app.log._configure_logger(None, sys.stderr, None, '', False)
logger.handlers[:] = []
def test_setup_logging_subsystem_colorize(self, restore_logging):
self.app.log.setup_logging_subsystem(colorize=None)
self.app.log.setup_logging_subsystem(colorize=True)
@pytest.mark.masked_modules('billiard.util')
def test_setup_logging_subsystem_no_mputil(self, restore_logging, mask_modules):
self.app.log.setup_logging_subsystem()
def test_setup_logger(self, restore_logging):
logger = self.setup_logger(loglevel=logging.ERROR, logfile=None,
root=False, colorize=True)
logger.handlers = []
self.app.log.already_setup = False
logger = self.setup_logger(loglevel=logging.ERROR, logfile=None,
root=False, colorize=None)
# setup_logger logs to stderr without logfile argument.
assert (conftest.get_logger_handlers(logger)[0].stream is
sys.__stderr__)
def test_setup_logger_no_handlers_stream(self, restore_logging):
l = self.get_logger()
l.handlers = []
with conftest.stdouts() as (stdout, stderr):
l = self.setup_logger(logfile=sys.stderr,
loglevel=logging.INFO, root=False)
l.info('The quick brown fox...')
assert 'The quick brown fox...' in stderr.getvalue()
@patch('os.fstat')
def test_setup_logger_no_handlers_file(self, *args):
_, tempfile = mkstemp(suffix='unittest', prefix='celery')
with patch('builtins.open') as osopen:
with conftest.restore_logging_context_manager():
files = defaultdict(StringIO)
def open_file(filename, *args, **kwargs):
f = files[filename]
f.fileno = Mock()
f.fileno.return_value = 99
return f
osopen.side_effect = open_file
l = self.get_logger()
l.handlers = []
l = self.setup_logger(
logfile=tempfile, loglevel=logging.INFO, root=False,
)
assert isinstance(conftest.get_logger_handlers(l)[0],
logging.FileHandler)
assert tempfile in files
def test_redirect_stdouts(self, restore_logging):
logger = self.setup_logger(loglevel=logging.ERROR, logfile=None,
root=False)
try:
with conftest.wrap_logger(logger) as sio:
self.app.log.redirect_stdouts_to_logger(
logger, loglevel=logging.ERROR,
)
logger.error('foo')
assert 'foo' in sio.getvalue()
self.app.log.redirect_stdouts_to_logger(
logger, stdout=False, stderr=False,
)
finally:
sys.stdout, sys.stderr = sys.__stdout__, sys.__stderr__
def test_logging_proxy(self, restore_logging):
logger = self.setup_logger(loglevel=logging.ERROR, logfile=None,
root=False)
with conftest.wrap_logger(logger) as sio:
p = LoggingProxy(logger, loglevel=logging.ERROR)
p.close()
p.write('foo')
assert 'foo' not in sio.getvalue()
p.closed = False
p.write('\n')
assert sio.getvalue() == ''
write_res = p.write('foo ')
assert sio.getvalue() == 'foo \n'
assert write_res == 4
lines = ['baz', 'xuzzy']
p.writelines(lines)
for line in lines:
assert line in sio.getvalue()
p.flush()
p.close()
assert not p.isatty()
with conftest.stdouts() as (stdout, stderr):
with in_sighandler():
p.write('foo')
assert stderr.getvalue()
def test_logging_proxy_bytes(self, restore_logging):
logger = self.setup_logger(loglevel=logging.ERROR, logfile=None,
root=False)
with conftest.wrap_logger(logger) as sio:
p = LoggingProxy(logger, loglevel=logging.ERROR)
p.close()
p.write(b'foo')
assert 'foo' not in str(sio.getvalue())
p.closed = False
p.write(b'\n')
assert str(sio.getvalue()) == ''
write_res = p.write(b'foo ')
assert str(sio.getvalue()) == 'foo \n'
assert write_res == 4
p.flush()
p.close()
assert not p.isatty()
with conftest.stdouts() as (stdout, stderr):
with in_sighandler():
p.write(b'foo')
assert stderr.getvalue()
def test_logging_proxy_recurse_protection(self, restore_logging):
logger = self.setup_logger(loglevel=logging.ERROR, logfile=None,
root=False)
p = LoggingProxy(logger, loglevel=logging.ERROR)
p._thread.recurse_protection = True
try:
assert p.write('FOOFO') == 0
finally:
p._thread.recurse_protection = False
class test_task_logger(test_default_logger):
def setup_method(self):
logger = self.logger = get_logger('celery.task')
logger.handlers = []
logging.root.manager.loggerDict.pop(logger.name, None)
self.uid = uuid()
@self.app.task(shared=False)
def test_task():
pass
self.get_logger().handlers = []
self.task = test_task
from celery._state import _task_stack
_task_stack.push(test_task)
def teardown_method(self):
from celery._state import _task_stack
_task_stack.pop()
def setup_logger(self, *args, **kwargs):
return self.app.log.setup_task_loggers(*args, **kwargs)
def get_logger(self, *args, **kwargs):
return get_task_logger('test_task_logger')
def test_renaming_base_logger(self):
with pytest.raises(RuntimeError):
get_task_logger('celery')
def test_renaming_task_logger(self):
with pytest.raises(RuntimeError):
get_task_logger('celery.task')
class MockLogger(logging.Logger):
_records = None
def __init__(self, *args, **kwargs):
self._records = []
super().__init__(*args, **kwargs)
def handle(self, record):
self._records.append(record)
def isEnabledFor(self, level):
return True
|