forked from dask/distributed
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_config.py
269 lines (218 loc) · 7.66 KB
/
test_config.py
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
from __future__ import print_function, division, absolute_import
import logging
import subprocess
import sys
import tempfile
import os
import pytest
from distributed.utils_test import (
captured_handler,
captured_logger,
new_config,
new_config_file,
)
from distributed.config import initialize_logging
def dump_logger_list():
root = logging.getLogger()
loggers = root.manager.loggerDict
print()
print("== Loggers (name, level, effective level, propagate) ==")
def logger_info(name, logger):
return (
name,
logging.getLevelName(logger.level),
logging.getLevelName(logger.getEffectiveLevel()),
logger.propagate,
)
infos = []
infos.append(logger_info("<root>", root))
for name, logger in sorted(loggers.items()):
if not isinstance(logger, logging.Logger):
# Skip 'PlaceHolder' objects
continue
assert logger.name == name
infos.append(logger_info(name, logger))
for info in infos:
print("%-40s %-8s %-8s %-5s" % info)
print()
def test_logging_default():
"""
Test default logging configuration.
"""
d = logging.getLogger("distributed")
assert len(d.handlers) == 1
assert isinstance(d.handlers[0], logging.StreamHandler)
# Work around Bokeh messing with the root logger level
# https://github.com/bokeh/bokeh/issues/5793
root = logging.getLogger("")
old_root_level = root.level
root.setLevel("WARN")
for handler in d.handlers:
handler.setLevel("INFO")
try:
dfb = logging.getLogger("distributed.foo.bar")
f = logging.getLogger("foo")
fb = logging.getLogger("foo.bar")
with captured_handler(d.handlers[0]) as distributed_log:
with captured_logger(root, level=logging.ERROR) as foreign_log:
h = logging.StreamHandler(foreign_log)
fmt = "[%(levelname)s in %(name)s] - %(message)s"
h.setFormatter(logging.Formatter(fmt))
fb.addHandler(h)
fb.propagate = False
# For debugging
dump_logger_list()
d.debug("1: debug")
d.info("2: info")
dfb.info("3: info")
fb.info("4: info")
fb.error("5: error")
f.info("6: info")
f.error("7: error")
distributed_log = distributed_log.getvalue().splitlines()
foreign_log = foreign_log.getvalue().splitlines()
# distributed log is configured at INFO level by default
assert distributed_log == [
"distributed - INFO - 2: info",
"distributed.foo.bar - INFO - 3: info",
]
# foreign logs should be unaffected by distributed's logging
# configuration. They get the default ERROR level from logging.
assert foreign_log == ["[ERROR in foo.bar] - 5: error", "7: error"]
finally:
root.setLevel(old_root_level)
def test_logging_empty_simple():
with new_config({}):
test_logging_default()
def test_logging_simple():
"""
Test simple ("old-style") logging configuration.
"""
c = {"logging": {"distributed.foo": "info", "distributed.foo.bar": "error"}}
# Must test using a subprocess to avoid wrecking pre-existing configuration
with new_config_file(c):
code = """if 1:
import logging
import dask
from distributed.utils_test import captured_handler
d = logging.getLogger('distributed')
assert len(d.handlers) == 1
assert isinstance(d.handlers[0], logging.StreamHandler)
df = logging.getLogger('distributed.foo')
dfb = logging.getLogger('distributed.foo.bar')
with captured_handler(d.handlers[0]) as distributed_log:
df.info("1: info")
dfb.warning("2: warning")
dfb.error("3: error")
distributed_log = distributed_log.getvalue().splitlines()
assert distributed_log == [
"distributed.foo - INFO - 1: info",
"distributed.foo.bar - ERROR - 3: error",
], (dask.config.config, distributed_log)
"""
subprocess.check_call([sys.executable, "-c", code])
def test_logging_extended():
"""
Test extended ("new-style") logging configuration.
"""
c = {
"logging": {
"version": "1",
"formatters": {
"simple": {"format": "%(levelname)s: %(name)s: %(message)s"}
},
"handlers": {
"console": {
"class": "logging.StreamHandler",
"stream": "ext://sys.stderr",
"formatter": "simple",
}
},
"loggers": {
"distributed.foo": {
"level": "INFO",
#'handlers': ['console'],
},
"distributed.foo.bar": {
"level": "ERROR",
#'handlers': ['console'],
},
},
"root": {"level": "WARNING", "handlers": ["console"]},
}
}
# Must test using a subprocess to avoid wrecking pre-existing configuration
with new_config_file(c):
code = """if 1:
import logging
from distributed.utils_test import captured_handler
root = logging.getLogger()
d = logging.getLogger('distributed')
df = logging.getLogger('distributed.foo')
dfb = logging.getLogger('distributed.foo.bar')
with captured_handler(root.handlers[0]) as root_log:
df.info("1: info")
dfb.warning("2: warning")
dfb.error("3: error")
d.info("4: info")
d.warning("5: warning")
root_log = root_log.getvalue().splitlines()
print(root_log)
assert root_log == [
"INFO: distributed.foo: 1: info",
"ERROR: distributed.foo.bar: 3: error",
"WARNING: distributed: 5: warning",
]
"""
subprocess.check_call([sys.executable, "-c", code])
def test_logging_mutual_exclusive():
"""
Ensure that 'logging-file-config' and 'logging' have to be mutual exclusive.
"""
config = {"logging": {"dask": "warning"}, "logging-file-config": "/path/to/config"}
with pytest.raises(RuntimeError):
initialize_logging(config)
def test_logging_file_config():
"""
Test `logging-file-config` logging configuration
"""
logging_config_contents = """
[handlers]
keys=console
[formatters]
keys=simple
[loggers]
keys=root, foo, foo_bar
[handler_console]
class=StreamHandler
level=INFO
formatter=simple
args=(sys.stdout,)
[formatter_simple]
format=%(levelname)s: %(name)s: %(message)s
[logger_root]
level=WARNING
handlers=console
[logger_foo]
level=INFO
handlers=console
qualname=foo
[logger_foo_bar]
level=ERROR
handlers=console
qualname=foo.bar
"""
with tempfile.NamedTemporaryFile(mode="w", delete=False) as logging_config:
logging_config.write(logging_config_contents)
dask_config = {"logging-file-config": logging_config.name}
with new_config_file(dask_config):
code = """if 1:
import logging
from distributed import config
foo = logging.getLogger('foo')
bar = logging.getLogger('foo.bar')
assert logging.INFO == foo.getEffectiveLevel()
assert logging.ERROR == bar.getEffectiveLevel()
"""
subprocess.check_call([sys.executable, "-c", code])
os.remove(logging_config.name)