# 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 .console import ConsoleOutput
from .filelogger import FileLogger
from .loggerhelper import AbstractLogger
from .stdoutlogsplitter import StdoutLogSplitter
[docs]
def start_body_item(method):
def wrapper(self, *args):
# TODO: Could _prev_log_message_handlers be used also here?
self._started_keywords += 1
self.log_message = self._log_message
method(self, *args)
return wrapper
[docs]
def end_body_item(method):
def wrapper(self, *args):
self._started_keywords -= 1
method(self, *args)
if not self._started_keywords:
self.log_message = self.message
return wrapper
[docs]
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()
[docs]
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):
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)
[docs]
def unregister_console_logger(self):
self._console_logger = None
[docs]
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)
[docs]
def register_xml_logger(self, logger):
self._xml_logger = self._wrap_and_relay(logger)
[docs]
def unregister_xml_logger(self):
self._xml_logger = None
[docs]
def register_listeners(self, listeners, library_listeners):
self._listeners = listeners
self._library_listeners = library_listeners
if listeners:
self._relay_cached_messages(listeners)
[docs]
def register_logger(self, *loggers):
for logger in loggers:
logger = self._wrap_and_relay(logger)
self._other_loggers.append(logger)
[docs]
def unregister_logger(self, *loggers):
for logger in loggers:
self._other_loggers = [l for l in self._other_loggers if l is not logger]
[docs]
def disable_message_cache(self):
self._message_cache = None
[docs]
def register_error_listener(self, listener):
self._error_listener = listener
if self._error_occurred:
listener()
[docs]
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
[docs]
def log_output(self, output):
for msg in StdoutLogSplitter(output):
self.log_message(msg)
[docs]
def enable_library_import_logging(self):
self._prev_log_message_handlers.append(self.log_message)
self.log_message = self.message
[docs]
def disable_library_import_logging(self):
self.log_message = self._prev_log_message_handlers.pop()
[docs]
def start_suite(self, data, result):
for logger in self.start_loggers:
logger.start_suite(data, result)
[docs]
def end_suite(self, data, result):
for logger in self.end_loggers:
logger.end_suite(data, result)
[docs]
def start_test(self, data, result):
for logger in self.start_loggers:
logger.start_test(data, result)
[docs]
def end_test(self, data, result):
for logger in self.end_loggers:
logger.end_test(data, result)
[docs]
@start_body_item
def start_keyword(self, data, result):
for logger in self.start_loggers:
logger.start_keyword(data, result)
[docs]
@end_body_item
def end_keyword(self, data, result):
for logger in self.end_loggers:
logger.end_keyword(data, result)
[docs]
@start_body_item
def start_user_keyword(self, data, implementation, result):
for logger in self.start_loggers:
logger.start_user_keyword(data, implementation, result)
[docs]
@end_body_item
def end_user_keyword(self, data, implementation, result):
for logger in self.end_loggers:
logger.end_user_keyword(data, implementation, result)
[docs]
@start_body_item
def start_library_keyword(self, data, implementation, result):
for logger in self.start_loggers:
logger.start_library_keyword(data, implementation, result)
[docs]
@end_body_item
def end_library_keyword(self, data, implementation, result):
for logger in self.end_loggers:
logger.end_library_keyword(data, implementation, result)
[docs]
@start_body_item
def start_invalid_keyword(self, data, implementation, result):
for logger in self.start_loggers:
logger.start_invalid_keyword(data, implementation, result)
[docs]
@end_body_item
def end_invalid_keyword(self, data, implementation, result):
for logger in self.end_loggers:
logger.end_invalid_keyword(data, implementation, result)
[docs]
@start_body_item
def start_for(self, data, result):
for logger in self.start_loggers:
logger.start_for(data, result)
[docs]
@end_body_item
def end_for(self, data, result):
for logger in self.end_loggers:
logger.end_for(data, result)
[docs]
@start_body_item
def start_for_iteration(self, data, result):
for logger in self.start_loggers:
logger.start_for_iteration(data, result)
[docs]
@end_body_item
def end_for_iteration(self, data, result):
for logger in self.end_loggers:
logger.end_for_iteration(data, result)
[docs]
@start_body_item
def start_while(self, data, result):
for logger in self.start_loggers:
logger.start_while(data, result)
[docs]
@end_body_item
def end_while(self, data, result):
for logger in self.end_loggers:
logger.end_while(data, result)
[docs]
@start_body_item
def start_while_iteration(self, data, result):
for logger in self.start_loggers:
logger.start_while_iteration(data, result)
[docs]
@end_body_item
def end_while_iteration(self, data, result):
for logger in self.end_loggers:
logger.end_while_iteration(data, result)
[docs]
@start_body_item
def start_if(self, data, result):
for logger in self.start_loggers:
logger.start_if(data, result)
[docs]
@end_body_item
def end_if(self, data, result):
for logger in self.end_loggers:
logger.end_if(data, result)
[docs]
@start_body_item
def start_if_branch(self, data, result):
for logger in self.start_loggers:
logger.start_if_branch(data, result)
[docs]
@end_body_item
def end_if_branch(self, data, result):
for logger in self.end_loggers:
logger.end_if_branch(data, result)
[docs]
@start_body_item
def start_try(self, data, result):
for logger in self.start_loggers:
logger.start_try(data, result)
[docs]
@end_body_item
def end_try(self, data, result):
for logger in self.end_loggers:
logger.end_try(data, result)
[docs]
@start_body_item
def start_try_branch(self, data, result):
for logger in self.start_loggers:
logger.start_try_branch(data, result)
[docs]
@end_body_item
def end_try_branch(self, data, result):
for logger in self.end_loggers:
logger.end_try_branch(data, result)
[docs]
@start_body_item
def start_var(self, data, result):
for logger in self.start_loggers:
logger.start_var(data, result)
[docs]
@end_body_item
def end_var(self, data, result):
for logger in self.end_loggers:
logger.end_var(data, result)
[docs]
@start_body_item
def start_break(self, data, result):
for logger in self.start_loggers:
logger.start_break(data, result)
[docs]
@end_body_item
def end_break(self, data, result):
for logger in self.end_loggers:
logger.end_break(data, result)
[docs]
@start_body_item
def start_continue(self, data, result):
for logger in self.start_loggers:
logger.start_continue(data, result)
[docs]
@end_body_item
def end_continue(self, data, result):
for logger in self.end_loggers:
logger.end_continue(data, result)
[docs]
@start_body_item
def start_return(self, data, result):
for logger in self.start_loggers:
logger.start_return(data, result)
[docs]
@end_body_item
def end_return(self, data, result):
for logger in self.end_loggers:
logger.end_return(data, result)
[docs]
@start_body_item
def start_error(self, data, result):
for logger in self.start_loggers:
logger.start_error(data, result)
[docs]
@end_body_item
def end_error(self, data, result):
for logger in self.end_loggers:
logger.end_error(data, result)
[docs]
def imported(self, import_type, name, **attrs):
for logger in self:
logger.imported(import_type, name, attrs)
[docs]
def output_file(self, path):
for logger in self:
logger.output_file(path)
[docs]
def report_file(self, path):
for logger in self:
logger.report_file(path)
[docs]
def log_file(self, path):
for logger in self:
logger.log_file(path)
[docs]
def xunit_file(self, path):
for logger in self:
logger.xunit_file(path)
[docs]
def debug_file(self, path):
for logger in self:
logger.debug_file(path)
[docs]
def result_file(self, kind, path):
kind_file = getattr(self, f'{kind.lower()}_file')
kind_file(path)
[docs]
def close(self):
for logger in self:
logger.close()
self.__init__(register_console_logger=False)
LOGGER = Logger()