tapi/src/main/java/org/opendaylight/transportpce/tapi/topology/TapiNetworkUtilsImpl.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.ListenableFuture;
  11 import java.nio.charset.Charset;
  12 import java.util.ArrayList;
  13 import java.util.HashMap;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.Optional;
  17 import java.util.UUID;
  18 import java.util.concurrent.ExecutionException;
  19 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  20 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
  21 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.DeleteTapiLinkInput;
  22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.DeleteTapiLinkOutput;
  23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.DeleteTapiLinkOutputBuilder;
  24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.InitRoadmRoadmTapiLinkInput;
  25 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.InitRoadmRoadmTapiLinkOutput;
  26 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.InitRoadmRoadmTapiLinkOutputBuilder;
  27 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.InitXpdrRdmTapiLinkInput;
  28 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.InitXpdrRdmTapiLinkOutput;
  29 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.InitXpdrRdmTapiLinkOutputBuilder;
  30 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.tapinetworkutils.rev210408.TransportpceTapinetworkutilsService;
  31 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.AdministrativeState;
  32 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.CapacityUnit;
  33 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.Context;
  34 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.ForwardingDirection;
  35 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LayerProtocolName;
  36 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LifecycleState;
  37 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.OperationalState;
  38 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.Uuid;
  39 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.capacity.TotalSizeBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.capacity.pac.AvailableCapacityBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.capacity.pac.TotalPotentialCapacityBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.Name;
  43 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.NameBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.Context1;
  45 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.ProtectionType;
  46 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.RestorationPolicy;
  47 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.context.TopologyContext;
  48 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.link.NodeEdgePoint;
  49 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.link.NodeEdgePointBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.link.NodeEdgePointKey;
  51 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.link.ResilienceTypeBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePoint;
  53 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePointKey;
  54 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.risk.parameter.pac.RiskCharacteristic;
  55 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.risk.parameter.pac.RiskCharacteristicBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Link;
  57 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.LinkBuilder;
  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.NodeKey;
  61 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.Topology;
  62 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.TopologyBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.TopologyKey;
  64 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.transfer.cost.pac.CostCharacteristic;
  65 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.transfer.cost.pac.CostCharacteristicBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.transfer.timing.pac.LatencyCharacteristic;
  67 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.transfer.timing.pac.LatencyCharacteristicBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.validation.pac.ValidationMechanism;
  69 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.validation.pac.ValidationMechanismBuilder;
  70 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  71 import org.opendaylight.yangtools.yang.common.RpcError;
  72 import org.opendaylight.yangtools.yang.common.RpcResult;
  73 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  74 import org.opendaylight.yangtools.yang.common.Uint64;
  75 import org.slf4j.Logger;
  76 import org.slf4j.LoggerFactory;
  77
  78 public class TapiNetworkUtilsImpl implements TransportpceTapinetworkutilsService {
  79
  80     private static final Logger LOG = LoggerFactory.getLogger(TapiNetworkUtilsImpl.class);
  81     private static final String PHTNC_MEDIA = "PHOTONIC_MEDIA";
  82     private static final String OTSI = "OTSi";
  83     private final Uuid tapiTopoUuid = new Uuid(UUID.nameUUIDFromBytes(TopologyUtils.T0_FULL_MULTILAYER
  84             .getBytes(Charset.forName("UTF-8"))).toString());
  85     private final NetworkTransactionService networkTransactionService;
  86
  87     public TapiNetworkUtilsImpl(NetworkTransactionService networkTransactionService) {
  88         this.networkTransactionService = networkTransactionService;
  89     }
  90
  91     @Override
  92     public ListenableFuture<RpcResult<InitRoadmRoadmTapiLinkOutput>> initRoadmRoadmTapiLink(
  93             InitRoadmRoadmTapiLinkInput input) {
  94         // TODO --> need to check if the nodes and neps exist in the topology
  95         String sourceNode = input.getRdmANode();
  96         String sourceTp = input.getDegATp();
  97         String destNode = input.getRdmZNode();
  98         String destTp = input.getDegZTp();
  99         String linkId = String.join("-", sourceNode, sourceTp.split("-")[0], sourceTp)
 100             + "to" + String.join("-", destNode, destTp.split("-")[0], destTp);
 101         Link link = createTapiLink(sourceNode, sourceTp, destNode, destTp, linkId, "OMS link name", PHTNC_MEDIA);
 102         InitRoadmRoadmTapiLinkOutputBuilder output = new InitRoadmRoadmTapiLinkOutputBuilder();
 103         if (link == null) {
 104             LOG.error("Error creating link object");
 105             return RpcResultBuilder.<InitRoadmRoadmTapiLinkOutput>failed().withError(RpcError.ErrorType.RPC,
 106                 "Failed to create link in topology").buildFuture();
 107         }
 108         if (putLinkInTopology(link)) {
 109             output = new InitRoadmRoadmTapiLinkOutputBuilder()
 110                 .setResult("Link created in tapi topology. Link-uuid = " + link.getUuid());
 111         }
 112         return RpcResultBuilder.success(output.build()).buildFuture();
 113     }
 114
 115     @Override
 116     public ListenableFuture<RpcResult<InitXpdrRdmTapiLinkOutput>> initXpdrRdmTapiLink(InitXpdrRdmTapiLinkInput input) {
 117         // TODO --> need to check if the nodes and neps exist in the topology
 118         String destNode = input.getRdmNode();
 119         String destTp = input.getAddDropTp();
 120         String sourceNode = input.getXpdrNode();
 121         String sourceTp = input.getNetworkTp();
 122         String linkId = String.join("-", sourceNode, sourceTp)
 123             + "to" + String.join("-", destNode, destTp.split("-")[0], destTp);
 124         Link link = createTapiLink(sourceNode, sourceTp, destNode, destTp, linkId, "XPDR-RDM link name", OTSI);
 125         InitXpdrRdmTapiLinkOutputBuilder output = new InitXpdrRdmTapiLinkOutputBuilder();
 126         if (link == null) {
 127             LOG.error("Error creating link object");
 128             return RpcResultBuilder.<InitXpdrRdmTapiLinkOutput>failed().withError(RpcError.ErrorType.RPC,
 129                 "Failed to create link in topology").buildFuture();
 130         }
 131         if (putLinkInTopology(link)) {
 132             output = new InitXpdrRdmTapiLinkOutputBuilder()
 133                 .setResult("Link created in tapi topology. Link-uuid = " + link.getUuid());
 134         }
 135         return RpcResultBuilder.success(output.build()).buildFuture();
 136     }
 137
 138     @Override
 139     public ListenableFuture<RpcResult<DeleteTapiLinkOutput>> deleteTapiLink(DeleteTapiLinkInput input) {
 140         // TODO: check if this IID is correct
 141         // TODO --> need to check if the link exists in the topology
 142         try {
 143             InstanceIdentifier<Link> linkIID = InstanceIdentifier.builder(Context.class)
 144                     .augmentation(Context1.class).child(TopologyContext.class).child(Topology.class,
 145                             new TopologyKey(tapiTopoUuid)).child(Link.class, new LinkKey(input.getUuid())).build();
 146             this.networkTransactionService.delete(LogicalDatastoreType.OPERATIONAL, linkIID);
 147             this.networkTransactionService.commit().get();
 148             LOG.info("TAPI link deleted successfully.");
 149             return RpcResultBuilder.success(new DeleteTapiLinkOutputBuilder()
 150                 .setResult("Link successfully deleted from tapi topology").build()).buildFuture();
 151         } catch (InterruptedException | ExecutionException e) {
 152             LOG.error("Failed to delete TAPI link", e);
 153             return RpcResultBuilder.<DeleteTapiLinkOutput>failed().withError(RpcError.ErrorType.RPC,
 154                 "Failed to delete link from topology").buildFuture();
 155         }
 156     }
 157
 158     private Link createTapiLink(String sourceNode, String sourceTp, String destNode, String destTp, String linkId,
 159                                 String valueName, String sourceNodeQual) {
 160         Map<NodeEdgePointKey, NodeEdgePoint> nepList = new HashMap<>();
 161         Uuid sourceUuidNode = new Uuid(UUID.nameUUIDFromBytes((String.join("+", sourceNode,
 162             sourceNodeQual)).getBytes(Charset.forName("UTF-8"))).toString());
 163         Uuid sourceUuidTp = new Uuid(UUID.nameUUIDFromBytes((String.join("+", sourceNode, PHTNC_MEDIA,
 164             sourceTp)).getBytes(Charset.forName("UTF-8"))).toString());
 165         Uuid destUuidNode = new Uuid(UUID.nameUUIDFromBytes((String.join("+", destNode,
 166             PHTNC_MEDIA)).getBytes(Charset.forName("UTF-8"))).toString());
 167         Uuid destUuidTp = new Uuid(UUID.nameUUIDFromBytes((String.join("+", destNode, PHTNC_MEDIA,
 168             destTp)).getBytes(Charset.forName("UTF-8"))).toString());
 169         if (!(nodeExists(sourceUuidNode) && nodeExists(destUuidNode)
 170                 && nepExists(sourceUuidTp, sourceUuidNode) && nepExists(destUuidTp, destUuidNode))) {
 171             LOG.error("Verify the input data. No link can be created, "
 172                 + "as either the node or the tp doesnt exist in the TAPI topology");
 173             return null;
 174         }
 175         NodeEdgePoint sourceNep = new NodeEdgePointBuilder()
 176             .setTopologyUuid(this.tapiTopoUuid)
 177             .setNodeUuid(sourceUuidNode)
 178             .setNodeEdgePointUuid(sourceUuidTp)
 179             .build();
 180         nepList.put(sourceNep.key(), sourceNep);
 181         NodeEdgePoint destNep = new NodeEdgePointBuilder()
 182             .setTopologyUuid(this.tapiTopoUuid)
 183             .setNodeUuid(destUuidNode)
 184             .setNodeEdgePointUuid(destUuidTp)
 185             .build();
 186         nepList.put(destNep.key(), destNep);
 187         Name linkName = new NameBuilder().setValueName(valueName)
 188             .setValue(linkId)
 189             .build();
 190         CostCharacteristic costCharacteristic = new CostCharacteristicBuilder()
 191             .setCostAlgorithm("Restricted Shortest Path - RSP")
 192             .setCostName("HOP_COUNT")
 193             .setCostValue("12345678")
 194             .build();
 195         LatencyCharacteristic latencyCharacteristic = new LatencyCharacteristicBuilder()
 196             .setFixedLatencyCharacteristic("12345678")
 197             .setQueingLatencyCharacteristic("12345678")
 198             .setJitterCharacteristic("12345678")
 199             .setWanderCharacteristic("12345678")
 200             .setTrafficPropertyName("FIXED_LATENCY")
 201             .build();
 202         RiskCharacteristic riskCharacteristic = new RiskCharacteristicBuilder()
 203             .setRiskCharacteristicName("risk characteristic")
 204             .setRiskIdentifierList(List.of("risk identifier1", "risk identifier2"))
 205             .build();
 206         ValidationMechanism validationMechanism = new ValidationMechanismBuilder()
 207             .setValidationMechanism("validation mechanism")
 208             .setValidationRobustness("validation robustness")
 209             .setLayerProtocolAdjacencyValidated("layer protocol adjacency")
 210             .build();
 211         return new LinkBuilder()
 212             .setUuid(new Uuid(
 213                 UUID.nameUUIDFromBytes(linkId.getBytes(Charset.forName("UTF-8")))
 214                     .toString()))
 215             .setName(Map.of(linkName.key(), linkName))
 216             .setLayerProtocolName(List.of(LayerProtocolName.PHOTONICMEDIA))
 217             .setNodeEdgePoint(nepList)
 218             .setDirection(ForwardingDirection.BIDIRECTIONAL)
 219             .setTransitionedLayerProtocolName(new ArrayList<>())
 220             .setResilienceType(new ResilienceTypeBuilder().setProtectionType(ProtectionType.NOPROTECTON)
 221                 .setRestorationPolicy(RestorationPolicy.NA)
 222                 .build())
 223             .setAdministrativeState(AdministrativeState.UNLOCKED)
 224             .setOperationalState(OperationalState.ENABLED)
 225             .setLifecycleState(LifecycleState.INSTALLED)
 226             .setTotalPotentialCapacity(new TotalPotentialCapacityBuilder().setTotalSize(
 227                 new TotalSizeBuilder().setUnit(CapacityUnit.GBPS)
 228                     .setValue(Uint64.valueOf(100)).build()).build())
 229             .setAvailableCapacity(new AvailableCapacityBuilder().setTotalSize(
 230                 new TotalSizeBuilder().setUnit(CapacityUnit.MBPS)
 231                     .setValue(Uint64.valueOf(100)).build())
 232                 .build())
 233             .setCostCharacteristic(Map.of(costCharacteristic.key(), costCharacteristic))
 234             .setLatencyCharacteristic(Map.of(latencyCharacteristic.key(), latencyCharacteristic))
 235             .setRiskCharacteristic(Map.of(riskCharacteristic.key(), riskCharacteristic))
 236             .setErrorCharacteristic("error")
 237             .setLossCharacteristic("loss")
 238             .setRepeatDeliveryCharacteristic("repeat delivery")
 239             .setDeliveryOrderCharacteristic("delivery order")
 240             .setUnavailableTimeCharacteristic("unavailable time")
 241             .setServerIntegrityProcessCharacteristic("server integrity process")
 242             .setValidationMechanism(Map.of(validationMechanism.key(), validationMechanism))
 243             .build();
 244     }
 245
 246     private boolean nepExists(Uuid nepUuid, Uuid nodeUuid) {
 247         LOG.info("Checking if nep with uuid {} existis in tapi topology", nepUuid);
 248         try {
 249             InstanceIdentifier<OwnedNodeEdgePoint> onepIID = InstanceIdentifier.builder(Context.class)
 250                 .augmentation(Context1.class).child(TopologyContext.class)
 251                 .child(Topology.class, new TopologyKey(tapiTopoUuid)).child(Node.class, new NodeKey(nodeUuid))
 252                 .child(OwnedNodeEdgePoint.class, new OwnedNodeEdgePointKey(nepUuid))
 253                 .build();
 254             Optional<OwnedNodeEdgePoint> optionalOnep = this.networkTransactionService.read(
 255                 LogicalDatastoreType.OPERATIONAL, onepIID).get();
 256             if (!optionalOnep.isPresent()) {
 257                 LOG.error("ONEP is not present in datastore");
 258                 return false;
 259             }
 260             return true;
 261         } catch (InterruptedException | ExecutionException e) {
 262             LOG.error("Couldnt retrieve nep from datastore");
 263             return false;
 264         }
 265     }
 266
 267     private boolean nodeExists(Uuid nodeUuid) {
 268         LOG.info("Checking if node with uuid {} existis in tapi topology", nodeUuid);
 269         try {
 270             InstanceIdentifier<Node> nodeIID = InstanceIdentifier.builder(Context.class)
 271                 .augmentation(Context1.class).child(TopologyContext.class)
 272                 .child(Topology.class, new TopologyKey(tapiTopoUuid)).child(Node.class, new NodeKey(nodeUuid))
 273                 .build();
 274             Optional<Node> optionalNode = this.networkTransactionService.read(
 275                 LogicalDatastoreType.OPERATIONAL, nodeIID).get();
 276             if (!optionalNode.isPresent()) {
 277                 LOG.error("Node is not present in datastore");
 278                 return false;
 279             }
 280             return true;
 281         } catch (InterruptedException | ExecutionException e) {
 282             LOG.error("Couldnt retrieve nep from datastore");
 283             return false;
 284         }
 285     }
 286
 287     private boolean putLinkInTopology(Link tapiLink) {
 288         // TODO is this merge correct? Should we just merge topology by changing the nodes map??
 289         // TODO: verify this is correct. Should we identify the context IID with the context UUID??
 290         LOG.info("Creating tapi node in TAPI topology context");
 291         InstanceIdentifier<Topology> topoIID = InstanceIdentifier.builder(Context.class)
 292             .augmentation(Context1.class).child(TopologyContext.class)
 293             .child(Topology.class, new TopologyKey(tapiTopoUuid))
 294             .build();
 295
 296         Topology topology = new TopologyBuilder().setUuid(tapiTopoUuid)
 297             .setLink(Map.of(tapiLink.key(), tapiLink)).build();
 298
 299         // merge in datastore
 300         this.networkTransactionService.merge(LogicalDatastoreType.OPERATIONAL, topoIID,
 301             topology);
 302         try {
 303             this.networkTransactionService.commit().get();
 304
 305         } catch (InterruptedException | ExecutionException e) {
 306             LOG.error("Error populating TAPI topology: ", e);
 307             return false;
 308         }
 309         LOG.info("TAPI Link added succesfully.");
 310         return true;
 311     }
 312 }