pluginconnector.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.
 
from .. import utils
from ..context import LOG
 
 
def PluginFactory(application, plugin_class):
    try:
        plugin = plugin_class(application)
    except Exception:
        msg, traceback = utils.get_error_details()
        return BrokenPlugin(msg, traceback, plugin_class)
    else:
        return PluginConnector(plugin, application)
 
 
class _PluginConnector():
 
    def __init__(self, name, doc='', error=None):
        self.namename = name
        self.docdoc = doc
        self.errorerror = error
        self.enabledenabled = False
        self.metadatametadata = {}
        self.config_panelconfig_panel = lambda self: None
 
 
class PluginConnector(_PluginConnector):
 
    def __init__(self, plugin, application):
        _PluginConnector.__init__(self, plugin.name, plugin.doc)
        self._plugin_plugin = plugin
        self._settings_settings = application.settings['Plugins'].add_section(plugin.name)
        self.config_panelconfig_panelconfig_panel = plugin.config_panel
        self.metadatametadatametadata = plugin.metadata
 
    def enable_on_startup(self):
        if self._settings_settings.get('_enabled', self._plugin_plugin.initially_enabled):
            self.enableenable()
 
    def enable(self):
        self._settings_settings.set('_enabled', True)
        self.enabledenabledenabled = True
        self._plugin_plugin.enable()
 
    def disable(self):
        if self.enabledenabledenabled:
            self._settings_settings.set('_enabled', False)
            self.enabledenabledenabled = False
            self._plugin_plugin.disable()
 
 
class BrokenPlugin(_PluginConnector):
 
    def __init__(self, error_msg, traceback, plugin_class):
        name = utils.name_from_class(plugin_class, 'Plugin')
        doc = 'This plugin is disabled because it failed to load properly.\n' \
               + 'Error: ' + error_msg + '\n' + traceback
        _PluginConnector.__init__(self, name, doc=doc, error=error_msg)
        LOG.error("Taking %s plugin into use failed:\n%s" % (name, error_msg))
 
    def enable_on_startup(self):
        pass