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