Synnefo

# Copyright 2012 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 django.core.management import CommandError

from synnefo.db.models import (Backend, VirtualMachine, Network,

                               Flavor, IPAddress, Subnet,

                               BridgePoolTable, MacPrefixPoolTable,

                               NetworkInterface, IPAddressLog)

from functools import wraps

from snf_django.lib.api import faults

from synnefo.api import util

from synnefo.logic import backend as backend_mod

from synnefo.logic.rapi import GanetiApiError, GanetiRapiClient

from synnefo.logic.utils import (id_from_instance_name,

                                 id_from_network_name)

import logging

log = logging.getLogger(__name__)

def format_vm_state(vm):

    if vm.operstate == "BUILD":

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

    else:

        return vm.operstate

def get_backend(backend_id):

    try:

        backend_id = int(backend_id)

        return Backend.objects.get(id=backend_id)

    except ValueError:

        raise CommandError("Invalid Backend ID: %s" % backend_id)

    except Backend.DoesNotExist:

        raise CommandError("Backend with ID %s not found in DB. "

                           " Use snf-manage backend-list to find"

                           " out available backend IDs." % backend_id)

def get_image(image_id, user_id):

    if image_id:

        try:

            return util.get_image_dict(image_id, user_id)

        except faults.ItemNotFound:

            raise CommandError("Image with ID %s not found."

                               " Use snf-manage image-list to find"

                               " out available image IDs." % image_id)

    else:

        raise CommandError("image-id is mandatory")

def get_vm(server_id):

    """Get a VirtualMachine object by its ID.

    @type server_id: int or string

    @param server_id: The server's DB id or the Ganeti name

    """

    try:

        server_id = int(server_id)

    except (ValueError, TypeError):

        try:

            server_id = id_from_instance_name(server_id)

        except VirtualMachine.InvalidBackendIdError:

            raise CommandError("Invalid server ID: %s" % server_id)

    try:

        return VirtualMachine.objects.get(id=server_id)

    except VirtualMachine.DoesNotExist:

        raise CommandError("Server with ID %s not found in DB."

                           " Use snf-manage server-list to find out"

                           " available server IDs." % server_id)

def get_network(network_id, for_update=True):

    """Get a Network object by its ID.

    @type network_id: int or string

    @param network_id: The networks DB id or the Ganeti name

    """

    try:

        network_id = int(network_id)

    except (ValueError, TypeError):

        try:

            network_id = id_from_network_name(network_id)

        except Network.InvalidBackendIdError:

            raise CommandError("Invalid network ID: %s" % network_id)

    networks = Network.objects

    if for_update:

        networks = networks.select_for_update()

    try:

        return networks.get(id=network_id)

    except Network.DoesNotExist:

        raise CommandError("Network with ID %s not found in DB."

                           " Use snf-manage network-list to find out"

                           " available network IDs." % network_id)

def get_subnet(subnet_id, for_update=True):

    """Get a Subnet object by its ID."""

    try:

        subet_id = int(subnet_id)

    except (ValueError, TypeError):

        raise CommandError("Invalid subnet ID: %s" % subnet_id)

    try:

        subnets = Subnet.objects

        if for_update:

            subnets.select_for_update()

        return subnets.get(id=subnet_id)

    except Subnet.DoesNotExist:

        raise CommandError("Subnet with ID %s not found in DB."

                           " Use snf-manage subnet-list to find out"

                           " available subnet IDs" % subnet_id)

def get_port(port_id, for_update=True):

    """Get a port object by its ID."""

    try:

        port_id = int(port_id)

    except (ValueError, TypeError):

        raise CommandError("Invalid port ID: %s" % port_id)

    try:

        ports = NetworkInterface.objects

        if for_update:

            ports.select_for_update()

        return ports.get(id=port_id)

    except NetworkInterface.DoesNotExist:

        raise CommandError("Port with ID %s not found in DB."

                           " Use snf-manage port-list to find out"

                           " available port IDs" % port_id)

def get_flavor(flavor_id):

    try:

        flavor_id = int(flavor_id)

        return Flavor.objects.get(id=flavor_id)

    except ValueError:

        raise CommandError("Invalid flavor ID: %s", flavor_id)

    except Flavor.DoesNotExist:

        raise CommandError("Flavor with ID %s not found in DB."

                           " Use snf-manage flavor-list to find out"

                           " available flavor IDs." % flavor_id)

def get_floating_ip_by_address(address, for_update=False):

    try:

        objects = IPAddress.objects

        if for_update:

            objects = objects.select_for_update()

        return objects.get(floating_ip=True, address=address, deleted=False)

    except IPAddress.DoesNotExist:

        raise CommandError("Floating IP does not exist.")

def get_floating_ip_log_by_address(address):

    try:

        objects = IPAddressLog.objects

        return objects.filter(address=address).order_by("released_at")

    except IPAddressLog.DoesNotExist:

        raise CommandError("Floating IP does not exist or it hasn't be"

                           "attached to any server yet")

def get_floating_ip_by_id(floating_ip_id, for_update=False):

    try:

        floating_ip_id = int(floating_ip_id)

    except (ValueError, TypeError):

        raise CommandError("Invalid floating-ip ID: %s" % floating_ip_id)

    try:

        objects = IPAddress.objects

        if for_update:

            objects = objects.select_for_update()

        return objects.get(floating_ip=True, id=floating_ip_id, deleted=False)

    except IPAddress.DoesNotExist:

        raise CommandError("Floating IP %s does not exist." % floating_ip_id)

def check_backend_credentials(clustername, port, username, password):

    try:

        client = GanetiRapiClient(clustername, port, username, password)

        # This command will raise an exception if there is no

        # write-access

        client.ModifyCluster()

    except GanetiApiError as e:

        raise CommandError(e)

    info = client.GetInfo()

    info_name = info['name']

    if info_name != clustername:

        raise CommandError("Invalid clustername value. Please use the"

                           " Ganeti Cluster name: %s" % info_name)

def convert_api_faults(func):

    @wraps(func)

    def wrapper(*args, **kwargs):

        try:

            return func(*args, **kwargs)

        except faults.Fault as e:

            raise CommandError(e.message)

    return wrapper

class Omit(object):

    pass

def wait_server_task(server, wait, stdout):

    jobID = server.task_job_id

    if wait:

        msg = "Issued job '%s'. Waiting to complete...\n"

        stdout.write(msg % jobID)

        client = server.get_client()

        wait_ganeti_job(client, jobID, stdout)

    else:

        msg = "Issued job '%s'.\n"

        stdout.write(msg % jobID)

def wait_ganeti_job(client, jobID, stdout):

    status, error = backend_mod.wait_for_job(client, jobID)

    if status == "success":

        stdout.write("Job finished successfully.\n")

    else:

        raise CommandError("Job failed! Error: %s\n" % error)

def pool_table_from_type(type_):

    if type_ == "mac-prefix":

        return MacPrefixPoolTable

    elif type_ == "bridge":

        return BridgePoolTable

    # elif type == "ip":

    #     return IPPoolTable

    else:

        raise ValueError("Invalid pool type")