libcloud/compute/providers.py

# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Provider related utilities
"""

from __future__ import absolute_import

from typing import Type
from typing import Union
from types import ModuleType
from typing import TYPE_CHECKING

from libcloud.compute.types import Provider
from libcloud.common.providers import get_driver as _get_provider_driver
from libcloud.common.providers import set_driver as _set_provider_driver
from libcloud.compute.types import OLD_CONSTANT_TO_NEW_MAPPING
from libcloud.compute.deprecated import DEPRECATED_DRIVERS


if TYPE_CHECKING:
    # NOTE: This is needed to avoid having setup.py depend on requests
    from libcloud.compute.base import NodeDriver

__all__ = ["Provider", "DRIVERS", "get_driver"]

DRIVERS = {
    Provider.AZURE: ("libcloud.compute.drivers.azure", "AzureNodeDriver"),
    Provider.AZURE_ARM: ("libcloud.compute.drivers.azure_arm", "AzureNodeDriver"),
    Provider.DUMMY: ("libcloud.compute.drivers.dummy", "DummyNodeDriver"),
    Provider.EC2: ("libcloud.compute.drivers.ec2", "EC2NodeDriver"),
    Provider.ECP: ("libcloud.compute.drivers.ecp", "ECPNodeDriver"),
    Provider.ELASTICHOSTS: (
        "libcloud.compute.drivers.elastichosts",
        "ElasticHostsNodeDriver",
    ),
    Provider.SKALICLOUD: (
        "libcloud.compute.drivers.skalicloud",
        "SkaliCloudNodeDriver",
    ),
    Provider.SERVERLOVE: (
        "libcloud.compute.drivers.serverlove",
        "ServerLoveNodeDriver",
    ),
    Provider.CLOUDSIGMA: (
        "libcloud.compute.drivers.cloudsigma",
        "CloudSigmaNodeDriver",
    ),
    Provider.GCE: ("libcloud.compute.drivers.gce", "GCENodeDriver"),
    Provider.GOGRID: ("libcloud.compute.drivers.gogrid", "GoGridNodeDriver"),
    Provider.RACKSPACE: ("libcloud.compute.drivers.rackspace", "RackspaceNodeDriver"),
    Provider.RACKSPACE_FIRST_GEN: (
        "libcloud.compute.drivers.rackspace",
        "RackspaceFirstGenNodeDriver",
    ),
    Provider.KILI: ("libcloud.compute.drivers.kili", "KiliCloudNodeDriver"),
    Provider.VPSNET: ("libcloud.compute.drivers.vpsnet", "VPSNetNodeDriver"),
    Provider.LINODE: ("libcloud.compute.drivers.linode", "LinodeNodeDriver"),
    Provider.RIMUHOSTING: (
        "libcloud.compute.drivers.rimuhosting",
        "RimuHostingNodeDriver",
    ),
    Provider.VOXEL: ("libcloud.compute.drivers.voxel", "VoxelNodeDriver"),
    Provider.SOFTLAYER: ("libcloud.compute.drivers.softlayer", "SoftLayerNodeDriver"),
    Provider.EUCALYPTUS: ("libcloud.compute.drivers.ec2", "EucNodeDriver"),
    Provider.OPENNEBULA: (
        "libcloud.compute.drivers.opennebula",
        "OpenNebulaNodeDriver",
    ),
    Provider.BRIGHTBOX: ("libcloud.compute.drivers.brightbox", "BrightboxNodeDriver"),
    Provider.NIMBUS: ("libcloud.compute.drivers.ec2", "NimbusNodeDriver"),
    Provider.BLUEBOX: ("libcloud.compute.drivers.bluebox", "BlueboxNodeDriver"),
    Provider.GANDI: ("libcloud.compute.drivers.gandi", "GandiNodeDriver"),
    Provider.DIMENSIONDATA: (
        "libcloud.compute.drivers.dimensiondata",
        "DimensionDataNodeDriver",
    ),
    Provider.OPENSTACK: ("libcloud.compute.drivers.openstack", "OpenStackNodeDriver"),
    Provider.VCLOUD: ("libcloud.compute.drivers.vcloud", "VCloudNodeDriver"),
    Provider.TERREMARK: ("libcloud.compute.drivers.vcloud", "TerremarkDriver"),
    Provider.CLOUDSTACK: (
        "libcloud.compute.drivers.cloudstack",
        "CloudStackNodeDriver",
    ),
    Provider.LIBVIRT: ("libcloud.compute.drivers.libvirt_driver", "LibvirtNodeDriver"),
    Provider.JOYENT: ("libcloud.compute.drivers.joyent", "JoyentNodeDriver"),
    Provider.VCL: ("libcloud.compute.drivers.vcl", "VCLNodeDriver"),
    Provider.KTUCLOUD: ("libcloud.compute.drivers.ktucloud", "KTUCloudNodeDriver"),
    Provider.HOSTVIRTUAL: (
        "libcloud.compute.drivers.hostvirtual",
        "HostVirtualNodeDriver",
    ),
    Provider.ABIQUO: ("libcloud.compute.drivers.abiquo", "AbiquoNodeDriver"),
    Provider.DIGITAL_OCEAN: (
        "libcloud.compute.drivers.digitalocean",
        "DigitalOceanNodeDriver",
    ),
    Provider.NEPHOSCALE: (
        "libcloud.compute.drivers.nephoscale",
        "NephoscaleNodeDriver",
    ),
    Provider.EXOSCALE: ("libcloud.compute.drivers.exoscale", "ExoscaleNodeDriver"),
    Provider.IKOULA: ("libcloud.compute.drivers.ikoula", "IkoulaNodeDriver"),
    Provider.OUTSCALE_SAS: ("libcloud.compute.drivers.ec2", "OutscaleSASNodeDriver"),
    Provider.OUTSCALE_INC: ("libcloud.compute.drivers.ec2", "OutscaleINCNodeDriver"),
    Provider.OUTSCALE: ("libcloud.compute.drivers.outscale", "OutscaleNodeDriver"),
    Provider.PROFIT_BRICKS: (
        "libcloud.compute.drivers.profitbricks",
        "ProfitBricksNodeDriver",
    ),
    Provider.VSPHERE: ("libcloud.compute.drivers.vsphere", "VSphereNodeDriver"),
    Provider.VULTR: ("libcloud.compute.drivers.vultr", "VultrNodeDriver"),
    Provider.AURORACOMPUTE: (
        "libcloud.compute.drivers.auroracompute",
        "AuroraComputeNodeDriver",
    ),
    Provider.CLOUDWATT: ("libcloud.compute.drivers.cloudwatt", "CloudwattNodeDriver"),
    Provider.EQUINIXMETAL: (
        "libcloud.compute.drivers.equinixmetal",
        "EquinixMetalNodeDriver",
    ),
    Provider.ONAPP: ("libcloud.compute.drivers.onapp", "OnAppNodeDriver"),
    Provider.OVH: ("libcloud.compute.drivers.ovh", "OvhNodeDriver"),
    Provider.INTERNETSOLUTIONS: (
        "libcloud.compute.drivers.internetsolutions",
        "InternetSolutionsNodeDriver",
    ),
    Provider.INDOSAT: ("libcloud.compute.drivers.indosat", "IndosatNodeDriver"),
    Provider.MEDONE: ("libcloud.compute.drivers.medone", "MedOneNodeDriver"),
    Provider.BSNL: ("libcloud.compute.drivers.bsnl", "BSNLNodeDriver"),
    Provider.NTTA: ("libcloud.compute.drivers.ntta", "NTTAmericaNodeDriver"),
    Provider.ALIYUN_ECS: ("libcloud.compute.drivers.ecs", "ECSDriver"),
    Provider.CLOUDSCALE: (
        "libcloud.compute.drivers.cloudscale",
        "CloudscaleNodeDriver",
    ),
    Provider.ONEANDONE: ("libcloud.compute.drivers.oneandone", "OneAndOneNodeDriver"),
    Provider.UPCLOUD: ("libcloud.compute.drivers.upcloud", "UpcloudDriver"),
    Provider.NTTCIS: ("libcloud.compute.drivers.nttcis", "NttCisNodeDriver"),
    Provider.SCALEWAY: ("libcloud.compute.drivers.scaleway", "ScalewayNodeDriver"),
    Provider.MAXIHOST: ("libcloud.compute.drivers.maxihost", "MaxihostNodeDriver"),
    Provider.GRIDSCALE: ("libcloud.compute.drivers.gridscale", "GridscaleNodeDriver"),
    Provider.KAMATERA: ("libcloud.compute.drivers.kamatera", "KamateraNodeDriver"),
    Provider.KUBEVIRT: ("libcloud.compute.drivers.kubevirt", "KubeVirtNodeDriver"),
    Provider.GIG_G8: ("libcloud.compute.drivers.gig_g8", "G8NodeDriver"),
}


def get_driver(provider):
    # type: (Union[Provider, str]) -> Type[NodeDriver]
    deprecated_constants = OLD_CONSTANT_TO_NEW_MAPPING
    return _get_provider_driver(
        drivers=DRIVERS,
        provider=provider,
        deprecated_providers=DEPRECATED_DRIVERS,
        deprecated_constants=deprecated_constants,
    )


def set_driver(provider, module, klass):
    # type: (Union[Provider, str], ModuleType, type) -> Type[NodeDriver]
    return _set_provider_driver(
        drivers=DRIVERS, provider=provider, module=module, klass=klass
    )