python-neutronclient/quantumclient/cli_lib.py

# vim: tabstop=4 shiftwidth=4 softtabstop=4

# Copyright 2011 Nicira Networks, Inc.
# Copyright 2011 Citrix Systems
#
#    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.
# @author: Somik Behera, Nicira Networks, Inc.
# @author: Brad Hall, Nicira Networks, Inc.
# @author: Salvatore Orlando, Citrix

""" Functions providing implementation for CLI commands. """

import logging
import traceback


LOG = logging.getLogger('quantumclient.cli_lib')


FORMAT = "json"


class OutputTemplate(object):
    """ A class for generating simple templated output.
        Based on Python templating mechanism.
        Templates can also express attributes on objects, such as network.id;
        templates can also be nested, thus allowing for iteration on inner
        templates.

        Examples:
        1) template with class attributes
        Name: %(person.name)s \n
        Surname: %(person.surname)s \n
        2) template with iteration
        Telephone numbers: \n
        %(phone_numbers|Telephone number:%(number)s)
        3) template with iteration and class attributes
        Addresses: \n
        %(Addresses|Street:%(address.street)s\nNumber%(address.number))

        Instances of this class are initialized with a template string and
        the dictionary for performing substitution. The class implements the
        __str__ method, so it can be directly printed.
    """

    def __init__(self, template, data):
        self._template = template
        self.data = data

    def __str__(self):
        return self._template % self

    def __getitem__(self, key):
        items = key.split("|")
        # Note(madhav-puri): for now the logic supports only 0 or 1 list
        # indicators (|) in a template.
        if len(items) > 2:
            raise Exception("Found more than one list indicator (|).")
        if len(items) == 1:
            return self._make_attribute(key)
        else:
            # Note(salvatore-orlando): items[0] must be subscriptable
            return self._make_list(self._make_attribute(items[0]), items[1])

    def _make_attribute(self, item):
        """ Renders an entity attribute key in the template.
           e.g.: entity.attribute
        """
        items = item.split('.')
        attr = self.data[items[0]]
        for _item in items[1:]:
            attr = attr[_item]
        return attr

    def _make_list(self, items, inner_template):
        """ Renders a list key in the template.
            e.g.: %(list|item data:%(item))
        """
        #make sure list is subscriptable
        if not hasattr(items, '__getitem__'):
            raise Exception("Element is not iterable")
        return "\n".join([str(OutputTemplate(inner_template, item))
                          for item in items])


class CmdOutputTemplate(OutputTemplate):
    """ This class provides templated output for CLI commands.
        Extends OutputTemplate loading a different template for each command.
    """

    _templates_v10 = dict(
        list_nets="""
Virtual Networks for Tenant %(tenant_id)s
%(networks|\tNetwork ID: %(id)s)s
""".strip(),

        list_nets_detail="""
Virtual Networks for Tenant %(tenant_id)s
%(networks|\tNetwork %(name)s with ID: %(id)s)s
""".strip(),

        show_net="""
Network ID: %(network.id)s
Network Name: %(network.name)s
""".strip(),

        show_net_detail="""
Network ID: %(network.id)s
Network Name: %(network.name)s
Ports: %(network.ports|\tID: %(id)s
\t\tadministrative state: %(state)s
\t\tinterface: %(attachment.id)s)s
""".strip(),

        create_net="""
Created a new Virtual Network with ID: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(),

        update_net="""
Updated Virtual Network with ID: %(network.id)s
for Tenant: %(tenant_id)s
""".strip(),

        delete_net="""
Deleted Virtual Network with ID: %(network_id)s
for Tenant %(tenant_id)s
""".strip(),

        list_ports="""
Ports on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
%(ports|\tLogical Port: %(id)s)s
""".strip(),

        list_ports_detail="""
Ports on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
%(ports|\tLogical Port: %(id)s
\t\tadministrative State: %(state)s)s
""".strip(),

        create_port="""
Created new Logical Port with ID: %(port_id)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(),

        show_port="""
Logical Port ID: %(port.id)s
administrative State: %(port.state)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(),

        show_port_detail="""
Logical Port ID: %(port.id)s
administrative State: %(port.state)s
interface: %(port.attachment.id)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(),

        update_port="""
Updated Logical Port with ID: %(port.id)s
on Virtual Network: %(network_id)s
for tenant: %(tenant_id)s
""".strip(),

        delete_port="""
Deleted Logical Port with ID: %(port_id)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(),

        plug_iface="""
Plugged interface %(attachment)s
into Logical Port: %(port_id)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(),

        unplug_iface="""
Unplugged interface from Logical Port: %(port_id)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(),

        show_iface="""
interface: %(iface.id)s
plugged in Logical Port ID: %(port_id)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(), )

    _templates_v11 = _templates_v10.copy()
    _templates_v11.update(dict(
        show_net="""
Network ID: %(network.id)s
network Name: %(network.name)s
operational Status: %(network.op-status)s
""".strip(),

        show_net_detail="""
Network ID: %(network.id)s
Network Name: %(network.name)s
operational Status: %(network.op-status)s
Ports: %(network.ports|\tID: %(id)s
\t\tadministrative state: %(state)s
\t\tinterface: %(attachment.id)s)s
""".strip(),

        show_port="""
Logical Port ID: %(port.id)s
administrative state: %(port.state)s
operational status: %(port.op-status)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(),

        show_port_detail="""
Logical Port ID: %(port.id)s
administrative State: %(port.state)s
operational status: %(port.op-status)s
interface: %(port.attachment.id)s
on Virtual Network: %(network_id)s
for Tenant: %(tenant_id)s
""".strip(), ))

    _templates = {
        '1.0': _templates_v10,
        '1.1': _templates_v11, }

    def __init__(self, cmd, data, version):
        super(CmdOutputTemplate, self).__init__(
            self._templates[version][cmd], data)


def _handle_exception(ex):
    status_code = None
    message = None
    # Retrieve dict at 1st element of tuple at last argument
    if ex.args and isinstance(ex.args[-1][0], dict):
        status_code = ex.args[-1][0].get('status_code', None)
        message = ex.args[-1][0].get('message', None)
        msg_1 = ("Command failed with error code: %s" %
                 (status_code or '<missing>'))
        msg_2 = "Error message:%s" % (message or '<missing>')
        print msg_1
        print msg_2
    else:
        traceback.print_exc()


def prepare_output(cmd, tenant_id, response, version):
    LOG.debug("Preparing output for response:%s, version:%s" %
              (response, version))
    response['tenant_id'] = tenant_id
    output = str(CmdOutputTemplate(cmd, response, version))
    LOG.debug("Finished preparing output for command:%s", cmd)
    return output


def list_nets(client, *args):
    tenant_id, version = args
    try:
        res = client.list_networks()
        LOG.debug("Operation 'list_networks' executed.")
        output = prepare_output("list_nets", tenant_id, res, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def list_nets_v11(client, *args):
    filters = {}
    tenant_id, version = args[:2]
    if len(args) > 2:
        filters = args[2]
    try:
        res = client.list_networks(**filters)
        LOG.debug("Operation 'list_networks' executed.")
        output = prepare_output("list_nets", tenant_id, res, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def list_nets_detail(client, *args):
    tenant_id, version = args
    try:
        res = client.list_networks_details()
        LOG.debug("Operation 'list_networks_details' executed.")
        output = prepare_output("list_nets_detail", tenant_id, res, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def list_nets_detail_v11(client, *args):
    filters = {}
    tenant_id, version = args[:2]
    if len(args) > 2:
        filters = args[2]
    try:
        res = client.list_networks_details(**filters)
        LOG.debug("Operation 'list_networks_details' executed.")
        output = prepare_output("list_nets_detail", tenant_id, res, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def create_net(client, *args):
    tenant_id, name, version = args
    data = {'network': {'name': name}}
    new_net_id = None
    try:
        res = client.create_network(data)
        new_net_id = res["network"]["id"]
        LOG.debug("Operation 'create_network' executed.")
        output = prepare_output("create_net",
                                tenant_id,
                                dict(network_id=new_net_id),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def delete_net(client, *args):
    tenant_id, network_id, version = args
    try:
        client.delete_network(network_id)
        LOG.debug("Operation 'delete_network' executed.")
        output = prepare_output("delete_net",
                                tenant_id,
                                dict(network_id=network_id),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def show_net(client, *args):
    tenant_id, network_id, version = args
    try:
        res = client.show_network(network_id)["network"]
        LOG.debug("Operation 'show_network' executed.")
        output = prepare_output("show_net", tenant_id,
                                dict(network=res),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def show_net_detail(client, *args):
    tenant_id, network_id, version = args
    try:
        res = client.show_network_details(network_id)["network"]
        LOG.debug("Operation 'show_network_details' executed.")
        if not len(res["ports"]):
            res["ports"] = [{"id": "<none>",
                             "state": "<none>",
                             "attachment": {"id": "<none>"}}]
        else:
            for port in res["ports"]:
                if "attachment" not in port:
                    port["attachment"] = {"id": "<none>"}

        output = prepare_output("show_net_detail",
                                tenant_id,
                                dict(network=res),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def update_net(client, *args):
    tenant_id, network_id, param_data, version = args
    data = {'network': {}}
    for kv in param_data.split(","):
        k, v = kv.split("=")
        data['network'][k] = v
    data['network']['id'] = network_id
    try:
        client.update_network(network_id, data)
        LOG.debug("Operation 'update_network' executed.")
        # Response has no body. Use data for populating output
        output = prepare_output("update_net", tenant_id, data, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def list_ports(client, *args):
    tenant_id, network_id, version = args
    try:
        ports = client.list_ports(network_id)
        LOG.debug("Operation 'list_ports' executed.")
        data = ports
        data['network_id'] = network_id
        output = prepare_output("list_ports", tenant_id, data, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def list_ports_v11(client, *args):
    filters = {}
    tenant_id, network_id, version = args[:3]
    if len(args) > 3:
        filters = args[3]
    try:
        ports = client.list_ports(network_id, **filters)
        LOG.debug("Operation 'list_ports' executed.")
        data = ports
        data['network_id'] = network_id
        output = prepare_output("list_ports", tenant_id, data, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def list_ports_detail(client, *args):
    tenant_id, network_id, version = args
    try:
        ports = client.list_ports_details(network_id)
        LOG.debug("Operation 'list_ports_details' executed.")
        data = ports
        data['network_id'] = network_id
        output = prepare_output("list_ports_detail", tenant_id, data, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def list_ports_detail_v11(client, *args):
    filters = {}
    tenant_id, network_id, version = args[:3]
    if len(args) > 3:
        filters = args[3]
    try:
        ports = client.list_ports_details(network_id, **filters)
        LOG.debug("Operation 'list_ports' executed.")
        data = ports
        data['network_id'] = network_id
        output = prepare_output("list_ports_detail", tenant_id, data, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def create_port(client, *args):
    tenant_id, network_id, version = args
    try:
        res = client.create_port(network_id)
        LOG.debug("Operation 'create_port' executed.")
        new_port_id = res["port"]["id"]
        output = prepare_output("create_port",
                                tenant_id,
                                dict(network_id=network_id,
                                     port_id=new_port_id),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def delete_port(client, *args):
    tenant_id, network_id, port_id, version = args
    try:
        client.delete_port(network_id, port_id)
        LOG.debug("Operation 'delete_port' executed.")
        output = prepare_output("delete_port",
                                tenant_id,
                                dict(network_id=network_id,
                                     port_id=port_id),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)
        return


def show_port(client, *args):
    tenant_id, network_id, port_id, version = args
    try:
        port = client.show_port(network_id, port_id)["port"]
        LOG.debug("Operation 'show_port' executed.")
        output = prepare_output("show_port", tenant_id,
                                dict(network_id=network_id,
                                     port=port),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def show_port_detail(client, *args):
    tenant_id, network_id, port_id, version = args
    try:
        port = client.show_port_details(network_id, port_id)["port"]
        LOG.debug("Operation 'show_port_details' executed.")
        if 'attachment' not in port:
            port['attachment'] = {'id': '<none>'}
        output = prepare_output("show_port_detail", tenant_id,
                                dict(network_id=network_id,
                                     port=port),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def update_port(client, *args):
    tenant_id, network_id, port_id, param_data, version = args
    data = {'port': {}}
    for kv in param_data.split(","):
        k, v = kv.split("=")
        data['port'][k] = v
    data['network_id'] = network_id
    data['port']['id'] = port_id
    try:
        client.update_port(network_id, port_id, data)
        LOG.debug("Operation 'udpate_port' executed.")
        # Response has no body. Use data for populating output
        output = prepare_output("update_port", tenant_id, data, version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def plug_iface(client, *args):
    tenant_id, network_id, port_id, attachment, version = args
    try:
        data = {'attachment': {'id': '%s' % attachment}}
        client.attach_resource(network_id, port_id, data)
        LOG.debug("Operation 'attach_resource' executed.")
        output = prepare_output("plug_iface", tenant_id,
                                dict(network_id=network_id,
                                     port_id=port_id,
                                     attachment=attachment),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def unplug_iface(client, *args):
    tenant_id, network_id, port_id, version = args
    try:
        client.detach_resource(network_id, port_id)
        LOG.debug("Operation 'detach_resource' executed.")
        output = prepare_output("unplug_iface",
                                tenant_id,
                                dict(network_id=network_id,
                                     port_id=port_id),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)


def show_iface(client, *args):
    tenant_id, network_id, port_id, version = args
    try:
        iface = client.show_port_attachment(network_id, port_id)['attachment']
        if 'id' not in iface:
            iface['id'] = '<none>'
        LOG.debug("Operation 'show_port_attachment' executed.")
        output = prepare_output("show_iface", tenant_id,
                                dict(network_id=network_id,
                                     port_id=port_id,
                                     iface=iface),
                                version)
        print output
    except Exception as ex:
        _handle_exception(ex)