[Kimchi-devel] [PATCH] [Kimchi 4/9] Virt-Viewer launcher: virtviewerfile module

[Daniel Henrique Barboza]

On 07/08/2016 03:51 PM, Paulo Ricardo Paz Vital wrote:
> On Jul 08 12:10PM, dhbarboza82 at gmail.com wrote:
>> From: Daniel Henrique Barboza <danielhb at linux.vnet.ibm.com>
>>
>> This new module contains functions to create virt
>> viewer files and a new model called VMVirtViewerFileModel
>> that will return a link to the new generated script
>> file in the lookup() method.
>>
>> Signed-off-by: Daniel Henrique Barboza <danielhb at linux.vnet.ibm.com>
>> ---
>>   model/virtviewerfile.py | 100 ++++++++++++++++++++++++++++++++++++++++++++++++
>>   1 file changed, 100 insertions(+)
>>   create mode 100644 model/virtviewerfile.py
>>
>> diff --git a/model/virtviewerfile.py b/model/virtviewerfile.py
>> new file mode 100644
>> index 0000000..9b2a9bd
>> --- /dev/null
>> +++ b/model/virtviewerfile.py
>> @@ -0,0 +1,100 @@
>> +#
>> +# Project Kimchi
>> +#
>> +# 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 libvirt
>> +import os
>> +
>> +from wok.config import config as wok_config
>> +from wok.exception import NotFoundError, OperationFailed
>> +from wok.plugins.kimchi import config as kimchi_config
>> +from wok.plugins.kimchi.model.vms import VMModel
>> +
>> +
>> +def write_virt_viewer_file(params):
>> +    file_template = """\
>> +[virt-viewer]
>> +type=%(type)s
>> +host=%(host)s
>> +port=%(graphics_port)s
>> +"""
>> +    file_contents = file_template % params
>> +
>> +    if params.get('graphics_passwd'):
>> +        file_contents += 'password=%s\n' % params['graphics_passwd']
>> +
>> +    try:
>> +        with open(params.get('path'), 'w') as vv_file:
>> +            vv_file.write(file_contents)
>> +    except Exception:
>> +        raise
>> +
>> +
>> +def _get_request_host():
>> +    host = cherrypy.request.headers.get('Host')
>> +    if not host:
>> +        host = wok_config.get("server", "host")
>> +    host = host.split(':')[0]
>> +    return host
>> +
>> +
>> +def create_virt_viewer_file(vm_name, graphics_info):
>> +    graphics_type = graphics_info[0]
>> +    graphics_port = graphics_info[2]
>> +    graphics_passwd = graphics_info[3]
>> +
>> +    try:
>> +        host = _get_request_host()
>> +
>> +        default_dir = kimchi_config.get_virtviewerfiles_path()
>> +        file_path = os.path.join(default_dir, '%s-access.vv' % vm_name)
>> +
>> +        file_params = {
>> +            'type': graphics_type,
>> +            'graphics_port': graphics_port,
>> +            'graphics_passwd': graphics_passwd,
>> +            'host': host,
>> +            'path': file_path
>> +        }
>> +        write_virt_viewer_file(file_params)
>> +        return file_path
>> +
>> +    except Exception as e:
>> +        raise OperationFailed("KCHVM0084E",
>> +                              {'name': vm_name, 'err': e.message})
>> +
>> +
>> +class VMVirtViewerFileModel(object):
>> +    def __init__(self, **kargs):
>> +        self.conn = kargs['conn']
>> +
>> +    def _check_if_vm_running(self, name):
>> +        dom = VMModel.get_vm(name, self.conn)
>> +        d_info = dom.info()
>> +        if d_info[0] != libvirt.VIR_DOMAIN_RUNNING:
>> +            raise NotFoundError("KCHVM0083E", {'name': name})
> Is really necessary implement this function? Isn't there any other way
> to get the information from any other class/method already implemented?
>
> Not a big deal, but only a way reuse already methods.

The only backend code I saw that checks whether the VM is
running or not is an internal implementation of serialconsole.py:


     def is_running(self):
         """
         Checks if this guest is currently in a running state.
         """
         return self._guest.state(0)[0] == libvirt.VIR_DOMAIN_RUNNING or \
             self._guest.state(0)[0] == libvirt.VIR_DOMAIN_PAUSED


This method can't be turned to static easily because it relies on the
internal _guest attribute.

We can create a staticmethod on vms.py and make everyone use it. I just
need to check if the PAUSED condition applies to this feature too.

>
>> +
>> +    def lookup(self, name):
>> +        self._check_if_vm_running(name)
>> +        graphics_info = VMModel.get_graphics(name, self.conn)
>> +        file_path = create_virt_viewer_file(name, graphics_info)
>> +
>> +        return 'plugins/kimchi/data/virtviewerfiles/%s' %\
>> +               os.path.basename(file_path)
>> -- 
>> 2.5.5
>>
>> _______________________________________________
>> Kimchi-devel mailing list
>> Kimchi-devel at ovirt.org
>> http://lists.ovirt.org/mailman/listinfo/kimchi-devel
>>