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