Commit 30ecbb13 authored by Waleed Akbar's avatar Waleed Akbar
Browse files

feat: Changes in Automation of Pluggable Demo 

- Integrate PluggablesZSMPlugin
- Add Pluggable service handler
parent 07334879

src/automation/client/PolicyClient.py

+8 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ 
import grpc, logging

from common.Constants import ServiceNameEnum

from common.Settings import get_service_host, get_service_port_grpc

from common.proto.policy_pb2 import PolicyRuleService, PolicyRuleState

from common.proto.policy_pb2 import PolicyRuleId, PolicyRuleService, PolicyRuleState

from common.proto.policy_pb2_grpc import PolicyServiceStub

from common.tools.client.RetryDecorator import retry, delay_exponential

from common.tools.grpc.Tools import grpc_message_to_json_string
@@ -52,3 +52,10 @@ class PolicyClient: 
        response = self.stub.PolicyAddService(request)

        LOGGER.info('AddPolicy result: {:s}'.format(grpc_message_to_json_string(response)))

        return response



    @RETRY_DECORATOR

    def PolicyDelete(self, request : PolicyRuleId) -> PolicyRuleState: # type: ignore

        LOGGER.info('DeletePolicy request: {:s}'.format(grpc_message_to_json_string(request)))

        response = self.stub.PolicyDelete(request)

        LOGGER.info('DeletePolicy result: {:s}'.format(grpc_message_to_json_string(response)))

        return response

src/automation/service/zsm_handler_api/ZSMFilterFields.py

+1 −0
Original line number Diff line number Diff line
@@ -22,6 +22,7 @@ class ZSMFilterFieldEnum(Enum): 
TARGET_SERVICE_TYPE_VALUES = {

    ServiceTypeEnum.SERVICETYPE_L2NM,

    ServiceTypeEnum.SERVICETYPE_OPTICAL_CONNECTIVITY,

    ServiceTypeEnum.SERVICETYPE_L3NM,

}



TELEMETRY_SERVICE_TYPE_VALUES = {

src/automation/service/zsm_handlers/PluggablesZSMPlugin.py

0 → 100644
+103 −0
Original line number Diff line number Diff line 
# Copyright 2022-2026 ETSI 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.



import grpc, logging

from uuid import uuid4

from common.proto.analytics_frontend_pb2 import AnalyzerId

from common.proto.policy_pb2 import PolicyRuleState

from common.proto.automation_pb2 import ZSMCreateRequest, ZSMService



from analytics.frontend.client.AnalyticsFrontendClient import AnalyticsFrontendClient

from automation.client.PolicyClient import PolicyClient

from context.client.ContextClient import ContextClient

from automation.service.zsm_handler_api._ZSMHandler import _ZSMHandler





LOGGER = logging.getLogger(__name__)



class PluggablesZSMPlugin(_ZSMHandler):

    def __init__(self):

        LOGGER.info('Init PluggablesZSMPlugin')



    def zsmCreate(self, request : ZSMCreateRequest, context : grpc.ServicerContext): # type: ignore

        context_client            = ContextClient()

        policy_client             = PolicyClient()

        analytics_frontend_client = AnalyticsFrontendClient()



        # Verify the input target service ID

        try:

            target_service_id = context_client.GetService(request.target_service_id)

        except grpc.RpcError as ex:

            LOGGER.exception(f'Unable to get target service:\n{str(target_service_id)}')

            if ex.code() != grpc.StatusCode.NOT_FOUND: raise  # pylint: disable=no-member

            context_client.close()

            return self._zsm_create_response_empty()



        # Verify the input telemetry service ID

        try:

            telemetry_service_id = context_client.GetService(request.telemetry_service_id)

        except grpc.RpcError as ex:

            LOGGER.exception(f'Unable to get telemetry service:\n{str(telemetry_service_id)}')

            if ex.code() != grpc.StatusCode.NOT_FOUND: raise  # pylint: disable=no-member

            context_client.close()

            return self._zsm_create_response_empty()



        # Start an analyzer

        try:

            analyzer_id: AnalyzerId = analytics_frontend_client.StartAnalyzer(request.analyzer) # type: ignore

            LOGGER.info('Analyzer_id:\n{:s}'.format(str(analyzer_id)))

        except grpc.RpcError as ex:

            LOGGER.exception(f'Unable to start Analyzer:\n{str(request.analyzer)}')

            if ex.code() != grpc.StatusCode.NOT_FOUND: raise  # pylint: disable=no-member

            context_client.close()

            analytics_frontend_client.close()

            return self._zsm_create_response_empty()



        # Create a policy

        try:

            LOGGER.info(f'Policy:\n{str(request.policy)}')

            policy_rule_state: PolicyRuleState = policy_client.PolicyAddService(request.policy) # type: ignore

            LOGGER.info(f'Policy rule state:\n{policy_rule_state}')

        except Exception as ex:

            LOGGER.exception(f'Unable to create policy:\n{str(request.policy)}')

            LOGGER.exception(ex.code())

            # ToDo: Investigate why PolicyAddService throws exception

            # if ex.code() != grpc.StatusCode.NOT_FOUND: raise  # pylint: disable=no-member

            context_client.close()

            policy_client.close()

            return self._zsm_create_response_empty()



        context_client.close()

        analytics_frontend_client.close()

        policy_client.close()

        return self._zsm_create_response(request)



    def zsmDelete(self):

        LOGGER.info('zsmDelete method')



    def zsmGetById(self):

        LOGGER.info('zsmGetById method')



    def zsmGetByService(self):

        LOGGER.info('zsmGetByService method')



    def _zsm_create_response(self, request):

        response                             = ZSMService()

        automation_id                        = str(uuid4())

        response.zsmServiceId.uuid.uuid      = automation_id

        response.serviceId.service_uuid.uuid = request.target_service_id.service_uuid.uuid

        return response



    def _zsm_create_response_empty(self):

        return ZSMService()

src/automation/service/zsm_handlers/__init__.py

+9 −2
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ from common.proto.context_pb2 import ServiceTypeEnum 
from ..zsm_handler_api.ZSMFilterFields import ZSMFilterFieldEnum

from automation.service.zsm_handlers.P4INTZSMPlugin      import P4INTZSMPlugin

from automation.service.zsm_handlers.OpticalZSMPlugin    import OpticalZSMPlugin

from automation.service.zsm_handlers.PluggablesZSMPlugin import PluggablesZSMPlugin



ZSM_SERVICE_HANDLERS = [

    (P4INTZSMPlugin, [
@@ -24,6 +25,12 @@ ZSM_SERVICE_HANDLERS = [ 
            ZSMFilterFieldEnum.TELEMETRY_SERVICE_TYPE : ServiceTypeEnum.SERVICETYPE_INT,

        }

    ]),

    (PluggablesZSMPlugin, [

        {

            ZSMFilterFieldEnum.TARGET_SERVICE_TYPE : ServiceTypeEnum.SERVICETYPE_L3NM,

            ZSMFilterFieldEnum.TELEMETRY_SERVICE_TYPE : ServiceTypeEnum.SERVICETYPE_OPTICAL_CONNECTIVITY,

        }

    ]),

    (OpticalZSMPlugin, [

        {

            ZSMFilterFieldEnum.TARGET_SERVICE_TYPE : ServiceTypeEnum.SERVICETYPE_OPTICAL_CONNECTIVITY,