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