From nobody Mon Dec 9 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of ovirt.org designates 66.187.230.42 as permitted sender) client-ip=66.187.230.42; envelope-from=kimchi-devel-bounces@ovirt.org; helo=lists.ovirt.org; Authentication-Results: mx.zoho.com; spf=pass (zoho.com: domain of ovirt.org designates 66.187.230.42 as permitted sender) smtp.mailfrom=kimchi-devel-bounces@ovirt.org; Return-Path: Received: from lists.ovirt.org (lists.phx.ovirt.org [66.187.230.42]) by mx.zohomail.com with SMTPS id 1485950678935125.45475788139674; Wed, 1 Feb 2017 04:04:38 -0800 (PST) Received: from lists.phx.ovirt.org (localhost [127.0.0.1]) by lists.ovirt.org (Postfix) with ESMTP id 211D98205F7; Wed, 1 Feb 2017 12:04:36 +0000 (UTC) Received: from mail-qt0-f175.google.com (mail-qt0-f175.google.com [209.85.216.175]) by lists.ovirt.org (Postfix) with ESMTPS id 393958205C6 for ; Wed, 1 Feb 2017 12:03:53 +0000 (UTC) Received: by mail-qt0-f175.google.com with SMTP id x49so260533358qtc.2 for ; Wed, 01 Feb 2017 04:03:53 -0800 (PST) Received: from arthas.ltc.br.ibm.com.com ([177.99.122.130]) by smtp.gmail.com with ESMTPSA id m30sm18461059qtg.10.2017.02.01.04.03.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 01 Feb 2017 04:03:51 -0800 (PST) X-Original-To: kimchi-devel@ovirt.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=gnaYOLa3AAWOWLtZK1n8I2dq7/sdGasSEbZlcD5c1oY=; b=Jb0Wfm7au46ojC6bxUXmxCLyx119yW/aGbx69O/ZO65gHeOgkQpr5BEM86h0VBbnKV pJ1HoK8BhbXDAAJphK9SioBu/DnPg7mLAyWkZ56R7awWQwOxiREehJOpdMpzXfG1nLnz kgaRpIv02LlHEACOid2Q7MZpa19ykdCi1RN+BWwCbngjW3siNpHU5OjvzGHVTh1l95LX 8gHacV5zFO8b3gko2Q5wavaSlF9ZuczL3PJwb2ZDW1MAERxPEmLt4bUa6slzvMofdoUU WNXQ2ViYTLtsIsCbqWJVHxCzNtng1y/rvwKRUksRSXy0CuEhqOFbm0vieh3u3dw5cXU+ pGMQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=gnaYOLa3AAWOWLtZK1n8I2dq7/sdGasSEbZlcD5c1oY=; b=AkFlTx4+6lxjNlS6/gdFETgu+ta4QTzS3D46VN1tqehm79DT2cnrq80eNmubdUDX/m blAzyqLlSIrysgNRNzwrlSVtNWri5AR7xdx2ep6rsQxviqsGPRUYSEiAMY4DIWqFDR6y AxD77UByLOp8FqFXVYpnindQoBaOh3qIE4JGjFBQPEz8KaSZ0MgPqGTYwY+EWfET4INK lqLCfgGsrf+mIZd5RbmvqkJvkwaL348/BODELF12VxjMHGOcOlOJQ/LvJqitJl6eAGup pHOLHwaqCQHNCmzW8hzvzkUeu+GRCSR+Q2zG66TII2RC6TI3EKz/lUHvva0rEVK3SQo0 i+PQ== X-Gm-Message-State: AIkVDXL3Yca83KzhXN7fyBIMY3TwYOjXRDYcw7J17SHLcQlyZkTH4Fa/9Vyww+GTGnR3Sg== X-Received: by 10.237.50.101 with SMTP id y92mr2482815qtd.179.1485950632123; Wed, 01 Feb 2017 04:03:52 -0800 (PST) From: To: Kimchi Devel Date: Wed, 1 Feb 2017 10:03:26 -0200 Message-Id: <20170201120327.477-2-dhbarboza82@gmail.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20170201120327.477-1-dhbarboza82@gmail.com> References: <20170201120327.477-1-dhbarboza82@gmail.com> Subject: [Kimchi-devel] [PATCH] [WoK 1/2] /config/plugins API: backend changes X-BeenThere: kimchi-devel@ovirt.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: kimchi-devel-bounces@ovirt.org Errors-To: kimchi-devel-bounces@ovirt.org X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" From: Daniel Henrique Barboza This patch adds a backend for a new API called /config/plugins. The idea is to be able to retrieve the 'enable' status of WoK plug-ins and also provide a way to enable/disable them. The enable|disable operation consists on two steps: - changing the 'enable=3D' attribute of the [WoK] section of the plugin .conf file; - the plug-in is removed/added in the cherrypy.tree on the fly. Several changes/enhancements in the backend were made to make this possible, such as: - added the 'test' parameter in the config.py.in file to make it available for reading in the backend. This parameter indicates whether WoK is running in test mode; - 'load_plugin' was moved from server.py to utils.py to make it available for utils functions to load plug-ins; - a new 'depends' attribute is now being considered in the root class of each plug-in. This is an array that indicates all the plug-ins it has a dependency on. For example, Kimchi would mark self.depends =3D ['gingerbase'] in its root file. The absence of this attribute means that the plug-in does not have any dependency aside from WoK. Previous /plugins API were removed because it was redundant with this work. Uni tests included. Signed-off-by: Daniel Henrique Barboza --- docs/API/config.md | 32 +++++++ docs/API/plugins.md | 13 --- src/wok/config.py.in | 5 +- src/wok/control/config.py | 31 ++++++- src/wok/control/plugins.py | 29 ------ src/wok/i18n.py | 4 + src/wok/model/plugins.py | 40 ++++++-- src/wok/server.py | 56 ++--------- src/wok/utils.py | 227 +++++++++++++++++++++++++++++++++++++++++= ++-- tests/test_api.py | 59 ++++++++++++ tests/test_utils.py | 75 ++++++++++++++- 11 files changed, 460 insertions(+), 111 deletions(-) delete mode 100644 docs/API/plugins.md delete mode 100644 src/wok/control/plugins.py diff --git a/docs/API/config.md b/docs/API/config.md index 4ba455e..87619ac 100644 --- a/docs/API/config.md +++ b/docs/API/config.md @@ -26,3 +26,35 @@ GET /config websockets_port: 64667, version: 2.0 } + +### Collection: Plugins + +**URI:** /config/plugins + +**Methods:** + +* **GET**: Retrieve a summarized list of all UI Plugins. + +#### Examples +GET /plugins +[{'name': 'pluginA', 'enabled': True, "depends":['pluginB'], "is_dependenc= y_of":[]}, + {'name': 'pluginB', 'enabled': False, "depends":[], "is_dependency_of":['= pluginA']}] + +### Resource: Plugins + +**URI:** /config/plugins/*:name* + +Represents the current state of a given WoK plug-in. + +**Methods:** + +* **GET**: Retrieve the state of the plug-in. + * name: The name of the plug-in. + * enabled: True if the plug-in is currently enabled in WoK, False othe= rwise. + +* **POST**: *See Plugin Actions* + +**Actions (POST):** + +* enable: Enable the plug-in in the configuration file. +* disable: Disable the plug-in in the configuration file. diff --git a/docs/API/plugins.md b/docs/API/plugins.md deleted file mode 100644 index aaa37b5..0000000 --- a/docs/API/plugins.md +++ /dev/null @@ -1,13 +0,0 @@ -## REST API Specification for Plugins - -### Collection: Plugins - -**URI:** /plugins - -**Methods:** - -* **GET**: Retrieve a summarized list names of all UI Plugins - -#### Examples -GET /plugins -[pluginA, pluginB, pluginC] diff --git a/src/wok/config.py.in b/src/wok/config.py.in index 9573e66..0e46b17 100644 --- a/src/wok/config.py.in +++ b/src/wok/config.py.in @@ -1,7 +1,7 @@ # # Project Wok # -# Copyright IBM Corp, 2015-2016 +# Copyright IBM Corp, 2015-2017 # # Code derived from Project Kimchi # @@ -269,6 +269,7 @@ def _get_config(): config.set("server", "environment", "production") config.set('server', 'max_body_size', '4*1024*1024') config.set("server", "server_root", "") + config.set("server", "test", "true") config.add_section("authentication") config.set("authentication", "method", "pam") config.set("authentication", "ldap_server", "") @@ -278,6 +279,8 @@ def _get_config(): config.add_section("logging") config.set("logging", "log_dir", paths.log_dir) config.set("logging", "log_level", DEFAULT_LOG_LEVEL) + config.set("logging", "access_log", "") + config.set("logging", "error_log", "") =20 config_file =3D os.path.join(paths.conf_dir, 'wok.conf') if os.path.exists(config_file): diff --git a/src/wok/control/config.py b/src/wok/control/config.py index 419abc0..05383c7 100644 --- a/src/wok/control/config.py +++ b/src/wok/control/config.py @@ -17,7 +17,7 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-130= 1 USA =20 -from wok.control.base import Resource +from wok.control.base import Collection, Resource from wok.control.utils import UrlSubNode =20 =20 @@ -28,15 +28,44 @@ CONFIG_REQUESTS =3D { } =20 =20 +PLUGIN_REQUESTS =3D { + 'POST': { + 'enable': "WOKPLUGIN0001L", + 'disable': "WOKPLUGIN0002L", + }, +} + + @UrlSubNode("config") class Config(Resource): def __init__(self, model, id=3DNone): super(Config, self).__init__(model, id) self.uri_fmt =3D '/config/%s' self.admin_methods =3D ['POST'] + self.plugins =3D Plugins(self.model) self.log_map =3D CONFIG_REQUESTS self.reload =3D self.generate_action_handler('reload') =20 @property def data(self): return self.info + + +class Plugins(Collection): + def __init__(self, model): + super(Plugins, self).__init__(model) + self.resource =3D Plugin + + +class Plugin(Resource): + def __init__(self, model, ident=3DNone): + super(Plugin, self).__init__(model, ident) + self.ident =3D ident + self.uri_fmt =3D "/config/plugins/%s" + self.log_map =3D PLUGIN_REQUESTS + self.enable =3D self.generate_action_handler('enable') + self.disable =3D self.generate_action_handler('disable') + + @property + def data(self): + return self.info diff --git a/src/wok/control/plugins.py b/src/wok/control/plugins.py deleted file mode 100644 index 57dfa1b..0000000 --- a/src/wok/control/plugins.py +++ /dev/null @@ -1,29 +0,0 @@ -# -# Project Wok -# -# Copyright IBM Corp, 2015-2016 -# -# Code derived from Project Kimchi -# -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation; either -# version 2.1 of the License, or (at your option) any later version. -# -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-130= 1 USA - -from wok.control.base import SimpleCollection -from wok.control.utils import UrlSubNode - - -@UrlSubNode("plugins") -class Plugins(SimpleCollection): - def __init__(self, model): - super(Plugins, self).__init__(model) diff --git a/src/wok/i18n.py b/src/wok/i18n.py index 935c9c1..d44c2f6 100644 --- a/src/wok/i18n.py +++ b/src/wok/i18n.py @@ -57,6 +57,8 @@ messages =3D { =20 "WOKCONFIG0001I": _("WoK is going to restart. Existing WoK connections= will be closed."), =20 + "WOKPLUGIN0001E": _("Unable to find plug-in %(name)s"), + # These messages (ending with L) are for user log purposes "WOKASYNC0001L": _("Successfully completed task '%(target_uri)s'"), "WOKASYNC0002L": _("Failed to complete task '%(target_uri)s'"), @@ -65,4 +67,6 @@ messages =3D { "WOKRES0001L": _("Request made on resource"), "WOKROOT0001L": _("User '%(username)s' login"), "WOKROOT0002L": _("User '%(username)s' logout"), + "WOKPLUGIN0001L": _("Enable plug-in %(ident)s."), + "WOKPLUGIN0002L": _("Disable plug-in %(ident)s."), } diff --git a/src/wok/model/plugins.py b/src/wok/model/plugins.py index 1b8ec5e..1b39e6c 100644 --- a/src/wok/model/plugins.py +++ b/src/wok/model/plugins.py @@ -1,7 +1,7 @@ # # Project Wok # -# Copyright IBM Corp, 2015-2016 +# Copyright IBM Corp, 2015-2017 # # Code derived from Project Kimchi # @@ -19,10 +19,11 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-130= 1 USA =20 -import cherrypy =20 -from wok.config import get_base_plugin_uri -from wok.utils import get_enabled_plugins +from wok.exception import NotFoundError +from wok.utils import get_all_affected_plugins_by_plugin +from wok.utils import get_plugin_dependencies, get_plugins, load_plugin_co= nf +from wok.utils import set_plugin_state =20 =20 class PluginsModel(object): @@ -30,7 +31,30 @@ class PluginsModel(object): pass =20 def get_list(self): - # Will only return plugins that were loaded correctly by WOK and a= re - # properly configured in cherrypy - return [plugin for (plugin, config) in get_enabled_plugins() - if get_base_plugin_uri(plugin) in cherrypy.tree.apps.keys(= )] + return [plugin for (plugin, config) in get_plugins()] + + +class PluginModel(object): + def __init__(self, **kargs): + pass + + def lookup(self, name): + name =3D name.encode('utf-8') + + plugin_conf =3D load_plugin_conf(name) + if not plugin_conf: + raise NotFoundError("WOKPLUGIN0001E", {'name': name}) + + depends =3D get_plugin_dependencies(name) + is_dependency_of =3D get_all_affected_plugins_by_plugin(name) + + return {"name": name, "enabled": plugin_conf['wok']['enable'], + "depends": depends, "is_dependency_of": is_dependency_of} + + def enable(self, name): + name =3D name.encode('utf-8') + set_plugin_state(name, True) + + def disable(self, name): + name =3D name.encode('utf-8') + set_plugin_state(name, False) diff --git a/src/wok/server.py b/src/wok/server.py index 48f455b..9b49c1a 100644 --- a/src/wok/server.py +++ b/src/wok/server.py @@ -1,7 +1,7 @@ # # Project Wok # -# Copyright IBM Corp, 2015-2016 +# Copyright IBM Corp, 2015-2017 # # Code derived from Project Kimchi # @@ -28,14 +28,14 @@ import os from wok import auth from wok import config from wok.config import config as configParser -from wok.config import PluginConfig, WokConfig +from wok.config import WokConfig from wok.control import sub_nodes from wok.model import model from wok.proxy import check_proxy_config from wok.reqlogger import RequestLogger from wok.root import WokRoot from wok.safewatchedfilehandler import SafeWatchedFileHandler -from wok.utils import get_enabled_plugins, import_class +from wok.utils import get_enabled_plugins, load_plugin =20 =20 LOGGING_LEVEL =3D {"debug": logging.DEBUG, @@ -153,56 +153,12 @@ class Server(object): self.app =3D cherrypy.tree.mount(WokRoot(model_instance, dev_env), options.server_root, self.configObj) =20 - self._load_plugins(options) + self._load_plugins() cherrypy.lib.sessions.init() =20 - def _load_plugins(self, options): + def _load_plugins(self): for plugin_name, plugin_config in get_enabled_plugins(): - try: - plugin_class =3D ('plugins.%s.%s' % - (plugin_name, - plugin_name[0].upper() + plugin_name[1:])) - del plugin_config['wok'] - plugin_config.update(PluginConfig(plugin_name)) - except KeyError: - continue - - try: - plugin_app =3D import_class(plugin_class)(options) - except (ImportError, Exception), e: - cherrypy.log.error_log.error( - "Failed to import plugin %s, " - "error: %s" % (plugin_class, e.message) - ) - continue - - # dynamically extend plugin config with custom data, if provid= ed - get_custom_conf =3D getattr(plugin_app, "get_custom_conf", Non= e) - if get_custom_conf is not None: - plugin_config.update(get_custom_conf()) - - # dynamically add tools.wokauth.on =3D True to extra plugin AP= Is - try: - sub_nodes =3D import_class('plugins.%s.control.sub_nodes' % - plugin_name) - - urlSubNodes =3D {} - for ident, node in sub_nodes.items(): - if node.url_auth: - ident =3D "/%s" % ident - urlSubNodes[ident] =3D {'tools.wokauth.on': True} - - plugin_config.update(urlSubNodes) - - except ImportError, e: - cherrypy.log.error_log.error( - "Failed to import subnodes for plugin %s, " - "error: %s" % (plugin_class, e.message) - ) - - cherrypy.tree.mount(plugin_app, - config.get_base_plugin_uri(plugin_name), - plugin_config) + load_plugin(plugin_name, plugin_config) =20 def start(self): # Subscribe to SignalHandler plugin diff --git a/src/wok/utils.py b/src/wok/utils.py index 9a08001..9e6bb8a 100644 --- a/src/wok/utils.py +++ b/src/wok/utils.py @@ -1,7 +1,7 @@ # # Project Wok # -# Copyright IBM Corp, 2015-2016 +# Copyright IBM Corp, 2015-2017 # # Code derived from Project Kimchi # @@ -37,9 +37,11 @@ import xml.etree.ElementTree as ET from cherrypy.lib.reprconf import Parser from datetime import datetime, timedelta from multiprocessing import Process, Queue +from optparse import Values from threading import Timer =20 -from wok.config import paths, PluginPaths +from wok import config +from wok.config import paths, PluginConfig, PluginPaths from wok.exception import InvalidParameter, TimeoutExpired from wok.stringutils import decode_value =20 @@ -57,13 +59,21 @@ def is_digit(value): return False =20 =20 -def _load_plugin_conf(name): +def get_plugin_config_file(name): plugin_conf =3D PluginPaths(name).conf_file if not os.path.exists(plugin_conf): cherrypy.log.error_log.error("Plugin configuration file %s" " doesn't exist." % plugin_conf) - return + return None + return plugin_conf + + +def load_plugin_conf(name): try: + plugin_conf =3D get_plugin_config_file(name) + if not plugin_conf: + return None + return Parser().dict_from_file(plugin_conf) except ValueError as e: cherrypy.log.error_log.error("Failed to load plugin " @@ -71,22 +81,223 @@ def _load_plugin_conf(name): (plugin_conf, e.message)) =20 =20 -def get_enabled_plugins(): +def get_plugins(enabled_only=3DFalse): plugin_dir =3D paths.plugins_dir + try: dir_contents =3D os.listdir(plugin_dir) except OSError: return + + test_mode =3D config.config.get('server', 'test').lower() =3D=3D 'true' + for name in dir_contents: if os.path.isdir(os.path.join(plugin_dir, name)): - plugin_config =3D _load_plugin_conf(name) + if name =3D=3D 'sample' and not test_mode: + continue + + plugin_config =3D load_plugin_conf(name) + if not plugin_config: + continue try: - if plugin_config['wok']['enable']: - yield (name, plugin_config) + if plugin_config['wok']['enable'] is None: + continue + + plugin_enabled =3D plugin_config['wok']['enable'] + if enabled_only and not plugin_enabled: + continue + + yield (name, plugin_config) except (TypeError, KeyError): continue =20 =20 +def get_enabled_plugins(): + return get_plugins(enabled_only=3DTrue) + + +def get_plugin_app_mounted_in_cherrypy(name): + plugin_uri =3D '/plugins/' + name + return cherrypy.tree.apps.get(plugin_uri, None) + + +def get_plugin_dependencies(name): + app =3D get_plugin_app_mounted_in_cherrypy(name) + if app is None or not hasattr(app.root, 'depends'): + return [] + return app.root.depends + + +def get_all_plugins_dependent_on(name): + if not cherrypy.tree.apps: + return [] + + dependencies =3D [] + for plugin, app in cherrypy.tree.apps.iteritems(): + if hasattr(app.root, 'depends') and name in app.root.depends: + dependencies.append(plugin.replace('/plugins/', '')) + + return dependencies + + +def get_all_affected_plugins_by_plugin(name): + dependencies =3D get_all_plugins_dependent_on(name) + if len(dependencies) =3D=3D 0: + return [] + + all_affected_plugins =3D dependencies + for dep in dependencies: + all_affected_plugins +=3D get_all_affected_plugins_by_plugin(dep) + + return all_affected_plugins + + +def disable_plugin(name): + plugin_deps =3D get_all_affected_plugins_by_plugin(name) + + for dep in set(plugin_deps): + update_plugin_config_file(dep, False) + update_cherrypy_mounted_tree(dep, False) + + update_plugin_config_file(name, False) + update_cherrypy_mounted_tree(name, False) + + +def enable_plugin(name): + update_plugin_config_file(name, True) + update_cherrypy_mounted_tree(name, True) + + plugin_deps =3D get_plugin_dependencies(name) + + for dep in set(plugin_deps): + enable_plugin(dep) + + +def set_plugin_state(name, state): + if state is False: + disable_plugin(name) + else: + enable_plugin(name) + + +def update_plugin_config_file(name, state): + plugin_conf =3D get_plugin_config_file(name) + if not plugin_conf: + return + + config_contents =3D None + + with open(plugin_conf, 'r') as f: + config_contents =3D f.readlines() + + wok_section_found =3D False + + pattern =3D re.compile("^\s*enable\s*=3D\s*") + + for i in range(0, len(config_contents)): + if config_contents[i] =3D=3D '[wok]\n': + wok_section_found =3D True + continue + + if pattern.match(config_contents[i]) and wok_section_found: + config_contents[i] =3D 'enable =3D %s\n' % str(state) + break + + with open(plugin_conf, 'w') as f: + f.writelines(config_contents) + + +def load_plugin(plugin_name, plugin_config): + try: + plugin_class =3D ('plugins.%s.%s' % + (plugin_name, + plugin_name[0].upper() + plugin_name[1:])) + del plugin_config['wok'] + plugin_config.update(PluginConfig(plugin_name)) + except KeyError: + return + + try: + options =3D get_plugin_config_options() + plugin_app =3D import_class(plugin_class)(options) + except (ImportError, Exception), e: + cherrypy.log.error_log.error( + "Failed to import plugin %s, " + "error: %s" % (plugin_class, e.message) + ) + return + + # dynamically extend plugin config with custom data, if provided + get_custom_conf =3D getattr(plugin_app, "get_custom_conf", None) + if get_custom_conf is not None: + plugin_config.update(get_custom_conf()) + + # dynamically add tools.wokauth.on =3D True to extra plugin APIs + try: + sub_nodes =3D import_class('plugins.%s.control.sub_nodes' % + plugin_name) + + urlSubNodes =3D {} + for ident, node in sub_nodes.items(): + if node.url_auth: + ident =3D "/%s" % ident + urlSubNodes[ident] =3D {'tools.wokauth.on': True} + + plugin_config.update(urlSubNodes) + + except ImportError, e: + cherrypy.log.error_log.error( + "Failed to import subnodes for plugin %s, " + "error: %s" % (plugin_class, e.message) + ) + + cherrypy.tree.mount(plugin_app, + config.get_base_plugin_uri(plugin_name), + plugin_config) + + +def is_plugin_mounted_in_cherrypy(plugin_uri): + return cherrypy.tree.apps.get(plugin_uri) is not None + + +def update_cherrypy_mounted_tree(plugin, state): + plugin_uri =3D '/plugin/' + plugin + + if state is False and is_plugin_mounted_in_cherrypy(plugin_uri): + del cherrypy.tree.apps[plugin_uri] + + if state is True and not is_plugin_mounted_in_cherrypy(plugin_uri): + plugin_config =3D load_plugin_conf(plugin) + load_plugin(plugin, plugin_config) + + +def get_plugin_config_options(): + options =3D Values() + + options.websockets_port =3D config.config.getint('server', + 'websockets_port') + options.cherrypy_port =3D config.config.getint('server', + 'cherrypy_port') + options.proxy_port =3D config.config.getint('server', 'proxy_port') + options.session_timeout =3D config.config.getint('server', + 'session_timeout') + + options.test =3D config.config.get('server', 'test') + if options.test =3D=3D 'None': + options.test =3D None + + options.environment =3D config.config.get('server', 'environment') + options.server_root =3D config.config.get('server', 'server_root') + options.max_body_size =3D config.config.get('server', 'max_body_size') + + options.log_dir =3D config.config.get('logging', 'log_dir') + options.log_level =3D config.config.get('logging', 'log_level') + options.access_log =3D config.config.get('logging', 'access_log') + options.error_log =3D config.config.get('logging', 'error_log') + + return options + + def get_all_tabs(): files =3D [os.path.join(paths.ui_dir, 'config/tab-ext.xml')] =20 diff --git a/tests/test_api.py b/tests/test_api.py index 1430bc1..6fbee75 100644 --- a/tests/test_api.py +++ b/tests/test_api.py @@ -26,6 +26,8 @@ import utils from functools import partial =20 from wok.asynctask import AsyncTask +from wok.utils import set_plugin_state +from wok.rollbackcontext import RollbackContext =20 test_server =3D None model =3D None @@ -54,6 +56,63 @@ class APITests(unittest.TestCase): "server_root"] self.assertEquals(sorted(keys), sorted(conf.keys())) =20 + def test_config_plugins(self): + resp =3D self.request('/config/plugins') + self.assertEquals(200, resp.status) + + plugins =3D json.loads(resp.read()) + if len(plugins) =3D=3D 0: + return + + plugin_name =3D '' + plugin_state =3D '' + for p in plugins: + if p.get('name') =3D=3D 'sample': + plugin_name =3D p.get('name').encode('utf-8') + plugin_state =3D p.get('enabled') + break + else: + return + + with RollbackContext() as rollback: + rollback.prependDefer(set_plugin_state, plugin_name, + plugin_state) + + resp =3D self.request('/config/plugins/sample') + self.assertEquals(200, resp.status) + + resp =3D self.request('/config/plugins/sample/enable', + '{}', 'POST') + self.assertEquals(200, resp.status) + + resp =3D self.request('/config/plugins') + self.assertEquals(200, resp.status) + plugins =3D json.loads(resp.read()) + + for p in plugins: + if p.get('name') =3D=3D 'sample': + plugin_state =3D p.get('enabled') + break + self.assertTrue(plugin_state) + + resp =3D self.request('/config/plugins/sample/disable', + '{}', 'POST') + self.assertEquals(200, resp.status) + + resp =3D self.request('/config/plugins') + self.assertEquals(200, resp.status) + plugins =3D json.loads(resp.read()) + + for p in plugins: + if p.get('name') =3D=3D 'sample': + plugin_state =3D p.get('enabled') + break + self.assertFalse(plugin_state) + + def test_plugins_api_404(self): + resp =3D self.request('/plugins') + self.assertEquals(404, resp.status) + def test_user_log(self): # Login and logout to make sure there there are entries in user log hdrs =3D {'AUTHORIZATION': '', diff --git a/tests/test_utils.py b/tests/test_utils.py index e7fd264..e63e1a2 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -19,10 +19,14 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-130= 1 USA =20 +import mock +import os +import tempfile import unittest =20 from wok.exception import InvalidParameter -from wok.utils import convert_data_size +from wok.rollbackcontext import RollbackContext +from wok.utils import convert_data_size, set_plugin_state =20 =20 class UtilsTests(unittest.TestCase): @@ -69,3 +73,72 @@ class UtilsTests(unittest.TestCase): =20 for d in success_data: self.assertEquals(d['got'], d['want']) + + def _get_fake_config_file_content(self, enable=3DTrue): + return """\ +[a_random_section] +# a random section for testing purposes +enable =3D 1 + +[wok] +# Enable plugin on Wok server (values: True|False) +enable =3D %s + +[fakeplugin] +# Yet another comment on this config file +enable =3D 2 +very_interesting_option =3D True +""" % str(enable) + + def _get_config_file_template(self, enable=3DTrue): + return """\ +[a_random_section] +# a random section for testing purposes +enable =3D 1 + +[wok] +# Enable plugin on Wok server (values: True|False) +enable =3D %s + +[fakeplugin] +# Yet another comment on this config file +enable =3D 2 +very_interesting_option =3D True +""" % str(enable) + + def _create_fake_config_file(self): + _, tmp_file_name =3D tempfile.mkstemp(suffix=3D'.conf') + + config_contents =3D self._get_fake_config_file_content() + with open(tmp_file_name, 'w') as f: + f.writelines(config_contents) + + return tmp_file_name + + @mock.patch('wok.utils.get_plugin_config_file') + @mock.patch('wok.utils.update_cherrypy_mounted_tree') + def test_set_plugin_state(self, mock_update_cherrypy, mock_config_file= ): + mock_update_cherrypy.return_value =3D True + + with RollbackContext() as rollback: + + config_file_name =3D self._create_fake_config_file() + rollback.prependDefer(os.remove, config_file_name) + + mock_config_file.return_value =3D config_file_name + + set_plugin_state('pluginA', False) + with open(config_file_name, 'r') as f: + updated_conf =3D f.read() + self.assertEqual( + updated_conf, + self._get_config_file_template(enable=3DFalse) + ) + + set_plugin_state('pluginA', True) + with open(config_file_name, 'r') as f: + updated_conf =3D f.read() + self.assertEqual( + updated_conf, + self._get_config_file_template(enable=3DTrue) + ) --=20 2.9.3 _______________________________________________ Kimchi-devel mailing list Kimchi-devel@ovirt.org http://lists.ovirt.org/mailman/listinfo/kimchi-devel From nobody Mon Dec 9 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of ovirt.org designates 66.187.230.42 as permitted sender) client-ip=66.187.230.42; envelope-from=kimchi-devel-bounces@ovirt.org; helo=lists.ovirt.org; Authentication-Results: mx.zoho.com; spf=pass (zoho.com: domain of ovirt.org designates 66.187.230.42 as permitted sender) smtp.mailfrom=kimchi-devel-bounces@ovirt.org; Return-Path: Received: from lists.ovirt.org (lists.phx.ovirt.org [66.187.230.42]) by mx.zohomail.com with SMTPS id 1485950687654888.0964068450749; Wed, 1 Feb 2017 04:04:47 -0800 (PST) Received: from lists.phx.ovirt.org (localhost [127.0.0.1]) by lists.ovirt.org (Postfix) with ESMTP id F37EB8205EF; Wed, 1 Feb 2017 12:04:43 +0000 (UTC) Received: from mail-qt0-f177.google.com (mail-qt0-f177.google.com [209.85.216.177]) by lists.ovirt.org (Postfix) with ESMTPS id 4012E8205C6 for ; Wed, 1 Feb 2017 12:03:54 +0000 (UTC) Received: by mail-qt0-f177.google.com with SMTP id k15so262333976qtg.3 for ; Wed, 01 Feb 2017 04:03:54 -0800 (PST) Received: from arthas.ltc.br.ibm.com.com ([177.99.122.130]) by smtp.gmail.com with ESMTPSA id m30sm18461059qtg.10.2017.02.01.04.03.52 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 01 Feb 2017 04:03:53 -0800 (PST) X-Original-To: kimchi-devel@ovirt.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=YEvoHGNDN9Rdar5QWtpKWQelJ/wJv3UaqvT3vwveYt0=; b=qFytjANxwhuv5dw8ihTPVPmvUFGEkRKWAxkoSw5PuU7iATE5oS/FkzRv302LjHaw7n mvMR+7HI+yYXLv4I47TkjG41cWfdvuaad98DSAPy0OHuwrsG1jvXuFpzQEuTGAqH2CKU lu7XnH/vnDSxS3eHLaSTO04x0X9okAiOQHzb7eYkWmXaZwmTbphxZt2/rP9vW1Ng2YI7 IhG2mn8GsSVzcI/2zdV0iNch2udwrrTHrvb+owFxPv1Tld8AhZmRhmQ6Q/fZqtd3ax6H GrOQKHZhk1bUuFnmv3o5LBIHnky+C6lCeqGQpHMTljBT3bAfv7Uu/XaZWGMreFQpFCwE 7XfQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=YEvoHGNDN9Rdar5QWtpKWQelJ/wJv3UaqvT3vwveYt0=; b=iOjQwUZ0isZ4voLHVtQGZIZVYOJM8PPFiCwQpefO9kYfWVLKxmLnNrgxoILWaHtsEX 1UnuO9jb6mL7rr4fhh9KRwsLhHxOd7oVeJfAgoJSkul53UThMKmHy2l54Wekscm1r0Sw Z9CcNnkhv26n/1/WdlXkjmuWoEdrvykC0QR0I+I+Nbg0lJdi1eO7/9x0t0+VI/pWomge gPugSnkdYOhqyZnhOlIqgO/D/7Zg2FuA/tczpIFu6X5OJrD0h5IZHMKrC+8NZV0BCEIw xA6TkjPOPdhXi9EuKZdrLESkzKlKSTAYuPeM5zO1c3NagDQ3Xvvczge12lIAxk+1YtYZ GByg== X-Gm-Message-State: AIkVDXK17kDtoVtJS+p3CM666Z20IHq9bEnjNuwPor9griSGstCm1iWqpbEzmSv2PP074g== X-Received: by 10.200.48.110 with SMTP id g43mr2153370qte.277.1485950633371; Wed, 01 Feb 2017 04:03:53 -0800 (PST) From: To: Kimchi Devel Date: Wed, 1 Feb 2017 10:03:27 -0200 Message-Id: <20170201120327.477-3-dhbarboza82@gmail.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20170201120327.477-1-dhbarboza82@gmail.com> References: <20170201120327.477-1-dhbarboza82@gmail.com> Subject: [Kimchi-devel] [PATCH] [WoK 2/2] /config/plugins: changing existing UI calls X-BeenThere: kimchi-devel@ovirt.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: kimchi-devel-bounces@ovirt.org Errors-To: kimchi-devel-bounces@ovirt.org X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" From: Daniel Henrique Barboza This patch changes ui/js/src/wok.api.js 'listPlugins' method to use the URL /config/plugins instead of /plugins. With this change, ui/js/src/wok.logos.js and ui/js/src/wok.main.js were also changed to handle the different return value from the /config/plugins API. Signed-off-by: Daniel Henrique Barboza --- ui/js/src/wok.api.js | 4 ++-- ui/js/src/wok.logos.js | 11 +++++++---- ui/js/src/wok.main.js | 10 +++++++--- 3 files changed, 16 insertions(+), 9 deletions(-) diff --git a/ui/js/src/wok.api.js b/ui/js/src/wok.api.js index e2829ab..c465dfb 100644 --- a/ui/js/src/wok.api.js +++ b/ui/js/src/wok.api.js @@ -1,7 +1,7 @@ /* * Project Wok * - * Copyright IBM Corp, 2015-2016 + * Copyright IBM Corp, 2015-2017 * * Code derived from Project Kimchi * @@ -111,7 +111,7 @@ var wok =3D { =20 listPlugins : function(suc, err, sync) { wok.requestJSON({ - url : 'plugins', + url : '/config/plugins', type : 'GET', contentType : 'application/json', dataType : 'json', diff --git a/ui/js/src/wok.logos.js b/ui/js/src/wok.logos.js index a825108..b4e2d75 100644 --- a/ui/js/src/wok.logos.js +++ b/ui/js/src/wok.logos.js @@ -1,7 +1,7 @@ /* * Project Wok * - * Copyright IBM Corp, 2016 + * Copyright IBM Corp, 2016-2017 * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -78,18 +78,21 @@ wok.logos =3D function(element, powered) { wok.listPlugins(function(plugins) { if(plugins && plugins.length > 0) { $(plugins).each(function(i, p) { + if (p.enabled =3D=3D=3D false) { + return true; + } var url =3D wok.substitute(pluginUrl, { - plugin: p + plugin: p.name }); obj[i] =3D { - name : p + name : p.name } var pluginVersions; pluginVersions =3D retrieveVersion(url); if(pluginVersions && pluginVersions.length > 0){ obj[i].version =3D pluginVersions; } - var imagepath =3D url+'/images/'+p; + var imagepath =3D url+'/images/'+p.name; if(checkImage(imagepath+'.svg') =3D=3D 200) { obj[i].image =3D imagepath+'.svg'; } diff --git a/ui/js/src/wok.main.js b/ui/js/src/wok.main.js index c67e97c..6de8ea0 100644 --- a/ui/js/src/wok.main.js +++ b/ui/js/src/wok.main.js @@ -142,16 +142,20 @@ wok.main =3D function() { var tabs =3D retrieveTabs('wok', wokConfigUrl); wok.listPlugins(function(plugins) { $(plugins).each(function(i, p) { + if (p.enabled =3D=3D=3D false) { + return true; + } + var url =3D wok.substitute(pluginConfigUrl, { - plugin: p + plugin: p.name }); var i18nUrl =3D wok.substitute(pluginI18nUrl, { - plugin: p + plugin: p.name }); wok.getI18n(function(i18nObj){ $.extend(i18n, i18nObj)}, function(i18nObj){ //i18n is not define by plu= gin }, i18nUrl, true); - var pluginTabs =3D retrieveTabs(p, url); + var pluginTabs =3D retrieveTabs(p.name, url); if(pluginTabs.length > 0){ tabs.push.apply(tabs, pluginTabs); } --=20 2.9.3 _______________________________________________ Kimchi-devel mailing list Kimchi-devel@ovirt.org http://lists.ovirt.org/mailman/listinfo/kimchi-devel