From ffe1454fe9f04a0ceeeb5005c102d6bdd2979ac3 Mon Sep 17 00:00:00 2001
From: gifrerenom <lluis.gifre@cttc.es>
Date: Sat, 25 Feb 2023 16:39:50 +0000
Subject: [PATCH] Service component:
- Improved filter to select service handler
- Disabled configuration of devices when there is nothing to configure
- Corrected TAPI Service Handler to use endpoint uuids instead of names
- Extended filters for selecting MicroWave Service Handler
- First implementation of L2NM IETF L2VPN Service Handler
- Extended service handler selector to be aware of devices managed by a controller
- Minor cosmetic changes
---
.../ServiceHandlerFactory.py | 3 ++
.../service/service_handlers/__init__.py | 2 +-
.../l2nm_emulated/ConfigRules.py | 16 ++++++---
.../L2NM_IETFL2VPN_ServiceHandler.py | 36 ++++++++-----------
.../l2nm_openconfig/ConfigRules.py | 19 +++++-----
.../l3nm_emulated/ConfigRules.py | 14 +++++---
.../l3nm_openconfig/ConfigRules.py | 4 +--
.../microwave/MicrowaveServiceHandler.py | 4 +--
.../tapi_tapi/TapiServiceHandler.py | 12 +++----
.../service/task_scheduler/TaskExecutor.py | 27 ++++++++++++--
.../tasks/Task_ConnectionConfigure.py | 2 +-
.../tasks/Task_ConnectionDeconfigure.py | 2 +-
.../tasks/Task_ServiceDelete.py | 2 +-
.../tasks/Task_ServiceSetStatus.py | 2 +-
14 files changed, 86 insertions(+), 59 deletions(-)
diff --git a/src/service/service/service_handler_api/ServiceHandlerFactory.py b/src/service/service/service_handler_api/ServiceHandlerFactory.py
index 6aa21b499..64ea204a2 100644
--- a/src/service/service/service_handler_api/ServiceHandlerFactory.py
+++ b/src/service/service/service_handler_api/ServiceHandlerFactory.py
@@ -73,6 +73,9 @@ class ServiceHandlerFactory:
if field_indice is None: continue
if not isinstance(field_values, Iterable) or isinstance(field_values, str):
field_values = [field_values]
+ if len(field_values) == 0:
+ # do not allow empty fields; might cause wrong selection
+ raise UnsatisfiedFilterException(filter_fields)
field_enum_values = FILTER_FIELD_ALLOWED_VALUES.get(field_name)
diff --git a/src/service/service/service_handlers/__init__.py b/src/service/service/service_handlers/__init__.py
index 9b4e442e5..fa215af2f 100644
--- a/src/service/service/service_handlers/__init__.py
+++ b/src/service/service/service_handlers/__init__.py
@@ -57,7 +57,7 @@ SERVICE_HANDLERS = [
(MicrowaveServiceHandler, [
{
FilterFieldEnum.SERVICE_TYPE : ServiceTypeEnum.SERVICETYPE_L2NM,
- FilterFieldEnum.DEVICE_DRIVER : DeviceDriverEnum.DEVICEDRIVER_IETF_NETWORK_TOPOLOGY,
+ FilterFieldEnum.DEVICE_DRIVER : [DeviceDriverEnum.DEVICEDRIVER_IETF_NETWORK_TOPOLOGY, DeviceDriverEnum.DEVICEDRIVER_ONF_TR_352],
}
]),
(P4ServiceHandler, [
diff --git a/src/service/service/service_handlers/l2nm_emulated/ConfigRules.py b/src/service/service/service_handlers/l2nm_emulated/ConfigRules.py
index c2ea6e213..84467dd2d 100644
--- a/src/service/service/service_handlers/l2nm_emulated/ConfigRules.py
+++ b/src/service/service/service_handlers/l2nm_emulated/ConfigRules.py
@@ -21,10 +21,13 @@ def setup_config_rules(
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
+ if service_settings is None: return []
+ if endpoint_settings is None: return []
- mtu = json_settings.get('mtu', 1450 ) # 1512
+ #json_settings : Dict = service_settings.value
+ json_endpoint_settings : Dict = 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
@@ -80,8 +83,11 @@ def teardown_config_rules(
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
+ if service_settings is None: return []
+ if endpoint_settings is None: return []
+
+ #json_settings : Dict = service_settings.value
+ json_endpoint_settings : Dict = endpoint_settings.value
#mtu = json_settings.get('mtu', 1450 ) # 1512
#address_families = json_settings.get('address_families', [] ) # ['IPV4']
diff --git a/src/service/service/service_handlers/l2nm_ietfl2vpn/L2NM_IETFL2VPN_ServiceHandler.py b/src/service/service/service_handlers/l2nm_ietfl2vpn/L2NM_IETFL2VPN_ServiceHandler.py
index 1f5817fe8..f84c8c824 100644
--- a/src/service/service/service_handlers/l2nm_ietfl2vpn/L2NM_IETFL2VPN_ServiceHandler.py
+++ b/src/service/service/service_handlers/l2nm_ietfl2vpn/L2NM_IETFL2VPN_ServiceHandler.py
@@ -47,34 +47,28 @@ class L2NM_IETFL2VPN_ServiceHandler(_ServiceHandler):
service_uuid = self.__service.service_id.service_uuid.uuid
settings = self.__settings_handler.get('/settings')
json_settings : Dict = {} if settings is None else settings.value
- capacity_value = json_settings.get('capacity_value', 50.0)
- capacity_unit = json_settings.get('capacity_unit', 'GHz')
- layer_proto_name = json_settings.get('layer_proto_name', 'PHOTONIC_MEDIA')
- layer_proto_qual = json_settings.get('layer_proto_qual', 'tapi-photonic-media:PHOTONIC_LAYER_QUALIFIER_NMC')
- direction = json_settings.get('direction', 'UNIDIRECTIONAL')
+ encap_type = json_settings.get('encapsulation_type', '')
+ vlan_id = json_settings.get('vlan_id', 100)
results = []
try:
- device_uuid_src, endpoint_uuid_src = get_device_endpoint_uuids(endpoints[0])
- device_uuid_dst, endpoint_uuid_dst = get_device_endpoint_uuids(endpoints[1])
+ src_device_uuid, src_endpoint_uuid = get_device_endpoint_uuids(endpoints[0])
+ dst_device_uuid, dst_endpoint_uuid = get_device_endpoint_uuids(endpoints[1])
- if device_uuid_src != device_uuid_dst:
- raise Exception('Diferent Src-Dst devices not supported by now')
- device_uuid = device_uuid_src
+ if src_device_uuid != dst_device_uuid:
+ raise Exception('Different Src-Dst devices not supported by now')
+ device_uuid = src_device_uuid
device_obj = self.__task_executor.get_device(DeviceId(**json_device_id(device_uuid)))
- endpoint_name_src = get_endpoint_matching(device_obj, endpoint_uuid_src).name
- endpoint_name_dst = get_endpoint_matching(device_obj, endpoint_uuid_dst).name
json_config_rule = json_config_rule_set('/services/service[{:s}]'.format(service_uuid), {
- 'uuid' : service_uuid,
- 'input_sip' : endpoint_name_src,
- 'output_sip' : endpoint_name_dst,
- 'capacity_unit' : capacity_unit,
- 'capacity_value' : capacity_value,
- 'layer_protocol_name' : layer_proto_name,
- 'layer_protocol_qualifier': layer_proto_qual,
- 'direction' : direction,
+ 'uuid' : service_uuid,
+ 'src_device_uuid' : src_device_uuid,
+ 'src_endpoint_uuid' : src_endpoint_uuid,
+ 'dst_device_uuid' : dst_device_uuid,
+ 'dst_endpoint_uuid' : dst_endpoint_uuid,
+ 'encapsulation_type': encap_type,
+ 'vlan_id' : vlan_id,
})
del device_obj.device_config.config_rules[:]
device_obj.device_config.config_rules.append(ConfigRule(**json_config_rule))
@@ -102,7 +96,7 @@ class L2NM_IETFL2VPN_ServiceHandler(_ServiceHandler):
device_uuid_dst, _ = get_device_endpoint_uuids(endpoints[1])
if device_uuid_src != device_uuid_dst:
- raise Exception('Diferent Src-Dst devices not supported by now')
+ raise Exception('Different Src-Dst devices not supported by now')
device_uuid = device_uuid_src
device_obj = self.__task_executor.get_device(DeviceId(**json_device_id(device_uuid)))
diff --git a/src/service/service/service_handlers/l2nm_openconfig/ConfigRules.py b/src/service/service/service_handlers/l2nm_openconfig/ConfigRules.py
index bbd91df93..58071f28a 100644
--- a/src/service/service/service_handlers/l2nm_openconfig/ConfigRules.py
+++ b/src/service/service/service_handlers/l2nm_openconfig/ConfigRules.py
@@ -24,12 +24,9 @@ def setup_config_rules(
if service_settings is None: return []
if endpoint_settings is None: return []
- json_settings : Dict = service_settings.value
+ #json_settings : Dict = service_settings.value
json_endpoint_settings : Dict = endpoint_settings.value
- 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
@@ -41,16 +38,15 @@ def setup_config_rules(
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', '5.5.5.5') # '5.5.5.5'
- circuit_id = json_endpoint_settings.get('circuit_id', '111' ) # '111'
-
+ 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_name, 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[{:s}]'.format(network_instance_name),
{'name': network_instance_name,
@@ -86,8 +82,11 @@ def teardown_config_rules(
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
+ if service_settings is None: return []
+ if endpoint_settings is None: return []
+
+ #json_settings : Dict = service_settings.value
+ json_endpoint_settings : Dict = endpoint_settings.value
#mtu = json_settings.get('mtu', 1450 ) # 1512
#address_families = json_settings.get('address_families', [] ) # ['IPV4']
diff --git a/src/service/service/service_handlers/l3nm_emulated/ConfigRules.py b/src/service/service/service_handlers/l3nm_emulated/ConfigRules.py
index 903ad8cd5..f4a46112e 100644
--- a/src/service/service/service_handlers/l3nm_emulated/ConfigRules.py
+++ b/src/service/service/service_handlers/l3nm_emulated/ConfigRules.py
@@ -21,8 +21,11 @@ def setup_config_rules(
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
+ if service_settings is None: return []
+ if endpoint_settings is None: return []
+
+ json_settings : Dict = service_settings.value
+ json_endpoint_settings : Dict = endpoint_settings.value
service_short_uuid = service_uuid.split('-')[-1]
network_instance_name = '{:s}-NetInst'.format(service_short_uuid)
@@ -142,8 +145,11 @@ def teardown_config_rules(
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
+ if service_settings is None: return []
+ if endpoint_settings is None: return []
+
+ json_settings : Dict = service_settings.value
+ json_endpoint_settings : Dict = endpoint_settings.value
#mtu = json_settings.get('mtu', 1450 ) # 1512
#address_families = json_settings.get('address_families', [] ) # ['IPV4']
diff --git a/src/service/service/service_handlers/l3nm_openconfig/ConfigRules.py b/src/service/service/service_handlers/l3nm_openconfig/ConfigRules.py
index 351efe5a5..4984fd77c 100644
--- a/src/service/service/service_handlers/l3nm_openconfig/ConfigRules.py
+++ b/src/service/service/service_handlers/l3nm_openconfig/ConfigRules.py
@@ -187,8 +187,8 @@ def teardown_config_rules(
if service_settings is None: return []
if endpoint_settings is None: return []
- 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
+ json_settings : Dict = service_settings.value
+ json_endpoint_settings : Dict = endpoint_settings.value
service_short_uuid = service_uuid.split('-')[-1]
network_instance_name = '{:s}-NetInst'.format(service_short_uuid)
diff --git a/src/service/service/service_handlers/microwave/MicrowaveServiceHandler.py b/src/service/service/service_handlers/microwave/MicrowaveServiceHandler.py
index ee64d2fa4..40c87eeee 100644
--- a/src/service/service/service_handlers/microwave/MicrowaveServiceHandler.py
+++ b/src/service/service/service_handlers/microwave/MicrowaveServiceHandler.py
@@ -61,7 +61,7 @@ class MicrowaveServiceHandler(_ServiceHandler):
device_uuid_dst, endpoint_uuid_dst = get_device_endpoint_uuids(endpoints[1])
if device_uuid_src != device_uuid_dst:
- raise Exception('Diferent Src-Dst devices not supported by now')
+ raise Exception('Different Src-Dst devices not supported by now')
device_uuid = device_uuid_src
device_obj = self.__task_executor.get_device(DeviceId(**json_device_id(device_uuid)))
@@ -106,7 +106,7 @@ class MicrowaveServiceHandler(_ServiceHandler):
device_uuid_dst, _ = get_device_endpoint_uuids(endpoints[1])
if device_uuid_src != device_uuid_dst:
- raise Exception('Diferent Src-Dst devices not supported by now')
+ raise Exception('Different Src-Dst devices not supported by now')
device_uuid = device_uuid_src
device_obj = self.__task_executor.get_device(DeviceId(**json_device_id(device_uuid)))
diff --git a/src/service/service/service_handlers/tapi_tapi/TapiServiceHandler.py b/src/service/service/service_handlers/tapi_tapi/TapiServiceHandler.py
index 8abd12b2a..dd9ff092a 100644
--- a/src/service/service/service_handlers/tapi_tapi/TapiServiceHandler.py
+++ b/src/service/service/service_handlers/tapi_tapi/TapiServiceHandler.py
@@ -19,7 +19,7 @@ from common.proto.context_pb2 import ConfigRule, DeviceId, Service
from common.tools.object_factory.ConfigRule import json_config_rule_delete, json_config_rule_set
from common.tools.object_factory.Device import json_device_id
from common.type_checkers.Checkers import chk_type
-from service.service.service_handler_api.Tools import get_device_endpoint_uuids, get_endpoint_matching
+from service.service.service_handler_api.Tools import get_device_endpoint_uuids
from service.service.service_handler_api._ServiceHandler import _ServiceHandler
from service.service.service_handler_api.SettingsHandler import SettingsHandler
from service.service.task_scheduler.TaskExecutor import TaskExecutor
@@ -59,17 +59,15 @@ class TapiServiceHandler(_ServiceHandler):
device_uuid_dst, endpoint_uuid_dst = get_device_endpoint_uuids(endpoints[1])
if device_uuid_src != device_uuid_dst:
- raise Exception('Diferent Src-Dst devices not supported by now')
+ raise Exception('Different Src-Dst devices not supported by now')
device_uuid = device_uuid_src
device_obj = self.__task_executor.get_device(DeviceId(**json_device_id(device_uuid)))
- endpoint_name_src = get_endpoint_matching(device_obj, endpoint_uuid_src).name
- endpoint_name_dst = get_endpoint_matching(device_obj, endpoint_uuid_dst).name
json_config_rule = json_config_rule_set('/services/service[{:s}]'.format(service_uuid), {
'uuid' : service_uuid,
- 'input_sip' : endpoint_name_src,
- 'output_sip' : endpoint_name_dst,
+ 'input_sip' : endpoint_uuid_src,
+ 'output_sip' : endpoint_uuid_dst,
'capacity_unit' : capacity_unit,
'capacity_value' : capacity_value,
'layer_protocol_name' : layer_proto_name,
@@ -102,7 +100,7 @@ class TapiServiceHandler(_ServiceHandler):
device_uuid_dst, _ = get_device_endpoint_uuids(endpoints[1])
if device_uuid_src != device_uuid_dst:
- raise Exception('Diferent Src-Dst devices not supported by now')
+ raise Exception('Different Src-Dst devices not supported by now')
device_uuid = device_uuid_src
device_obj = self.__task_executor.get_device(DeviceId(**json_device_id(device_uuid)))
diff --git a/src/service/service/task_scheduler/TaskExecutor.py b/src/service/service/task_scheduler/TaskExecutor.py
index 932c56e2b..e475f29c6 100644
--- a/src/service/service/task_scheduler/TaskExecutor.py
+++ b/src/service/service/task_scheduler/TaskExecutor.py
@@ -12,10 +12,12 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+import json
from enum import Enum
from typing import TYPE_CHECKING, Any, Dict, Optional, Union
from common.method_wrappers.ServiceExceptions import NotFoundException
from common.proto.context_pb2 import Connection, ConnectionId, Device, DeviceId, Service, ServiceId
+from common.tools.object_factory.Device import json_device_id
from context.client.ContextClient import ContextClient
from device.client.DeviceClient import DeviceClient
from service.service.service_handler_api.ServiceHandlerFactory import ServiceHandlerFactory, get_service_handler_class
@@ -103,13 +105,32 @@ class TaskExecutor:
self._device_client.ConfigureDevice(device)
self._store_grpc_object(CacheableObjectType.DEVICE, device_key, device)
- def get_devices_from_connection(self, connection : Connection) -> Dict[str, Device]:
+ def get_devices_from_connection(
+ self, connection : Connection, exclude_managed : bool = False
+ ) -> Dict[str, Device]:
devices = dict()
for endpoint_id in connection.path_hops_endpoint_ids:
device = self.get_device(endpoint_id.device_id)
device_uuid = endpoint_id.device_id.device_uuid.uuid
if device is None: raise Exception('Device({:s}) not found'.format(str(device_uuid)))
- devices[device_uuid] = device
+
+ manager = None
+ for config_rule in device.device_config.config_rules:
+ if config_rule.WhichOneof('config_rule') != 'custom': continue
+ if config_rule.custom.resource_key != '_manager': continue
+ manager = json.loads(config_rule.custom.resource_value)
+ break
+
+ if manager is not None:
+ if not exclude_managed:
+ devices[device_uuid] = device
+ manager_uuid = manager['uuid']
+ manager = self.get_device(DeviceId(**json_device_id(manager_uuid)))
+ manager_uuid = manager.device_id.device_uuid.uuid
+ if manager is None: raise Exception('Device({:s}) not found'.format(str(manager_uuid)))
+ devices[manager_uuid] = manager
+ else:
+ devices[device_uuid] = device
return devices
# ----- Service-related methods ------------------------------------------------------------------------------------
@@ -139,6 +160,6 @@ class TaskExecutor:
def get_service_handler(
self, connection : Connection, service : Service, **service_handler_settings
) -> '_ServiceHandler':
- connection_devices = self.get_devices_from_connection(connection)
+ connection_devices = self.get_devices_from_connection(connection, exclude_managed=True)
service_handler_class = get_service_handler_class(self._service_handler_factory, service, connection_devices)
return service_handler_class(service, self, **service_handler_settings)
diff --git a/src/service/service/task_scheduler/tasks/Task_ConnectionConfigure.py b/src/service/service/task_scheduler/tasks/Task_ConnectionConfigure.py
index 5a47005b3..4367ffdee 100644
--- a/src/service/service/task_scheduler/tasks/Task_ConnectionConfigure.py
+++ b/src/service/service/task_scheduler/tasks/Task_ConnectionConfigure.py
@@ -32,7 +32,7 @@ class Task_ConnectionConfigure(_Task):
def connection_id(self) -> ConnectionId: return self._connection_id
@staticmethod
- def build_key(connection_id : ConnectionId) -> str:
+ def build_key(connection_id : ConnectionId) -> str: # pylint: disable=arguments-differ
str_connection_id = get_connection_key(connection_id)
return KEY_TEMPLATE.format(connection_id=str_connection_id)
diff --git a/src/service/service/task_scheduler/tasks/Task_ConnectionDeconfigure.py b/src/service/service/task_scheduler/tasks/Task_ConnectionDeconfigure.py
index 5736054fe..70f41566e 100644
--- a/src/service/service/task_scheduler/tasks/Task_ConnectionDeconfigure.py
+++ b/src/service/service/task_scheduler/tasks/Task_ConnectionDeconfigure.py
@@ -32,7 +32,7 @@ class Task_ConnectionDeconfigure(_Task):
def connection_id(self) -> ConnectionId: return self._connection_id
@staticmethod
- def build_key(connection_id : ConnectionId) -> str:
+ def build_key(connection_id : ConnectionId) -> str: # pylint: disable=arguments-differ
str_connection_id = get_connection_key(connection_id)
return KEY_TEMPLATE.format(connection_id=str_connection_id)
diff --git a/src/service/service/task_scheduler/tasks/Task_ServiceDelete.py b/src/service/service/task_scheduler/tasks/Task_ServiceDelete.py
index 6a4e11b54..0f021b6ca 100644
--- a/src/service/service/task_scheduler/tasks/Task_ServiceDelete.py
+++ b/src/service/service/task_scheduler/tasks/Task_ServiceDelete.py
@@ -28,7 +28,7 @@ class Task_ServiceDelete(_Task):
def service_id(self) -> ServiceId: return self._service_id
@staticmethod
- def build_key(service_id : ServiceId) -> str:
+ def build_key(service_id : ServiceId) -> str: # pylint: disable=arguments-differ
str_service_id = get_service_key(service_id)
return KEY_TEMPLATE.format(service_id=str_service_id)
diff --git a/src/service/service/task_scheduler/tasks/Task_ServiceSetStatus.py b/src/service/service/task_scheduler/tasks/Task_ServiceSetStatus.py
index 815cb33c3..d5360fe85 100644
--- a/src/service/service/task_scheduler/tasks/Task_ServiceSetStatus.py
+++ b/src/service/service/task_scheduler/tasks/Task_ServiceSetStatus.py
@@ -32,7 +32,7 @@ class Task_ServiceSetStatus(_Task):
def new_status(self) -> ServiceStatusEnum: return self._new_status
@staticmethod
- def build_key(service_id : ServiceId, new_status : ServiceStatusEnum) -> str:
+ def build_key(service_id : ServiceId, new_status : ServiceStatusEnum) -> str: # pylint: disable=arguments-differ
str_service_id = get_service_key(service_id)
str_new_status = ServiceStatusEnum.Name(new_status)
return KEY_TEMPLATE.format(service_id=str_service_id, new_status=str_new_status)
--
GitLab