tapi/src/main/java/org/opendaylight/transportpce/tapi/topology/TopologyUtils.java

   1 /*
   2  * Copyright © 2021 Nokia, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.transportpce.tapi.topology;
   9
  10 import com.google.common.util.concurrent.FluentFuture;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import java.nio.charset.Charset;
  13 import java.util.ArrayList;
  14 import java.util.HashMap;
  15 import java.util.Iterator;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.NoSuchElementException;
  19 import java.util.Optional;
  20 import java.util.Set;
  21 import java.util.UUID;
  22 import java.util.concurrent.ExecutionException;
  23 import java.util.stream.Collectors;
  24 import org.eclipse.jdt.annotation.NonNull;
  25 import org.eclipse.jdt.annotation.Nullable;
  26 import org.opendaylight.mdsal.binding.api.DataBroker;
  27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  28 import org.opendaylight.transportpce.common.InstanceIdentifiers;
  29 import org.opendaylight.transportpce.common.NetworkUtils;
  30 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
  31 import org.opendaylight.transportpce.tapi.TapiStringConstants;
  32 import org.opendaylight.transportpce.tapi.utils.TapiLink;
  33 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.Mapping;
  34 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.MappingKey;
  35 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.network.Nodes;
  36 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.network.NodesKey;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Link1;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.TerminationPoint1;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.OpenroadmLinkType;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.OpenroadmNodeType;
  41 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.OpenroadmTpType;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
  48 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LayerProtocolName;
  49 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.Uuid;
  50 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.Name;
  51 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.NameBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.tapi.context.ServiceInterfacePoint;
  53 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.tapi.context.ServiceInterfacePointKey;
  54 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.connectivity.rev181210.OwnedNodeEdgePoint1;
  55 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePoint;
  56 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePointBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePointKey;
  58 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.LinkKey;
  59 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node;
  60 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.NodeBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.NodeKey;
  62 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.Topology;
  63 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.TopologyBuilder;
  64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  65 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  66 import org.slf4j.Logger;
  67 import org.slf4j.LoggerFactory;
  68
  69 public final class TopologyUtils {
  70
  71     private final NetworkTransactionService networkTransactionService;
  72     private final DataBroker dataBroker;
  73     private static final Logger LOG = LoggerFactory.getLogger(TopologyUtils.class);
  74     private Map<ServiceInterfacePointKey, ServiceInterfacePoint> tapiSips;
  75     private final TapiLink tapiLink;
  76
  77     public TopologyUtils(NetworkTransactionService networkTransactionService, DataBroker dataBroker,
  78                          TapiLink tapiLink) {
  79         this.networkTransactionService = networkTransactionService;
  80         this.dataBroker = dataBroker;
  81         this.tapiSips = new HashMap<>();
  82         this.tapiLink = tapiLink;
  83     }
  84
  85     public Network readTopology(InstanceIdentifier<Network> networkIID) throws TapiTopologyException {
  86         Network topology = null;
  87         ListenableFuture<Optional<Network>> topologyFuture =
  88                 this.networkTransactionService.read(LogicalDatastoreType.CONFIGURATION, networkIID);
  89         try {
  90             topology = topologyFuture.get().get();
  91         } catch (InterruptedException e) {
  92             Thread.currentThread().interrupt();
  93             throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
  94                     .firstKeyOf(Network.class).getNetworkId().getValue(), e);
  95         } catch (ExecutionException e) {
  96             throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
  97                     .firstKeyOf(Network.class).getNetworkId().getValue(), e);
  98         } catch (NoSuchElementException e) {
  99             return null;
 100         }
 101         return topology;
 102     }
 103
 104     public Topology createFullOtnTopology() throws TapiTopologyException {
 105         // read openroadm-topology
 106         Network openroadmTopo = readTopology(InstanceIdentifiers.OVERLAY_NETWORK_II);
 107         Uuid topoUuid = new Uuid(UUID.nameUUIDFromBytes(TapiStringConstants.T0_FULL_MULTILAYER
 108             .getBytes(Charset.forName("UTF-8"))).toString());
 109         Name name = new NameBuilder()
 110             .setValue(TapiStringConstants.T0_FULL_MULTILAYER)
 111             .setValueName("TAPI Topology Name")
 112             .build();
 113         if (openroadmTopo != null) {
 114             List<Link> linkList = new ArrayList<>();
 115             if (openroadmTopo.augmentation(Network1.class) != null) {
 116                 linkList.addAll(openroadmTopo.augmentation(Network1.class).getLink().values());
 117             }
 118             List<Link> xponderOutLinkList = linkList.stream()
 119                 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDEROUTPUT))
 120                 .collect(Collectors.toList());
 121             List<Link> xponderInLinkList = linkList.stream()
 122                 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDERINPUT))
 123                 .collect(Collectors.toList());
 124             // read otn-topology
 125             Network otnTopo = readTopology(InstanceIdentifiers.OTN_NETWORK_II);
 126             Map<NodeId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
 127                 .ietf.network.rev180226.networks.network.Node> otnNodeMap = otnTopo.nonnullNode()
 128                 .values().stream().collect(Collectors.toMap(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
 129                     .ietf.network.rev180226.networks.network.Node::getNodeId, node -> node));
 130
 131             Map<String, List<String>> networkPortMap = new HashMap<>();
 132             Iterator<Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
 133                 .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node>> itOtnNodeMap = otnNodeMap
 134                 .entrySet().iterator();
 135             while (itOtnNodeMap.hasNext()) {
 136                 Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
 137                     .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node> entry = itOtnNodeMap.next();
 138                 String portMappingNodeId = entry.getValue().getSupportingNode().values().stream()
 139                     .filter(sn -> sn.getNetworkRef().getValue().equals(NetworkUtils.UNDERLAY_NETWORK_ID))
 140                     .findFirst()
 141                     .get().getNodeRef().getValue();
 142                 List<String> networkPortList = new ArrayList<>();
 143                 for (TerminationPoint tp: entry.getValue().augmentation(Node1.class).getTerminationPoint().values()) {
 144                     // TODO -> why are we checking with respect to XPDR links?? Is there a real purpose on doing that?
 145                     if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERNETWORK)
 146                         && checkTp(entry.getKey().getValue(), portMappingNodeId, tp, xponderOutLinkList,
 147                         xponderInLinkList)) {
 148                         networkPortList.add(tp.getTpId().getValue());
 149                     }
 150                 }
 151                 if (!networkPortList.isEmpty()) {
 152                     networkPortMap.put(entry.getKey().getValue(), networkPortList);
 153                 }
 154             }
 155             Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node>
 156                 tapiNodeList = new HashMap<>();
 157             Map<LinkKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Link>
 158                 tapiLinkList = new HashMap<>();
 159             ConvertORTopoToTapiFullTopo tapiFactory = new ConvertORTopoToTapiFullTopo(topoUuid, this.tapiLink);
 160             Iterator<Map.Entry<String, List<String>>> it = networkPortMap.entrySet().iterator();
 161             while (it.hasNext()) {
 162                 String nodeId = it.next().getKey();
 163                 tapiFactory.convertNode(otnNodeMap.get(new NodeId(nodeId)), networkPortMap.get(nodeId));
 164                 tapiNodeList.putAll(tapiFactory.getTapiNodes());
 165                 tapiLinkList.putAll(tapiFactory.getTapiLinks());
 166             }
 167             // roadm infrastructure not abstracted
 168             // read openroadm-network
 169             Network openroadmNet = readTopology(InstanceIdentifiers.UNDERLAY_NETWORK_II);
 170             if (openroadmNet != null && openroadmNet.nonnullNode().values().stream().filter(nt ->
 171                 nt.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Node1.class)
 172                     .getNodeType().equals(OpenroadmNodeType.ROADM)).count() > 0) {
 173                 // map roadm nodes
 174                 for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
 175                     .ietf.network.rev180226.networks.network.Node roadm:openroadmNet.nonnullNode().values().stream()
 176                     .filter(nt -> nt.augmentation(org.opendaylight.yang.gen.v1.http
 177                         .org.openroadm.common.network.rev211210.Node1.class)
 178                         .getNodeType().equals(OpenroadmNodeType.ROADM))
 179                     .collect(Collectors.toList())) {
 180                     tapiFactory.convertRoadmNode(roadm, openroadmTopo);
 181                     tapiNodeList.putAll(tapiFactory.getTapiNodes());
 182                 }
 183             } else {
 184                 LOG.warn("No roadm nodes exist in the network");
 185             }
 186             // map roadm to roadm link
 187             List<Link> rdmTordmLinkList = linkList.stream()
 188                 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.ROADMTOROADM))
 189                 .collect(Collectors.toList());
 190             tapiFactory.convertRdmToRdmLinks(rdmTordmLinkList);
 191             tapiLinkList.putAll(tapiFactory.getTapiLinks());
 192             // map xpdr_input to roadm and xpdr_output to roadm links.
 193             xponderInLinkList.addAll(xponderOutLinkList);
 194             tapiFactory.convertXpdrToRdmLinks(xponderInLinkList);
 195             tapiLinkList.putAll(tapiFactory.getTapiLinks());
 196
 197             // Retrieve created sips map in TapiFactory when mapping all the nodes
 198             this.tapiSips = tapiFactory.getTapiSips();
 199             return new TopologyBuilder()
 200                 .setName(Map.of(name.key(), name))
 201                 .setUuid(topoUuid)
 202                 .setNode(tapiNodeList)
 203                 .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
 204                     LayerProtocolName.DSR))
 205                 .setLink(tapiLinkList).build();
 206         }
 207         return new TopologyBuilder()
 208             .setName(Map.of(name.key(), name))
 209             .setUuid(topoUuid)
 210             .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
 211                 LayerProtocolName.DSR))
 212             .build();
 213     }
 214
 215     public Map<ServiceInterfacePointKey, ServiceInterfacePoint> getSipMap() {
 216         return tapiSips;
 217     }
 218
 219     public boolean checkTp(String nodeIdTopo, String nodeIdPortMap, TerminationPoint tp, List<Link> xpdOut,
 220                            List<Link> xpdIn) {
 221         LOG.info("Inside Checktp for node {}-{}", nodeIdTopo, nodeIdPortMap);
 222         String networkLcp;
 223         if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERCLIENT)) {
 224             networkLcp = tp.augmentation(
 225                     org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.TerminationPoint1.class)
 226                     .getAssociatedConnectionMapTp().iterator().next().getValue();
 227         } else {
 228             networkLcp = tp.getTpId().getValue();
 229         }
 230         LOG.info("Network LCP associated = {}", networkLcp);
 231         @NonNull
 232         KeyedInstanceIdentifier<Mapping, MappingKey> pmIID = InstanceIdentifier.create(
 233                 org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.Network.class)
 234                 .child(Nodes.class, new NodesKey(nodeIdPortMap)).child(Mapping.class, new MappingKey(networkLcp));
 235         @NonNull
 236         FluentFuture<Optional<Mapping>> mappingOpt = this.dataBroker.newReadOnlyTransaction().read(
 237                 LogicalDatastoreType.CONFIGURATION, pmIID);
 238         Mapping mapping = null;
 239         if (mappingOpt.isDone()) {
 240             try {
 241                 mapping = mappingOpt.get().get();
 242             } catch (InterruptedException | ExecutionException e) {
 243                 LOG.error("Error getting mapping for {}", networkLcp,e);
 244                 return false;
 245             }
 246         } else {
 247             LOG.error("Impossible to get mapping of associated network port {} of tp {}", networkLcp, tp.getTpId()
 248                     .getValue());
 249             return false;
 250         }
 251         LOG.info("Mapping found = {}", mapping);
 252         String networkPortDirection = mapping.getPortDirection();
 253         // long count = 0;
 254         switch (networkPortDirection) {
 255             // TODO -> remove the part of counting only if the Network LCP is part of a Link.
 256             //  We want to have all OTN nodes in the TAPI topology
 257             case "bidirectional":
 258                 return true;
 259             case "tx":
 260             case "rx":
 261                 @Nullable
 262                 String partnerLcp = mapping.getPartnerLcp();
 263                 LOG.info("PartnerLCP = {}", partnerLcp);
 264                 return true;
 265             default:
 266                 LOG.error("Invalid port direction for {}", networkLcp);
 267                 return false;
 268         }
 269     }
 270
 271     public org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.get.topology.details.output.Topology
 272             transformTopology(Topology topology) {
 273         org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210
 274             .get.topology.details.output.TopologyBuilder topologyBuilder =
 275                 new org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210
 276             .get.topology.details.output.TopologyBuilder()
 277                 .setUuid(topology.getUuid())
 278                 .setName(topology.getName())
 279                 .setLayerProtocolName(topology.getLayerProtocolName())
 280                 .setNode(topology.getNode())
 281                 .setLink(topology.getLink());
 282         if (topology.getNode() == null) {
 283             topologyBuilder.setNode(topology.getNode());
 284             return topologyBuilder.build();
 285         }
 286         // TODO -> Need to remove CEPs from NEPs. If not error from get Topology details output
 287         Map<NodeKey, Node> mapNode = new HashMap<>();
 288         for (Node node: topology.getNode().values()) {
 289             Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepMap = new HashMap<>();
 290             for (OwnedNodeEdgePoint onep: node.getOwnedNodeEdgePoint().values()) {
 291                 OwnedNodeEdgePoint1 onep1 = onep.augmentation(OwnedNodeEdgePoint1.class);
 292                 if (onep1 == null) {
 293                     onepMap.put(onep.key(), onep);
 294                     continue;
 295                 }
 296                 OwnedNodeEdgePointBuilder newOnepBuilder = new OwnedNodeEdgePointBuilder()
 297                         .setUuid(onep.getUuid())
 298                         .setLayerProtocolName(onep.getLayerProtocolName())
 299                         .setName(onep.getName())
 300                         .setSupportedCepLayerProtocolQualifier(onep.getSupportedCepLayerProtocolQualifier())
 301                         .setAdministrativeState(onep.getAdministrativeState())
 302                         .setOperationalState(onep.getOperationalState())
 303                         .setLifecycleState(onep.getLifecycleState())
 304                         .setTerminationDirection(onep.getTerminationDirection())
 305                         .setTerminationState(onep.getTerminationState())
 306                         .setLinkPortDirection(onep.getLinkPortDirection())
 307                         .setLinkPortRole(onep.getLinkPortRole());
 308                 if (onep.getMappedServiceInterfacePoint() != null) {
 309                     newOnepBuilder.setMappedServiceInterfacePoint(onep.getMappedServiceInterfacePoint());
 310                 }
 311                 OwnedNodeEdgePoint nep = newOnepBuilder.build();
 312                 onepMap.put(nep.key(), nep);
 313             }
 314             Node newNode = new NodeBuilder(node)
 315                     .setOwnedNodeEdgePoint(onepMap)
 316                     .build();
 317             mapNode.put(newNode.key(), newNode);
 318         }
 319         topologyBuilder.setNode(mapNode);
 320         return topologyBuilder.build();
 321     }
 322 }