Commit eb1c97b8 authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

Compute component: 

- Migrated to use new generic Rest servicer
- Moved client declarations close to use places to prevent initialization locks
- Adaptations to comply with the new settings framework
- Updated unitary tests to use new generic Rest and gRPC servicers and clients
- Minor code styling/formatting
parent 4375de80

src/compute/service/rest_server/nbi_plugins/ietf_l2vpn/L2VPN_Service.py

+6 −12
Original line number Diff line number Diff line
@@ -17,7 +17,6 @@ from flask import request 
from flask.json import jsonify

from flask_restful import Resource

from common.Constants import DEFAULT_CONTEXT_UUID

from common.Settings import get_setting

from context.client.ContextClient import ContextClient

from context.proto.context_pb2 import ServiceId, SliceStatusEnum

from service.client.ServiceClient import ServiceClient
@@ -29,22 +28,16 @@ from .tools.HttpStatusCodes import HTTP_GATEWAYTIMEOUT, HTTP_NOCONTENT, HTTP_OK, 
LOGGER = logging.getLogger(__name__)



class L2VPN_Service(Resource):

    def __init__(self) -> None:

        super().__init__()

        self.context_client = ContextClient(

            get_setting('CONTEXTSERVICE_SERVICE_HOST'), get_setting('CONTEXTSERVICE_SERVICE_PORT_GRPC'))

        self.service_client = ServiceClient(

            get_setting('SERVICESERVICE_SERVICE_HOST'), get_setting('SERVICESERVICE_SERVICE_PORT_GRPC'))



    @HTTP_AUTH.login_required

    def get(self, vpn_id : str):

        LOGGER.debug('VPN_Id: {:s}'.format(str(vpn_id)))

        LOGGER.debug('Request: {:s}'.format(str(request)))



        response = jsonify({})



        try:

            target = get_service(self.context_client, vpn_id)

            context_client = ContextClient()



            target = get_service(context_client, vpn_id)

            if target is not None:

                if target.service_id.service_uuid.uuid != vpn_id: # pylint: disable=no-member

                    raise Exception('Service retrieval failed. Wrong Service Id was returned')
@@ -53,7 +46,7 @@ class L2VPN_Service(Resource): 
                response.status_code = HTTP_OK if service_status == service_ready_status else HTTP_GATEWAYTIMEOUT

                return response



            target = get_slice(self.context_client, vpn_id)

            target = get_slice(context_client, vpn_id)

            if target is not None:

                if target.slice_id.slice_uuid.uuid != vpn_id: # pylint: disable=no-member

                    raise Exception('Slice retrieval failed. Wrong Slice Id was returned')
@@ -80,7 +73,8 @@ class L2VPN_Service(Resource): 
        service_id_request.service_uuid.uuid = vpn_id



        try:

            self.service_client.DeleteService(service_id_request)

            service_client = ServiceClient()

            service_client.DeleteService(service_id_request)

            response = jsonify({})

            response.status_code = HTTP_NOCONTENT

        except Exception as e: # pylint: disable=broad-except

src/compute/service/rest_server/nbi_plugins/ietf_l2vpn/L2VPN_Services.py

+4 −10
Original line number Diff line number Diff line
@@ -19,7 +19,6 @@ from flask.json import jsonify 
from flask_restful import Resource

from werkzeug.exceptions import UnsupportedMediaType

from common.Constants import DEFAULT_CONTEXT_UUID

from common.Settings import get_setting

from service.client.ServiceClient import ServiceClient

from service.proto.context_pb2 import Service, ServiceStatusEnum, ServiceTypeEnum

from slice.client.SliceClient import SliceClient
@@ -32,13 +31,6 @@ from .tools.Validator import validate_message 
LOGGER = logging.getLogger(__name__)



class L2VPN_Services(Resource):

    def __init__(self) -> None:

        super().__init__()

        self.service_client = ServiceClient(

            get_setting('SERVICESERVICE_SERVICE_HOST'), get_setting('SERVICESERVICE_SERVICE_PORT_GRPC'))

        self.slice_client = SliceClient(

            get_setting('SLICESERVICE_SERVICE_HOST'), get_setting('SLICESERVICE_SERVICE_PORT_GRPC'))



    @HTTP_AUTH.login_required

    def get(self):

        return {}
@@ -62,7 +54,8 @@ class L2VPN_Services(Resource): 
                    service_request.service_type = ServiceTypeEnum.SERVICETYPE_L3NM

                    service_request.service_status.service_status = ServiceStatusEnum.SERVICESTATUS_PLANNED



                    service_reply = self.service_client.CreateService(service_request)

                    service_client = ServiceClient()

                    service_reply = service_client.CreateService(service_request)

                    if service_reply != service_request.service_id: # pylint: disable=no-member

                        raise Exception('Service creation failed. Wrong Service Id was returned')

                elif vpn_service_type == 'vpls':
@@ -72,7 +65,8 @@ class L2VPN_Services(Resource): 
                    slice_request.slice_id.slice_uuid.uuid = vpn_service['vpn-id']

                    slice_request.slice_status.slice_status = SliceStatusEnum.SLICESTATUS_PLANNED



                    slice_reply = self.slice_client.CreateSlice(slice_request)

                    slice_client = SliceClient()

                    slice_reply = slice_client.CreateSlice(slice_request)

                    if slice_reply != slice_request.slice_id: # pylint: disable=no-member

                        raise Exception('Slice creation failed. Wrong Slice Id was returned')

src/compute/service/rest_server/nbi_plugins/ietf_l2vpn/L2VPN_SiteNetworkAccesses.py

+8 −13
Original line number Diff line number Diff line
@@ -204,25 +204,20 @@ def process_list_site_network_access( 
    return response



class L2VPN_SiteNetworkAccesses(Resource):

    def __init__(self) -> None:

        super().__init__()

        self.context_client = ContextClient(

            get_setting('CONTEXTSERVICE_SERVICE_HOST'), get_setting('CONTEXTSERVICE_SERVICE_PORT_GRPC'))

        self.service_client = ServiceClient(

            get_setting('SERVICESERVICE_SERVICE_HOST'), get_setting('SERVICESERVICE_SERVICE_PORT_GRPC'))

        self.slice_client = SliceClient(

            get_setting('SLICESERVICE_SERVICE_HOST'), get_setting('SLICESERVICE_SERVICE_PORT_GRPC'))



    @HTTP_AUTH.login_required

    def post(self, site_id : str):

        if not request.is_json: raise UnsupportedMediaType('JSON payload is required')

        LOGGER.debug('Site_Id: {:s}'.format(str(site_id)))

        return process_list_site_network_access(

            self.context_client, self.service_client, self.slice_client, request.json)

        context_client = ContextClient()

        service_client = ServiceClient()

        slice_client = SliceClient()

        return process_list_site_network_access(context_client, service_client, slice_client, request.json)



    @HTTP_AUTH.login_required

    def put(self, site_id : str):

        if not request.is_json: raise UnsupportedMediaType('JSON payload is required')

        LOGGER.debug('Site_Id: {:s}'.format(str(site_id)))

        return process_list_site_network_access(

            self.context_client, self.service_client, self.slice_client, request.json)
 
        context_client = ContextClient()

        service_client = ServiceClient()

        slice_client = SliceClient()

        return process_list_site_network_access(context_client, service_client, slice_client, request.json)

src/compute/tests/MockService_Dependencies.py

0 → 100644
+58 −0
Original line number Diff line number Diff line 
# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)

#

# Licensed 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.



import os

from typing import Union

from common.Constants import ServiceNameEnum

from common.Settings import ENVVAR_SUFIX_SERVICE_HOST, ENVVAR_SUFIX_SERVICE_PORT_GRPC, get_env_var_name

from common.tests.MockServicerImpl_Context import MockServicerImpl_Context

from common.tests.MockServicerImpl_Service import MockServicerImpl_Service

from common.tests.MockServicerImpl_Slice import MockServicerImpl_Slice

from common.tools.service.GenericGrpcService import GenericGrpcService

from context.proto.context_pb2_grpc import add_ContextServiceServicer_to_server

from service.proto.service_pb2_grpc import add_ServiceServiceServicer_to_server

from slice.proto.slice_pb2_grpc import add_SliceServiceServicer_to_server



LOCAL_HOST = '127.0.0.1'



SERVICE_CONTEXT = ServiceNameEnum.CONTEXT

SERVICE_SERVICE = ServiceNameEnum.SERVICE

SERVICE_SLICE = ServiceNameEnum.SLICE



class MockService_Dependencies(GenericGrpcService):

    # Mock Service implementing Context, Service and Slice to simplify unitary tests of Compute



    def __init__(self, bind_port: Union[str, int]) -> None:

        super().__init__(bind_port, LOCAL_HOST, enable_health_servicer=False, cls_name='MockService')



    # pylint: disable=attribute-defined-outside-init

    def install_servicers(self):

        self.context_servicer = MockServicerImpl_Context()

        add_ContextServiceServicer_to_server(self.context_servicer, self.server)



        self.service_servicer = MockServicerImpl_Service()

        add_ServiceServiceServicer_to_server(self.service_servicer, self.server)



        self.slice_servicer = MockServicerImpl_Slice()

        add_SliceServiceServicer_to_server(self.slice_servicer, self.server)



    def configure_env_vars(self):

        os.environ[get_env_var_name(SERVICE_CONTEXT, ENVVAR_SUFIX_SERVICE_HOST     )] = str(self.bind_address)

        os.environ[get_env_var_name(SERVICE_CONTEXT, ENVVAR_SUFIX_SERVICE_PORT_GRPC)] = str(self.bind_port)



        os.environ[get_env_var_name(SERVICE_SERVICE, ENVVAR_SUFIX_SERVICE_HOST     )] = str(self.bind_address)

        os.environ[get_env_var_name(SERVICE_SERVICE, ENVVAR_SUFIX_SERVICE_PORT_GRPC)] = str(self.bind_port)



        os.environ[get_env_var_name(SERVICE_SLICE, ENVVAR_SUFIX_SERVICE_HOST     )] = str(self.bind_address)

        os.environ[get_env_var_name(SERVICE_SLICE, ENVVAR_SUFIX_SERVICE_PORT_GRPC)] = str(self.bind_port)

src/compute/tests/PrepareTestScenario.py

0 → 100644
+52 −0
Original line number Diff line number Diff line 
# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)

#

# Licensed 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.



import os, pytest, time

from common.Constants import ServiceNameEnum

from common.Settings import (

    ENVVAR_SUFIX_SERVICE_HOST, ENVVAR_SUFIX_SERVICE_PORT_HTTP, get_env_var_name, get_service_port_http)

from compute.service.rest_server.RestServer import RestServer

from compute.service.rest_server.nbi_plugins.ietf_l2vpn import register_ietf_l2vpn

from compute.tests.MockService_Dependencies import MockService_Dependencies

from .mock_osm.MockOSM import MockOSM

from .Constants import WIM_MAPPING, WIM_USERNAME, WIM_PASSWORD



LOCAL_HOST = '127.0.0.1'

MOCKSERVICE_PORT = 10000

COMPUTE_SERVICE_PORT = MOCKSERVICE_PORT + get_service_port_http(ServiceNameEnum.COMPUTE)    # avoid privileged ports

os.environ[get_env_var_name(ServiceNameEnum.COMPUTE, ENVVAR_SUFIX_SERVICE_HOST     )] = str(LOCAL_HOST)

os.environ[get_env_var_name(ServiceNameEnum.COMPUTE, ENVVAR_SUFIX_SERVICE_PORT_HTTP)] = str(COMPUTE_SERVICE_PORT)



@pytest.fixture(scope='session')

def mock_service():

    _service = MockService_Dependencies(MOCKSERVICE_PORT)

    _service.configure_env_vars()

    _service.start()

    yield _service

    _service.stop()



@pytest.fixture(scope='session')

def compute_service_rest(mock_service):  # pylint: disable=redefined-outer-name

    _rest_server = RestServer()

    register_ietf_l2vpn(_rest_server)

    _rest_server.start()

    time.sleep(1) # bring time for the server to start

    yield _rest_server

    _rest_server.shutdown()

    _rest_server.join()



@pytest.fixture(scope='session')

def osm_wim(compute_service_rest): # pylint: disable=redefined-outer-name

    wim_url = 'http://{:s}:{:d}'.format(LOCAL_HOST, COMPUTE_SERVICE_PORT)

    return MockOSM(wim_url, WIM_MAPPING, WIM_USERNAME, WIM_PASSWORD)