listeners.py

Go to the documentation of this file.

#  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.
 
import os.path
 
from robot.errors import DataError
from robot.utils import Importer, is_string, split_args_from_name_or_path, type_name
 
from .listenermethods import ListenerMethods, LibraryListenerMethods
from .loggerhelper import AbstractLoggerProxy, IsLogged
from .logger import LOGGER
 
 
class Listeners:
    
    _method_names = ('start_suite', 'end_suite', 'start_test', 'end_test',
                     'start_keyword', 'end_keyword', 'log_message', 'message',
                     'output_file', 'report_file', 'log_file', 'debug_file',
                     'xunit_file', 'library_import', 'resource_import',
                     'variables_import', 'close')
 
    def __init__(self, listeners, log_level='INFO'):
        self._is_logged_is_logged = IsLogged(log_level)
        listeners = ListenerProxy.import_listeners(listeners,
                                                   self._method_names_method_names)
        for name in self._method_names_method_names:
            method = ListenerMethods(name, listeners)
            if name.endswith(('_keyword', '_file', '_import', 'log_message')):
                name = '_' + name
            setattr(self, name, method)
 
    def set_log_level(self, level):
        self._is_logged_is_logged.set_level(level)
 
    def start_keyword(self, kw):
        if kw.type not in (kw.IF_ELSE_ROOT, kw.TRY_EXCEPT_ROOT):
            self._start_keyword(kw)
 
    def end_keyword(self, kw):
        if kw.type not in (kw.IF_ELSE_ROOT, kw.TRY_EXCEPT_ROOT):
            self._end_keyword(kw)
 
    def log_message(self, msg):
        if self._is_logged_is_logged(msg.level):
            self._log_message(msg)
 
    def imported(self, import_type, name, attrs):
        method = getattr(self, '_%s_import' % import_type.lower())
        method(name, attrs)
 
    def output_file(self, file_type, path):
        method = getattr(self, '_%s_file' % file_type.lower())
        method(path)
 
    def __bool__(self):
        return any(isinstance(method, ListenerMethods) and method
                   for method in self.__dict__.values())
 
 
class LibraryListeners:
    
    _method_names = ('start_suite', 'end_suite', 'start_test', 'end_test',
                     'start_keyword', 'end_keyword', 'log_message', 'message',
                     'close')
 
    def __init__(self, log_level='INFO'):
        self._is_logged_is_logged = IsLogged(log_level)
        for name in self._method_names_method_names:
            method = LibraryListenerMethods(name)
            if name == 'log_message':
                name = '_' + name
            setattr(self, name, method)
 
    def register(self, listeners, library):
        listeners = ListenerProxy.import_listeners(listeners,
                                                   self._method_names_method_names,
                                                   prefix='_',
                                                   raise_on_error=True)
        for method in self._listener_methods_listener_methods():
            method.register(listeners, library)
 
    def _listener_methods(self):
        return [method for method in self.__dict__.values()
                if isinstance(method, LibraryListenerMethods)]
 
    def unregister(self, library, close=False):
        if close:
            self.close(library=library)
        for method in self._listener_methods_listener_methods():
            method.unregister(library)
 
    def new_suite_scope(self):
        for method in self._listener_methods_listener_methods():
            method.new_suite_scope()
 
    def discard_suite_scope(self):
        for method in self._listener_methods_listener_methods():
            method.discard_suite_scope()
 
    def set_log_level(self, level):
        self._is_logged_is_logged.set_level(level)
 
    def log_message(self, msg):
        if self._is_logged_is_logged(msg.level):
            self._log_message(msg)
 
    def imported(self, import_type, name, attrs):
        pass
 
    def output_file(self, file_type, path):
        pass
 
 
class ListenerProxy(AbstractLoggerProxy):
    
    _no_method = None
 
    def __init__(self, listener, method_names, prefix=None):
        listener, name = self._import_listener_import_listener(listener)
        AbstractLoggerProxy.__init__(self, listener, method_names, prefix)
        self.namename = name
        self.versionversion = self._get_version_get_version(listener)
        if self.versionversion == 3:
            self.start_keywordstart_keyword = self.end_keywordend_keyword = None
            self.library_importlibrary_import = self.resource_importresource_import = self.variables_importvariables_import = None
 
    def _import_listener(self, listener):
        if not is_string(listener):
            # Modules have `__name__`, with others better to use `type_name`.
            name = getattr(listener, '__name__', None) or type_name(listener)
            return listener, name
        name, args = split_args_from_name_or_path(listener)
        importer = Importer('listener', logger=LOGGER)
        listener = importer.import_class_or_module(os.path.normpath(name),
                                                   instantiate_with_args=args)
        return listener, name
 
    def _get_version(self, listener):
        try:
            version = int(listener.ROBOT_LISTENER_API_VERSION)
            if version not in (2, 3):
                raise ValueError
        except AttributeError:
            raise DataError("Listener '%s' does not have mandatory "
                            "'ROBOT_LISTENER_API_VERSION' attribute."
                            % self.namename)
        except (ValueError, TypeError):
            raise DataError("Listener '%s' uses unsupported API version '%s'."
                            % (self.namename, listener.ROBOT_LISTENER_API_VERSION))
        return version
 
    @classmethod
    def import_listeners(cls, listeners, method_names, prefix=None,
                         raise_on_error=False):
        imported = []
        for listener in listeners:
            try:
                imported.append(cls(listener, method_names, prefix))
            except DataError as err:
                name = listener if is_string(listener) else type_name(listener)
                msg = "Taking listener '%s' into use failed: %s" % (name, err)
                if raise_on_error:
                    raise DataError(msg)
                LOGGER.error(msg)
        return imported