Initial OR-TAPI mapping: Topology
[transportpce.git] / tapi / src / main / java / org / opendaylight / transportpce / tapi / topology / TopologyUtils.java
index 457f1b91d22756fae93e6189ae89eca8aad3a8c6..846d533a96a6c6edd70cfcfebaf3e12768d70698 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2019 Orange, Inc. and others.  All rights reserved.
+ * Copyright © 2021 Nokia, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  */
 package org.opendaylight.transportpce.tapi.topology;
 
-public final class TopologyUtils {
+import com.google.common.util.concurrent.FluentFuture;
+import com.google.common.util.concurrent.ListenableFuture;
+import java.nio.charset.Charset;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
+import java.util.Optional;
+import java.util.UUID;
+import java.util.concurrent.ExecutionException;
+import java.util.stream.Collectors;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.transportpce.common.InstanceIdentifiers;
+import org.opendaylight.transportpce.common.NetworkUtils;
+import org.opendaylight.transportpce.common.network.NetworkTransactionService;
+import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.mapping.Mapping;
+import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.mapping.MappingKey;
+import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.network.Nodes;
+import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.network.NodesKey;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Link1;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmLinkType;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmNodeType;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmTpType;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LayerProtocolName;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.Uuid;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.Name;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.NameBuilder;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.tapi.context.ServiceInterfacePoint;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.tapi.context.ServiceInterfacePointKey;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.LinkKey;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.NodeKey;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.Topology;
+import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.TopologyBuilder;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
-    private TopologyUtils() {
-    }
+public final class TopologyUtils {
 
+    private final NetworkTransactionService networkTransactionService;
+    private final DataBroker dataBroker;
+    private static final Logger LOG = LoggerFactory.getLogger(TopologyUtils.class);
     public static final String T0_MULTILAYER = "T0 - Multi-layer topology";
+    public static final String T0_FULL_MULTILAYER = "T0 - Full Multi-layer topology";
     public static final String TPDR_100G = "Transponder 100GE";
+    private Map<ServiceInterfacePointKey, ServiceInterfacePoint> tapiSips;
+
+    public TopologyUtils(NetworkTransactionService networkTransactionService, DataBroker dataBroker) {
+        this.networkTransactionService = networkTransactionService;
+        this.dataBroker = dataBroker;
+        this.tapiSips = new HashMap<>();
+    }
+
+    public Network readTopology(InstanceIdentifier<Network> networkIID) throws TapiTopologyException {
+        Network topology = null;
+        ListenableFuture<Optional<Network>> topologyFuture =
+                this.networkTransactionService.read(LogicalDatastoreType.CONFIGURATION, networkIID);
+        try {
+            topology = topologyFuture.get().get();
+        } catch (InterruptedException e) {
+            Thread.currentThread().interrupt();
+            throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
+                    .firstKeyOf(Network.class).getNetworkId().getValue(), e);
+        } catch (ExecutionException e) {
+            throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
+                    .firstKeyOf(Network.class).getNetworkId().getValue(), e);
+        } catch (NoSuchElementException e) {
+            return null;
+        }
+        return topology;
+    }
+
+    public Topology createFullOtnTopology() throws TapiTopologyException {
+        // read openroadm-topology
+        Network openroadmTopo = readTopology(InstanceIdentifiers.OVERLAY_NETWORK_II);
+        List<Link> linkList = new ArrayList<>();
+        if (openroadmTopo.augmentation(Network1.class) != null) {
+            linkList.addAll(openroadmTopo.augmentation(Network1.class).getLink().values());
+        }
+        List<Link> xponderOutLinkList = linkList.stream()
+            .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDEROUTPUT))
+            .collect(Collectors.toList());
+        List<Link> xponderInLinkList = linkList.stream()
+            .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDERINPUT))
+            .collect(Collectors.toList());
+        // read otn-topology
+        Network otnTopo = readTopology(InstanceIdentifiers.OTN_NETWORK_II);
+        Map<NodeId, org.opendaylight.yang.gen.v1.urn
+            .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node> otnNodeMap = otnTopo.nonnullNode()
+            .values().stream().collect(Collectors.toMap(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
+                .ietf.network.rev180226.networks.network.Node::getNodeId, node -> node));
+
+        Map<String, List<String>> networkPortMap = new HashMap<>();
+        Iterator<Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
+            .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node>> itOtnNodeMap = otnNodeMap
+            .entrySet().iterator();
+        while (itOtnNodeMap.hasNext()) {
+            Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
+                .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node> entry = itOtnNodeMap.next();
+            String portMappingNodeId = entry.getValue().getSupportingNode().values().stream()
+                .filter(sn -> sn.getNetworkRef().getValue().equals(NetworkUtils.UNDERLAY_NETWORK_ID))
+                .findFirst()
+                .get().getNodeRef().getValue();
+            List<String> networkPortList = new ArrayList<>();
+            for (TerminationPoint tp: entry.getValue().augmentation(Node1.class).getTerminationPoint().values()) {
+                // TODO -> why are we checking with respect to XPDR links?? Is there a real purpose on doing that?
+                if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERNETWORK)
+                    && checkTp(entry.getKey().getValue(), portMappingNodeId, tp, xponderOutLinkList,
+                    xponderInLinkList)) {
+                    networkPortList.add(tp.getTpId().getValue());
+                }
+            }
+            if (!networkPortList.isEmpty()) {
+                networkPortMap.put(entry.getKey().getValue(), networkPortList);
+            }
+        }
+        Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node>
+            tapiNodeList = new HashMap<>();
+        Map<LinkKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Link>
+            tapiLinkList = new HashMap<>();
+        Uuid topoUuid = new Uuid(UUID.nameUUIDFromBytes(TopologyUtils.T0_FULL_MULTILAYER
+            .getBytes(Charset.forName("UTF-8"))).toString());
+        ConvertORTopoToTapiFullTopo tapiFactory = new ConvertORTopoToTapiFullTopo(topoUuid);
+        Iterator<Map.Entry<String, List<String>>> it = networkPortMap.entrySet().iterator();
+        while (it.hasNext()) {
+            String nodeId = it.next().getKey();
+            tapiFactory.convertNode(otnNodeMap.get(new NodeId(nodeId)), networkPortMap.get(nodeId));
+            tapiNodeList.putAll(tapiFactory.getTapiNodes());
+            tapiLinkList.putAll(tapiFactory.getTapiLinks());
+        }
+        // roadm infrastructure not abstracted
+        // read openroadm-network
+        Network openroadmNet = readTopology(InstanceIdentifiers.UNDERLAY_NETWORK_II);
+        if (openroadmNet != null && openroadmNet.nonnullNode().values().stream().filter(nt ->
+                nt.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1.class)
+                        .getNodeType().equals(OpenroadmNodeType.ROADM)).count() > 0) {
+            // map roadm nodes
+            for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node
+                    roadm:openroadmNet.nonnullNode().values().stream().filter(
+                            nt -> nt.augmentation(org.opendaylight.yang.gen.v1.http
+                            .org.openroadm.common.network.rev200529.Node1.class)
+                            .getNodeType().equals(OpenroadmNodeType.ROADM))
+                    .collect(Collectors.toList())) {
+                tapiFactory.convertRoadmNode(roadm, openroadmTopo);
+                tapiNodeList.putAll(tapiFactory.getTapiNodes());
+            }
+        } else {
+            LOG.warn("No roadm nodes exist in the network");
+        }
+        // map roadm to roadm link
+        List<Link> rdmTordmLinkList = linkList.stream()
+                .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.ROADMTOROADM))
+                .collect(Collectors.toList());
+        tapiFactory.convertRdmToRdmLinks(rdmTordmLinkList);
+        tapiLinkList.putAll(tapiFactory.getTapiLinks());
+        // map xpdr_input to roadm and xpdr_output to roadm links.
+        xponderInLinkList.addAll(xponderOutLinkList);
+        tapiFactory.convertXpdrToRdmLinks(xponderInLinkList);
+        tapiLinkList.putAll(tapiFactory.getTapiLinks());
+
+        if (otnTopo.augmentation(Network1.class) != null) {
+            Map<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks
+                    .network.LinkKey, Link> otnLinkMap = otnTopo.augmentation(Network1.class).getLink();
+            tapiFactory.convertLinks(otnLinkMap);
+            tapiLinkList.putAll(tapiFactory.getTapiLinks());
+        }
+        Name name = new NameBuilder().setValue(TopologyUtils.T0_FULL_MULTILAYER).setValueName("TAPI Topology Name")
+                .build();
+        // Retrieve created sips map in TapiFactory when mapping all the nodes
+        this.tapiSips = tapiFactory.getTapiSips();
+        return new TopologyBuilder()
+                .setName(Map.of(name.key(), name))
+                .setUuid(topoUuid)
+                .setNode(tapiNodeList)
+                .setLayerProtocolName(List.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
+                        LayerProtocolName.DSR))
+                .setLink(tapiLinkList).build();
+    }
+
+    public Map<ServiceInterfacePointKey, ServiceInterfacePoint> getSipMap() {
+        return tapiSips;
+    }
+
+    public boolean checkTp(String nodeIdTopo, String nodeIdPortMap, TerminationPoint tp, List<Link> xpdOut,
+                           List<Link> xpdIn) {
+        LOG.info("Inside Checktp for node {}-{}", nodeIdTopo, nodeIdPortMap);
+        String networkLcp;
+        if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERCLIENT)) {
+            networkLcp = tp.augmentation(
+                    org.opendaylight.yang.gen.v1.http.transportpce.topology.rev201019.TerminationPoint1.class)
+                    .getAssociatedConnectionMapPort();
+        } else {
+            networkLcp = tp.getTpId().getValue();
+        }
+        LOG.info("Network LCP associated = {}", networkLcp);
+        @NonNull
+        KeyedInstanceIdentifier<Mapping, MappingKey> pmIID = InstanceIdentifier.create(
+                org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.Network.class)
+                .child(Nodes.class, new NodesKey(nodeIdPortMap)).child(Mapping.class, new MappingKey(networkLcp));
+        @NonNull
+        FluentFuture<Optional<Mapping>> mappingOpt = this.dataBroker.newReadOnlyTransaction().read(
+                LogicalDatastoreType.CONFIGURATION, pmIID);
+        Mapping mapping = null;
+        if (mappingOpt.isDone()) {
+            try {
+                mapping = mappingOpt.get().get();
+            } catch (InterruptedException | ExecutionException e) {
+                LOG.error("Error getting mapping for {}", networkLcp,e);
+                return false;
+            }
+        } else {
+            LOG.error("Impossible to get mapping of associated network port {} of tp {}", networkLcp, tp.getTpId()
+                    .getValue());
+            return false;
+        }
+        LOG.info("Mapping found = {}", mapping);
+        String networkPortDirection = mapping.getPortDirection();
+        // long count = 0;
+        switch (networkPortDirection) {
+            // TODO -> remove the part of counting only if the Network LCP is part of a Link.
+            //  We want to have all OTN nodes in the TAPI topology
+            case "bidirectional":
+                return true;
+            case "tx":
+            case "rx":
+                @Nullable
+                String partnerLcp = mapping.getPartnerLcp();
+                LOG.info("PartnerLCP = {}", partnerLcp);
+                return true;
+            default:
+                LOG.error("Invalid port direction for {}", networkLcp);
+                return false;
+        }
+    }
+
+    public org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.get.topology.details.output.Topology
+            transformTopology(Topology topology) {
+        return new org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210
+            .get.topology.details.output.TopologyBuilder()
+                .setUuid(topology.getUuid())
+                .setName(topology.getName())
+                .setLayerProtocolName(topology.getLayerProtocolName())
+                .setNode(topology.getNode())
+                .setLink(topology.getLink())
+                .build();
+    }
 
 }