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