- Kimchi-devel - oVirt List Archives

[PATCH v2][Wok 3/8] Implements control/model of new plugin API
by Rodrigo Trujillo 06 Jun '16

06 Jun '16

Signed-off-by: Rodrigo Trujillo <rodrigo.trujillo(a)linux.vnet.ibm.com> --- src/wok/control/plugins.py | 31 ++++++++++++++++++++++++++++--- src/wok/i18n.py | 3 +++ src/wok/model/plugins.py | 38 ++++++++++++++++++++++++++++++-------- 3 files changed, 61 insertions(+), 11 deletions(-) diff --git a/src/wok/control/plugins.py b/src/wok/control/plugins.py index 57dfa1b..5c125eb 100644 --- a/src/wok/control/plugins.py +++ b/src/wok/control/plugins.py @@ -19,11 +19,36 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -from wok.control.base import SimpleCollection +from wok.control.base import Collection, Resource, SimpleCollection from wok.control.utils import UrlSubNode -@UrlSubNode("plugins") -class Plugins(SimpleCollection): +@UrlSubNode("plugins", False) +class PluginsSimple(SimpleCollection): + """ + Returns only enabled plugins in order to built initial Wok UI + """ + def __init__(self, model): + super(PluginsSimple, self).__init__(model) + pass + + +@UrlSubNode("pluginsmanager", True) +class Plugins(Collection): def __init__(self, model): super(Plugins, self).__init__(model) + self.resource = Plugin + self.admin_methods = ['GET'] + + +class Plugin(Resource): + def __init__(self, model, id): + super(Plugin, self).__init__(model, id) + self.uri_fmt = "/pluginsmanager/%s" + self.enable = self.generate_action_handler('enable') + self.disable = self.generate_action_handler('disable') + self.admin_methods = ['GET', 'POST'] + + @property + def data(self): + return self.info diff --git a/src/wok/i18n.py b/src/wok/i18n.py index 4fc21f1..bda3949 100644 --- a/src/wok/i18n.py +++ b/src/wok/i18n.py @@ -60,4 +60,7 @@ messages = { "WOKRES0001L": _("Request made on resource"), "WOKROOT0001L": _("User '%(username)s' logged in"), "WOKROOT0002L": _("User '%(username)s' logged out"), + + "WOKPLUG0001E": _("Plugin '%(plugin_name)s' not found."), + "WOKPLUG0002E": _("Error updating configuration file of plugin '%(plugin)s'."), } diff --git a/src/wok/model/plugins.py b/src/wok/model/plugins.py index 4beff44..b0ac366 100644 --- a/src/wok/model/plugins.py +++ b/src/wok/model/plugins.py @@ -3,8 +3,6 @@ # # 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 @@ -19,9 +17,17 @@ # License along with this library; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -import cherrypy -from wok.utils import get_enabled_plugins +from wok.exception import NotFoundError +from wok.pluginsmanager import Plugins + + +class PluginsSimpleModel(object): + def __init__(self, **kargs): + pass + + def get_list(self): + return Plugins().get_enabled_plugins() class PluginsModel(object): @@ -29,7 +35,23 @@ class PluginsModel(object): pass def get_list(self): - # Will only return plugins that were loaded correctly by WOK and are - # properly configured in cherrypy - return [plugin for (plugin, config) in get_enabled_plugins() - if config.get('wok').get('uri') in cherrypy.tree.apps.keys()] + return Plugins().get_all_plugins_names() + + +class PluginModel(object): + def __init__(self, **kargs): + pass + + def lookup(self, plugin): + info = Plugins().get_plugin_info(plugin) + if not info: + raise NotFoundError('WOKPLUG0001E', {'plugin_name': plugin}) + + return {'name': plugin, + 'enabled': info['enabled']} + + def enable(self, plugin_name): + Plugins().enable_plugin(plugin_name) + + def disable(self, plugin_name): + Plugins().disable_plugin(plugin_name) -- 2.1.0

1 0

[PATCH v2][Wok 2/8] Changes server behavior to use pluginsmanager
by Rodrigo Trujillo 06 Jun '16

06 Jun '16

Signed-off-by: Rodrigo Trujillo <rodrigo.trujillo(a)linux.vnet.ibm.com> --- src/wok/auth.py | 15 ++++++++------- src/wok/root.py | 8 ++++---- src/wok/server.py | 57 ++++++------------------------------------------------- src/wok/utils.py | 52 -------------------------------------------------- 4 files changed, 18 insertions(+), 114 deletions(-) diff --git a/src/wok/auth.py b/src/wok/auth.py index 0355e86..f8be4b5 100644 --- a/src/wok/auth.py +++ b/src/wok/auth.py @@ -35,15 +35,15 @@ import urllib2 from wok import template from wok.config import config from wok.exception import InvalidOperation, OperationFailed -from wok.utils import get_all_tabs, run_command +from wok.pluginsmanager import get_all_tabs +from wok.utils import run_command + USER_NAME = 'username' USER_GROUPS = 'groups' USER_ROLES = 'roles' REFRESH = 'robot-refresh' -tabs = get_all_tabs() - def redirect_login(): url = "/login.html" @@ -85,7 +85,7 @@ class PAMUser(User): # after adding support to change user roles that info should be read # from a specific objstore and fallback to default only if any entry is # found - self.user[USER_ROLES] = dict.fromkeys(tabs, 'user') + self.user[USER_ROLES] = dict.fromkeys(get_all_tabs(), 'user') def get_groups(self): out, err, rc = run_command(['id', '-Gn', self.user[USER_NAME]]) @@ -99,7 +99,7 @@ class PAMUser(User): # after adding support to change user roles that info should be # read from a specific objstore and fallback to default only if # any entry is found - self.user[USER_ROLES] = dict.fromkeys(tabs, 'admin') + self.user[USER_ROLES] = dict.fromkeys(get_all_tabs(), 'admin') return self.user[USER_ROLES] @@ -195,7 +195,7 @@ class LDAPUser(User): self.user[USER_GROUPS] = list() # FIXME: user roles will be changed according roles assignment after # objstore is integrated - self.user[USER_ROLES] = dict.fromkeys(tabs, 'user') + self.user[USER_ROLES] = dict.fromkeys(get_all_tabs(), 'user') @staticmethod def authenticate(username, password): @@ -236,7 +236,8 @@ class LDAPUser(User): "authentication", "ldap_admin_id").strip('"').split(',') for admin_id in admin_ids: if self.user[USER_NAME] == admin_id.strip(): - self.user[USER_ROLES] = dict.fromkeys(tabs, 'admin') + self.user[USER_ROLES] = dict.fromkeys(get_all_tabs(), + 'admin') return self.user[USER_ROLES] def get_user(self): diff --git a/src/wok/root.py b/src/wok/root.py index 29ea657..cb8b376 100644 --- a/src/wok/root.py +++ b/src/wok/root.py @@ -123,10 +123,10 @@ class Root(Resource): data['scripts'] = [] for plugin, app in cherrypy.tree.apps.iteritems(): - if app.root.extends is not None: - scripts = app.root.extends.get(script_name, {}) - if page in scripts.keys(): - data['scripts'].append(scripts[page]) + if app.root.extends is not None: + scripts = app.root.extends.get(script_name, {}) + if page in scripts.keys(): + data['scripts'].append(scripts[page]) if page.endswith('.html'): context = template.render('/tabs/' + page, data) diff --git a/src/wok/server.py b/src/wok/server.py index 902d4bf..3cb257f 100644 --- a/src/wok/server.py +++ b/src/wok/server.py @@ -30,14 +30,14 @@ from string import Template from wok import auth from wok import config from wok.config import config as configParser -from wok.config import paths, PluginConfig, WokConfig +from wok.config import paths, WokConfig from wok.control import sub_nodes from wok.model import model +from wok.pluginsmanager import Plugins from wok.proxy import start_proxy, terminate_proxy from wok.reqlogger import RequestLogger from wok.root import WokRoot from wok.safewatchedfilehandler import SafeWatchedFileHandler -from wok.utils import get_enabled_plugins, import_class LOGGING_LEVEL = {"debug": logging.DEBUG, @@ -171,61 +171,16 @@ class Server(object): self.app = cherrypy.tree.mount(WokRoot(model_instance, dev_env), config=self.configObj) - self._load_plugins(options) + + # Initiate and handles plugins + plugins = Plugins(options) + plugins.load_plugins() # Terminate proxy when cherrypy server is terminated cherrypy.engine.subscribe('exit', terminate_proxy) cherrypy.lib.sessions.init() - def _load_plugins(self, options): - for plugin_name, plugin_config in get_enabled_plugins(): - try: - plugin_class = ('plugins.%s.%s' % - (plugin_name, - plugin_name[0].upper() + plugin_name[1:])) - script_name = plugin_config['wok']['uri'] - del plugin_config['wok'] - - plugin_config.update(PluginConfig(plugin_name)) - except KeyError: - continue - - try: - plugin_app = import_class(plugin_class)(options) - except ImportError, 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 provided - get_custom_conf = 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 = True to extra plugin APIs - try: - sub_nodes = import_class('plugins.%s.control.sub_nodes' % - plugin_name) - - urlSubNodes = {} - for ident, node in sub_nodes.items(): - if node.url_auth: - ident = "/%s" % ident - urlSubNodes[ident] = {'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, script_name, plugin_config) - def start(self): # Subscribe to SignalHandler plugin if hasattr(cherrypy.engine, 'signal_handler'): diff --git a/src/wok/utils.py b/src/wok/utils.py index 4b3b0ac..10f2850 100644 --- a/src/wok/utils.py +++ b/src/wok/utils.py @@ -32,16 +32,13 @@ import sqlite3 import subprocess import sys import traceback -import xml.etree.ElementTree as ET import locale -from cherrypy.lib.reprconf import Parser from datetime import datetime, timedelta from multiprocessing import Process, Queue from threading import Timer from wok.asynctask import AsyncTask -from wok.config import paths, PluginPaths from wok.exception import InvalidParameter, TimeoutExpired @@ -76,55 +73,6 @@ def is_digit(value): return False -def _load_plugin_conf(name): - plugin_conf = 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 - try: - return Parser().dict_from_file(plugin_conf) - except ValueError as e: - cherrypy.log.error_log.error("Failed to load plugin " - "conf from %s: %s" % - (plugin_conf, e.message)) - - -def get_enabled_plugins(): - plugin_dir = paths.plugins_dir - try: - dir_contents = os.listdir(plugin_dir) - except OSError: - return - for name in dir_contents: - if os.path.isdir(os.path.join(plugin_dir, name)): - plugin_config = _load_plugin_conf(name) - try: - if plugin_config['wok']['enable']: - yield (name, plugin_config) - except (TypeError, KeyError): - continue - - -def get_all_tabs(): - files = [] - - for plugin, _ in get_enabled_plugins(): - files.append(os.path.join(PluginPaths(plugin).ui_dir, - 'config/tab-ext.xml')) - - tabs = [] - for f in files: - try: - root = ET.parse(f) - except (IOError): - wok_log.debug("Unable to load %s", f) - continue - tabs.extend([t.text.lower() for t in root.getiterator('title')]) - - return tabs - - def get_plugin_from_request(): """ Returns name of plugin being requested. If no plugin, returns 'wok'. -- 2.1.0

1 0

[PATCH v2][Wok 1/8] Creates pluginmanager.py module
by Rodrigo Trujillo 06 Jun '16

06 Jun '16

Signed-off-by: Rodrigo Trujillo <rodrigo.trujillo(a)linux.vnet.ibm.com> --- src/wok/pluginsmanager.py | 238 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 238 insertions(+) create mode 100644 src/wok/pluginsmanager.py diff --git a/src/wok/pluginsmanager.py b/src/wok/pluginsmanager.py new file mode 100644 index 0000000..d799f11 --- /dev/null +++ b/src/wok/pluginsmanager.py @@ -0,0 +1,238 @@ +# +# Project Wok +# +# Copyright IBM Corp, 2016 +# +# 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-1301 USA +# + + +import cherrypy +import os +import xml.etree.ElementTree as ET +from cherrypy.lib.reprconf import Parser +from configobj import ConfigObj + + +from basemodel import Singleton +from wok.config import paths, PluginConfig, PluginPaths +from wok.exception import OperationFailed +from wok.utils import import_class, wok_log + + +class Plugins(): + __metaclass__ = Singleton + + def __init__(self, options=None): + # { '<PLUGIN_NAME>': { + # config: <PLUGIN_CHERRYPY_CONFIG>, + # enabled: <TRUE/FALSE>, + # uri: <PLUGIN_URI_FROM_FILE_CONFIG>, + # app: <PLUGIN_MAIN_MODULE> + # conf_file: <PLUGIN_CONFIGURATION_FILE> + self._plugins_dict = {} + self.options = options + self._init_all_plugins() + + def _load_plugin_app(self, name): + """ + Loads the plugin main module + """ + plugin_class = ('plugins.%s.%s' % (name, name[0].upper() + name[1:])) + try: + plugin_app = import_class(plugin_class)(self.options) + except ImportError, e: + wok_log.error("Failed to import plugin %s, error: %s" % + (plugin_class, e.message)) + self._plugins_dict[name]['enabled'] = False + self._plugins_dict[name]['app'] = None + return + self._plugins_dict[name]['app'] = plugin_app + + def _load_plugin_app_config(self, name): + """ + Sets the plugin's cherrypy configuration. That is a merge between Wok + standard configuration plus plugin's self configuration + """ + app_conf = {} + app_conf.update(PluginConfig(name)) + plugin_app = self._plugins_dict[name]['app'] + if plugin_app is None: + return + + # dynamically extend plugin config with custom data, if provided + get_custom_conf = getattr(plugin_app, "get_custom_conf", None) + if get_custom_conf is not None: + app_conf.update(get_custom_conf()) + + # dynamically add tools.wokauth.on = True to extra plugin APIs + try: + sub_nodes = import_class('plugins.%s.control.sub_nodes' % + name) + urlSubNodes = {} + for ident, node in sub_nodes.items(): + if node.url_auth: + ident = "/%s" % ident + urlSubNodes[ident] = {'tools.wokauth.on': True} + app_conf.update(urlSubNodes) + except ImportError, e: + wok_log.error("Failed to import subnodes for plugin %s, error: %s" + % (name, e.message)) + self._plugins_dict[name]['config'] = app_conf + + def _load_plugin_config_file(self, name): + """ + Loads the information from Wok section in <plugin>.conf file. Currently + two tags/options are required to Wok and section looks like: + [wok] + enable = True + uri = '/plugins/mypluginpath' + """ + plugin_conf_file = PluginPaths(name).conf_file + config = {} + if not os.path.exists(plugin_conf_file): + wok_log.error("Plugin configuration file %s doesn't exist." % + plugin_conf_file) + else: + try: + config = Parser().dict_from_file(plugin_conf_file) + except ValueError as e: + msg = "Failed to load plugin conf from %s: %s" + wok_log.error(msg % (plugin_conf_file, e.message)) + + plugin = self._plugins_dict[name] + plugin['conf_file'] = plugin_conf_file + plugin['enabled'] = config.get('wok', {}).get('enable', False) + plugin['uri'] = config.get('wok', {}).get('uri', 'Unknow') + + def _init_all_plugins(self): + """ + Initializes internal plugin dictionary, searching all directories in + <install_path>/wok/plugins, each directory should store a plugin + content. Then loads its configuration file in order to set as enabled + or disabled. + """ + plugin_dir = paths.plugins_dir + try: + dir_contents = os.listdir(plugin_dir) + except OSError as e: + wok_log.error("Failed to fetch plugins from '%s': %s" % + (plugin_dir, e.message)) + return + for name in dir_contents: + if os.path.isdir(os.path.join(plugin_dir, name)): + # TODO: + # Add command line option to disable plugin by its name + # + self._plugins_dict[name] = {} + self._plugins_dict[name]['config'] = {} + self._plugins_dict[name]['app'] = None + self._load_plugin_config_file(name) + + # Disable all plugins but 'sample' in test mode + if (self.options is not None) and self.options.test: + self._plugins_dict[name]['enabled'] = (name == 'sample') + + if not self._plugins_dict[name]['enabled']: + wok_log.info("Initializing plugin: %s [DISABLED]" % name) + else: + wok_log.info("Initializing plugin: %s [ENABLED]" % name) + + def _set_cherrypy_app(self, name): + """ + Load plugin module and cherrypy configuration, then set it as cherrypy + app. + """ + self._load_plugin_app(name) + self._load_plugin_app_config(name) + if self._plugins_dict[name]['enabled']: + cherrypy.tree.mount( + self._plugins_dict[name]['app'], + self._plugins_dict[name]['uri'], + self._plugins_dict[name]['config']) + wok_log.info("Plugin '%s' loaded" % + self._plugins_dict[name]['app']) + + def load_plugins(self): + """ + Set enabled plugins into Cherrypy + """ + for plugin in self.get_enabled_plugins(): + self._set_cherrypy_app(plugin) + + def get_all_plugins_info(self): + return self._plugins_dict + + def get_plugin_info(self, name): + return self._plugins_dict.get(name, {}) + + def get_all_plugins_names(self): + ret = self._plugins_dict.keys() + ret.sort() + return ret + + def get_enabled_plugins(self): + ret = [plugin for plugin in self._plugins_dict.keys() if + self._plugins_dict[plugin]['enabled']] + ret.sort() + return ret + + def _enable_plugin_conf_file(self, f_conf, enable=True): + try: + # 'unrepr' makes ConfigObj read and write characters like ("'?) + conf = ConfigObj(infile=f_conf, unrepr=True) + conf['wok']['enable'] = enable + with open(f_conf, 'wb') as f: + conf.write(f) + except Exception as e: + wok_log.error('Error updating plugin conf file. ' + e.message) + raise + + def _change_plugin_state(self, name, enable=True): + plugin = self._plugins_dict[name] + if plugin['enabled'] == enable: + return + try: + self._enable_plugin_conf_file(plugin['conf_file'], enable) + except: + raise OperationFailed('WOKPLUG0002E', {'plugin': name}) + plugin['enabled'] = enable + + def enable_plugin(self, plugin): + wok_log.info("PluginsManager: Enabling plugin '%s'" % plugin) + self._change_plugin_state(plugin, True) + + def disable_plugin(self, plugin): + wok_log.info("PluginsManager: Disabling plugin '%s'" % plugin) + self._change_plugin_state(plugin, False) + + +def get_all_tabs(): + files = [] + + for plugin in Plugins().get_enabled_plugins(): + files.append(os.path.join(PluginPaths(plugin).ui_dir, + 'config/tab-ext.xml')) + + tabs = [] + for f in files: + try: + root = ET.parse(f) + except (IOError): + wok_log.debug("Unable to load %s", f) + continue + tabs.extend([t.text.lower() for t in root.getiterator('title')]) + + return tabs -- 2.1.0

1 0

[PATCH v2][Wok 0/8]
by Rodrigo Trujillo 06 Jun '16

06 Jun '16

V2: Addresses Aline's review points and other problems found: - Added test cases for pluginsmanager; - Fixes Sample plugin and use it in test cases; - Start Wok server only after command line option checking; - Keep API /plugins due to problems with authentication and Wok initialization (see below); - Keep API /pluginsmanager with authentication; Authorization problem: Tried to keep the API as pluginsmanager only, with authentication, but got problem in UI login, due to the way Wok initializes (it requests the plugins, them tries to load the screen, once failing it call the login screen) With authentication, if user is not logged, plugins request fails and the login is not showed. So, I kept /plugins API without authentication to show only enabled plugins and let Wok initializes flawlessly. Then created the /pluginsmanager, which requires authentication and allows to enable/disable plugins. Created this issue to improve Wok: https://github.com/kimchi-project/wok/issues/131 Idealy, /pluginsmanager GET should be unauthenticated (to list plugins) but POST actions should require authentication, for security V1: This is initial basic version of Plugins Manager. Features: - Improve plugins load and initialization; - New API to enable/disable a given plugin; - Update plugin configuration file; - Fix UI in order make Wok work as usual; ToDos (improvements): - Update (enable/disable) plugin in cherrypy (live); - Support to plugins dependencies; - Add command-line options to enable-disable given plugins Rodrigo Trujillo (8): Creates pluginmanager.py module Changes server behavior to use pluginsmanager Implements control/model of new plugin API Change plugins API documentation by pluginsmanager API Load Wok Server after options checkings Fix Sample plugin Fix test utils imports and add auth tests Add Plugins Manager test cases docs/API/plugins.md | 13 -- docs/API/pluginsmanager.md | 61 ++++++ src/wok/auth.py | 15 +- src/wok/control/plugins.py | 31 ++- src/wok/i18n.py | 3 + src/wok/model/plugins.py | 38 +++- src/wok/plugins/sample/__init__.py | 54 ++++- src/wok/plugins/sample/control/__init__.py | 26 +++ src/wok/plugins/sample/sample.conf.in | 22 -- src/wok/plugins/sample/ui/config/tab-ext.xml | 9 +- .../plugins/sample/ui/pages/sample-tab1.html.tmpl | 3 + .../plugins/sample/ui/pages/sample-tab2.html.tmpl | 3 + src/wok/pluginsmanager.py | 238 +++++++++++++++++++++ src/wok/root.py | 8 +- src/wok/server.py | 57 +---- src/wok/utils.py | 52 ----- src/wokd.in | 6 +- tests/test_plugin.py | 104 ++++++++- tests/test_server.py | 10 +- tests/utils.py | 7 +- 20 files changed, 582 insertions(+), 178 deletions(-) delete mode 100644 docs/API/plugins.md create mode 100644 docs/API/pluginsmanager.md create mode 100644 src/wok/plugins/sample/control/__init__.py create mode 100644 src/wok/pluginsmanager.py -- 2.1.0

1 0

Re: [Kimchi-devel] [PATCH] [Kimchi] Pass only those fields that have been modified in Edit Guest; Match maxmem to mem when guest is not running or paused
by Socorro Stoppler 06 Jun '16

06 Jun '16

On 06/03/2016 02:24 PM, Aline Manera wrote: > > Hi Socorro, > > Only a minor comment below and a question. > > On 06/02/2016 07:23 PM, Socorro Stoppler wrote: >> v2: >> Made adjustments on how things were being done based on feedback. >> Also included the fix for github issue#: 941 - max memory should >> increase when mem is increased. >> >> v1: >> This patch fixes bugzilla#: 141686 -after memory hot plug seeing >> error 'KCHCPUHP0005E' >> This patch addresses the issue of what is being passed down to the >> backend >> when guest is modified. The issue was passing parameters that were not >> modified caused the backend to throw an error in the mem hotplug >> scenario. >> It now only passes down those parameters that have been modified >> regarding >> memory and cpu fields. >> >> Signed-off-by: Socorro Stoppler <socorro(a)linux.vnet.ibm.com> >> --- >> ui/js/src/kimchi.guest_edit_main.js | 159 >> ++++++++++++++++++++++++------------ >> ui/pages/guest-edit.html.tmpl | 2 +- >> 2 files changed, 108 insertions(+), 53 deletions(-) >> >> diff --git a/ui/js/src/kimchi.guest_edit_main.js >> b/ui/js/src/kimchi.guest_edit_main.js >> index 4cee8fe..fc67d82 100644 >> --- a/ui/js/src/kimchi.guest_edit_main.js >> +++ b/ui/js/src/kimchi.guest_edit_main.js >> @@ -668,10 +668,8 @@ kimchi.guest_edit_main = function() { >> guest['max-processor'] = guest.cpu_info['maxvcpus']; >> guest['icon'] = guest['icon'] || >> 'plugins/kimchi/images/icon-vm.png'; >> $('#form-guest-edit-general').fillWithObject(guest); >> - >> $('#guest-edit-memory-textbox').val(parseInt(guest.memory.current)); >> $('#guest-edit-max-memory-textbox').val(parseInt(guest.memory.maxmemory)); >> - >> kimchi.thisVMState = guest['state']; >> refreshCDROMs(); >> $('#guest-edit-attach-cdrom-button').on('click', >> function(event) { >> @@ -706,6 +704,12 @@ kimchi.guest_edit_main = function() { >> $('#guest-show-max-processor >> i.fa').toggleClass('fa-plus-circle fa-minus-circle'); >> }); >> >> + if ((kimchi.thisVMState !== "running") && >> (kimchi.thisVMState !== "paused")) { >> + $("#guest-edit-memory-textbox").bind('keyup blur', >> function(e) { >> + $('#guest-edit-max-memory-textbox').val($(this).val()); >> + }); >> + } >> + >> var onAttached = function(params) { >> refreshCDROMs(); >> }; >> @@ -736,59 +740,110 @@ kimchi.guest_edit_main = function() { >> kimchi.retrieveVM(kimchi.selectedGuest, initContent); >> >> var generalSubmit = function(event) { >> - $(saveButton).prop('disabled', true); >> - var data = $('#form-guest-edit-general').serializeObject(); >> - if (data['memory'] !== undefined) { >> - data['memory'] = Number(data['memory']); >> - } >> - if (data['max-memory'] !== undefined) { >> - data['max-memory'] = Number(data['max-memory']); >> - } >> - >> - // Test memory values before submit. Avoid requests we know >> are going to fail >> - if (parseInt($('#guest-edit-memory-textbox').val()) > >> parseInt($('#guest-edit-max-memory-textbox').val())) { >> - wok.message.error(i18n['KCHVM0002E'], >> '#alert-modal-container'); >> - $(saveButton).prop('disabled', false); >> - return; >> - } >> - >> - // Test CPU values before submit. Avoid requests we know are >> going to fail >> - if (parseInt($('#guest-edit-cores-textbox').val()) > >> parseInt($('#guest-edit-max-processor-textbox').val())) { >> - wok.message.error(i18n['KCHVM0003E'], >> '#alert-modal-container'); >> - $(saveButton).prop('disabled', false); >> - return; >> - } >> - >> - if (data['vcpus'] !== undefined) { >> - var cpu = Number(data['vcpus']); >> - var maxCpu = Number(data['max-processor']); >> - if (data['max-processor'] !== undefined && >> data['max-processor'] !== "") { >> - if (maxCpu >= cpu || maxCpu < cpu ) { // if maxCpu >> < cpu, this will throw an error from backend >> - data['cpu_info'] = { >> - vcpus: cpu, >> - maxvcpus: maxCpu >> - }; >> + kimchi.retrieveVM(kimchi.selectedGuest, function(org) { >> + $(saveButton).prop('disabled', true); >> + var data = $('#form-guest-edit-general').serializeObject(); >> + data['memory'] = {current: Number(data['memory-ui']), >> maxmemory: Number(data['max-memory'])}; >> + data['cpu_info'] = {maxvcpus: >> Number(data['max-processor']), vcpus: Number(data['vcpus']), >> topology: org['cpu_info']['topology']}; >> + var changedFields = {}; >> + for (var key in data) { >> + valueFromUI = data[key]; >> + if (valueFromUI instanceof Object) { >> + // Compare if Objects of original and data are >> identical >> + // Handle special case when key is memory and >> guest is running as valueFromUI will return a null for max mem >> + // since it is disabled; for cpu_info, when >> guest is running, just skip it since no processing is required >> + if (kimchi.thisVMState === 'running' || >> kimchi.thisVMState === 'paused') { > >> + if (key === 'cpu_info') { >> + continue; >> + } > > The above 'if' is not needed as there is nothing to do. This above is needed as otherwise, cpu_info will be added to changedFields due to topology having a value of {} (i.e. the Objects are no longer the same). > >> + if (key === 'memory') { >> + // Replace valueFromUI of max mem with >> one from original as otherwise the value is undefined >> + data['memory']['maxmemory'] = >> org.memory.maxmemory; >> + } >> + } >> + // NOTE: Be aware of using this comparison as >> the order of the properties matter >> + if (JSON.stringify(valueFromUI) !== >> JSON.stringify(org[key])) { >> + changedFields[key] = valueFromUI; >> + } >> + } else { >> + if (org[key] !== undefined) { >> + if (data[key] != org[key]) { >> + changedFields[key] = valueFromUI; >> + } >> + } >> } >> - } else { >> - data['cpu_info'] = { >> - vcpus: cpu, >> - maxvcpus: cpu >> - }; >> } >> - delete data['vcpus']; >> - delete data['max-processor']; >> - } >> - >> - memory = {'current': data['memory'], 'maxmemory': >> data['max-memory']}; >> + var origMem = Number(org.memory.current); >> + var origMaxMem = Number(org.memory.maxmemory); >> + var origCpu = Number(org.cpu_info.vcpus); >> + var origMaxCpu = Number(org.cpu_info.maxvcpus); >> + var currentMem = data['memory-ui']; >> + var currentMaxMem = data['max-memory']; >> + var currentCpu = data['vcpus']; >> + var currentMaxCpu = data['max-processor']; >> + >> + if ('memory' in changedFields) { >> + if (currentMaxMem !== undefined) { >> + currentMaxMem = Number(currentMaxMem); >> + if (currentMaxMem === origMaxMem) { >> + delete changedFields.memory.maxmemory; >> + } >> + } else { >> + delete changedFields.memory.maxmemory; >> + } >> + if (currentMem !== undefined) { >> + currentMem = Number(currentMem); >> + if (kimchi.thisVMState === 'running' || >> kimchi.thisVMState === 'paused') { >> + // Compare to original max mem since current >> max mem is undefined in UI due to being disabled >> + if (currentMem > origMaxMem) { >> + wok.message.error(i18n['KCHVM0002E'], '#alert-modal-container'); >> + $(saveButton).prop('disabled', false); >> + return; >> + } >> + } >> + if (currentMem === origMem) { >> + delete changedFields.memory.current; >> + } >> + } else { >> + delete changedFields.memory.current; >> + } >> + } >> + if ('cpu_info' in changedFields) { >> + if (currentMaxCpu !== undefined) { >> + currentMaxCpu = Number(currentMaxCpu); >> + if (currentMaxCpu === origMaxCpu) { >> + delete changedFields.cpu_info.maxvcpus; >> + } >> + } else { >> + delete changedFields.cpu_info.maxvcpus; >> + } >> + if (currentCpu !== undefined) { >> + currentCpu = Number(currentCpu); >> + if (currentMaxCpu !== undefined && currentCpu > >> currentMaxCpu) { >> + wok.message.error(i18n['KCHVM0003E'], >> '#alert-modal-container'); >> + $(saveButton).prop('disabled', false); >> + return; >> + } >> + if (currentCpu === origCpu) { >> + delete changedFields.cpu_info.vcpus; >> + } >> + if (currentMaxCpu === origMaxCpu) { >> + delete changedFields.cpu_info.maxvcpus; >> + } >> + } else { >> + delete changedFields.cpu_info.vcpus; >> + } >> + // Delete this as it is not applicable regardless >> + delete changedFields.cpu_info.topology; >> + } >> + kimchi.updateVM(kimchi.selectedGuest, changedFields, >> function() { >> + kimchi.listVmsAuto(); >> + wok.window.close(); >> + }, function(err) { >> + wok.message.error(err.responseJSON.reason, >> '#alert-modal-container'); >> + $(saveButton).prop('disabled', false); >> + }); >> >> - data.memory = memory; >> - delete data['max-memory']; >> - kimchi.updateVM(kimchi.selectedGuest, data, function() { >> - kimchi.listVmsAuto(); >> - wok.window.close(); >> - }, function(err) { >> - wok.message.error(err.responseJSON.reason, >> '#alert-modal-container'); >> - $(saveButton).prop('disabled', false); >> }); >> }; >> >> diff --git a/ui/pages/guest-edit.html.tmpl >> b/ui/pages/guest-edit.html.tmpl >> index 5b7155a..f18d42c 100644 >> --- a/ui/pages/guest-edit.html.tmpl >> +++ b/ui/pages/guest-edit.html.tmpl >> @@ -58,7 +58,7 @@ >> <div class="form-group"> >> <label >> for="guest-edit-memory-textbox">$_("Memory (MB)")</label> >> <div id="guest-memory"> > >> - <input id="guest-edit-memory-textbox" >> class="form-control" name="memory" type="number" min="1024" >> step="1024" /> >> + <input id="guest-edit-memory-textbox" >> class="form-control" name="memory-ui" type="number" min="1024" >> step="1024" /> > > Any special reason for that change? I believe it was due to having a conflict w/data['memory'] that we introduced in generalSubmit. > >> <button id="guest-show-max-memory" >> class="btn btn-primary" type="button"><i class="fa >> fa-plus-circle"></i> <span class="text">$_("More")</span></button> >> </div> >> </div> >

1 0

[PATCH] [Wok 2/2] Log time in ISO format
by Lucio Correia 03 Jun '16

03 Jun '16

Signed-off-by: Lucio Correia <luciojhc(a)linux.vnet.ibm.com> --- src/wok/reqlogger.py | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/src/wok/reqlogger.py b/src/wok/reqlogger.py index 2ec62b8..6f32c44 100644 --- a/src/wok/reqlogger.py +++ b/src/wok/reqlogger.py @@ -23,9 +23,9 @@ import json import logging import logging.handlers import os.path +import time from cherrypy.process.plugins import BackgroundTask -from datetime import datetime from tempfile import NamedTemporaryFile from wok.config import config, get_log_download_path @@ -37,11 +37,12 @@ from wok.utils import ascii_dict, remove_old_files FILTER_FIELDS = ['app', 'date', 'download', 'ip', 'req', 'user', 'time'] LOG_DOWNLOAD_URI = "/data/logs/%s" LOG_DOWNLOAD_TIMEOUT = 6 -LOG_FORMAT = "[%(date)s %(time)s] %(req)-6s %(app)-11s %(ip)-15s %(user)s: " \ - "%(message)s\n" +LOG_FORMAT = "[%(date)s %(time)s %(zone)s] %(req)-6s %(app)-11s %(ip)-15s " \ + "%(user)s: %(message)s\n" RECORD_TEMPLATE_DICT = { 'date': '', 'time': '', + 'zone': '', 'req': '', 'app': '', 'ip': '', @@ -49,6 +50,9 @@ RECORD_TEMPLATE_DICT = { 'message': '', } SECONDS_PER_HOUR = 360 +TS_DATE_FORMAT = "%Y-%m-%d" +TS_TIME_FORMAT = "%H:%M:%S" +TS_ZONE_FORMAT = "%Z" # Log handler setup REQUEST_LOG_FILE = "wok-req.log" @@ -180,10 +184,11 @@ class RequestRecord(object): self.message = message self.kwargs = kwargs - # register timestamp - timestamp = datetime.today() - self.kwargs['date'] = timestamp.strftime('%Y-%m-%d') - self.kwargs['time'] = timestamp.strftime('%H:%M:%S') + # register timestamp in local time + timestamp = time.localtime() + self.kwargs['date'] = time.strftime(TS_DATE_FORMAT, timestamp) + self.kwargs['time'] = time.strftime(TS_TIME_FORMAT, timestamp) + self.kwargs['zone'] = time.strftime(TS_ZONE_FORMAT, timestamp) def __str__(self): info = json.JSONEncoder().encode(self.kwargs) -- 1.9.1

1 0

[PATCH] [Wok 1/2] Include user IP address in request log messages
by Lucio Correia 03 Jun '16

03 Jun '16

* Allow advanced log searches by IP address * Add RECORD_TEMPLATE_DICT to avoid versioning errors with older log entries, which don't have IP address. * Remove duplicated comment line Signed-off-by: Lucio Correia <luciojhc(a)linux.vnet.ibm.com> --- src/wok/control/base.py | 10 ++++++---- src/wok/reqlogger.py | 17 ++++++++++++++--- src/wok/root.py | 6 ++++-- 3 files changed, 24 insertions(+), 9 deletions(-) diff --git a/src/wok/control/base.py b/src/wok/control/base.py index 4b459ed..419179a 100644 --- a/src/wok/control/base.py +++ b/src/wok/control/base.py @@ -146,7 +146,8 @@ class Resource(object): msg, app=get_plugin_from_request(), req=method, - user=cherrypy.session.get(USER_NAME, 'N/A') + user=cherrypy.session.get(USER_NAME, 'N/A'), + ip=cherrypy.request.remote.ip ).log() if destructive is False or \ @@ -227,7 +228,8 @@ class Resource(object): msg, app=get_plugin_from_request(), req=method, - user=cherrypy.session.get(USER_NAME, 'N/A') + user=cherrypy.session.get(USER_NAME, 'N/A'), + ip=cherrypy.request.remote.ip ).log() return result @@ -374,7 +376,6 @@ class Collection(object): except Exception as e: # In case of errors when fetching a resource info, pass and # log the error, so, other resources are returned - # log the error, so, other resources are returned. # Encoding error message as ident is also encoded value. # This has to be done to avoid unicode error, # as combination of encoded and unicode value results into @@ -455,7 +456,8 @@ class Collection(object): msg, app=get_plugin_from_request(), req=method, - user=cherrypy.session.get(USER_NAME, 'N/A') + user=cherrypy.session.get(USER_NAME, 'N/A'), + ip=cherrypy.request.remote.ip ).log() return result diff --git a/src/wok/reqlogger.py b/src/wok/reqlogger.py index bbd1bd0..2ec62b8 100644 --- a/src/wok/reqlogger.py +++ b/src/wok/reqlogger.py @@ -34,10 +34,20 @@ from wok.utils import ascii_dict, remove_old_files # Log search setup -FILTER_FIELDS = ['app', 'date', 'download', 'req', 'user', 'time'] +FILTER_FIELDS = ['app', 'date', 'download', 'ip', 'req', 'user', 'time'] LOG_DOWNLOAD_URI = "/data/logs/%s" LOG_DOWNLOAD_TIMEOUT = 6 -LOG_FORMAT = "[%(date)s %(time)s] %(req)-6s %(app)-11s %(user)s: %(message)s\n" +LOG_FORMAT = "[%(date)s %(time)s] %(req)-6s %(app)-11s %(ip)-15s %(user)s: " \ + "%(message)s\n" +RECORD_TEMPLATE_DICT = { + 'date': '', + 'time': '', + 'req': '', + 'app': '', + 'ip': '', + 'user': '', + 'message': '', +} SECONDS_PER_HOUR = 360 # Log handler setup @@ -86,7 +96,8 @@ class RequestParser(object): with fd: for record in sortedList: - asciiRecord = ascii_dict(record) + asciiRecord = RECORD_TEMPLATE_DICT + asciiRecord.update(ascii_dict(record)) fd.write(LOG_FORMAT % asciiRecord) fd.close() diff --git a/src/wok/root.py b/src/wok/root.py index 29ea657..902e203 100644 --- a/src/wok/root.py +++ b/src/wok/root.py @@ -172,7 +172,8 @@ class WokRoot(Root): msg, app=get_plugin_from_request(), req=method, - user=cherrypy.session.get(auth.USER_NAME, 'N/A') + user=cherrypy.session.get(auth.USER_NAME, 'N/A'), + ip=cherrypy.request.remote.ip ).log() return json.dumps(user_info) @@ -187,7 +188,8 @@ class WokRoot(Root): msg, app=get_plugin_from_request(), req=method, - user=params['username'] + user=params['username'], + ip=cherrypy.request.remote.ip ).log() auth.logout() -- 1.9.1

1 0

[PATCH] [Wok 0/2] User Request Log improvements
by Lucio Correia 03 Jun '16

03 Jun '16

Lucio Correia (2): Include user IP address in request log messages Log time in ISO format src/wok/control/base.py | 10 ++++++---- src/wok/reqlogger.py | 32 ++++++++++++++++++++++++-------- src/wok/root.py | 6 ++++-- 3 files changed, 34 insertions(+), 14 deletions(-) -- 1.9.1

1 0

[PATCH] [Wok] Fixed Bootgrid pagination links cursors
by sguimaraes943＠gmail.com 03 Jun '16

03 Jun '16

From: Samuel Guimarães <sguimaraes943(a)gmail.com> This patch fixes active pagination links displaying text or default cursors. When the pagination is disabled it will show the "not-allowed" cursor and when active, it will use default link cursor (pointer). Samuel Guimarães (1): Fixed Bootgrid pagination links cursors ui/css/src/wok.scss | 25 +++++++++++++++++++++++++ ui/css/wok.css | 16 ++++++++++++++++ 2 files changed, 41 insertions(+) -- 1.9.3

2 2

[PATCH] [Kimchi] Github #934: fix storage pool name in template-edit.html.tmpl
by dhbarboza82＠gmail.com 03 Jun '16

03 Jun '16

From: Daniel Henrique Barboza <danielhb(a)linux.vnet.ibm.com> A curious behavior was happening in ui/pages/template-edit.html.tmpl. As reported in Github issue #934, Kimchi was having trouble editing templates in which the storage pool had spaces in the name. Considering a storage pool name 'this is a storage pool', which is a valid storage pool name in libvirt and Kimchi backend, this is how the edit template HTML was being rendered when editing a template with this pool: <input class="template-storage-name" value="this" is="" a="" storage="" pool="" type="text" style="display:none"> If no changes are made in the template storage pool, the UI tries to update the template object with a storage pool named "this", failing a backend check and raising a storage pool not found error. However, if any change is made in the storage pool select box, the JS logic would set the input value properly and dodge this malformed input tag. This patch solves this issue by adding double quote around the storage name element, so value="{storageName}" instead of value={storageName}. This is how the input tag is generated after this change: <input class="template-storage-name" value="this is a storage pool" type="text" style="display:none"> And the UI will always retrieve the right storage pool name when editing a template, even if the name has spaces. Signed-off-by: Daniel Henrique Barboza <danielhb(a)linux.vnet.ibm.com> --- ui/pages/template-edit.html.tmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ui/pages/template-edit.html.tmpl b/ui/pages/template-edit.html.tmpl index c880ef4..2d7deed 100644 --- a/ui/pages/template-edit.html.tmpl +++ b/ui/pages/template-edit.html.tmpl @@ -175,7 +175,7 @@ <script id="template-storage-pool-tmpl" type="text/html"> <div id="storageRow{storageIndex}" class='item'> <span class="template-storage-cell storage-pool"> - <input class="template-storage-name" value={storageName} type="text" style="display:none" /> + <input class="template-storage-name" value="{storageName}" type="text" style="display:none" /> <select id="selectStorageName-{storageIndex}" class="selectStorageName"></select> </span> <span class="template-storage-cell type"> -- 2.5.5

2 1