Adapt PCE to compute a 400GE path
[transportpce.git] / pce / src / test / java / org / opendaylight / transportpce / pce / networkanalyzer / PceOpticalNodeTest.java
1 /*
2  * Copyright © 2020 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
9 package org.opendaylight.transportpce.pce.networkanalyzer;
10
11 import java.math.BigDecimal;
12 import java.util.Arrays;
13 import java.util.BitSet;
14 import java.util.HashMap;
15 import java.util.Map;
16 import org.junit.Assert;
17 import org.junit.Before;
18 import org.junit.Test;
19 import org.mockito.Mock;
20 import org.mockito.MockitoAnnotations;
21 import org.opendaylight.transportpce.common.NetworkUtils;
22 import org.opendaylight.transportpce.common.StringConstants;
23 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
24 import org.opendaylight.transportpce.common.fixedflex.GridUtils;
25 import org.opendaylight.transportpce.common.mapping.PortMapping;
26 import org.opendaylight.transportpce.test.AbstractTest;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1Builder;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.optical.channel.types.rev200529.FrequencyGHz;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.optical.channel.types.rev200529.FrequencyTHz;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.DegreeAttributes;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.DegreeAttributesBuilder;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.SrgAttributes;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.SrgAttributesBuilder;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.termination.point.CpAttributesBuilder;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.termination.point.CtpAttributesBuilder;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.termination.point.PpAttributesBuilder;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.termination.point.RxTtpAttributesBuilder;
41 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.termination.point.TxTtpAttributesBuilder;
42 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.termination.point.XpdrClientAttributesBuilder;
43 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.termination.point.XpdrNetworkAttributesBuilder;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.node.termination.point.XpdrPortAttributesBuilder;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmNodeType;
46 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmTpType;
47 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.available.freq.map.AvailFreqMaps;
48 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.available.freq.map.AvailFreqMapsBuilder;
49 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.available.freq.map.AvailFreqMapsKey;
50 import org.opendaylight.yang.gen.v1.http.org.openroadm.service.format.rev190531.ServiceFormat;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NetworkId;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.NodeBuilder;
55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.NodeKey;
56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.node.SupportingNode;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.node.SupportingNodeBuilder;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.node.SupportingNodeKey;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1Builder;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPointBuilder;
63 import org.opendaylight.yangtools.yang.common.Uint16;
64
65 public class PceOpticalNodeTest extends AbstractTest {
66
67     private PceOpticalNode pceOpticalNode;
68     private Node node;
69     private BitSet usedBitSet = new BitSet(8);
70     private BitSet availableBitSet = new BitSet(8);
71     private String deviceNodeId = "device node";
72     private String serviceType = "100GE";
73     @Mock
74     private PortMapping portMapping;
75
76     @Before
77     public void setUp() {
78         NodeBuilder node1Builder = getNodeBuilder(geSupportingNodes(), OpenroadmTpType.SRGTXRXPP);
79         node = node1Builder.setNodeId(new NodeId("test")).build();
80         availableBitSet.set(0,8);
81         MockitoAnnotations.initMocks(this);
82     }
83
84     @Test
85     public void isValidTest() {
86         OpenroadmNodeType nodeType = OpenroadmNodeType.ROADM;
87         pceOpticalNode = new PceOpticalNode(deviceNodeId, serviceType, portMapping, node, nodeType,
88             StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
89         Assert.assertTrue(pceOpticalNode.isValid());
90     }
91
92     @Test
93     public void testInitSrgTps() {
94
95         pceOpticalNode = new PceOpticalNode(deviceNodeId, serviceType, portMapping, node,
96                 OpenroadmNodeType.ROADM, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
97         pceOpticalNode.initSrgTps();
98         pceOpticalNode.initXndrTps(ServiceFormat.OMS);
99         pceOpticalNode.initFrequenciesBitSet();
100         Assert.assertFalse(pceOpticalNode.isValid());
101         Assert.assertNull(pceOpticalNode.getBitSetData());
102         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
103         Assert.assertNull(pceOpticalNode.getAvailableTribPorts());
104         Assert.assertNull(pceOpticalNode.getAvailableTribPorts());
105         Assert.assertNull(pceOpticalNode.getXpdrClient("test"));
106     }
107
108     @Test
109     public void testInitXndrTpSrgTypes() {
110         NodeBuilder node1Builder = getNodeBuilder(geSupportingNodes(), OpenroadmTpType.XPONDERNETWORK);
111         Node specificNode = node1Builder.build();
112         pceOpticalNode = new PceOpticalNode(deviceNodeId, serviceType, portMapping, specificNode,
113                 OpenroadmNodeType.SRG, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
114         pceOpticalNode.initFrequenciesBitSet();
115         Assert.assertTrue(pceOpticalNode.isValid());
116         Assert.assertEquals(availableBitSet, pceOpticalNode.getBitSetData().get(88,96));
117         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
118     }
119
120     @Test
121     public void testInitXndrTpDegTypes() {
122         pceOpticalNode = new PceOpticalNode(deviceNodeId, serviceType, portMapping, node,
123                 OpenroadmNodeType.DEGREE, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
124         pceOpticalNode.initFrequenciesBitSet();
125         Assert.assertTrue(pceOpticalNode.isValid());
126         Assert.assertEquals(usedBitSet,pceOpticalNode.getBitSetData().get(88,96));
127         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
128     }
129
130     @Test
131     public void testInitXndrTpXpondrTypes() {
132         pceOpticalNode = new PceOpticalNode(deviceNodeId, serviceType, portMapping, node,
133                 OpenroadmNodeType.XPONDER, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
134         pceOpticalNode.initFrequenciesBitSet();
135         Assert.assertTrue(pceOpticalNode.isValid());
136         Assert.assertEquals(availableBitSet, pceOpticalNode.getBitSetData().get(88,96));
137         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
138     }
139
140     @Test
141     public void testinitFrequenciesBitSet() {
142         pceOpticalNode = new PceOpticalNode(null, null, null, node,
143                 OpenroadmNodeType.ROADM, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
144         pceOpticalNode.initXndrTps(ServiceFormat.OMS);
145         pceOpticalNode.initFrequenciesBitSet();
146         Assert.assertFalse(pceOpticalNode.isValid());
147         Assert.assertNull(pceOpticalNode.getBitSetData());
148         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
149     }
150
151     @Test
152     public void testGetRdmSrgClient() {
153         pceOpticalNode = new PceOpticalNode(null, null, null, node,
154                 OpenroadmNodeType.ROADM, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
155         pceOpticalNode.initSrgTps();
156         Assert.assertNull(pceOpticalNode.getRdmSrgClient("7"));
157         Assert.assertFalse(pceOpticalNode.isValid());
158         Assert.assertNull(pceOpticalNode.getBitSetData());
159         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
160     }
161
162     @Test
163     public void testGetRdmSrgClientEmpty() {
164         NodeBuilder node1Builder = getNodeBuilderEmpty(geSupportingNodes(), OpenroadmTpType.SRGTXRXPP);
165         Node specificNode = node1Builder.setNodeId(new NodeId("test")).build();
166         pceOpticalNode = new PceOpticalNode(null, null, null, specificNode,
167                 OpenroadmNodeType.ROADM, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
168         pceOpticalNode.initSrgTps();
169         pceOpticalNode.initFrequenciesBitSet();
170         pceOpticalNode.initXndrTps(ServiceFormat.OMS);
171         Assert.assertNull(pceOpticalNode.getRdmSrgClient("7"));
172         Assert.assertFalse(pceOpticalNode.isValid());
173         Assert.assertNull(pceOpticalNode.getBitSetData());
174         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
175     }
176
177     @Test
178     public void testGetRdmSrgClientDeg() {
179         pceOpticalNode = new PceOpticalNode(null, null, null, node,
180                 OpenroadmNodeType.DEGREE, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
181         pceOpticalNode.initSrgTps();
182         Assert.assertNull(pceOpticalNode.getRdmSrgClient("7"));
183         Assert.assertFalse(pceOpticalNode.isValid());
184         Assert.assertNull(pceOpticalNode.getBitSetData());
185         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
186     }
187
188     @Test
189     public void testGetRdmSrgClientsrgtxcp() {
190         NodeBuilder node1Builder = getNodeBuilder(geSupportingNodes(), OpenroadmTpType.SRGTXCP);
191         Node specificNode = node1Builder.build();
192         pceOpticalNode = new PceOpticalNode(null, null, null, specificNode,
193                 OpenroadmNodeType.ROADM, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
194         pceOpticalNode.initSrgTps();
195         Assert.assertFalse(pceOpticalNode.isValid());
196         Assert.assertNull(pceOpticalNode.getBitSetData());
197         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
198         Assert.assertNull(pceOpticalNode.getRdmSrgClient("5"));
199     }
200
201     @Test
202     public void testGetRdmSrgClientDegreerxtpp() {
203         NodeBuilder node1Builder = getNodeBuilder(geSupportingNodes(), OpenroadmTpType.DEGREERXTTP);
204         node = node1Builder.build();
205         pceOpticalNode = new PceOpticalNode(null, null, null, node,
206                 OpenroadmNodeType.ROADM, StringConstants.OPENROADM_DEVICE_VERSION_2_2_1, GridConstant.SLOT_WIDTH_50);
207         pceOpticalNode.initSrgTps();
208         Assert.assertNull(pceOpticalNode.getRdmSrgClient("2"));
209         Assert.assertFalse(pceOpticalNode.isValid());
210         Assert.assertNull(pceOpticalNode.getBitSetData());
211         Assert.assertTrue(pceOpticalNode.checkTP("testTP"));
212     }
213
214     private Map<SupportingNodeKey,SupportingNode> geSupportingNodes() {
215         Map<SupportingNodeKey,SupportingNode> supportingNodes1 = new HashMap<>();
216         SupportingNode supportingNode1 = new SupportingNodeBuilder()
217                 .setNodeRef(new NodeId("node 1"))
218                 .setNetworkRef(new NetworkId(NetworkUtils.CLLI_NETWORK_ID))
219                 .build();
220         supportingNodes1
221                 .put(supportingNode1.key(),supportingNode1);
222
223         SupportingNode supportingNode2 = new SupportingNodeBuilder()
224                 .setNodeRef(new NodeId("node 2"))
225                 .setNetworkRef(new NetworkId(NetworkUtils.UNDERLAY_NETWORK_ID))
226                 .build();
227         supportingNodes1
228                 .put(supportingNode2.key(),supportingNode2);
229         return supportingNodes1;
230     }
231
232     private NodeBuilder getNodeBuilder(Map<SupportingNodeKey,SupportingNode> supportingNodes1,
233             OpenroadmTpType openroadmTpType) {
234
235         TerminationPoint1Builder tp1Bldr = getTerminationPoint1Builder(openroadmTpType);
236         TerminationPointBuilder xpdrTpBldr = getTerminationPointBuilder();
237         xpdrTpBldr.addAugmentation(tp1Bldr.build());
238         xpdrTpBldr.addAugmentation(createAnotherTerminationPoint().build());
239         org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.Node1 node1 = getNode1();
240         TerminationPoint xpdr = xpdrTpBldr.build();
241         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1 node1Rev180226 =
242                 new Node1Builder()
243                         .setTerminationPoint(Map.of(xpdr.key(),xpdr))
244                         .build();
245         Node1 node11 = new org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1Builder()
246                 .setAdministrativeState(AdminStates.InService).setOperationalState(State.InService).build();
247
248
249         return new NodeBuilder()
250                 .setNodeId(new NodeId("node_test"))
251                 .withKey(new NodeKey(new NodeId("node 1")))
252                 .addAugmentation(node1Rev180226)
253                 .addAugmentation(node1)
254                 .addAugmentation(node11)
255                 .setSupportingNode(supportingNodes1);
256     }
257
258     private NodeBuilder getNodeBuilderEmpty(Map<SupportingNodeKey,SupportingNode>  supportingNodes1,
259             OpenroadmTpType openroadmTpType) {
260
261         TerminationPoint1Builder tp1Bldr = getTerminationPoint1Builder(openroadmTpType);
262         TerminationPointBuilder xpdrTpBldr = getTerminationPointBuilder();
263         xpdrTpBldr.addAugmentation(tp1Bldr.build());
264         xpdrTpBldr.addAugmentation(createAnotherTerminationPoint().build());
265
266         org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.Node1 node1 = getNode1Empty();
267         TerminationPoint xpdr = xpdrTpBldr.build();
268         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1 node1Rev180226 =
269                 new Node1Builder()
270                         .setTerminationPoint(Map.of(xpdr.key(),xpdr))
271                         .build();
272         Node1 node11 = new org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1Builder()
273                 .setAdministrativeState(AdminStates.InService).setOperationalState(State.InService).build();
274
275
276         return new NodeBuilder()
277                 .setNodeId(new NodeId("node_test"))
278                 .withKey(new NodeKey(new NodeId("node 1")))
279                 .addAugmentation(node1Rev180226)
280                 .addAugmentation(node1)
281                 .addAugmentation(node11)
282                 .setSupportingNode(supportingNodes1);
283     }
284
285     private org.opendaylight
286             .yang.gen.v1.http.org.openroadm.network.topology.rev200529.Node1 getNode1() {
287         return new org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.Node1Builder()
288                 .setSrgAttributes(getSrgAttributes())
289                 .setDegreeAttributes(getDegAttributes())
290                 .build();
291     }
292
293     private org.opendaylight
294             .yang.gen.v1.http.org.openroadm.network.topology.rev200529.Node1 getNode1Empty() {
295         return new org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.Node1Builder()
296                 .setSrgAttributes(getEmptySrgAttributes())
297                 .setDegreeAttributes(getEmptyDegAttributes())
298                 .build();
299     }
300
301     private DegreeAttributes getDegAttributes() {
302         byte[] byteArray = new byte[GridConstant.NB_OCTECTS];
303         Arrays.fill(byteArray, (byte) GridConstant.USED_SLOT_VALUE);
304         byteArray[7] = (byte) GridConstant.AVAILABLE_SLOT_VALUE;
305         Map<AvailFreqMapsKey, AvailFreqMaps> waveMap = new HashMap<>();
306         AvailFreqMaps availFreqMaps = new AvailFreqMapsBuilder().setMapName(GridConstant.C_BAND)
307                 .setFreqMapGranularity(new FrequencyGHz(BigDecimal.valueOf(GridConstant.GRANULARITY)))
308                 .setStartEdgeFreq(new FrequencyTHz(BigDecimal.valueOf(GridConstant.START_EDGE_FREQUENCY)))
309                 .setEffectiveBits(Uint16.valueOf(GridConstant.EFFECTIVE_BITS))
310                 .setFreqMap(byteArray)
311                 .build();
312         waveMap.put(availFreqMaps.key(), availFreqMaps);
313         return new DegreeAttributesBuilder()
314                 .setAvailFreqMaps(waveMap)
315                 .build();
316     }
317
318     private SrgAttributes getSrgAttributes() {
319         return new SrgAttributesBuilder().setAvailFreqMaps(GridUtils.initFreqMaps4FixedGrid2Available()).build();
320     }
321
322     private DegreeAttributes getEmptyDegAttributes() {
323         return (new DegreeAttributesBuilder())
324                 .setAvailFreqMaps(Map.of())
325                 .build();
326     }
327
328     private SrgAttributes getEmptySrgAttributes() {
329         return new SrgAttributesBuilder().setAvailFreqMaps(Map.of()).build();
330     }
331
332     private TerminationPointBuilder getTerminationPointBuilder() {
333         return new TerminationPointBuilder().setTpId(new TpId("2"));
334     }
335
336     private TerminationPoint1Builder getTerminationPoint1Builder(OpenroadmTpType openroadmTpType) {
337
338         return new TerminationPoint1Builder().setTpType(openroadmTpType).setOperationalState(State.InService)
339                 .setAdministrativeState(AdminStates.InService);
340
341     }
342
343     private org.opendaylight.yang.gen
344             .v1.http.org.openroadm.network.topology.rev200529.TerminationPoint1Builder createAnotherTerminationPoint() {
345         return new org.opendaylight
346                 .yang.gen.v1.http.org.openroadm.network.topology.rev200529.TerminationPoint1Builder()
347                 .setCtpAttributes((new CtpAttributesBuilder()).build())
348                 .setCpAttributes((new CpAttributesBuilder()).build())
349                 .setTxTtpAttributes((new TxTtpAttributesBuilder()).setUsedWavelengths(Map.of()).build())
350                 .setRxTtpAttributes((new RxTtpAttributesBuilder()).setUsedWavelengths(Map.of()).build())
351                 .setPpAttributes((new PpAttributesBuilder()).setUsedWavelength(Map.of()).build())
352                 .setXpdrClientAttributes((new XpdrClientAttributesBuilder()).build())
353                 .setXpdrPortAttributes((new XpdrPortAttributesBuilder()).build())
354                 .setXpdrNetworkAttributes(new XpdrNetworkAttributesBuilder()
355                         .setTailEquipmentId("destNode" + "--" + "destTp").build());
356     }
357
358 }