Synnefo

# Copyright 2012-2013 GRNET S.A. All rights reserved.

from synnefo.webproject.management.commands import ListCommand

from synnefo.db.models import Flavor, VirtualMachine

class Command(ListCommand):

    help = "List available server flavors"

    object_class = Flavor

    deleted_field = "deleted"

    def get_vms(flavor):

        return VirtualMachine.objects.filter(flavor=flavor, deleted=False)\

                                     .count()

    FIELDS = {

        "id": ("id", "Flavor's unique ID"),

        "name": ("name", "Flavor's unique name"),

        "cpu": ("cpu", "Number of CPUs"),

        "ram": ("ram", "Size(MB) of RAM"),

        "disk": ("disk", "Size(GB) of disk"),

        "template": ("disk_template", "Disk template"),

        "vms": (get_vms, "Number of active servers using this flavor")

    }

    fields = ["id", "name", "cpu", "ram", "disk", "template", "vms"]

# Copyright 2012-2013 GRNET S.A. All rights reserved.

from synnefo.webproject.management.commands import ListCommand

from logging import getLogger

log = getLogger(__name__)

class Command(ListCommand):

    option_list = ListCommand.option_list + (

            '--ipv6',

            help="Include IPv6 information"),

    object_class = Network

    deleted_field = "deleted"

    user_uuid_field = "userid"

    def get_machines(network):

        return network.machines.filter(deleted=False).count()

    def get_backends(network):

        return network.backend_networks.values_list("backend_id", flat=True)

    FIELDS = {

        "id": ("id", "The ID of the network"),

        "name": ("name", "The name of the network"),

        "user.uuid": ("userid", "The UUID of the network's owner"),

        "public": ("public", "Whether network is public or private"),

        "flavor": ("flavor", "The network's flavor"),

        "state": ("state", "The network's state"),

        "dhcp": ("dhcp", "Whether network uses nfdhcpd or not"),

        "subnet.ipv4": ("subnet", "The IPv4 subnet of the network"),

        "gateway.ipv4": ("gateway", "The IPv4 gateway of the network"),

        "subnet.ipv6": ("subnet", "The IPv6 subnet of the network"),

        "gateway.ipv6": ("gateway", "The IPv6 gateway of the network"),

        "created": ("created", "The date the network was created"),

        "updated": ("created", "The date the network was updated"),

        "deleted": ("deleted", "Whether the network is deleted or not"),

        "mode": ("mode", "The mode of the network"),

        "link": ("link", "The link of the network"),

        "mac_prefix": ("mac_prefix", "The network's MAC prefix"),

        "vms": (get_machines, "Number of connected servers"),

        "backends": (get_backends, "IDs of Ganeti backends that the network is"

                                   " connected to"),

    }

    fields = ["id", "name", "user.uuid", "state", "public", "subnet.ipv4",

              "gateway.ipv4", "link", "mac_prefix"]

    def handle_args(self, *args, **options):

        if options["public"]:

            self.filters["public"] = True

        if options["ipv6"]:

            self.fields.extend(["subnet.ipv6", "gateway.ipv6"])

# Copyright 2012-2013 GRNET S.A. All rights reserved.

from synnefo.webproject.management.commands import ListCommand

from synnefo.management.common import get_backend

from synnefo.api.util import get_image

from logging import getLogger

log = getLogger(__name__)

class Command(ListCommand):

    option_list = ListCommand.option_list + (

            "--build",

            action="store_true",

            dest="build",

            default=False,

            help="List only servers in the building state"),

            "--image-name",

            action="store_true",

            dest="image_name",

            help="Display image name instead of image ID"),

    object_class = VirtualMachine

    deleted_field = "deleted"

    user_uuid_field = "userid"

    def get_public_ip(vm):

        try:

            return vm.nics.all()[0].ipv4

        except IndexError:

            return None

    def format_vm_state(vm):

        if vm.operstate == "BUILD":

            return "BUILD(" + str(vm.buildpercentage) + "%)"

            return vm.operstate

    FIELDS = {

        "id": ("id", "ID of the server"),

        "name": ("name", "Name of the server"),

        "user.uuid": ("userid", "The UUID of the server's owner"),

        "flavor": ("flavor.name", "The name of the server's flavor"),

        "backend": ("backend", "The Ganeti backend that hosts the VM"),

        "image.id": ("imageid", "The ID of the server's image"),

        "image.name": ("image", "The name of the server's image"),

        "state": (format_vm_state, "The current state of the server"),

        "ip": (get_public_ip, "The public IP of the server"),

        "created": ("created", "The date the server was created"),

        "deleted": ("deleted", "Whether the server is deleted or not"),

        "suspended": ("suspended", "Whether the server is administratively"

                      " suspended"),

    }

    fields = ["id", "name", "user.uuid", "state", "flavor", "image.id",

              "backend"]

    def handle_args(self, *args, **options):

        if options["suspended"]:

            self.filters["suspended"] = True

        if options["backend_id"]:

            backend = get_backend(options["backend_id"])

            self.filters["backend"] = backend.id

        if options["build"]:

            self.filters["operstate"] = "BUILD"

        if options["image_name"]:

            self.fields.replace("image.id", "image.name")

    def handle_db_objects(self, rows, *args, **kwargs):

        icache = ImageCache()

        for vm in rows:

            vm.image = icache.get_image(vm.imageid, vm.userid)

from synnefo.db.models import Backend, IPPoolTable

from synnefo.webproject.management.commands import ListCommand

class Command(ListCommand):

    help = "List Ganeti backends"

    object_class = Backend

    def get_vms(backend):

        return backend.virtual_machines.filter(deleted=False).count()

    def get_mem(backend):

        return "%s/%s" % (backend.mfree, backend.mtotal)

    def get_disk(backend):

        return "%s/%s" % (backend.dfree, backend.dtotal)

    def get_ips(backend):

        free_ips = 0

        total_ips = 0

        for bnet in backend.networks.filter(deleted=False,

                                            network__public=True,

                                            network__deleted=False):

            network = bnet.network

            try:

                pool = IPPoolTable.objects.get(id=network.pool_id).pool

                free_ips += pool.count_available()

                total_ips += pool.pool_size

            except IPPoolTable.DoesNotExist:

                pass

        return "%s/%s" % (free_ips, total_ips)

    FIELDS = {

        "id": ("id", "Backend's unique ID"),

        "clustername": ("clustername", "The name of the Ganeti cluster"),

        "port": ("port", ""),

        "username": ("username", "The RAPI user"),

        "drained": ("drained", "Whether backend is marked as drained"),

        "offline": ("offline", "Whether backend if marked as offline"),

        "vms": (get_vms, "Number of VMs that this backend hosts"),

        "ips": (get_ips, "free/total number of public IPs"),

        "mem": (get_mem, "free/total memory (MB)"),

        "disk": (get_mem, "free/total disk (GB)"),

    }

    fields = ["id", "clustername", "port", "username", "drained", "offline",

              "vms", "ips"]

# Copyright 2012-2013 GRNET S.A. All rights reserved.

#

# Redistribution and use in source and binary forms, with or

# without modification, are permitted provided that the following

# conditions are met:

#

#   1. Redistributions of source code must retain the above

#      copyright notice, this list of conditions and the following

#      disclaimer.

#

#   2. Redistributions in binary form must reproduce the above

#      copyright notice, this list of conditions and the following

#      disclaimer in the documentation and/or other materials

#      provided with the distribution.

#

# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

# POSSIBILITY OF SUCH DAMAGE.

#

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be

# interpreted as representing official policies, either expressed

# or implied, of GRNET S.A.

from optparse import make_option

from django.core.management.base import BaseCommand, CommandError

from django.core.exceptions import FieldError

from synnefo.webproject.management import util

from synnefo.management.common import UserCache

class ListCommand(BaseCommand):

    """Generic *-list management command.

    Management command to handle common tasks when implementing a -list

    management command. This class handles the following tasks:

    * Retrieving objects from database.

    The DB model class is declared in ``object_class`` class attribute. Also,

    results can be filter using either the ``filters`` and ``excludes``

    attribute or the "--filter-by" option.

    * Display specific fields of the database objects.

    List of available fields is defined in the ``FIELDS`` class attribute,

    which is a dictionary mapping from field names to tuples containing the

    way the field is retrieved and a text help message to display. The first

    field of the tuple is either a string containing a chain of attribute

    accesses (e.g. "machine.flavor.cpu") either a callable function, taking

    as argument the DB object and returning a single value.

    The fields that will be displayed be default is contained in the ``fields``

    class attribute. The user can specify different fields using the "--fields"

    option.

    * Handling of user UUIDs and names.

    If the ``user_uuid_field`` is declared, then "--user" and "--display-mails"

    options will become available. The first one allows filtering via either

    a user's UUID or display name. The "--displayname" option will append

    the displayname of ther user with "user_uuid_field" to the output.

    * Pretty printing output to a nice table.

    """

    # The following fields must be handled in the ListCommand subclasses!

    # The django DB model

    object_class = None

    # The name of the field containg the user ID of the user, if any.

    user_uuid_field = None

    # The name of the field containg the deleted flag, if any.

    deleted_field = None

    # Dictionary with all available fields

    FIELDS = {}

    # List of fields to display by default

    fields = []

    # Default filters and excludes

    filters = {}

    excludes = {}

    help = "Generic List Command"

    option_list = BaseCommand.option_list + (

        make_option(

            "-o", "--output",

            dest="fields",

            help="Comma-separated list of output fields"),

        make_option(

            "--list-fields",

            dest="list_fields",

            action="store_true",

            default=False,

            help="List available output fields"),

        make_option(

            "--filter-by",

            dest="filter_by",

            metavar="FILTERS",

            help="Filter results. Comma separated list of key `cond` val pairs"

                 " that displayed entries must satisfy. e.g."

                 " --filter-by \"deleted=False,id>=22\"."),

        make_option(

            "--list-filters",

            dest="list_filters",

            action="store_true",

            default=False,

            help="List available filters"),

        make_option(

            "--no-headers",

            dest="headers",

            action="store_false",

            default=True,

            help="Do not display headers"),

        make_option(

            "--output-format",

            dest="output_format",

            metavar="[pretty, csv, json]",

            default="pretty",

            choices=["pretty", "csv", "json"],

            help="Select the output format: pretty [the default], tabs"

                 " [tab-separated output], csv [comma-separated output]"),

    )

    def __init__(self, *args, **kwargs):

        if self.user_uuid_field:

            self.option_list += (

                make_option(

                    "-u", "--user",

                    dest="user",

                    metavar="USER",

                    help="List items only for this user."

                         " 'USER' can be either a user UUID or a display"

                         " name"),

                make_option(

                    "--display-mails",

                    dest="display_mails",

                    action="store_true",

                    default=False,

                    help="Include the user's email"),

            )

        if self.deleted_field:

            self.option_list += (

                make_option(

                    "-d", "--deleted",

                    dest="deleted",

                    action="store_true",

                    help="Display only deleted items"),

            )

        super(ListCommand, self).__init__(*args, **kwargs)

    def handle(self, *args, **options):

        if len(args) > 0:

            raise CommandError("List commands do not accept any argument")

        assert(self.object_class), "object_class variable must be declared"

        if options["list_fields"]:

            self.display_fields()

            return

        if options["list_filters"]:

            self.display_filters()

            return

        # --output option

        if options["fields"]:

            fields = options["fields"]

            fields = fields.split(",")

            self.validate_fields(fields)

            self.fields = options["fields"].split(",")

        # --filter-by option

        if options["filter_by"]:

            filters, excludes = util.parse_filters(options["filter_by"])

        else:

            filters, excludes = ({}, {})

        self.filters.update(filters)

        self.excludes.update(excludes)

        # --user option

        user = options.get("user")

        if user:

            if "@" in user:

                user = UserCache().get_uuid(user)

            self.filters[self.user_uuid_field] = user

        # --deleted option

        if self.deleted_field:

            deleted = options.get("deleted")

            if deleted:

                self.filters[self.deleted_field] = True

            else:

                self.filters[self.deleted_field] = False

        # Special handling of arguments

        self.handle_args(self, *args, **options)

        objects = self.object_class.objects

        try:

            objects = objects.filter(**self.filters)

            objects = objects.exclude(**self.excludes)

        except FieldError as e:

            raise CommandError(e)

        except Exception as e:

            raise CommandError("Can not filter results: %s" % e)

        # --display-mails option

        display_mails = options.get("display_mails")

        if display_mails:

            if 'user_mail' in self.object_class._meta.get_all_field_names():

                raise RuntimeError("%s has already a 'user_mail' attribute")

            self.fields.append("user.email")

            self.FIELDS["user.email"] =\

                ("user_email", "The email of the owner.")

            uuids = [getattr(obj, self.user_uuid_field) for obj in objects]

            ucache = UserCache()

            ucache.fetch_names(list(set(uuids)))

            for obj in objects:

                uuid = getattr(obj, self.user_uuid_field)

                obj.user_email = ucache.get_name(uuid)

        # Special handling of DB results

        self.handle_db_objects(objects)

        headers = self.fields

        columns = [self.FIELDS[key][0] for key in headers]

        table = []

        for obj in objects:

            row = []

            for attr in columns:

                if callable(attr):

                    row.append(attr(obj))

                else:

                    item = obj

                    attrs = attr.split(".")

                    for attr in attrs:

                        item = getattr(item, attr)

                    row.append(item)

            table.append(row)

        # Special handle of output

        self.handle_output(table, headers)

        # Print output

        output_format = options["output_format"]

        headers = headers if options["headers"] else None

        util.pprint_table(self.stdout, table, headers, output_format)

    def handle_args(self, *args, **kwargs):

        pass

    def handle_db_objects(self, objects):

        pass

    def handle_output(self, table, headers):

        pass

    def display_fields(self):

        headers = ["Field", "Description"]

        table = []

        for field, (_, help_msg) in self.FIELDS.items():

            table.append((field, help_msg))

        util.pprint_table(self.stdout, table, headers)

    def validate_fields(self, fields):

        for f in fields:

            if f not in self.FIELDS.keys():

                raise CommandError("Unknown field '%s'. 'Use --list-fields"

                                   " option to find out available fields."

                                   % f)

    def display_filters(self):

        headers = ["Filter", "Description", "Help"]

        table = []

        for field in self.object_class._meta.fields:

            table.append((field.name, field.verbose_name, field.help_text))

        util.pprint_table(self.stdout, table, headers)

import json

def pprint_table(out, table, headers=None, output_format='pretty',

                 separator=None):

    sep = separator if separator else "  "

    def stringnify(obj):

    headers = map(stringnify, headers)

    table = [map(stringnify, row) for row in table]

    if output_format == "json":

        table = [dict(zip(headers, row)) for row in table]

        out.write(json.dumps(table, indent=4))

        out.write("\n")

    elif output_format == "csv":

        if headers:

            line = ",".join("\"%s\"" % uenc(v) for v in headers)

            out.write(line + "\n")

            for row in table:

                line = ",".join("\"%s\"" % uenc(v) for v in row)

                out.write(line + "\n")

    elif output_format == "pretty":

        # Find out the max width of each column

        widths = [max(map(len, col)) for col in zip(*([headers] + table))]

        t_length = sum(widths) + len(sep) * (len(widths) - 1)

        if headers:

            # pretty print the headers

            line = sep.join(uenc(v.rjust(w)) for v, w in zip(headers, widths))

            out.write(line + "\n")

            out.write("-" * t_length + "\n")

        # print the rest table

        for row in table:

            line = sep.join(uenc(v.rjust(w)) for v, w in zip(row, widths))

            out.write(line + "\n")

    else:

        raise ValueError("Unknown output format '%s'" % output_format)