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

   1 /*
   2  * Copyright © 2019 Orange, 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.Arrays;
  15 import java.util.HashMap;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.NoSuchElementException;
  19 import java.util.Optional;
  20 import java.util.UUID;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.stream.Collectors;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.opendaylight.mdsal.binding.api.DataBroker;
  26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  27 import org.opendaylight.transportpce.common.InstanceIdentifiers;
  28 import org.opendaylight.transportpce.common.NetworkUtils;
  29 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.network.Nodes;
  30 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.network.NodesKey;
  31 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.network.nodes.Mapping;
  32 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.network.nodes.MappingKey;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.Link1;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.TerminationPoint1;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmLinkType;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmNodeType;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmTpType;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
  44 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.AdministrativeState;
  45 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LayerProtocolName;
  46 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LifecycleState;
  47 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.OperationalState;
  48 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.PortDirection;
  49 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.PortRole;
  50 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.TerminationDirection;
  51 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.TerminationState;
  52 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.Uuid;
  53 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.Name;
  54 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.NameBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetLinkDetailsInput;
  56 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetLinkDetailsOutput;
  57 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetNodeDetailsInput;
  58 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetNodeDetailsOutput;
  59 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetNodeEdgePointDetailsInput;
  60 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetNodeEdgePointDetailsOutput;
  61 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyDetailsInput;
  62 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyDetailsOutput;
  63 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyDetailsOutputBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyListInput;
  65 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.GetTopologyListOutput;
  66 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.TapiTopologyService;
  67 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.get.topology.details.output.Topology;
  68 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.get.topology.details.output.TopologyBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePoint;
  70 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.OwnedNodeEdgePointBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.edge.point.MappedServiceInterfacePoint;
  72 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.node.edge.point.MappedServiceInterfacePointBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.NodeBuilder;
  74 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  75 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  76 import org.opendaylight.yangtools.yang.common.RpcResult;
  77 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  78 import org.slf4j.Logger;
  79 import org.slf4j.LoggerFactory;
  80
  81 public class TapiTopologyImpl implements TapiTopologyService {
  82
  83     private static final Logger LOG = LoggerFactory.getLogger(TapiTopologyImpl.class);
  84     private static final String ETH_TOPO = "Ethernet Topology";
  85     private static final String T0_MULTI_LAYER_TOPO = "T0 - Multi-layer topology";
  86     private final DataBroker dataBroker;
  87
  88     public TapiTopologyImpl(DataBroker dataBroker) {
  89         this.dataBroker = dataBroker;
  90     }
  91
  92     @Override
  93     public ListenableFuture<RpcResult<GetNodeDetailsOutput>> getNodeDetails(GetNodeDetailsInput input) {
  94         // TODO Auto-generated method stub
  95         return null;
  96     }
  97
  98     @Override
  99     public ListenableFuture<RpcResult<GetTopologyDetailsOutput>> getTopologyDetails(GetTopologyDetailsInput input) {
 100         LOG.info("Building TAPI Topology abstraction from {}", input.getTopologyIdOrName());
 101         Topology topology = null;
 102         switch (input.getTopologyIdOrName()) {
 103             case NetworkUtils.OVERLAY_NETWORK_ID:
 104                 topology = createAbstractedOpenroadmTopology();
 105                 break;
 106             case NetworkUtils.OTN_NETWORK_ID:
 107                 topology = createAbstractedOtnTopology();
 108                 break;
 109             default:
 110                 LOG.error("{} unknown - can not be abstracted", input.getTopologyIdOrName());
 111                 break;
 112         }
 113         if (topology != null) {
 114             return RpcResultBuilder.success(new GetTopologyDetailsOutputBuilder().setTopology(topology).build())
 115                 .buildFuture();
 116         } else {
 117             return RpcResultBuilder.success(new GetTopologyDetailsOutputBuilder().build()).buildFuture();
 118         }
 119     }
 120
 121     private Topology createAbstractedOpenroadmTopology() {
 122         // read openroadm-topology
 123         @NonNull
 124         FluentFuture<Optional<Network>> openroadmTopoOpt = dataBroker.newReadOnlyTransaction()
 125                 .read(LogicalDatastoreType.CONFIGURATION, InstanceIdentifiers.OVERLAY_NETWORK_II);
 126         if (!openroadmTopoOpt.isDone()) {
 127             LOG.warn("Cannot get openroadm topology, returning null");
 128             return null;
 129         }
 130         Optional<Network> optionalOpenroadmTop = null;
 131         try {
 132             optionalOpenroadmTop = openroadmTopoOpt.get();
 133         } catch (InterruptedException e) {
 134             //sonar : "InterruptedException" should not be ignored (java:S2142)
 135             //https://www.ibm.com/developerworks/java/library/j-jtp05236/index.html?ca=drs-#2.1
 136             Thread.currentThread().interrupt();
 137             return null;
 138         } catch (ExecutionException | NoSuchElementException e) {
 139             LOG.error("Impossible to retrieve openroadm-topology from mdsal", e);
 140             return null;
 141         }
 142
 143         if (!optionalOpenroadmTop.isPresent()) {
 144             LOG.warn("Openroadm topology is not present, returning null");
 145             return null;
 146         }
 147         Network openroadmTopo = optionalOpenroadmTop.get();
 148         List<Node> nodeList = openroadmTopo.getNode();
 149         List<Link> linkList = null;
 150         if (openroadmTopo.augmentation(Network1.class) != null) {
 151             linkList = openroadmTopo.augmentation(Network1.class).getLink();
 152         } else {
 153             linkList = new ArrayList<>();
 154         }
 155         List<Link> xponderOutLinkList = linkList.stream()
 156                 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDEROUTPUT))
 157                 .collect(Collectors.toList());
 158         List<Link> xponderInLinkList = linkList.stream()
 159                 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDERINPUT))
 160                 .collect(Collectors.toList());
 161
 162         List<Node> xpdrNodeList = nodeList
 163                 .stream()
 164                 .filter(nt -> nt
 165                         .augmentation(org.opendaylight.yang.gen.v1
 166                                 .http.org.openroadm.common.network.rev181130.Node1.class)
 167                         .getNodeType().equals(OpenroadmNodeType.XPONDER)).collect(Collectors.toList());
 168         Map<String, List<String>> clientPortMap = new HashMap<>();
 169         for (Node node : xpdrNodeList) {
 170             String nodeId = node.getSupportingNode().get(0).getNodeRef().getValue();
 171             List<String> clientPortList = new ArrayList<>();
 172             for (TerminationPoint tp : node.augmentation(Node1.class).getTerminationPoint()) {
 173                 if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERCLIENT)
 174                         && checkTp(node.getNodeId().getValue(), nodeId, tp, xponderOutLinkList, xponderInLinkList)) {
 175                     clientPortList.add(tp.getTpId().getValue());
 176                 }
 177             }
 178             if (!clientPortList.isEmpty()) {
 179                 clientPortMap.put(nodeId, clientPortList);
 180             }
 181         }
 182         List<String> goodTpList = extractGoodTpList(clientPortMap);
 183         // tapi topology creation
 184         List<Name> names = new ArrayList<>();
 185         names.add(new NameBuilder().setValue(ETH_TOPO).setValueName("Topo Name").build());
 186         Uuid uuid = new Uuid(UUID.nameUUIDFromBytes(ETH_TOPO.getBytes(Charset.forName("UTF-8"))).toString());
 187         List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node>
 188             tapiNodeList = new ArrayList<>();
 189         tapiNodeList.add(createTapiNode(goodTpList));
 190         return new TopologyBuilder().setName(names).setUuid(uuid).setNode(tapiNodeList).build();
 191
 192     }
 193
 194     private List<String> extractGoodTpList(Map<String, List<String>> clientPortMap) {
 195         List<String> goodTpList = new ArrayList<>();
 196         for (Map.Entry<String, List<String>> entry : clientPortMap.entrySet()) {
 197             String key = entry.getKey();
 198             List<String> value = entry.getValue();
 199             for (String tpid : value) {
 200                 goodTpList.add(key + "--" + tpid);
 201             }
 202         }
 203         return goodTpList;
 204     }
 205
 206     private Topology createAbstractedOtnTopology() {
 207         // read otn-topology
 208         @NonNull
 209         FluentFuture<Optional<Network>> otnTopoOpt = dataBroker.newReadOnlyTransaction().read(
 210             LogicalDatastoreType.CONFIGURATION, InstanceIdentifiers.OTN_NETWORK_II);
 211         if (otnTopoOpt.isDone()) {
 212             Network otnTopo = null;
 213             try {
 214                 otnTopo = otnTopoOpt.get().get();
 215             } catch (InterruptedException | ExecutionException | NoSuchElementException e) {
 216                 LOG.error("Impossible to retreive otn-topology from mdsal",e);
 217                 return null;
 218             }
 219             List<Node> nodeList = otnTopo.getNode();
 220             List<Node> otnNodeList = nodeList.stream().filter(nt -> nt.augmentation(
 221                 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.Node1.class)
 222                 .getNodeType().equals(OpenroadmNodeType.SWITCH) || nt.augmentation(
 223                     org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.Node1.class)
 224                     .getNodeType().equals(OpenroadmNodeType.MUXPDR)).collect(Collectors.toList());
 225             List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node> tapiNodeList =
 226                 new ArrayList<>();
 227             List<org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Link> tapiLinkList =
 228                 new ArrayList<>();
 229             Uuid topoUuid = new Uuid(UUID.nameUUIDFromBytes(T0_MULTI_LAYER_TOPO.getBytes(Charset.forName("UTF-8")))
 230                 .toString());
 231             for (Node node : otnNodeList) {
 232                 ConvertORTopoObjectToTapiTopoObject tapiFactory =
 233                     new ConvertORTopoObjectToTapiTopoObject(node, null, topoUuid);
 234                 tapiFactory.convertNode();
 235                 tapiNodeList.addAll(tapiFactory.getTapiNodes());
 236                 tapiLinkList.addAll(tapiFactory.getTapiLinks());
 237             }
 238             return new TopologyBuilder()
 239                     .setName(Arrays.asList(new NameBuilder().setValue(T0_MULTI_LAYER_TOPO)
 240                             .setValueName("TAPI Topology Name").build()))
 241                     .setUuid(topoUuid)
 242                     .setNode(tapiNodeList)
 243                     .setLink(tapiLinkList).build();
 244         } else {
 245             return null;
 246         }
 247     }
 248
 249     @Override
 250     public ListenableFuture<RpcResult<GetNodeEdgePointDetailsOutput>> getNodeEdgePointDetails(
 251         GetNodeEdgePointDetailsInput input) {
 252         // TODO Auto-generated method stub
 253         return null;
 254     }
 255
 256     @Override
 257     public ListenableFuture<RpcResult<GetLinkDetailsOutput>> getLinkDetails(GetLinkDetailsInput input) {
 258         // TODO Auto-generated method stub
 259         return null;
 260     }
 261
 262     @Override
 263     public ListenableFuture<RpcResult<GetTopologyListOutput>> getTopologyList(GetTopologyListInput input) {
 264         // TODO Auto-generated method stub
 265         return null;
 266     }
 267
 268     private org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node createTapiNode(List<
 269         String> tpList) {
 270         List<Name> names = new ArrayList<>();
 271         Name name = new NameBuilder().setValueName("node name").setValue("TAPI Ethernet Node").build();
 272         names.add(name);
 273         List<LayerProtocolName> layerProtocols = new ArrayList<>();
 274         layerProtocols.add(LayerProtocolName.ETH);
 275         List<OwnedNodeEdgePoint> onepl = new ArrayList<>();
 276         for (int i = 0; i < tpList.size(); i++) {
 277             List<Name> onedNames = new ArrayList<>();
 278             onedNames.add(new NameBuilder().setValueName("OwnedNodeEdgePoint " + i).setValue(tpList.get(i)).build());
 279             OwnedNodeEdgePoint onep = new OwnedNodeEdgePointBuilder()
 280                 .setUuid(new Uuid(UUID.nameUUIDFromBytes(("OwnedNodeEdgePoint " + i).getBytes(Charset.forName("UTF-8")))
 281                     .toString()))
 282                 .setLayerProtocolName(LayerProtocolName.ETH).setMappedServiceInterfacePoint(createSIP(1))
 283                 .setLinkPortDirection(PortDirection.BIDIRECTIONAL).setLinkPortRole(PortRole.SYMMETRIC)
 284                 .setAdministrativeState(AdministrativeState.UNLOCKED).setOperationalState(OperationalState.ENABLED)
 285                 .setLifecycleState(LifecycleState.INSTALLED).setName(onedNames).setTerminationDirection(
 286                     TerminationDirection.BIDIRECTIONAL).setTerminationState(TerminationState.TERMINATEDBIDIRECTIONAL)
 287                 .build();
 288             onepl.add(onep);
 289         }
 290
 291         return new NodeBuilder()
 292                 .setUuid(new Uuid(UUID.nameUUIDFromBytes(name.getValue().getBytes(Charset.forName("UTF-8")))
 293                     .toString()))
 294                 .setName(names).setLayerProtocolName(layerProtocols)
 295                 .setAdministrativeState(AdministrativeState.UNLOCKED)
 296                 .setOperationalState(OperationalState.ENABLED)
 297                 .setLifecycleState(LifecycleState.INSTALLED)
 298                 .setOwnedNodeEdgePoint(onepl)
 299                 .build();
 300     }
 301
 302     private List<MappedServiceInterfacePoint> createSIP(int nb) {
 303         List<MappedServiceInterfacePoint> msipl = new ArrayList<>();
 304         for (int i = 0; i < nb; i++) {
 305             MappedServiceInterfacePoint msip = new MappedServiceInterfacePointBuilder().setServiceInterfacePointUuid(
 306                 new Uuid(UUID.randomUUID().toString())).build();
 307             msipl.add(msip);
 308         }
 309         return msipl;
 310     }
 311
 312     private boolean checkTp(String nodeIdTopo, String nodeIdPortMap, TerminationPoint tp, List<Link> xpdOut, List<
 313         Link> xpdIn) {
 314         @Nullable
 315         String networkLcp = tp.augmentation(
 316             org.opendaylight.yang.gen.v1.http.transportpce.topology.rev200129.TerminationPoint1.class)
 317             .getAssociatedConnectionMapPort();
 318         @NonNull
 319         KeyedInstanceIdentifier<Mapping, MappingKey> pmIID = InstanceIdentifier.create(
 320             org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200827.Network.class)
 321             .child(Nodes.class, new NodesKey(nodeIdPortMap)).child(Mapping.class, new MappingKey(networkLcp));
 322         @NonNull
 323         FluentFuture<Optional<Mapping>> mappingOpt = dataBroker.newReadOnlyTransaction().read(
 324             LogicalDatastoreType.CONFIGURATION, pmIID);
 325         Mapping mapping = null;
 326         if (mappingOpt.isDone()) {
 327             try {
 328                 mapping = mappingOpt.get().get();
 329             } catch (InterruptedException | ExecutionException e) {
 330                 LOG.error("Error getting mapping for {}", networkLcp,e);
 331                 return false;
 332             }
 333         } else {
 334             LOG.error("Impossible to get mapping of associated network port {} of tp {}", networkLcp, tp.getTpId()
 335                 .getValue());
 336             return false;
 337         }
 338         String networkPortDirection = mapping.getPortDirection();
 339         long count = 0;
 340         switch (networkPortDirection) {
 341             case "bidirectional":
 342                 count += xpdOut.stream().filter(lk -> lk.getSource().getSourceNode().getValue().equals(nodeIdTopo) && lk
 343                     .getSource().getSourceTp().equals(networkLcp)).count();
 344                 count += xpdIn.stream().filter(lk -> lk.getDestination().getDestNode().getValue().equals(nodeIdTopo)
 345                     && lk.getDestination().getDestTp().equals(networkLcp)).count();
 346                 return (count == 2);
 347             case "tx":
 348             case "rx":
 349                 @Nullable
 350                 String partnerLcp = mapping.getPartnerLcp();
 351                 if (mapping.getPortQual().equals("tx")) {
 352                     count += xpdOut.stream().filter(lk -> lk.getSource().getSourceNode().getValue().equals(nodeIdTopo)
 353                         && lk.getSource().getSourceTp().equals(networkLcp)).count();
 354                     count += xpdIn.stream().filter(lk -> lk.getDestination().getDestNode().getValue().equals(nodeIdTopo)
 355                         && lk.getDestination().getDestTp().equals(partnerLcp)).count();
 356                 }
 357                 if (mapping.getPortQual().equals("rx")) {
 358                     count += xpdIn.stream().filter(lk -> lk.getDestination().getDestNode().getValue().equals(nodeIdTopo)
 359                         && lk.getDestination().getDestTp().equals(networkLcp)).count();
 360                     count += xpdOut.stream().filter(lk -> lk.getSource().getSourceNode().getValue().equals(nodeIdTopo)
 361                         && lk.getSource().getSourceTp().equals(partnerLcp)).count();
 362                 }
 363                 return (count == 2);
 364             default:
 365                 LOG.error("Invalid port direction for {}", networkLcp);
 366                 return false;
 367         }
 368     }
 369
 370 }