hypervisor_base.py

from abc import ABCMeta, abstractmethod


##
# Base class for hypervisors. This class must be extended by
#       a hypervisor driver.
#     
class HypervisorBase(object):
    __metaclass__ = ABCMeta

    @abstractmethod
    ##
    # Returns the hypervisor specific ID of the VM or container.
    #       
    #       Args:
    #         Defined in derived class.
    #         
    #       Returns:
    #         Hypervisor specific ID for a VM or container.
    #       
    def get_id(self):
      pass

    @abstractmethod
    ##
    # Deploys a VM or continer.
    #       
    #       Args:
    #         Defined in derived class.
    #         
    #       Returns:
    #         Hypervisor specific return code.
    #       
    def deploy(self):
      pass

    @abstractmethod
    ##
    # Pauses a VM or continer.
    #       
    #       Args:
    #         Defined in derived class.
    #         
    #       Returns:
    #         Hypervisor specific return code.
    #       
    def pause(self):
      pass

    @abstractmethod
    ##
    # Destroys a VM or continer.
    #       
    #       Args:
    #         Defined in derived class.
    #         
    #       Returns:
    #         Hypervisor specific return code.
    #       
    def destroy(self):
      pass

    @abstractmethod
    ##
    # Executes a command in the VM or continer.
    #       
    #       Args:
    #         Defined in derived class.
    #         
    #       Returns:
    #         Hypervisor specific return code.
    #       
    def execute_in_guest(self):
      pass

    @abstractmethod
    ##
    # Returns the current status of a VM or continer.
    #       
    #       Args:
    #         Defined in derived class.
    #         
    #       Returns:
    #         Current status of a VM or container.
    #       
    def guest_status(self):
      pass