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

   1 /*
   2  * Copyright © 2021 Nokia.  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 java.nio.charset.Charset;
  11 import java.util.List;
  12 import java.util.Map;
  13 import java.util.Optional;
  14 import java.util.Set;
  15 import java.util.UUID;
  16 import java.util.concurrent.ExecutionException;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
  19 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  20 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  21 import org.opendaylight.transportpce.common.NetworkUtils;
  22 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
  23 import org.opendaylight.transportpce.tapi.TapiStringConstants;
  24 import org.opendaylight.transportpce.tapi.utils.TapiLink;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.Link1;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev230526.OpenroadmLinkType;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NetworkId;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.Networks;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.NetworkKey;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.LinkKey;
  35 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.Context;
  36 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.LayerProtocolName;
  37 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.Uuid;
  38 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.Context1;
  39 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.context.TopologyContext;
  40 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.Topology;
  41 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.TopologyBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.TopologyKey;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 public class TapiOrLinkListener implements DataTreeChangeListener<Link> {
  48
  49     private static final Logger LOG = LoggerFactory.getLogger(TapiOrLinkListener.class);
  50     private final TapiLink tapiLink;
  51     private final NetworkTransactionService networkTransactionService;
  52     private final Uuid tapiTopoUuid = new Uuid(UUID.nameUUIDFromBytes(
  53                 TapiStringConstants.T0_FULL_MULTILAYER.getBytes(Charset.forName("UTF-8")))
  54             .toString());
  55
  56     public TapiOrLinkListener(final TapiLink tapiLink, final NetworkTransactionService networkTransactionService) {
  57         this.tapiLink = tapiLink;
  58         this.networkTransactionService = networkTransactionService;
  59     }
  60
  61     @Override
  62     public void onDataTreeChanged(@NonNull List<DataTreeModification<Link>> changes) {
  63         LOG.info("onDataTreeChanged - {}", this.getClass().getSimpleName());
  64         for (DataTreeModification<Link> change : changes) {
  65
  66             Link link = change.getRootNode().dataAfter();
  67             if (link == null) {
  68                 continue;
  69             }
  70             LOG.info("New link in openroadm topology");
  71             // Todo: XPDR links are unidirectional, therefore we need to check for the current one and
  72             //  the opposite one. But first check the type
  73             Link1 link1 = link.augmentation(Link1.class);
  74             if (link1 == null) {
  75                 LOG.error("No type in link. We cannot trigger the TAPI link creation");
  76                 return;
  77             }
  78
  79             if (!(link1.getLinkType().equals(OpenroadmLinkType.XPONDERINPUT)
  80                         || link1.getLinkType().equals(OpenroadmLinkType.XPONDEROUTPUT))
  81                         || link1.getLinkType().equals(OpenroadmLinkType.ROADMTOROADM)) {
  82                 // No creation of link for ADD/DROP/EXPRESS links
  83                 LOG.warn("Not triggering creation of link for type = {}", link1.getLinkType().getName());
  84                 continue;
  85             }
  86
  87             if (!oppositeLinkExists(link1.getOppositeLink())) {
  88                 LOG.warn("Opposite link doest exist. Not creating TAPI link");
  89                 return;
  90             }
  91             LOG.info("Opposite link already in datastore. Creating TAPI bidirectional link");
  92
  93             String srcNode = getRoadmOrXpdr(link.getSource().getSourceNode().getValue());
  94             String srcTp = link.getSource().getSourceTp().getValue();
  95             String destNode = getRoadmOrXpdr(link.getDestination().getDestNode().getValue());
  96             String destTp = link.getDestination().getDestTp().getValue();
  97             //Configuring link type to default OMS_XPDR-RDM
  98             String linkType = TapiStringConstants.OMS_XPDR_RDM_LINK;
  99
 100             if (link1.getLinkType().equals(OpenroadmLinkType.ROADMTOROADM)) {
 101                 // For ROADM to ROADM link, only capture change on existing links to track change in OMS
 102                 // Avoid creating 2 unidirectional links since these links are bidirectional in TAPI :
 103                 // Links are created at initialization through a process that guarantees the creation of a unique link
 104                 // Thus check that the link already exist in Datastore to upgrade it rather than creating an additional
 105                 // unidirectional link
 106                 if (!(linkExistInTopology(srcNode, srcTp, destNode, destTp, getQual(srcNode), getQual(destNode),
 107                         TapiStringConstants.PHTNC_MEDIA_OTS, TapiStringConstants.PHTNC_MEDIA_OTS))) {
 108                     continue;
 109                 }
 110                 LOG.warn("Now triggering creation of link for type = {} to account for OMS change",
 111                     link1.getLinkType().getName());
 112                 linkType = TapiStringConstants.OMS_RDM_RDM_LINK;
 113             }
 114
 115             // for Xpdr to roadm link, create Link only if it was not before in datastore since links are created
 116             // through rpcs and do not contain characteristics subject to potential updates
 117             if (change.getRootNode().dataBefore() != null) {
 118                 continue;
 119             }
 120             putTapiLinkInTopology(this.tapiLink.createTapiLink(srcNode, srcTp, destNode, destTp,
 121                 linkType, getQual(srcNode), getQual(destNode),
 122                 TapiStringConstants.PHTNC_MEDIA_OTS, TapiStringConstants.PHTNC_MEDIA_OTS,
 123                 link1.getAdministrativeState().getName(), link1.getOperationalState().getName(),
 124                 Set.of(LayerProtocolName.PHOTONICMEDIA), Set.of(LayerProtocolName.PHOTONICMEDIA.getName()),
 125                 tapiTopoUuid));
 126         }
 127     }
 128
 129     private boolean linkExistInTopology(String srcNodeId, String srcTpId, String dstNodeId, String dstTpId,
 130             String srcNodeQual, String dstNodeQual, String srcTpQual, String dstTpQual) {
 131         String sourceNepKey = String.join("+", srcNodeId, srcTpQual, srcTpId);
 132         String destNepKey = String.join("+", dstNodeId, dstTpQual, dstTpId);
 133         String linkKey = String.join("to", sourceNepKey, destNepKey);
 134         Uuid linkUuid = new Uuid(
 135             UUID.nameUUIDFromBytes(linkKey.getBytes(Charset.forName("UTF-8"))).toString());
 136         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link>
 137                 linkIID = InstanceIdentifier.builder(Context.class)
 138             .augmentation(Context1.class).child(TopologyContext.class)
 139             .child(Topology.class, new TopologyKey(tapiTopoUuid))
 140             .child(org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link.class,
 141                 new org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.LinkKey(linkUuid))
 142             .build();
 143         try {
 144             Optional<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link> optLink =
 145                 this.networkTransactionService.read(LogicalDatastoreType.OPERATIONAL, linkIID).get();
 146             if (optLink.isEmpty()) {
 147                 return false;
 148             }
 149         } catch (InterruptedException | ExecutionException e) {
 150             LOG.error("Could not read TAPI link in DataStore checking that rdm2rdm link is present");
 151         }
 152         return true;
 153     }
 154
 155     private void putTapiLinkInTopology(
 156             org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link tapiXpdrLink) {
 157         LOG.info("Creating tapi link in TAPI topology context");
 158         // merge in datastore
 159         this.networkTransactionService.merge(
 160             LogicalDatastoreType.OPERATIONAL,
 161             InstanceIdentifier.builder(Context.class)
 162                 .augmentation(Context1.class).child(TopologyContext.class)
 163                 .child(Topology.class, new TopologyKey(this.tapiTopoUuid))
 164                 .build(),
 165             new TopologyBuilder()
 166                 .setUuid(this.tapiTopoUuid)
 167                 .setLink(Map.of(tapiXpdrLink.key(), tapiXpdrLink))
 168                 .build());
 169         try {
 170             this.networkTransactionService.commit().get();
 171         } catch (InterruptedException | ExecutionException e) {
 172             LOG.error("Error populating TAPI topology: ", e);
 173         }
 174         LOG.info("TAPI Link added succesfully.");
 175     }
 176
 177     private String getQual(String node) {
 178         return node.contains("ROADM") ? TapiStringConstants.PHTNC_MEDIA : TapiStringConstants.XPDR;
 179     }
 180
 181     private boolean oppositeLinkExists(LinkId oppositeLink) {
 182         try {
 183             if (this.networkTransactionService
 184                     .read(
 185                         LogicalDatastoreType.CONFIGURATION,
 186                         InstanceIdentifier.builder(Networks.class)
 187                             .child(Network.class, new NetworkKey(new NetworkId(NetworkUtils.OVERLAY_NETWORK_ID)))
 188                             .augmentation(Network1.class)
 189                             .child(Link.class, new LinkKey(oppositeLink))
 190                             .build())
 191                     .get()
 192                     .isEmpty()) {
 193                 LOG.error("Opposite link not found in datastore {}", oppositeLink.getValue());
 194                 return false;
 195             }
 196             return true;
 197         } catch (InterruptedException | ExecutionException e) {
 198             LOG.error("Failed to read opposite link", e);
 199             return false;
 200         }
 201     }
 202
 203     private String getRoadmOrXpdr(String node) {
 204         return node.contains("ROADM")
 205             ? String.join("-", node.split("-")[0], node.split("-")[1])
 206             : node;
 207     }
 208 }