Synnefo » ./kamaki

# Copyright 2011-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 sys import stdout

from time import sleep

from kamaki.clients.cyclades.rest_api import CycladesRestClient

from kamaki.clients import ClientError

class CycladesClient(CycladesRestClient):

    """GRNet Cyclades API client"""

    def start_server(self, server_id):

        """Submit a startup request

        :param server_id: integer (str or int)

        """

        req = {'start': {}}

        r = self.servers_post(server_id, 'action', json_data=req, success=202)

        r.release()

    def shutdown_server(self, server_id):

        """Submit a shutdown request

        :param server_id: integer (str or int)

        """

        req = {'shutdown': {}}

        r = self.servers_post(server_id, 'action', json_data=req, success=202)

        r.release()

    def get_server_console(self, server_id):

        """

        :param server_id: integer (str or int)

        :returns: (dict) info to set a VNC connection to VM

        """

        req = {'console': {'type': 'vnc'}}

        r = self.servers_post(server_id, 'action', json_data=req, success=200)

        return r.json['console']

    def get_firewall_profile(self, server_id):

        """

        :param server_id: integer (str or int)

        :returns: (str) ENABLED | DISABLED | PROTECTED

        :raises ClientError: 520 No Firewall Profile

        """

        r = self.get_server_details(server_id)

        try:

            return r['attachments']['values'][0]['firewallProfile']

        except KeyError:

            raise ClientError(

                'No Firewall Profile',

                details='Server %s is missing a firewall profile' % server_id)

    def set_firewall_profile(self, server_id, profile):

        """Set the firewall profile for the public interface of a server

        :param server_id: integer (str or int)

        :param profile: (str) ENABLED | DISABLED | PROTECTED

        """

        req = {'firewallProfile': {'profile': profile}}

        r = self.servers_post(server_id, 'action', json_data=req, success=202)

        r.release()

    def list_servers(self, detail=False, changes_since=None):

        """

        :param detail: (bool) append full server details to each item if true

        :param changes_since: (date)

        :returns: list of server ids and names

        """

        detail = 'detail' if detail else ''

        r = self.servers_get(command=detail, changes_since=changes_since)

        return r.json['servers']['values']

    def list_server_nics(self, server_id):

        """

        :param server_id: integer (str or int)

        :returns: (dict) network interface connections

        """

        r = self.servers_get(server_id, 'ips')

        return r.json['addresses']['values']

    def get_server_stats(self, server_id):

        """

        :param server_id: integer (str or int)

        :returns: (dict) auto-generated graphs of statistics (urls)

        """

        r = self.servers_get(server_id, 'stats')

        return r.json['stats']

    def list_networks(self, detail=False):

        """

        :param detail: (bool)

        :returns: (list) id,name if not detail else full info per network

        """

        detail = 'detail' if detail else ''

        r = self.networks_get(command=detail)

        return r.json['networks']['values']

    def list_network_nics(self, network_id):

        """

        :param network_id: integer (str or int)

        :returns: (list)

        """

        r = self.networks_get(network_id=network_id)

        return r.json['network']['attachments']['values']

    def create_network(

            self, name,

            cidr=None, gateway=None, type=None, dhcp=False):

        """

        :param name: (str)

        :param cidr: (str)

        :param geteway: (str)

        :param type: (str)

        :param dhcp: (bool)

        :returns: (dict) network detailed info

        """

        net = dict(name=name)

        if cidr:

            net['cidr'] = cidr

        if gateway:

            net['gateway'] = gateway

        if type:

            net['type'] = type

        net['dhcp'] = True if dhcp else False

        req = dict(network=net)

        r = self.networks_post(json_data=req, success=202)

        return r.json['network']

    def get_network_details(self, network_id):

        """

        :param network_id: integer (str or int)

        :returns: (dict)

        """

        r = self.networks_get(network_id=network_id)

        return r.json['network']

    def update_network_name(self, network_id, new_name):

        """

        :param network_id: integer (str or int)

        :param new_name: (str)

        """

        req = {'network': {'name': new_name}}

        r = self.networks_put(network_id=network_id, json_data=req)

        r.release()

    def delete_network(self, network_id):

        """

        :param network_id: integer (str or int)

        :raises ClientError: 421 Network in use

        """

        try:

            r = self.networks_delete(network_id)

        except ClientError as err:

            if err.status == 421:

                err.details = [

                    'Network may be still connected to at least one server']

            raise err

        r.release()

    def connect_server(self, server_id, network_id):

        """ Connect a server to a network

        :param server_id: integer (str or int)

        :param network_id: integer (str or int)

        """

        req = {'add': {'serverRef': server_id}}

        r = self.networks_post(network_id, 'action', json_data=req)

        r.release()

    def disconnect_server(self, server_id, nic_id):

        """

        :param server_id: integer (str or int)

        :param nic_id: (str)

        :returns: (int) the number of nics disconnected

        """

        vm_nets = self.list_server_nics(server_id)

        num_of_disconnections = 0

        for (nic_id, network_id) in [(

                net['id'],

                net['network_id']) for net in vm_nets if nic_id == net['id']]:

            req = {'remove': {'attachment': '%s' % nic_id}}

            r = self.networks_post(network_id, 'action', json_data=req)

            r.release()

            num_of_disconnections += 1

        return num_of_disconnections

    def disconnect_network_nics(self, netid):

        """

        :param netid: integer (str or int)

        """

        for nic in self.list_network_nics(netid):

            req = dict(remove=dict(attachment=nic))

            r = self.networks_post(netid, 'action', json_data=req)

            r.release()

    def wait_server(

            self,

            server_id,

            current_status='BUILD',

            delay=0.5,

            max_wait=128,

            wait_cb=None):

        """Wait for server while its status is current_status

        :param server_id: integer (str or int)

        :param current_status: (str) BUILD|ACTIVE|STOPPED|DELETED|REBOOT

        :param delay: time interval between retries

        :param wait_cb: if set a progressbar is used to show progress

        :returns: (str) the new mode if succesfull, (bool) False if timed out

        """

        r = self.get_server_details(server_id)

        if r['status'] != current_status:

            return r['status']

        old_wait = total_wait = 0

        if current_status == 'BUILD':

            max_wait = 100

            wait_gen = wait_cb(max_wait) if wait_cb else None

        elif wait_cb:

            wait_gen = wait_cb(1 + max_wait // delay)

            wait_gen.next()

        while r['status'] == current_status and total_wait <= max_wait:

            if current_status == 'BUILD':

                total_wait = int(r['progress'])

                if wait_cb:

                    for i in range(int(old_wait), int(total_wait)):

                        wait_gen.next()

                    old_wait = total_wait

                else:

                    stdout.write('.')

                    stdout.flush()

            else:

                if wait_cb:

                    wait_gen.next()

                else:

                    stdout.write('.')

                    stdout.flush()

                total_wait += delay

            sleep(delay)

            r = self.get_server_details(server_id)

        if r['status'] != current_status:

            if wait_cb:

                try:

                    while True:

                        wait_gen.next()

                except:

                    pass

            return r['status']

        return False