Refactoring of Tapi Step3
[transportpce.git] / 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.rev231221.mapping.Mapping;
34 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev231221.mapping.MappingKey;
35 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev231221.network.Nodes;
36 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev231221.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     public static final String NOOPMODEDECLARED = "No operational mode declared in Topo for Tp {}, assumes by default ";
81
82     public TopologyUtils(NetworkTransactionService networkTransactionService, DataBroker dataBroker,
83                          TapiLink tapiLink) {
84         this.networkTransactionService = networkTransactionService;
85         this.dataBroker = dataBroker;
86         this.tapiSips = new HashMap<>();
87         this.tapiLink = tapiLink;
88     }
89
90     public Network readTopology(InstanceIdentifier<Network> networkIID) throws TapiTopologyException {
91         Network topology = null;
92         ListenableFuture<Optional<Network>> topologyFuture =
93                 this.networkTransactionService.read(LogicalDatastoreType.CONFIGURATION, networkIID);
94         try {
95             topology = topologyFuture.get().orElseThrow();
96         } catch (InterruptedException e) {
97             Thread.currentThread().interrupt();
98             throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
99                     .firstKeyOf(Network.class).getNetworkId().getValue(), e);
100         } catch (ExecutionException e) {
101             throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
102                     .firstKeyOf(Network.class).getNetworkId().getValue(), e);
103         } catch (NoSuchElementException e) {
104             return null;
105         }
106         return topology;
107     }
108
109     public List<String> readTopologyName(Uuid topoUuid) throws TapiTopologyException {
110         Topology topology = null;
111         InstanceIdentifier<Topology> topoIID = InstanceIdentifier.builder(
112                 Context.class).augmentation(org.opendaylight.yang.gen.v1.urn
113                 .onf.otcc.yang.tapi.topology.rev221121.Context1.class).child(TopologyContext.class)
114                 .child(Topology.class, new TopologyKey(topoUuid)).build();
115
116         ListenableFuture<Optional<Topology>> topologyFuture =
117                 this.networkTransactionService.read(LogicalDatastoreType.OPERATIONAL, topoIID);
118         try {
119             topology = topologyFuture.get().orElseThrow();
120         } catch (InterruptedException e) {
121             Thread.currentThread().interrupt();
122             throw new TapiTopologyException("Unable to get from mdsal topology: " + topoIID
123                     .firstKeyOf(Topology.class).getUuid().getValue(), e);
124         } catch (ExecutionException e) {
125             throw new TapiTopologyException("Unable to get from mdsal topology: " + topoIID
126                 .firstKeyOf(Topology.class).getUuid().getValue(), e);
127         } catch (NoSuchElementException e) {
128             return null;
129         }
130         List<String> nameList = new ArrayList<>();
131         for (Map.Entry<NameKey, Name> entry : topology.getName().entrySet()) {
132             nameList.add(entry.getValue().getValue());
133         }
134         LOG.debug("Topology nameList {} = ", nameList.toString());
135         return nameList;
136     }
137
138     public Topology createFullOtnTopology() throws TapiTopologyException {
139         // read openroadm-topology
140         Network openroadmTopo = readTopology(InstanceIdentifiers.OVERLAY_NETWORK_II);
141         Uuid topoUuid = new Uuid(UUID.nameUUIDFromBytes(TapiStringConstants.T0_FULL_MULTILAYER
142             .getBytes(Charset.forName("UTF-8"))).toString());
143         Name name = new NameBuilder()
144             .setValue(TapiStringConstants.T0_FULL_MULTILAYER)
145             .setValueName("TAPI Topology Name")
146             .build();
147         if (openroadmTopo != null) {
148             List<Link> linkList = new ArrayList<>();
149             if (openroadmTopo.augmentation(Network1.class) != null) {
150                 linkList.addAll(openroadmTopo.augmentation(Network1.class).getLink().values());
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             // read otn-topology
159             Network otnTopo = readTopology(InstanceIdentifiers.OTN_NETWORK_II);
160             Map<NodeId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
161                 .ietf.network.rev180226.networks.network.Node> otnNodeMap = otnTopo.nonnullNode()
162                 .values().stream().collect(Collectors.toMap(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
163                     .ietf.network.rev180226.networks.network.Node::getNodeId, node -> node));
164
165             Map<String, List<String>> networkPortMap = new HashMap<>();
166             Iterator<Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
167                 .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node>> itOtnNodeMap = otnNodeMap
168                 .entrySet().iterator();
169             while (itOtnNodeMap.hasNext()) {
170                 Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
171                     .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node> entry = itOtnNodeMap.next();
172                 String portMappingNodeId = entry.getValue().getSupportingNode().values().stream()
173                     .filter(sn -> sn.getNetworkRef().getValue().equals(NetworkUtils.UNDERLAY_NETWORK_ID))
174                     .findFirst()
175                     .orElseThrow().getNodeRef().getValue();
176                 List<String> networkPortList = new ArrayList<>();
177                 for (TerminationPoint tp: entry.getValue().augmentation(Node1.class).getTerminationPoint().values()) {
178                     // TODO -> why are we checking with respect to XPDR links?? Is there a real purpose on doing that?
179                     if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERNETWORK)
180                         && checkTp(entry.getKey().getValue(), portMappingNodeId, tp, xponderOutLinkList,
181                         xponderInLinkList)) {
182                         networkPortList.add(tp.getTpId().getValue());
183                     }
184                 }
185                 if (!networkPortList.isEmpty()) {
186                     networkPortMap.put(entry.getKey().getValue(), networkPortList);
187                 }
188             }
189             Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
190                 tapiNodeList = new HashMap<>();
191             Map<LinkKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link>
192                 tapiLinkList = new HashMap<>();
193             ConvertORTopoToTapiFullTopo tapiFullFactory = new ConvertORTopoToTapiFullTopo(topoUuid, this.tapiLink);
194             ConvertORToTapiTopology tapiFactory = new ConvertORToTapiTopology(topoUuid);
195             Iterator<Map.Entry<String, List<String>>> it = networkPortMap.entrySet().iterator();
196             while (it.hasNext()) {
197                 String nodeId = it.next().getKey();
198                 tapiFactory.convertNode(otnNodeMap.get(new NodeId(nodeId)), networkPortMap.get(nodeId));
199                 this.tapiSips.putAll(tapiFactory.getTapiSips());
200                 tapiFullFactory.setTapiNodes(tapiFactory.getTapiNodes());
201                 tapiFullFactory.setTapiSips(tapiFactory.getTapiSips());
202                 tapiNodeList.putAll(tapiFactory.getTapiNodes());
203                 tapiLinkList.putAll(tapiFullFactory.getTapiLinks());
204             }
205             // roadm infrastructure not abstracted
206             // read openroadm-network
207             Network openroadmNet = readTopology(InstanceIdentifiers.UNDERLAY_NETWORK_II);
208             if (openroadmNet != null && openroadmNet.nonnullNode().values().stream()
209                 .filter(nt -> nt
210                     .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.Node1.class)
211                     .getNodeType()
212                     .equals(OpenroadmNodeType.ROADM))
213                 .count() > 0) {
214                 // map roadm nodes
215                 for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network
216                         .Node roadm:openroadmNet.nonnullNode().values().stream()
217                     .filter(nt -> nt
218                         .augmentation(
219                             org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.Node1.class)
220                         .getNodeType()
221                         .equals(OpenroadmNodeType.ROADM))
222                     .collect(Collectors.toList())) {
223                     tapiFullFactory.convertRoadmNode(roadm, openroadmTopo);
224                     this.tapiSips.putAll(tapiFullFactory.getTapiSips());
225                     tapiNodeList.putAll(tapiFullFactory.getTapiNodes());
226                     tapiLinkList.putAll(tapiFullFactory.getTapiLinks());
227                 }
228             } else {
229                 LOG.warn("No roadm nodes exist in the network");
230             }
231             // map roadm to roadm link
232             List<Link> rdmTordmLinkList = linkList.stream()
233                 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.ROADMTOROADM))
234                 .collect(Collectors.toList());
235             tapiFullFactory.convertRdmToRdmLinks(rdmTordmLinkList);
236             tapiLinkList.putAll(tapiFullFactory.getTapiLinks());
237             // map xpdr_input to roadm and xpdr_output to roadm links.
238             xponderInLinkList.addAll(xponderOutLinkList);
239             tapiFullFactory.convertXpdrToRdmLinks(xponderInLinkList);
240             tapiLinkList.putAll(tapiFullFactory.getTapiLinks());
241
242             // Retrieve created sips map in TapiFactory when mapping all the nodes
243             this.tapiSips.putAll(tapiFullFactory.getTapiSips());
244             var topo = new TopologyBuilder()
245                 .setName(Map.of(name.key(), name))
246                 .setUuid(topoUuid)
247                 .setNode(tapiNodeList)
248                 .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
249                     LayerProtocolName.DSR))
250                 .setLink(tapiLinkList).build();
251             LOG.error("TOPOUTIL, Initial FullTopology Builder.build = {}", topo.toString());
252             return new TopologyBuilder()
253                 .setName(Map.of(name.key(), name))
254                 .setUuid(topoUuid)
255                 .setNode(tapiNodeList)
256                 .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
257                     LayerProtocolName.DSR))
258                 .setLink(tapiLinkList).build();
259         }
260         return new TopologyBuilder()
261             .setName(Map.of(name.key(), name))
262             .setUuid(topoUuid)
263             .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
264                 LayerProtocolName.DSR))
265             .build();
266     }
267
268     public boolean checkTp(String nodeIdTopo, String nodeIdPortMap, TerminationPoint tp, List<Link> xpdOut,
269                            List<Link> xpdIn) {
270         LOG.info("Inside Checktp for node {}-{}", nodeIdTopo, nodeIdPortMap);
271         String networkLcp;
272         if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERCLIENT)) {
273             networkLcp = tp.augmentation(
274                     org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.TerminationPoint1.class)
275                 .getAssociatedConnectionMapTp().iterator().next().getValue();
276         } else {
277             networkLcp = tp.getTpId().getValue();
278         }
279         LOG.info("Network LCP associated = {}", networkLcp);
280         @NonNull
281         KeyedInstanceIdentifier<Mapping, MappingKey> pmIID = InstanceIdentifier.create(
282                 org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev231221.Network.class)
283                 .child(Nodes.class, new NodesKey(nodeIdPortMap)).child(Mapping.class, new MappingKey(networkLcp));
284         @NonNull
285         FluentFuture<Optional<Mapping>> mappingOpt = this.dataBroker.newReadOnlyTransaction().read(
286                 LogicalDatastoreType.CONFIGURATION, pmIID);
287         Mapping mapping = null;
288         if (mappingOpt.isDone()) {
289             try {
290                 mapping = mappingOpt.get().orElseThrow();
291             } catch (InterruptedException | ExecutionException e) {
292                 LOG.error("Error getting mapping for {}", networkLcp,e);
293                 return false;
294             }
295         } else {
296             LOG.error("Impossible to get mapping of associated network port {} of tp {}", networkLcp, tp.getTpId()
297                     .getValue());
298             return false;
299         }
300         LOG.info("Mapping found = {}", mapping);
301         String networkPortDirection = mapping.getPortDirection();
302         switch (networkPortDirection) {
303             // TODO -> remove the part of counting only if the Network LCP is part of a Link.
304             //  We want to have all OTN nodes in the TAPI topology
305             case "bidirectional":
306                 return true;
307             case "tx":
308             case "rx":
309                 @Nullable
310                 String partnerLcp = mapping.getPartnerLcp();
311                 LOG.info("PartnerLCP = {}", partnerLcp);
312                 return true;
313             default:
314                 LOG.error("Invalid port direction for {}", networkLcp);
315                 return false;
316         }
317     }
318
319     public org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.get.topology.details.output.Topology
320             transformTopology(Topology topology) {
321         org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121
322             .get.topology.details.output.TopologyBuilder topologyBuilder =
323                 new org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121
324             .get.topology.details.output.TopologyBuilder()
325                 .setUuid(topology.getUuid())
326                 .setName(topology.getName())
327                 .setLayerProtocolName(topology.getLayerProtocolName())
328                 .setLink(topology.getLink());
329         if (topology.nonnullNode().isEmpty()) {
330             return topologyBuilder.build();
331         }
332         Map<NodeKey, Node> mapNode = new HashMap<>();
333         for (Node node: topology.nonnullNode().values()) {
334             Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepMap = new HashMap<>();
335             for (OwnedNodeEdgePoint onep: node.nonnullOwnedNodeEdgePoint().values()) {
336 //                    OwnedNodeEdgePoint1 onep1 = onep.augmentation(OwnedNodeEdgePoint1.class);
337 //                    if (onep1 == null) {
338 //                        onepMap.put(onep.key(), onep);
339 //                        continue;
340 //                    }
341                 OwnedNodeEdgePoint newOnep = new OwnedNodeEdgePointBuilder()
342                         .setUuid(onep.getUuid())
343                         .setLayerProtocolName(onep.getLayerProtocolName())
344                         .setName(onep.getName())
345                         .setSupportedCepLayerProtocolQualifierInstances(onep
346                             .getSupportedCepLayerProtocolQualifierInstances())
347                         .setAdministrativeState(onep.getAdministrativeState())
348                         .setOperationalState(onep.getOperationalState())
349                         .setLifecycleState(onep.getLifecycleState())
350 //                            .setTerminationDirection(onep.getTerminationDirection())
351 //                            .setTerminationState(onep.getTerminationState())
352                         .setDirection(onep.getDirection())
353                         .setSupportedPayloadStructure(onep.getSupportedPayloadStructure())
354                         .setAvailablePayloadStructure(onep.getAvailablePayloadStructure())
355                         .setLinkPortRole(onep.getLinkPortRole())
356                         .setMappedServiceInterfacePoint(onep.nonnullMappedServiceInterfacePoint())
357                         .build();
358                 onepMap.put(newOnep.key(), newOnep);
359             }
360             Node newNode = new NodeBuilder()
361                     .setUuid(node.getUuid())
362                     .setName(node.getName())
363                     .setOperationalState(node.getOperationalState())
364                     .setAdministrativeState(node.getAdministrativeState())
365                     .setLifecycleState(node.getLifecycleState())
366                     .setLayerProtocolName(node.getLayerProtocolName())
367                     .setNodeRuleGroup(node.getNodeRuleGroup())
368                     .setInterRuleGroup(node.getInterRuleGroup())
369                     .setOwnedNodeEdgePoint(onepMap)
370                     .build();
371             mapNode.put(newNode.key(), newNode);
372         }
373         topologyBuilder.setNode(mapNode);
374         return topologyBuilder.build();
375     }
376
377     public Map<ServiceInterfacePointKey, ServiceInterfacePoint> getSipMap() {
378         return tapiSips;
379     }
380
381 }