From b6312de40cc146d7d7649f76ac6a1115dd555c7f Mon Sep 17 00:00:00 2001
From: merle <sebastien.merle@stritzinger.com>
Date: Wed, 5 Oct 2022 07:25:10 -0700
Subject: [PATCH] Add skeleton for TE service handler
---
.../service_handler_api/FilterFields.py | 3 +-
.../service/service_handlers/__init__.py | 7 +
.../service_handlers/te/ConfigRules.py | 44 +++++
.../service_handlers/te/TEServiceHandler.py | 161 ++++++++++++++++++
.../service/service_handlers/te/__init__.py | 14 ++
tutorial/2-6-teraflow-service.json | 18 ++
6 files changed, 246 insertions(+), 1 deletion(-)
create mode 100644 src/service/service/service_handlers/te/ConfigRules.py
create mode 100644 src/service/service/service_handlers/te/TEServiceHandler.py
create mode 100644 src/service/service/service_handlers/te/__init__.py
create mode 100644 tutorial/2-6-teraflow-service.json
diff --git a/src/service/service/service_handler_api/FilterFields.py b/src/service/service/service_handler_api/FilterFields.py
index 3ec71dc64..4f2fb5d12 100644
--- a/src/service/service/service_handler_api/FilterFields.py
+++ b/src/service/service/service_handler_api/FilterFields.py
@@ -23,7 +23,8 @@ SERVICE_TYPE_VALUES = {
ServiceTypeEnum.SERVICETYPE_UNKNOWN,
ServiceTypeEnum.SERVICETYPE_L3NM,
ServiceTypeEnum.SERVICETYPE_L2NM,
- ServiceTypeEnum.SERVICETYPE_TAPI_CONNECTIVITY_SERVICE
+ ServiceTypeEnum.SERVICETYPE_TAPI_CONNECTIVITY_SERVICE,
+ ServiceTypeEnum.SERVICETYPE_TE,
}
DEVICE_DRIVER_VALUES = {
diff --git a/src/service/service/service_handlers/__init__.py b/src/service/service/service_handlers/__init__.py
index 257bc138f..03a76ed26 100644
--- a/src/service/service/service_handlers/__init__.py
+++ b/src/service/service/service_handlers/__init__.py
@@ -23,6 +23,7 @@ from .microwave.MicrowaveServiceHandler import MicrowaveServiceHandler
from .p4.p4_service_handler import P4ServiceHandler
from .tapi_tapi.TapiServiceHandler import TapiServiceHandler
from .tapi_xr.TapiXrServiceHandler import TapiXrServiceHandler
+from .te.TEServiceHandler import TEServiceHandler
SERVICE_HANDLERS = [
(L2NMEmulatedServiceHandler, [
@@ -79,4 +80,10 @@ SERVICE_HANDLERS = [
FilterFieldEnum.DEVICE_DRIVER : [DeviceDriverEnum.DEVICEDRIVER_IETF_L2VPN],
}
]),
+ (TEServiceHandler, [
+ {
+ FilterFieldEnum.SERVICE_TYPE : ServiceTypeEnum.SERVICETYPE_TE,
+ FilterFieldEnum.DEVICE_DRIVER : DeviceDriverEnum.DEVICEDRIVER_UNDEFINED,
+ }
+ ]),
]
diff --git a/src/service/service/service_handlers/te/ConfigRules.py b/src/service/service/service_handlers/te/ConfigRules.py
new file mode 100644
index 000000000..7b79fca5a
--- /dev/null
+++ b/src/service/service/service_handlers/te/ConfigRules.py
@@ -0,0 +1,44 @@
+# 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 logging
+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
+
+LOGGER = logging.getLogger(__name__)
+
+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
+
+ json_config_rules = [
+ ]
+ 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
+
+ json_config_rules = [
+ ]
+ return json_config_rules
diff --git a/src/service/service/service_handlers/te/TEServiceHandler.py b/src/service/service/service_handlers/te/TEServiceHandler.py
new file mode 100644
index 000000000..d12d642f0
--- /dev/null
+++ b/src/service/service/service_handlers/te/TEServiceHandler.py
@@ -0,0 +1,161 @@
+# 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.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__)
+
+class TEServiceHandler(_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)
+
+ 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)))
+ 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
+
+ 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)))
+ 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
+
+ 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))]
+
+ 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))]
+
+ 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
+
+ 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
diff --git a/src/service/service/service_handlers/te/__init__.py b/src/service/service/service_handlers/te/__init__.py
new file mode 100644
index 000000000..70a332512
--- /dev/null
+++ b/src/service/service/service_handlers/te/__init__.py
@@ -0,0 +1,14 @@
+# 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.
+
diff --git a/tutorial/2-6-teraflow-service.json b/tutorial/2-6-teraflow-service.json
new file mode 100644
index 000000000..6f8e1d52d
--- /dev/null
+++ b/tutorial/2-6-teraflow-service.json
@@ -0,0 +1,18 @@
+{
+ "services": [
+ {
+ "service_id": {"context_id": {"context_uuid": {"uuid": "admin"}}, "service_uuid": {"uuid": "2c025055-bf6c-4250-8560-cf62f2d29e72"}},
+ "service_type": 4,
+ "service_status": {"service_status": 2},
+ "service_endpoint_ids": [
+ {"device_id": {"device_uuid": {"uuid":"RT1"}}, "endpoint_uuid": {"uuid":"eth-src"}},
+ {"device_id": {"device_uuid": {"uuid":"RT6"}}, "endpoint_uuid": {"uuid":"eth-dst"}}
+ ],
+ "service_constraints": [],
+ "service_config": {"config_rules": [
+ {"action": 1, "custom": {"resource_key": "/lsp[foo]", "resource_value": "{\"src\": {\"device_id\": {\"device_uuid\": {\"uuid\":\"RT1\"}}, \"endpoint_uuid\": {\"uuid\":\"eth-src\"}}, \"dest\": {\"device_id\": {\"device_uuid\": {\"uuid\":\"RT6\"}}, \"endpoint_uuid\": {\"uuid\":\"eth-dst\"}}, \"binding_label\": 1111}"}},
+ {"action": 1, "custom": {"resource_key": "/lsp[bar]", "resource_value": "{\"src\": {\"device_id\": {\"device_uuid\": {\"uuid\":\"RT6\"}}, \"endpoint_uuid\": {\"uuid\":\"eth-dst\"}}, \"dest\": {\"device_id\": {\"device_uuid\": {\"uuid\":\"RT1\"}}, \"endpoint_uuid\": {\"uuid\":\"eth-src\"}}, \"binding_label\": 6666}"}}
+ ]}
+ }
+ ]
+}
\ No newline at end of file
--
GitLab