File size: 7,858 Bytes
09a3fa9 | 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 | # Copyright (c) OpenMMLab. All rights reserved.
import logging
import os
import re
import sys
from collections import OrderedDict
from unittest.mock import patch
import pytest
from mmengine.logging import MMLogger, print_log
class TestLogger:
stream_handler_regex_time = r'\d{2}/\d{2} \d{2}:\d{2}:\d{2}'
file_handler_regex_time = r'\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2}'
@patch('mmengine.logging.logger._get_rank', lambda: 0)
def test_init_rank0(self, tmp_path):
logger = MMLogger.get_instance('rank0.pkg1', log_level='INFO')
assert logger.name == 'mmengine'
assert logger.instance_name == 'rank0.pkg1'
assert logger.instance_name == 'rank0.pkg1'
# Logger get from `MMLogger.get_instance` does not inherit from
# `logging.root`
assert logger.parent is None
assert len(logger.handlers) == 1
assert isinstance(logger.handlers[0], logging.StreamHandler)
assert logger.level == logging.NOTSET
assert logger.handlers[0].level == logging.INFO
# If `rank=0`, the `log_level` of stream_handler and file_handler
# depends on the given arguments.
tmp_file = tmp_path / 'tmp_file.log'
logger = MMLogger.get_instance(
'rank0.pkg2', log_level='INFO', log_file=str(tmp_file))
assert isinstance(logger, logging.Logger)
assert len(logger.handlers) == 2
assert isinstance(logger.handlers[0], logging.StreamHandler)
assert isinstance(logger.handlers[1], logging.FileHandler)
logger_pkg3 = MMLogger.get_instance('rank0.pkg2')
assert id(logger_pkg3) == id(logger)
logger = MMLogger.get_instance(
'rank0.pkg3', logger_name='logger_test', log_level='INFO')
assert logger.name == 'logger_test'
assert logger.instance_name == 'rank0.pkg3'
# `FileHandler` should be closed in Windows, otherwise we cannot
# delete the temporary directory
logging.shutdown()
MMLogger._instance_dict.clear()
@patch('mmengine.logging.logger._get_rank', lambda: 1)
def test_init_rank1(self, tmp_path):
# If `rank!=1`, the `loglevel` of file_handler is `logging.ERROR`.
tmp_file = tmp_path / 'tmp_file.log'
log_path = tmp_path / 'tmp_file_rank1.log'
logger = MMLogger.get_instance(
'rank1.pkg2', log_level='INFO', log_file=str(tmp_file))
assert len(logger.handlers) == 1
logger = MMLogger.get_instance(
'rank1.pkg3',
log_level='INFO',
log_file=str(tmp_file),
distributed=True)
assert logger.handlers[0].level == logging.ERROR
assert logger.handlers[1].level == logging.INFO
assert len(logger.handlers) == 2
assert os.path.exists(log_path)
# `FileHandler` should be closed in Windows, otherwise we cannot
# delete the temporary directory
logging.shutdown()
MMLogger._instance_dict.clear()
@pytest.mark.parametrize('log_level',
[logging.WARNING, logging.INFO, logging.DEBUG])
def test_handler(self, capsys, tmp_path, log_level):
# test stream handler can output correct format logs
instance_name = f'test_stream_{str(log_level)}'
logger = MMLogger.get_instance(instance_name, log_level=log_level)
logger.log(level=log_level, msg='welcome')
out, _ = capsys.readouterr()
# Skip match colored INFO
loglevl_name = logging._levelToName[log_level]
match = re.fullmatch(
self.stream_handler_regex_time + f' - mmengine - '
f'(.*){loglevl_name}(.*) - welcome\n', out)
assert match is not None
# test file_handler output plain text without color.
tmp_file = tmp_path / 'tmp_file.log'
instance_name = f'test_file_{log_level}'
logger = MMLogger.get_instance(
instance_name, log_level=log_level, log_file=tmp_file)
logger.log(level=log_level, msg='welcome')
with open(tmp_path / 'tmp_file.log') as f:
log_text = f.read()
match = re.fullmatch(
self.file_handler_regex_time +
f' - mmengine - {loglevl_name} - '
f'welcome\n', log_text)
assert match is not None
# `FileHandler` should be closed in Windows, otherwise we cannot
# delete the temporary directory
logging.shutdown()
MMLogger._instance_dict.clear()
def test_error_format(self, capsys):
# test error level log can output file path, function name and
# line number
logger = MMLogger.get_instance('test_error', log_level='INFO')
logger.error('welcome')
lineno = sys._getframe().f_lineno - 1
# replace \ for windows:
# origin: c:\\a\\b\\c.py
# replaced: c:\\\\a\\\\b\\\\c.py for re.match.
file_path = __file__.replace('\\', '\\\\')
function_name = sys._getframe().f_code.co_name
pattern = self.stream_handler_regex_time + \
r' - mmengine - (.*)ERROR(.*) - ' \
f'{file_path} - {function_name} - ' \
f'{lineno} - welcome\n'
out, _ = capsys.readouterr()
match = re.fullmatch(pattern, out)
assert match is not None
def test_print_log(self, capsys, tmp_path):
# caplog cannot record MMLogger's logs.
# Test simple print.
print_log('welcome', logger=None)
out, _ = capsys.readouterr()
assert out == 'welcome\n'
# Test silent logger and skip print.
print_log('welcome', logger='silent')
out, _ = capsys.readouterr()
assert out == ''
logger = MMLogger.get_instance('test_print_log')
# Test using specified logger
print_log('welcome', logger=logger)
out, _ = capsys.readouterr()
match = re.fullmatch(
self.stream_handler_regex_time + ' - mmengine - (.*)INFO(.*) - '
'welcome\n', out)
assert match is not None
# Test access logger by name.
print_log('welcome', logger='test_print_log')
out, _ = capsys.readouterr()
match = re.fullmatch(
self.stream_handler_regex_time + ' - mmengine - (.*)INFO(.*) - '
'welcome\n', out)
assert match is not None
# Test access the latest created logger.
print_log('welcome', logger='current')
out, _ = capsys.readouterr()
match = re.fullmatch(
self.stream_handler_regex_time + ' - mmengine - (.*)INFO(.*) - '
'welcome\n', out)
assert match is not None
# Test invalid logger type.
with pytest.raises(TypeError):
print_log('welcome', logger=dict)
with pytest.raises(ValueError):
print_log('welcome', logger='unknown')
def test_get_instance(self):
# Test get root mmengine logger.
MMLogger._instance_dict = OrderedDict()
root_logger = MMLogger.get_current_instance()
mmdet_logger = MMLogger.get_instance('mmdet')
assert root_logger.name == mmdet_logger.name
assert id(root_logger) != id(mmdet_logger)
assert id(MMLogger.get_instance('mmengine')) == id(root_logger)
# Test original `get_current_instance` function.
MMLogger.get_instance('mmdet')
assert MMLogger.get_current_instance().instance_name == 'mmdet'
def test_set_level(self, capsys):
logger = MMLogger.get_instance('test_set_level')
logger.info('hello')
out, _ = capsys.readouterr()
assert 'INFO' in out
logger.setLevel('WARNING')
logger.info('hello')
out, _ = capsys.readouterr()
assert not out
logger.warning('hello')
out, _ = capsys.readouterr()
assert 'WARNING' in out
|