forked from robotframework/robotframework
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlogger.py
More file actions
283 lines (235 loc) · 9.23 KB
/
Copy pathlogger.py
File metadata and controls
283 lines (235 loc) · 9.23 KB
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
# Copyright 2008-2015 Nokia Networks
# Copyright 2016- Robot Framework Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from contextlib import contextmanager
import os
from robot.errors import DataError
from robot.result import For, If, IfBranch, ForIteration
from .console import ConsoleOutput
from .filelogger import FileLogger
from .loggerhelper import AbstractLogger, AbstractLoggerProxy
from .stdoutlogsplitter import StdoutLogSplitter
class Logger(AbstractLogger):
"""A global logger proxy to delegating messages to registered loggers.
Whenever something is written to LOGGER in code, all registered loggers are
notified. Messages are also cached and cached messages written to new
loggers when they are registered.
NOTE: This API is likely to change in future versions.
"""
def __init__(self, register_console_logger=True):
self._console_logger = None
self._syslog = None
self._xml_logger = None
self._listeners = None
self._library_listeners = None
self._other_loggers = []
self._message_cache = []
self._log_message_cache = None
self._started_keywords = 0
self._error_occurred = False
self._error_listener = None
self._prev_log_message_handlers = []
self._enabled = 0
self._cache_only = False
if register_console_logger:
self.register_console_logger()
@property
def start_loggers(self):
loggers = [self._console_logger, self._syslog, self._xml_logger,
self._listeners, self._library_listeners]
return [logger for logger in self._other_loggers + loggers if logger]
@property
def end_loggers(self):
loggers = [self._listeners, self._library_listeners,
self._console_logger, self._syslog, self._xml_logger]
return [logger for logger in loggers + self._other_loggers if logger]
def __iter__(self):
return iter(self.end_loggers)
def __enter__(self):
if not self._enabled:
self.register_syslog()
self._enabled += 1
def __exit__(self, *exc_info):
self._enabled -= 1
if not self._enabled:
self.close()
def register_console_logger(self, type='verbose', width=78, colors='AUTO',
markers='AUTO', stdout=None, stderr=None):
logger = ConsoleOutput(type, width, colors, markers, stdout, stderr)
self._console_logger = self._wrap_and_relay(logger)
def _wrap_and_relay(self, logger):
logger = LoggerProxy(logger)
self._relay_cached_messages(logger)
return logger
def _relay_cached_messages(self, logger):
if self._message_cache:
for msg in self._message_cache[:]:
logger.message(msg)
def unregister_console_logger(self):
self._console_logger = None
def register_syslog(self, path=None, level='INFO'):
if not path:
path = os.environ.get('ROBOT_SYSLOG_FILE', 'NONE')
level = os.environ.get('ROBOT_SYSLOG_LEVEL', level)
if path.upper() == 'NONE':
return
try:
syslog = FileLogger(path, level)
except DataError as err:
self.error("Opening syslog file '%s' failed: %s" % (path, err.message))
else:
self._syslog = self._wrap_and_relay(syslog)
def register_xml_logger(self, logger):
self._xml_logger = self._wrap_and_relay(logger)
def unregister_xml_logger(self):
self._xml_logger = None
def register_listeners(self, listeners, library_listeners):
self._listeners = listeners
self._library_listeners = library_listeners
if listeners:
self._relay_cached_messages(listeners)
def register_logger(self, *loggers):
for logger in loggers:
logger = self._wrap_and_relay(logger)
self._other_loggers.append(logger)
def unregister_logger(self, *loggers):
for logger in loggers:
self._other_loggers = [proxy for proxy in self._other_loggers
if proxy.logger is not logger]
def disable_message_cache(self):
self._message_cache = None
def register_error_listener(self, listener):
self._error_listener = listener
if self._error_occurred:
listener()
def message(self, msg):
"""Messages about what the framework is doing, warnings, errors, ..."""
if not self._cache_only:
for logger in self:
logger.message(msg)
if self._message_cache is not None:
self._message_cache.append(msg)
if msg.level == 'ERROR':
self._error_occurred = True
if self._error_listener:
self._error_listener()
@property
@contextmanager
def cache_only(self):
self._cache_only = True
try:
yield
finally:
self._cache_only = False
@property
@contextmanager
def delayed_logging(self):
prev_cache = self._log_message_cache
self._log_message_cache = []
try:
yield
finally:
messages = self._log_message_cache
self._log_message_cache = prev_cache
for msg in messages or ():
self._log_message(msg, no_cache=True)
def _log_message(self, msg, no_cache=False):
"""Log messages written (mainly) by libraries."""
if self._log_message_cache is not None and not no_cache:
msg.resolve_delayed_message()
self._log_message_cache.append(msg)
return
for logger in self:
logger.log_message(msg)
if msg.level in ('WARN', 'ERROR'):
self.message(msg)
log_message = message
def log_output(self, output):
for msg in StdoutLogSplitter(output):
self.log_message(msg)
def enable_library_import_logging(self):
self._prev_log_message_handlers.append(self.log_message)
self.log_message = self.message
def disable_library_import_logging(self):
self.log_message = self._prev_log_message_handlers.pop()
def start_suite(self, suite):
for logger in self.start_loggers:
logger.start_suite(suite)
def end_suite(self, suite):
for logger in self.end_loggers:
logger.end_suite(suite)
def start_test(self, test):
for logger in self.start_loggers:
logger.start_test(test)
def end_test(self, test):
for logger in self.end_loggers:
logger.end_test(test)
def start_keyword(self, keyword):
# TODO: Could _prev_log_message_handlers be used also here?
self._started_keywords += 1
self.log_message = self._log_message
for logger in self.start_loggers:
logger.start_keyword(keyword)
def end_keyword(self, keyword):
self._started_keywords -= 1
for logger in self.end_loggers:
logger.end_keyword(keyword)
if not self._started_keywords:
self.log_message = self.message
def imported(self, import_type, name, **attrs):
for logger in self:
logger.imported(import_type, name, attrs)
def output_file(self, file_type, path):
"""Finished output, report, log, debug, or xunit file"""
for logger in self:
logger.output_file(file_type, path)
def close(self):
for logger in self:
logger.close()
self.__init__(register_console_logger=False)
class LoggerProxy(AbstractLoggerProxy):
_methods = ('start_suite', 'end_suite', 'start_test', 'end_test',
'start_keyword', 'end_keyword', 'message', 'log_message',
'imported', 'output_file', 'close')
_start_keyword_methods = {
'IF/ELSE ROOT': 'start_if',
'IF': 'start_if_branch',
'ELSE IF': 'start_if_branch',
'ELSE': 'start_if_branch',
'FOR': 'start_for',
'FOR ITERATION': 'start_for_iteration'
}
_end_keyword_methods = {
'IF/ELSE ROOT': 'end_if',
'IF': 'end_if_branch',
'ELSE IF': 'end_if_branch',
'ELSE': 'end_if_branch',
'FOR': 'end_for',
'FOR ITERATION': 'end_for_iteration'
}
def start_keyword(self, kw):
name = self._start_keyword_methods.get(kw.type)
if name and hasattr(self.logger, name):
method = getattr(self.logger, name)
else:
method = self.logger.start_keyword
method(kw)
def end_keyword(self, kw):
name = self._end_keyword_methods.get(kw.type)
if name and hasattr(self.logger, name):
method = getattr(self.logger, name)
else:
method = self.logger.end_keyword
method(kw)
LOGGER = Logger()