Create a script to generate a Topology

- add  link configuration helper class

Issue-ID: OAM-249
Change-Id: Ie71a0096d07922c6c305c95a12943b1806f5ca0f
Signed-off-by: demx8as6 <martin.skorupski@highstreet-technologies.com>

diff --git a/code/network-topology-instance-generator/model/python/link_config.py b/code/network-topology-instance-generator/model/python/link_config.py
new file mode 100644 (file)
index 0000000..d33edcc
--- /dev/null
+++ b/code/network-topology-instance-generator/model/python/link_config.py
@@ -0,0 +1,154 @@
+# Copyright 2022 highstreet technologies GmbH
+#
+# 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.
+
+#!/usr/bin/python
+"""
+Module to construct the input configuration for a TAPI link object.
+"""
+from typing import Dict
+from model.python.tapi_node import TapiNode
+from model.python.tapi_node_edge_point import TapiNodeEdgePoint
+from model.python.top import Top
+
+
+class LinkConfig(Top):
+    """
+    Class containing  methods creating an link configuration object.
+    """
+
+    __topology_reference = "unknown"
+    __name_prefix: str = "unknown"
+    __consumer: TapiNode = None
+    __provider: TapiNode = None
+
+    __data: dict = {"link": {
+        "name": "noName",
+        "a": {},
+        "z": {}
+    }}
+
+    # constructor
+    def __init__(self, topology_reference: str, name_prefix: str,
+                 provider: TapiNode, consumer: TapiNode):
+        super().__init__({})
+        self.__topology_reference = topology_reference
+        self.__name_prefix = name_prefix
+        self.__consumer = consumer
+        self.__provider = provider
+
+        self.data = {"link": {
+            "name": self.name(),
+            "a": {
+                "topology-uuid": topology_reference,
+                "node-uuid": consumer.data()["uuid"],
+                "node-edge-point-uuid":
+                    self.consumer_node_edge_point().identifier()
+
+            },
+            "z": {
+                "topology-uuid": topology_reference,
+                "node-uuid": provider.data()["uuid"],
+                "node-edge-point-uuid":
+                    self.provider_node_edge_point().identifier()
+            }
+        }}
+
+    def configuration(self) -> Dict[str, Dict[str, Dict]]:
+        """
+        Getter returning the configuration.
+        :return Link identifier as string
+        """
+        return {"configuration": {
+            "topology-reference:": self.__topology_reference,
+            "name_prefix": self.__name_prefix,
+            "provider": self.__provider.json(),
+            "consumer": self.__consumer.json()
+        }}
+
+    def data(self) -> Dict[str, Dict]:
+        """
+        Getter returning the link data of the link.
+        :return Link confguation data as json object
+        """
+        return self.__data
+
+    def identifier(self) -> str:
+        """
+        Getter returning the link configuration identifier of the link.
+        :return Link identifier as string
+        """
+        return "--".join([
+            self.__consumer.identifier(),
+            self.__provider.identifier(),
+        ])
+
+    def name(self) -> str:
+        """
+        Getter returning the name of the link.
+        :return Link name as string
+        """
+        if self.__consumer:
+            return "|".join([
+                self.__name_prefix.upper(),
+                self.__consumer.name(),
+                "->",
+                self.__provider.name(),
+                ""
+            ])
+        return ""
+
+    def json(self) -> dict:
+        """
+        Getter for the json represention of this object.
+        :return JSON object of link configuration
+        """
+        return self.data
+
+    def consumer_node_edge_point(self) -> TapiNodeEdgePoint:
+        name_prefix = self.__name_prefix
+
+        # exception for O-RAN Fronthaul Management plane to SMO
+        if self.__consumer.function() == "o-ran-sc-topology-common:smo" and \
+           self.__provider.function() == "o-ran-sc-topology-common:o-ru" and \
+                name_prefix == "ofh-netconf":  # "open-fronthaul-m-plane-netconf":
+            name_prefix = "oam-netconf"
+
+        # exception for O-RAN Gateway plane to SMO
+        if self.__consumer.function() == "o-ran-sc-topology-common:smo" and \
+                name_prefix == "o1-netconf":  # "open-fronthaul-m-plane-netconf":
+            name_prefix = "oam-netconf"
+
+        # exception for O-RU to FHGW
+        if self.__provider.function() == "o-ran-sc-topology-common:fronthaul-gateway" and \
+                name_prefix == "eth-ofh":  # "open-fronthaul-m-plane-netconf":
+            name_prefix = "ofh-netconf"
+
+        # exception for O-RU to FHGW
+        if self.__consumer.function() == "o-ran-sc-topology-common:fronthaul-gateway" and \
+                name_prefix == "ofh-netconf":  # "open-fronthaul-m-plane-netconf":
+            name_prefix = "eth-ofh"
+
+        cep_name = name_prefix.lower() + "-consumer"
+        return self.__consumer.node_edge_point_by_cep_name(cep_name,  self.__provider.local_id())
+
+    def provider_node_edge_point(self) -> TapiNodeEdgePoint:
+        name_prefix = self.__name_prefix
+
+        cep_name = name_prefix.lower() + "-provider"
+        # exception for f1-c and f1-u
+        split = name_prefix.lower().split("-")
+        if len(split) == 3:
+            cep_name = "-".join([split[0], split[2], "provider"])
+
+        return self.__provider.node_edge_point_by_cep_name(cep_name, self.__consumer.local_id())