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

Service component: 

- Added missing L2NM-OpenConfig Service Handler
parent a9af0c80

src/service/service/service_handlers/__init__.py

+7 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ 
from common.proto.context_pb2 import DeviceDriverEnum, ServiceTypeEnum

from ..service_handler_api.FilterFields import FilterFieldEnum

from .l2nm_emulated.L2NMEmulatedServiceHandler import L2NMEmulatedServiceHandler

from .l2nm_openconfig.L2NMOpenConfigServiceHandler import L2NMOpenConfigServiceHandler

from .l3nm_emulated.L3NMEmulatedServiceHandler import L3NMEmulatedServiceHandler

from .l3nm_openconfig.L3NMOpenConfigServiceHandler import L3NMOpenConfigServiceHandler

from .p4.p4_service_handler import P4ServiceHandler
@@ -28,6 +29,12 @@ SERVICE_HANDLERS = [ 
            FilterFieldEnum.DEVICE_DRIVER : DeviceDriverEnum.DEVICEDRIVER_UNDEFINED,

        }

    ]),

    (L2NMOpenConfigServiceHandler, [

        {

            FilterFieldEnum.SERVICE_TYPE  : ServiceTypeEnum.SERVICETYPE_L2NM,

            FilterFieldEnum.DEVICE_DRIVER : DeviceDriverEnum.DEVICEDRIVER_OPENCONFIG,

        }

    ]),

    (L3NMEmulatedServiceHandler, [

        {

            FilterFieldEnum.SERVICE_TYPE  : ServiceTypeEnum.SERVICETYPE_L3NM,

src/service/service/service_handlers/l2nm_openconfig/ConfigRules.py

0 → 100644
+134 −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.



from typing import Dict, List

from common.tools.object_factory.ConfigRule import json_config_rule_delete, json_config_rule_set

from service.service.service_handler_api.AnyTreeTools import TreeNode



def setup_config_rules(

    service_uuid : str, connection_uuid : str, device_uuid : str, endpoint_uuid : str,

    service_settings : TreeNode, endpoint_settings : TreeNode

) -> List[Dict]:



    json_settings          : Dict = {} if service_settings  is None else service_settings.value

    json_endpoint_settings : Dict = {} if endpoint_settings is None else endpoint_settings.value



    mtu                 = json_settings.get('mtu',                 1450 )    # 1512

    #address_families    = json_settings.get('address_families',    []   )    # ['IPV4']

    #bgp_as              = json_settings.get('bgp_as',              0    )    # 65000

    #bgp_route_target    = json_settings.get('bgp_route_target',    '0:0')    # 65000:333



    router_id           = json_endpoint_settings.get('router_id',           '0.0.0.0')  # '10.95.0.10'

    #route_distinguisher = json_endpoint_settings.get('route_distinguisher', '0:0'    )  # '60001:801'

    sub_interface_index = json_endpoint_settings.get('sub_interface_index', 0        )  # 1

    vlan_id             = json_endpoint_settings.get('vlan_id',             1        )  # 400

    #address_ip          = json_endpoint_settings.get('address_ip',          '0.0.0.0')  # '2.2.2.1'

    #address_prefix      = json_endpoint_settings.get('address_prefix',      24       )  # 30

    remote_router       = json_endpoint_settings.get('remote_router',       '0.0.0.0')  # '5.5.5.5'

    circuit_id          = json_endpoint_settings.get('circuit_id',          '000'    )  # '111'



    if_cirid_name         = '{:s}.{:s}'.format(endpoint_uuid, str(circuit_id))

    network_instance_name = 'ELAN-AC:{:s}'.format(str(circuit_id))

    connection_point_id   = 'VC-1'



    json_config_rules = [

        json_config_rule_set(

            '/network_instance[default]',

            {'name': 'default', 'type': 'DEFAULT_INSTANCE', 'router_id': router_id}),



        json_config_rule_set(

            '/network_instance[default]/protocols[OSPF]',

            {'name': 'default', 'identifier': 'OSPF', 'protocol_name': 'OSPF'}),



        json_config_rule_set(

            '/network_instance[default]/protocols[STATIC]',

            {'name': 'default', 'identifier': 'STATIC', 'protocol_name': 'STATIC'}),



        json_config_rule_set(

            '/network_instance[{:s}]'.format(network_instance_name),

            {'name': network_instance_name, 'type': 'L2VSI'}),



        json_config_rule_set(

            '/interface[{:s}]/subinterface[{:d}]'.format(if_cirid_name, sub_interface_index),

            {'name': if_cirid_name, 'type': 'l2vlan', 'index': sub_interface_index, 'vlan_id': vlan_id}),



        json_config_rule_set(

            '/network_instance[{:s}]/interface[{:s}]'.format(network_instance_name, if_cirid_name),

            {'name': network_instance_name, 'id': if_cirid_name, 'interface': if_cirid_name,

            'subinterface': sub_interface_index}),



        json_config_rule_set(

            '/network_instance[{:s}]/connection_point[{:s}]'.format(network_instance_name, connection_point_id),

            {'name': network_instance_name, 'connection_point': connection_point_id, 'VC_ID': circuit_id,

             'remote_system': remote_router}),

    ]

    return json_config_rules



def teardown_config_rules(

    service_uuid : str, connection_uuid : str, device_uuid : str, endpoint_uuid : str,

    service_settings : TreeNode, endpoint_settings : TreeNode

) -> List[Dict]:



    #json_settings          : Dict = {} if service_settings  is None else service_settings.value

    json_endpoint_settings : Dict = {} if endpoint_settings is None else endpoint_settings.value



    #mtu                 = json_settings.get('mtu',                 1450 )    # 1512

    #address_families    = json_settings.get('address_families',    []   )    # ['IPV4']

    #bgp_as              = json_settings.get('bgp_as',              0    )    # 65000

    #bgp_route_target    = json_settings.get('bgp_route_target',    '0:0')    # 65000:333



    router_id           = json_endpoint_settings.get('router_id',           '0.0.0.0')  # '10.95.0.10'

    #route_distinguisher = json_endpoint_settings.get('route_distinguisher', '0:0'    )  # '60001:801'

    sub_interface_index = json_endpoint_settings.get('sub_interface_index', 0        )  # 1

    #vlan_id             = json_endpoint_settings.get('vlan_id',             1        )  # 400

    #address_ip          = json_endpoint_settings.get('address_ip',          '0.0.0.0')  # '2.2.2.1'

    #address_prefix      = json_endpoint_settings.get('address_prefix',      24       )  # 30

    #remote_router       = json_endpoint_settings.get('remote_router',       '0.0.0.0')  # '5.5.5.5'

    circuit_id          = json_endpoint_settings.get('circuit_id',          '000'    )  # '111'



    if_cirid_name         = '{:s}.{:s}'.format(endpoint_uuid, str(circuit_id))

    network_instance_name = 'ELAN-AC:{:s}'.format(str(circuit_id))

    connection_point_id   = 'VC-1'



    json_config_rules = [

        json_config_rule_delete(

            '/network_instance[{:s}]/connection_point[{:s}]'.format(network_instance_name, connection_point_id),

            {'name': network_instance_name, 'connection_point': connection_point_id}),



        json_config_rule_delete(

            '/network_instance[{:s}]/interface[{:s}]'.format(network_instance_name, if_cirid_name),

            {'name': network_instance_name, 'id': if_cirid_name, 'interface': if_cirid_name,

            'subinterface': sub_interface_index}),



        json_config_rule_delete(

            '/interface[{:s}]/subinterface[{:d}]'.format(if_cirid_name, sub_interface_index),

            {'name': if_cirid_name, 'index': sub_interface_index}),



        json_config_rule_delete(

            '/network_instance[{:s}]'.format(network_instance_name),

            {'name': network_instance_name}),



        json_config_rule_delete(

            '/network_instance[default]/protocols[STATIC]',

            {'name': 'default', 'identifier': 'STATIC', 'protocol_name': 'STATIC'}),



        json_config_rule_delete(

            '/network_instance[default]/protocols[OSPF]',

            {'name': 'default', 'identifier': 'OSPF', 'protocol_name': 'OSPF'}),



        json_config_rule_delete(

            '/network_instance[default]',

            {'name': 'default', 'type': 'DEFAULT_INSTANCE', 'router_id': router_id}),

    ]

    return json_config_rules

src/service/service/service_handlers/l2nm_openconfig/L2NMOpenConfigServiceHandler.py

0 → 100644
+187 −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 anytree, json, logging

from typing import Any, List, Optional, Tuple, Union

from common.method_wrappers.Decorator import MetricTypeEnum, MetricsPool, metered_subclass_method, INF

from common.proto.context_pb2 import ConfigActionEnum, ConfigRule, DeviceId, Service

from common.tools.object_factory.Device import json_device_id

from common.type_checkers.Checkers import chk_length, chk_type

from service.service.service_handler_api._ServiceHandler import _ServiceHandler

from service.service.service_handler_api.AnyTreeTools import TreeNode, delete_subnode, get_subnode, set_subnode_value

from service.service.task_scheduler.TaskExecutor import TaskExecutor

from .ConfigRules import setup_config_rules, teardown_config_rules



LOGGER = logging.getLogger(__name__)



HISTOGRAM_BUCKETS = (

    # .005, .01, .025, .05, .075, .1, .25, .5, .75, 1.0, INF

    0.0010, 0.0025, 0.0050, 0.0075,

    0.0100, 0.0250, 0.0500, 0.0750,

    0.1000, 0.2500, 0.5000, 0.7500,

    1.0000, 2.5000, 5.0000, 7.5000,

    10.0000, 25.000, 50.0000, 75.000,

    100.0, INF

)

METRICS_POOL = MetricsPool('Service', 'Handler', labels={'handler': 'l2nm_openconfig'})

METRICS_POOL.get_or_create('SetEndpoint',      MetricTypeEnum.HISTOGRAM_DURATION, buckets=HISTOGRAM_BUCKETS)

METRICS_POOL.get_or_create('DeleteEndpoint',   MetricTypeEnum.HISTOGRAM_DURATION, buckets=HISTOGRAM_BUCKETS)

METRICS_POOL.get_or_create('SetConstraint',    MetricTypeEnum.HISTOGRAM_DURATION, buckets=HISTOGRAM_BUCKETS)

METRICS_POOL.get_or_create('DeleteConstraint', MetricTypeEnum.HISTOGRAM_DURATION, buckets=HISTOGRAM_BUCKETS)

METRICS_POOL.get_or_create('SetConfig',        MetricTypeEnum.HISTOGRAM_DURATION, buckets=HISTOGRAM_BUCKETS)

METRICS_POOL.get_or_create('DeleteConfig',     MetricTypeEnum.HISTOGRAM_DURATION, buckets=HISTOGRAM_BUCKETS)



class L2NMOpenConfigServiceHandler(_ServiceHandler):

    def __init__(   # pylint: disable=super-init-not-called

        self, service : Service, task_executor : TaskExecutor, **settings

    ) -> None:

        self.__service = service

        self.__task_executor = task_executor # pylint: disable=unused-private-member

        self.__resolver = anytree.Resolver(pathattr='name')

        self.__config = TreeNode('.')

        for config_rule in service.service_config.config_rules:

            action = config_rule.action

            if config_rule.WhichOneof('config_rule') != 'custom': continue

            resource_key = config_rule.custom.resource_key

            resource_value = config_rule.custom.resource_value

            if action == ConfigActionEnum.CONFIGACTION_SET:

                try:

                    resource_value = json.loads(resource_value)

                except: # pylint: disable=bare-except

                    pass

                set_subnode_value(self.__resolver, self.__config, resource_key, resource_value)

            elif action == ConfigActionEnum.CONFIGACTION_DELETE:

                delete_subnode(self.__resolver, self.__config, resource_key)



    @metered_subclass_method(METRICS_POOL)

    def SetEndpoint(

        self, endpoints : List[Tuple[str, str, Optional[str]]], connection_uuid : Optional[str] = None

    ) -> List[Union[bool, Exception]]:

        chk_type('endpoints', endpoints, list)

        if len(endpoints) == 0: return []



        service_uuid = self.__service.service_id.service_uuid.uuid

        settings : TreeNode = get_subnode(self.__resolver, self.__config, '/settings', None)



        results = []

        for endpoint in endpoints:

            try:

                chk_type('endpoint', endpoint, (tuple, list))

                chk_length('endpoint', endpoint, min_length=2, max_length=3)

                device_uuid, endpoint_uuid = endpoint[0:2] # ignore topology_uuid by now



                endpoint_settings_uri = '/device[{:s}]/endpoint[{:s}]/settings'.format(device_uuid, endpoint_uuid)

                endpoint_settings : TreeNode = get_subnode(self.__resolver, self.__config, endpoint_settings_uri, None)



                json_config_rules = setup_config_rules(

                    service_uuid, connection_uuid, device_uuid, endpoint_uuid, settings, endpoint_settings)



                device = self.__task_executor.get_device(DeviceId(**json_device_id(device_uuid)))

                del device.device_config.config_rules[:]

                for json_config_rule in json_config_rules:

                    device.device_config.config_rules.append(ConfigRule(**json_config_rule))

                self.__task_executor.configure_device(device)

                results.append(True)

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

                LOGGER.exception('Unable to SetEndpoint({:s})'.format(str(endpoint)))

                results.append(e)



        return results



    @metered_subclass_method(METRICS_POOL)

    def DeleteEndpoint(

        self, endpoints : List[Tuple[str, str, Optional[str]]], connection_uuid : Optional[str] = None

    ) -> List[Union[bool, Exception]]:

        chk_type('endpoints', endpoints, list)

        if len(endpoints) == 0: return []



        service_uuid = self.__service.service_id.service_uuid.uuid

        settings : TreeNode = get_subnode(self.__resolver, self.__config, '/settings', None)



        results = []

        for endpoint in endpoints:

            try:

                chk_type('endpoint', endpoint, (tuple, list))

                chk_length('endpoint', endpoint, min_length=2, max_length=3)

                device_uuid, endpoint_uuid = endpoint[0:2] # ignore topology_uuid by now



                endpoint_settings_uri = '/device[{:s}]/endpoint[{:s}]/settings'.format(device_uuid, endpoint_uuid)

                endpoint_settings : TreeNode = get_subnode(self.__resolver, self.__config, endpoint_settings_uri, None)



                json_config_rules = teardown_config_rules(

                    service_uuid, connection_uuid, device_uuid, endpoint_uuid, settings, endpoint_settings)



                device = self.__task_executor.get_device(DeviceId(**json_device_id(device_uuid)))

                del device.device_config.config_rules[:]

                for json_config_rule in json_config_rules:

                    device.device_config.config_rules.append(ConfigRule(**json_config_rule))

                self.__task_executor.configure_device(device)

                results.append(True)

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

                LOGGER.exception('Unable to DeleteEndpoint({:s})'.format(str(endpoint)))

                results.append(e)



        return results



    @metered_subclass_method(METRICS_POOL)

    def SetConstraint(self, constraints : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]:

        chk_type('constraints', constraints, list)

        if len(constraints) == 0: return []



        msg = '[SetConstraint] Method not implemented. Constraints({:s}) are being ignored.'

        LOGGER.warning(msg.format(str(constraints)))

        return [True for _ in range(len(constraints))]



    @metered_subclass_method(METRICS_POOL)

    def DeleteConstraint(self, constraints : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]:

        chk_type('constraints', constraints, list)

        if len(constraints) == 0: return []



        msg = '[DeleteConstraint] Method not implemented. Constraints({:s}) are being ignored.'

        LOGGER.warning(msg.format(str(constraints)))

        return [True for _ in range(len(constraints))]



    @metered_subclass_method(METRICS_POOL)

    def SetConfig(self, resources : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]:

        chk_type('resources', resources, list)

        if len(resources) == 0: return []



        results = []

        for resource in resources:

            try:

                resource_key, resource_value = resource

                resource_value = json.loads(resource_value)

                set_subnode_value(self.__resolver, self.__config, resource_key, resource_value)

                results.append(True)

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

                LOGGER.exception('Unable to SetConfig({:s})'.format(str(resource)))

                results.append(e)



        return results



    @metered_subclass_method(METRICS_POOL)

    def DeleteConfig(self, resources : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]:

        chk_type('resources', resources, list)

        if len(resources) == 0: return []



        results = []

        for resource in resources:

            try:

                resource_key, _ = resource

                delete_subnode(self.__resolver, self.__config, resource_key)

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

                LOGGER.exception('Unable to DeleteConfig({:s})'.format(str(resource)))

                results.append(e)



        return results

src/service/service/service_handlers/l2nm_openconfig/__init__.py

0 → 100644
+14 −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.