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

Merge branch... 

Merge branch 'feat/237-elaborate-ietf-slice-nbi-to-support-adding-deleting-new-sdp-connection-group-and-match' into 'develop'

Resolve "Elaborate IETF Slice NBI to support adding/deleting new sdp, connection group, and match criteria"

See merge request !302
parents fd46ebf5 7f30dddc

scripts/run_tests_locally-nbi-ietf-slice.sh

0 → 100755
+25 −0
Original line number Diff line number Diff line 
#!/bin/bash

# Copyright 2022-2024 ETSI OSG/SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)

#

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





PROJECTDIR=`pwd`



cd $PROJECTDIR/src

RCFILE=$PROJECTDIR/coverage/.coveragerc



# Run unitary tests and analyze coverage of code at same time

# helpful pytest flags: --log-level=INFO -o log_cli=true --verbose --maxfail=1 --durations=0

coverage run --rcfile=$RCFILE --append -m pytest --log-level=INFO --verbose \

    nbi/tests/test_slice_2.py

src/common/tools/context_queries/Slice.py

+104 −3
Original line number Diff line number Diff line
@@ -12,12 +12,20 @@ 
# See the License for the specific language governing permissions and

# limitations under the License.



import grpc, logging

from typing import Optional

import logging

from typing import Optional, Tuple, Union

from uuid import UUID, uuid5



import grpc



from common.Constants import DEFAULT_CONTEXT_NAME

from common.proto.context_pb2 import Slice, SliceFilter, SliceId

from common.method_wrappers.ServiceExceptions import InvalidArgumentsException

from common.proto.context_pb2 import ContextId, Slice, SliceFilter, SliceId

from context.client.ContextClient import ContextClient





NAMESPACE_TFS = UUID("200e3a1f-2223-534f-a100-758e29c37f40")



LOGGER = logging.getLogger(__name__)



def get_slice_by_id(
@@ -59,3 +67,96 @@ def get_slice_by_uuid( 
        context_client, slice_id, rw_copy=rw_copy, include_endpoint_ids=include_endpoint_ids,

        include_constraints=include_constraints, include_service_ids=include_service_ids,

        include_subslice_ids=include_subslice_ids, include_config_rules=include_config_rules)





def get_uuid_from_string(

    str_uuid_or_name: Union[str, UUID], prefix_for_name: Optional[str] = None

) -> str:

    # if UUID given, assume it is already a valid UUID

    if isinstance(str_uuid_or_name, UUID):

        return str_uuid_or_name

    if not isinstance(str_uuid_or_name, str):

        MSG = "Parameter({:s}) cannot be used to produce a UUID"

        raise Exception(MSG.format(str(repr(str_uuid_or_name))))

    try:

        # try to parse as UUID

        return str(UUID(str_uuid_or_name))

    except:  # pylint: disable=bare-except

        # produce a UUID within TFS namespace from parameter

        if prefix_for_name is not None:

            str_uuid_or_name = "{:s}/{:s}".format(prefix_for_name, str_uuid_or_name)

        return str(uuid5(NAMESPACE_TFS, str_uuid_or_name))





def context_get_uuid(

    context_id: ContextId,

    context_name: str = "",

    allow_random: bool = False,

    allow_default: bool = False,

) -> str:

    context_uuid = context_id.context_uuid.uuid



    if len(context_uuid) > 0:

        return get_uuid_from_string(context_uuid)

    if len(context_name) > 0:

        return get_uuid_from_string(context_name)

    if allow_default:

        return get_uuid_from_string(DEFAULT_CONTEXT_NAME)



    raise InvalidArgumentsException(

        [

            ("context_id.context_uuid.uuid", context_uuid),

            ("name", context_name),

        ],

        extra_details=["At least one is required to produce a Context UUID"],

    )





def slice_get_uuid(slice_id: SliceId) -> Tuple[str, str]:

    context_uuid = context_get_uuid(slice_id.context_id, allow_random=False)

    raw_slice_uuid = slice_id.slice_uuid.uuid



    if len(raw_slice_uuid) > 0:

        return context_uuid, get_uuid_from_string(

            raw_slice_uuid, prefix_for_name=context_uuid

        )



    raise InvalidArgumentsException(

        [

            ("slice_id.slice_uuid.uuid", raw_slice_uuid),

        ],

        extra_details=["At least one is required to produce a Slice UUID"],

    )



def get_slice_by_defualt_id(

    context_client : ContextClient, default_slice_id : SliceId, context_uuid : str = DEFAULT_CONTEXT_NAME,

    rw_copy : bool = False, include_endpoint_ids : bool = True, include_constraints : bool = True,

    include_service_ids : bool = True, include_subslice_ids : bool = True, include_config_rules : bool = True

) -> Optional[Slice]:

    context_uuid, slice_uuid = slice_get_uuid(default_slice_id)

    LOGGER.debug(f'P60: {context_uuid} {slice_uuid}')

    slice_id = SliceId()

    slice_id.context_id.context_uuid.uuid = context_uuid    # pylint: disable=no-member

    slice_id.slice_uuid.uuid = slice_uuid                   # pylint: disable=no-member

    return get_slice_by_id(

        context_client, slice_id, rw_copy=rw_copy, include_endpoint_ids=include_endpoint_ids,

        include_constraints=include_constraints, include_service_ids=include_service_ids,

        include_subslice_ids=include_subslice_ids, include_config_rules=include_config_rules)





def get_slice_by_defualt_name(

    context_client : ContextClient, slice_name : str, context_uuid : str = DEFAULT_CONTEXT_NAME,

    rw_copy : bool = False, include_endpoint_ids : bool = True, include_constraints : bool = True,

    include_service_ids : bool = True, include_subslice_ids : bool = True, include_config_rules : bool = True

) -> Optional[Slice]:

    default_slice_id = SliceId()

    default_slice_id.context_id.context_uuid.uuid = context_uuid    # pylint: disable=no-member

    default_slice_id.slice_uuid.uuid = slice_name                   # pylint: disable=no-member

    context_uuid, slice_uuid = slice_get_uuid(default_slice_id)

    slice_id = SliceId()

    slice_id.context_id.context_uuid.uuid = context_uuid    # pylint: disable=no-member

    slice_id.slice_uuid.uuid = slice_uuid                   # pylint: disable=no-member

    return get_slice_by_id(

        context_client, slice_id, rw_copy=rw_copy, include_endpoint_ids=include_endpoint_ids,

        include_constraints=include_constraints, include_service_ids=include_service_ids,

        include_subslice_ids=include_subslice_ids, include_config_rules=include_config_rules)

src/nbi/service/__main__.py

+2 −0
Original line number Diff line number Diff line
@@ -31,6 +31,7 @@ from .rest_server.nbi_plugins.ietf_network_slice import register_ietf_nss 
from .rest_server.nbi_plugins.ietf_acl import register_ietf_acl

from .rest_server.nbi_plugins.qkd_app import register_qkd_app

from .rest_server.nbi_plugins.tfs_api import register_tfs_api

from .rest_server.nbi_plugins import register_restconf

from .context_subscription import register_context_subscription



terminate = threading.Event()
@@ -79,6 +80,7 @@ def main(): 
    register_ietf_acl(rest_server)

    register_qkd_app(rest_server)

    register_tfs_api(rest_server)

    register_restconf(rest_server)

    rest_server.start()



    register_context_subscription()

src/nbi/service/rest_server/nbi_plugins/__init__.py

+24 −0
Original line number Diff line number Diff line
@@ -12,3 +12,27 @@ 
# See the License for the specific language governing permissions and

# limitations under the License.



from flask.json import jsonify

from flask_restful import Resource



from nbi.service.rest_server.RestServer import RestServer



from .tools.HttpStatusCodes import HTTP_CREATED



URL_PREFIX = "/restconf/data"





class BaseServer(Resource):

    def post(self):

        response = jsonify({})

        response.status_code = HTTP_CREATED

        return response





def _add_resource(rest_server: RestServer, resource: Resource, *urls, **kwargs):

    urls = [(URL_PREFIX + url) for url in urls]

    rest_server.add_resource(resource, *urls, **kwargs)





def register_restconf(rest_server: RestServer):

    _add_resource(rest_server, BaseServer, "")

src/nbi/service/rest_server/nbi_plugins/ietf_network_slice/NSS_Service.py

+45 −23
Original line number Diff line number Diff line 
# Copyright 2022-2024 ETSI SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)

# Copyright 2022-2024 ETSI OSG/SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.
@@ -13,47 +13,61 @@ 
# limitations under the License.



import logging



from flask.json import jsonify

from flask_restful import Resource



from common.proto.context_pb2 import SliceStatusEnum

from common.tools.context_queries.Slice import get_slice_by_uuid

from common.tools.grpc.Tools import grpc_message_to_json

from context.client.ContextClient import ContextClient

from slice.client.SliceClient import SliceClient



from ..tools.Authentication import HTTP_AUTH

from ..tools.HttpStatusCodes import HTTP_GATEWAYTIMEOUT, HTTP_NOCONTENT, HTTP_OK, HTTP_SERVERERROR

from ..tools.HttpStatusCodes import (

    HTTP_GATEWAYTIMEOUT,

    HTTP_NOCONTENT,

    HTTP_OK,

    HTTP_SERVERERROR,

)



LOGGER = logging.getLogger(__name__)





class NSS_Service(Resource):

    @HTTP_AUTH.login_required

    # @HTTP_AUTH.login_required

    def get(self, slice_id: str):

        LOGGER.debug('GET Slice ID: {:s}'.format(str(slice_id)))

        LOGGER.debug("GET Slice ID: {:s}".format(str(slice_id)))

        try:

            context_client = ContextClient()



            target = get_slice_by_uuid(context_client, slice_id, rw_copy=True)

            if target is None:

                raise Exception('Slice({:s}) not found in database'.format(str(slice_id)))

                raise Exception(

                    "Slice({:s}) not found in database".format(str(slice_id))

                )



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

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

                raise Exception("Slice retrieval failed. Wrong Slice Id was returned")



            slice_ready_status = SliceStatusEnum.SLICESTATUS_ACTIVE

            slice_status = target.slice_status.slice_status  # pylint: disable=no-member

            response = jsonify(grpc_message_to_json(target))

            response.status_code = HTTP_OK if slice_status == slice_ready_status else HTTP_GATEWAYTIMEOUT

            response.status_code = (

                HTTP_OK if slice_status == slice_ready_status else HTTP_GATEWAYTIMEOUT

            )



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

            LOGGER.exception('Something went wrong Retrieving Slice({:s})'.format(str(slice_id)))

            response = jsonify({'error': str(e)})

            LOGGER.exception(

                "Something went wrong Retrieving Slice({:s})".format(str(slice_id))

            )

            response = jsonify({"error": str(e)})

            response.status_code = HTTP_SERVERERROR

        return response





    @HTTP_AUTH.login_required

    # @HTTP_AUTH.login_required

    def delete(self, slice_id: str):

        LOGGER.debug('DELETE Slice ID: {:s}'.format(str(slice_id)))

        LOGGER.debug("DELETE Slice ID: {:s}".format(str(slice_id)))

        try:

            context_client = ContextClient()

            target = get_slice_by_uuid(context_client, slice_id)
@@ -62,17 +76,25 @@ class NSS_Service(Resource): 
            response.status_code = HTTP_OK



            if target is None:

                LOGGER.warning('Slice({:s}) not found in database. Nothing done.'.format(str(slice_id)))

                LOGGER.warning(

                    "Slice({:s}) not found in database. Nothing done.".format(

                        str(slice_id)

                    )

                )

                response.status_code = HTTP_NOCONTENT

            else:

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

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

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

                    raise Exception(

                        "Slice retrieval failed. Wrong Slice Id was returned"

                    )

                slice_client = SliceClient()

                slice_client.DeleteSlice(target.slice_id)

                LOGGER.debug(f"Slice({slice_id}) successfully deleted")



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

            LOGGER.exception('Something went wrong Deleting Slice({:s})'.format(str(slice_id)))

            response = jsonify({'error': str(e)})

            LOGGER.exception(

                "Something went wrong Deleting Slice({:s})".format(str(slice_id))

            )

            response = jsonify({"error": str(e)})

            response.status_code = HTTP_SERVERERROR

        return response