Add endpoint networks API

coriolis/api/v1/endpoint_networks.py

@@ -0,0 +1,30 @@
+# Copyright 2017 Cloudbase Solutions Srl
+# All Rights Reserved.
+
+from oslo_log import log as logging
+
+from coriolis.api import wsgi as api_wsgi
+from coriolis.api.v1.views import endpoint_network_view
+from coriolis.endpoint_networks import api
+from coriolis import utils
+
+LOG = logging.getLogger(__name__)
+
+
+class EndpointNetworkController(api_wsgi.Controller):
+    def __init__(self):
+        self._network_api = api.API()
+        super(EndpointNetworkController, self).__init__()
+
+    def index(self, req, endpoint_id):
+        env = req.GET.get("env")
+        if env is not None:
+            env = utils.decode_base64_param(env)
+
+        return endpoint_network_view.collection(
+            req, self._network_api.get_endpoint_networks(
+                req.environ['coriolis.context'], endpoint_id, env))
+
+
+def create_resource():
+    return api_wsgi.Resource(EndpointNetworkController())

coriolis/api/v1/router.py

@@ -7,6 +7,7 @@ from coriolis import api
 from coriolis.api.v1 import endpoint_actions
 from coriolis.api.v1 import endpoints
 from coriolis.api.v1 import endpoint_instances
+from coriolis.api.v1 import endpoint_networks
 from coriolis.api.v1 import migrations
 from coriolis.api.v1 import migration_actions
 from coriolis.api.v1 import provider_schemas
@@ -57,6 +58,11 @@ class APIRouter(api.APIRouter):
         mapper.resource('instance', 'endpoints/{endpoint_id}/instances',
                         controller=self.resources['endpoint_instances'])
 
+        self.resources['endpoint_networks'] = \
+            endpoint_networks.create_resource()
+        mapper.resource('network', 'endpoints/{endpoint_id}/networks',
+                        controller=self.resources['endpoint_networks'])
+
         self.resources['provider_schemas'] = \
             provider_schemas.create_resource()
         mapper.resource('provider_schemas',

coriolis/api/v1/views/endpoint_network_view.py

@@ -0,0 +1,23 @@
+# Copyright 2017 Cloudbase Solutions Srl
+# All Rights Reserved.
+
+import itertools
+
+
+def _format_network(req, network, keys=None):
+    def transform(key, value):
+        if keys and key not in keys:
+            return
+        yield (key, value)
+
+    return dict(itertools.chain.from_iterable(
+        transform(k, v) for k, v in network.items()))
+
+
+def single(req, network):
+    return {"network": _format_network(req, network)}
+
+
+def collection(req, networks):
+    formatted_networks = [_format_network(req, m) for m in networks]
+    return {'networks': formatted_networks}

coriolis/conductor/rpc/client.py

@@ -46,6 +46,12 @@ class ConductorClient(object):
             limit=limit,
             instance_name_pattern=instance_name_pattern)
 
+    def get_endpoint_networks(self, ctxt, endpoint_id, env):
+        return self._client.call(
+            ctxt, 'get_endpoint_networks',
+            endpoint_id=endpoint_id,
+            env=env)
+
     def validate_endpoint_connection(self, ctxt, endpoint_id):
         return self._client.call(
             ctxt, 'validate_endpoint_connection',

coriolis/conductor/rpc/server.py

@@ -113,6 +113,12 @@ class ConductorServerEndpoint(object):
             ctxt, endpoint.type, endpoint.connection_info, marker, limit,
             instance_name_pattern)
 
+    def get_endpoint_networks(self, ctxt, endpoint_id, env):
+        endpoint = self.get_endpoint(ctxt, endpoint_id)
+
+        return self._rpc_worker_client.get_endpoint_networks(
+            ctxt, endpoint.type, endpoint.connection_info, env)
+
     def validate_endpoint_connection(self, ctxt, endpoint_id):
         endpoint = self.get_endpoint(ctxt, endpoint_id)
         return self._rpc_worker_client.validate_endpoint_connection(

coriolis/constants.py

@@ -47,6 +47,7 @@ PROVIDER_TYPE_REPLICA_EXPORT = 8
 PROVIDER_TYPE_ENDPOINT = 16
 PROVIDER_TYPE_RESOURCES_ENDPOINT = 32
 PROVIDER_TYPE_OS_MORPHING = 64
+PROVIDER_TYPE_ENDPOINT_NETWORKS = 128
 
 DISK_FORMAT_VMDK = 'vmdk'
 DISK_FORMAT_RAW = 'raw'

coriolis/endpoint_networks/api.py

@@ -0,0 +1,13 @@
+# Copyright 2017 Cloudbase Solutions Srl
+# All Rights Reserved.
+
+from coriolis.conductor.rpc import client as rpc_client
+
+
+class API(object):
+    def __init__(self):
+        self._rpc_client = rpc_client.ConductorClient()
+
+    def get_endpoint_networks(self, ctxt, endpoint_id, env):
+        return self._rpc_client.get_endpoint_networks(
+            ctxt, endpoint_id, env)

coriolis/providers/base.py

@@ -43,6 +43,16 @@ class BaseResourcesEndpointProvider(BaseEndpointProvider):
             "The provider does not define an instance list method.")
 
 
+class BaseEndpointNetworksProvider(object):
+    """ Defines operations for endpoints networks """
+    __metaclass__ = abc.ABCMeta
+
+    @abc.abstractmethod
+    def get_networks(self, ctxt, connection_info, env):
+        """ Returns a list of networks """
+        raise NotImplementedError()
+
+
 class BaseInstanceProvider(BaseProvider):
     __metaclass__ = abc.ABCMeta
 

coriolis/providers/factory.py

@@ -25,6 +25,8 @@ PROVIDER_TYPE_MAP = {
     constants.PROVIDER_TYPE_ENDPOINT: base.BaseEndpointProvider,
     constants.PROVIDER_TYPE_RESOURCES_ENDPOINT:
         base.BaseResourcesEndpointProvider,
+    constants.PROVIDER_TYPE_ENDPOINT_NETWORKS:
+        base.BaseEndpointNetworksProvider,
     constants.PROVIDER_TYPE_OS_MORPHING: base.BaseImportInstanceProvider
 }
 

coriolis/schemas.py

@@ -24,6 +24,7 @@ PROVIDER_TARGET_ENVIRONMENT_SCHEMA_NAME = "target_environment_schema.json"
 _CORIOLIS_VM_EXPORT_INFO_SCHEMA_NAME = "vm_export_info_schema.json"
 _CORIOLIS_VM_INSTANCE_INFO_SCHEMA_NAME = "vm_instance_info_schema.json"
 _CORIOLIS_OS_MORPHING_RES_SCHEMA_NAME = "os_morphing_resources_schema.json"
+_CORIOLIS_VM_NETWORK_SCHEMA_NAME = "vm_network_schema.json"
 
 
 def get_schema(package_name, schema_name,
@@ -76,3 +77,6 @@ CORIOLIS_OS_MORPHING_RESOURCES_SCHEMA = get_schema(
 
 CORIOLIS_VM_INSTANCE_INFO_SCHEMA = get_schema(
     __name__, _CORIOLIS_VM_INSTANCE_INFO_SCHEMA_NAME)
+
+CORIOLIS_VM_NETWORK_SCHEMA = get_schema(
+    __name__, _CORIOLIS_VM_NETWORK_SCHEMA_NAME)

coriolis/schemas/vm_network_schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://cloudbase.it/coriolis/schemas/vm_network_info#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Human-readable name of th network."
+    },
+    "id": {
+      "type": "string",
+      "description": "Unique identifier of the network."
+    }
+  },
+  "required": [
+    "id",
+    "name"
+  ]
+}

coriolis/utils.py

@@ -1,6 +1,8 @@
 # Copyright 2016 Cloudbase Solutions Srl
 # All Rights Reserved.
 
+import base64
+import binascii
 import functools
 import hashlib
 import io
@@ -382,3 +384,10 @@ def parse_int_value(value):
         return int(str(value))
     except ValueError:
         raise exception.InvalidInput("Invalid integer: %s" % value)
+
+
+def decode_base64_param(value):
+    try:
+        return base64.b64decode(value).decode()
+    except (binascii.Error, TypeError) as ex:
+        raise exception.InvalidInput(reason=str(ex))

coriolis/worker/rpc/client.py

@@ -41,6 +41,13 @@ class WorkerClient(object):
             limit=limit,
             instance_name_pattern=instance_name_pattern)
 
+    def get_endpoint_networks(self, ctxt, platform_name, connection_info, env):
+        return self._client.call(
+            ctxt, 'get_endpoint_networks',
+            platform_name=platform_name,
+            connection_info=connection_info,
+            env=env)
+
     def validate_endpoint_connection(self, ctxt, platform_name,
                                      connection_info):
         return self._client.call(

coriolis/worker/rpc/server.py

@@ -184,6 +184,21 @@ class WorkerServerEndpoint(object):
 
         return instances_info
 
+    def get_endpoint_networks(self, ctxt, platform_name, connection_info, env):
+        provider = providers_factory.get_provider(
+            platform_name, constants.PROVIDER_TYPE_ENDPOINT_NETWORKS, None)
+
+        secret_connection_info = utils.get_secret_connection_info(
+            ctxt, connection_info)
+
+        networks_info = provider.get_networks(
+            ctxt, secret_connection_info, env)
+        for network_info in networks_info:
+            schemas.validate_value(
+                network_info, schemas.CORIOLIS_VM_NETWORK_SCHEMA)
+
+        return networks_info
+
     def get_available_providers(self, ctxt):
         return providers_factory.get_available_providers()