Source code for mcvirt.exceptions

"""Provide access to all MCVirt exceptions."""

# Copyright (c) 2016 - I.T. Dev Ltd
#
# This file is part of MCVirt.
#
# MCVirt is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# MCVirt is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with MCVirt.  If not, see <http://www.gnu.org/licenses/>

import Pyro4

from mcvirt.utils import get_all_submodules


class MCVirtException(Exception):
    """Provides an exception to be thrown for errors in MCVirt"""

    pass


class ConnectionFailureToRemoteLibvirtInstance(MCVirtException):
    """Connection failure whilst attempting to obtain a remote libvirt connection"""

    pass


class CACertificateNotFoundException(MCVirtException):
    """CA certificate for host could not be found"""

    pass


class OpenSSLNotFoundException(MCVirtException):
    """The OpenSSL executable could not be found"""

    pass


class UserNotPresentInGroup(MCVirtException):
    """User to be removed from group is not in the group"""

    pass


class InsufficientPermissionsException(MCVirtException):
    """User does not have the required permission"""

    pass


class UnprivilegedUserException(MCVirtException):
    """Unprivileged user running executable"""

    pass


class InvalidPermissionGroupException(MCVirtException):
    """Attempted to perform actions on an invalid permission group"""

    pass


class MCVirtLockException(MCVirtException):
    """A lock has already been found"""

    pass


class LibVirtConnectionException(MCVirtException):
    """An error ocurred whilst connecting to LibVirt"""

    pass


class DuplicatePermissionException(MCVirtException):
    """User already exists in group"""

    pass


class NodeAlreadyPresent(MCVirtException):
    """Node being added is already connected to cluster"""

    pass


class NodeDoesNotExistException(MCVirtException):
    """The node does not exist"""

    pass


class RemoteObjectConflict(MCVirtException):
    """The remote node contains an object that will cause conflict when syncing"""

    pass


class ClusterNotInitialisedException(MCVirtException):
    """The cluster has not been initialised, so cannot connect to the remote node"""

    pass


class InvalidConnectionString(MCVirtException):
    """Connection string is invalid"""

    pass


class CAFileAlreadyExists(MCVirtException):
    """The CA file already exists."""

    pass


class IncorrectCredentials(MCVirtException):
    """The supplied credentials are incorrect"""

    pass


class InvalidUsernameException(MCVirtException):
    """Username is within a reserved namespace"""

    pass


class AuthenticationError(MCVirtException):
    """Incorrect credentials"""

    pass


class CurrentUserError(MCVirtException):
    """Error whilst obtaining current pyro user"""

    pass


class UserDoesNotExistException(MCVirtException):
    """The specified user does not exist"""

    pass


class PasswordsDoNotMatchException(MCVirtException):
    """The new passwords do not match"""

    pass


class RemoteCommandExecutionFailedException(MCVirtException):
    """A remote command execution fails"""

    pass


class UnknownRemoteCommandException(MCVirtException):
    """An unknown command was passed to the remote machine"""

    pass


class NodeAuthenticationException(MCVirtException):
    """Incorrect password supplied for remote node"""

    pass


class CouldNotConnectToNodeException(MCVirtException):
    """Could not connect to remove cluster node"""

    pass


class RemoteNodeLockedException(MCVirtException):
    """Remote node is locked"""

    pass


class IsoNotPresentOnDestinationNodeException(MCVirtException):
    """ISO attached to VM does not exist on destination node
    whilst performing a migration]
    """

    pass


class InvalidISOPathException(MCVirtException):
    """ISO to add does not exist"""

    pass


class NameNotSpecifiedException(MCVirtException):
    """A name has not been specified and cannot be determined by the path/URL"""

    pass


class IsoAlreadyExistsException(MCVirtException):
    """An ISO with the same name already exists"""

    pass


class FailedToRemoveFileException(MCVirtException):
    """A failure occurred whilst trying to remove an ISO"""

    pass


class IsoInUseException(MCVirtException):
    """The ISO is in use, so cannot be removed"""

    pass


class DrbdNotInstalledException(MCVirtException):
    """Drbd is not installed"""

    pass


class DrbdAlreadyEnabled(MCVirtException):
    """Drbd has already been enabled on this node"""

    pass


class DrbdNotEnabledOnNode(MCVirtException):
    """Drbd volumes cannot be created on a node that has not been configured to use Drbd"""

    pass


class NetworkAlreadyExistsException(MCVirtException):
    """Network already exists with the same name"""

    pass


class LibvirtException(MCVirtException):
    """Issue with performing libvirt command"""

    pass


class NetworkDoesNotExistException(MCVirtException):
    """Network does not exist"""

    pass


class NetworkUtilizedException(MCVirtException):
    """Network is utilized by virtual machines"""

    pass


class InvalidVolumeGroupNameException(MCVirtException):
    """The specified name of the volume group is invalid"""

    pass


class InvalidIPAddressException(MCVirtException):
    """The specified IP address is invalid"""

    pass


class ArgumentParserException(MCVirtException):
    """An invalid argument was provided"""

    pass


class StorageTypeNotSpecified(MCVirtException):
    """Storage type has not been specified"""

    pass


class InvalidNodesException(MCVirtException):
    """The nodes passed is invalid"""

    pass


class HardDriveDoesNotExistException(MCVirtException):
    """The given hard drive does not exist"""

    pass


class StorageTypesCannotBeMixedException(MCVirtException):
    """Storage types cannot be mixed within a single VM"""

    pass


class LogicalVolumeDoesNotExistException(MCVirtException):
    """A required logical volume does not exist"""

    pass


class BackupSnapshotAlreadyExistsException(MCVirtException):
    """The backup snapshot for the logical volume already exists"""

    pass


class BackupSnapshotDoesNotExistException(MCVirtException):
    """The backup snapshot for the logical volume does not exist"""

    pass


class ExternalStorageCommandErrorException(MCVirtException):
    """An error occurred whilst performing an external command"""

    pass


class ReachedMaximumStorageDevicesException(MCVirtException):
    """Reached the limit to number of hard disks attached to VM"""

    pass


class DrbdStateException(MCVirtException):
    """The Drbd state is not OK"""

    pass


class DrbdBlockDeviceDoesNotExistException(MCVirtException):
    """Drbd block device does not exist"""

    pass


class DrbdVolumeNotInSyncException(MCVirtException):
    """The last Drbd verification of the volume failed"""

    pass


class UnknownStorageTypeException(MCVirtException):
    """An hard drive object with an unknown disk type has been initialised"""

    pass


class NetworkAdapterDoesNotExistException(MCVirtException):
    """The network adapter does not exist"""

    pass


class ConfigFileCouldNotBeFoundException(MCVirtException):
    """Config file could not be found"""

    pass


class MigrationFailureExcpetion(MCVirtException):
    """A Libvirt Exception occurred whilst performing a migration"""

    pass


class InvalidVirtualMachineNameException(MCVirtException):
    """VM is being created with an invalid name"""

    pass


class VmAlreadyExistsException(MCVirtException):
    """VM is being created with a duplicate name"""

    pass


class VmDirectoryAlreadyExistsException(MCVirtException):
    """Directory for a VM already exists"""

    pass


class VmAlreadyStoppedException(MCVirtException):
    """VM is already stopped when attempting to stop it"""

    pass


class VmAlreadyStartedException(MCVirtException):
    """VM is already started when attempting to start it"""

    pass


class VmAlreadyRegisteredException(MCVirtException):
    """VM is already registered on a node"""

    pass


class VmRegisteredElsewhereException(MCVirtException):
    """Attempt to perform an action on a VM registered on another node"""

    pass


class VmRunningException(MCVirtException):
    """An offline migration can only be performed on a powered off VM"""

    pass


class VmStoppedException(MCVirtException):
    """An online migraiton can only be performed on a powered on VM"""


class UnsuitableNodeException(MCVirtException):
    """The node is unsuitable to run the VM"""

    pass


class VmNotRegistered(MCVirtException):
    """The virtual machine is not currently registered on a node"""

    pass


class CannotStartClonedVmException(MCVirtException):
    """Cloned VMs cannot be started"""

    pass


class CannotCloneDrbdBasedVmsException(MCVirtException):
    """Cannot clone Drbd-based VMs"""

    pass


class CannotDeleteClonedVmException(MCVirtException):
    """Cannot delete a cloned VM"""

    pass


class VirtualMachineLockException(MCVirtException):
    """Lock cannot be set to the current lock state"""

    pass


class InvalidArgumentException(MCVirtException):
    """Argument given is not valid"""

    pass


class VirtualMachineDoesNotExistException(MCVirtException):
    """Virtual machine does not exist"""

    pass


class VmIsCloneException(MCVirtException):
    """VM is a clone"""

    pass


class VncNotEnabledException(MCVirtException):
    """VNC is not enabled on the VM"""

    pass


class CannotMigrateLocalDiskException(MCVirtException):
    """Local disks cannot be migrated"""

    pass


class DiskAlreadyExistsException(MCVirtException):
    """The disk already exists"""

    pass


class MCVirtCommandException(MCVirtException):
    """Provides an exception to be thrown after errors whilst calling external commands"""

    pass


class InterfaceDoesNotExist(MCVirtException):
    """Physical interface does not exist"""

    pass


class MissingConfigurationException(MCVirtException):
    """Configuration is missing"""

    pass


class CACertificateAlreadyExists(MCVirtException):
    """CA file for server already exists"""

    pass


class MustGenerateCertificateException(MCVirtException):
    """The certificate cannot be manually added and must be generated"""

    pass


class InvalidUserTypeException(MCVirtException):
    """An invalid user type was specified."""

    pass


class UserAlreadyExistsException(MCVirtException):
    """The given user already exists."""

    pass


class LibvirtNotInstalledException(MCVirtException):
    """Libvirt does not appear to be installed"""

    pass


class AttributeAlreadyChanged(MCVirtException):
    """Attribute, user is trying to change, has already changed"""

    pass


class BlankPasswordException(MCVirtException):
    """The provided password is blank"""

    pass


class NodeVersionMismatch(Pyro4.errors.SecurityError):
    """A node is running a different version of MCVirt"""

    pass


class InaccessibleNodeException(MCVirtException, Pyro4.errors.SecurityError):
    """Unable to connect to node in the cluster"""

    pass


for exception_class in get_all_submodules(MCVirtException):
    Pyro4.util.all_exceptions[
        '%s.%s' % (exception_class.__module__, exception_class.__name__)
    ] = exception_class