Refactor SupportedIfCapability usage
[transportpce.git] / pce / src / test / java / org / opendaylight / transportpce / pce / utils / TransactionUtils.java
1 /*
2  * Copyright © 2020 Orange Systems, 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
10 package org.opendaylight.transportpce.pce.utils;
11
12 import java.math.BigDecimal;
13 import java.util.HashMap;
14 import java.util.Map;
15 import java.util.Optional;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.opendaylight.mdsal.binding.api.DataBroker;
18 import org.opendaylight.mdsal.binding.api.WriteTransaction;
19 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
20 import org.opendaylight.transportpce.common.fixedflex.GridUtils;
21 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.Mapping;
22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.MappingBuilder;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.link.types.rev191129.FiberPmd;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.link.types.rev191129.RatioDB;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Node1Builder;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.Interface;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified.link.attributes.AmplifiedLink;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified.link.attributes.AmplifiedLinkKey;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified.link.attributes.amplified.link.SectionElementBuilder;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.span.attributes.LinkConcatenation1.FiberType;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.span.attributes.LinkConcatenation1Builder;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.Link1Builder;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.link.OMSAttributesBuilder;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.link.oms.attributes.AmplifiedLinkBuilder;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.link.oms.attributes.SpanBuilder;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.node.DegreeAttributes;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.node.DegreeAttributesBuilder;
41 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.node.SrgAttributes;
42 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.node.SrgAttributesBuilder;
43 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.OpenroadmLinkType;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.OpenroadmNodeType;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.link.concatenation.LinkConcatenation;
46 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.link.concatenation.LinkConcatenationBuilder;
47 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.link.concatenation.LinkConcatenationKey;
48 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.CurrentPmList;
49 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.CurrentPmListBuilder;
50 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.group.CurrentPm;
51 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.group.CurrentPmBuilder;
52 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.list.CurrentPmEntry;
53 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.list.CurrentPmEntryBuilder;
54 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.val.group.Measurement;
55 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.val.group.MeasurementBuilder;
56 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.val.group.MeasurementKey;
57 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev171215.PmDataType;
58 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev171215.Validity;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NetworkId;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.NetworkBuilder;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.NodeBuilder;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.NodeKey;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.node.SupportingNode;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.node.SupportingNodeBuilder;
67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.node.SupportingNodeKey;
68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1Builder;
71 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
72 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
73 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.LinkBuilder;
74 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.link.DestinationBuilder;
75 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.link.SourceBuilder;
76 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
77 import org.opendaylight.yangtools.yang.binding.Augmentation;
78 import org.opendaylight.yangtools.yang.binding.DataObject;
79 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
80 import org.opendaylight.yangtools.yang.common.Uint16;
81 import org.opendaylight.yangtools.yang.common.Uint32;
82
83 public final class TransactionUtils {
84
85     private TransactionUtils() {
86     }
87
88     @SuppressWarnings({"unchecked","rawtypes"})
89     // FIXME check if the InstanceIdentifier raw type can be avoided
90     // Raw types use are discouraged since they lack type safety.
91     // Resulting Problems are observed at run time and not at compile time
92     public static void writeTransaction(DataBroker dataBroker, InstanceIdentifier instanceIdentifier,
93                                         DataObject object) {
94         @NonNull
95         WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
96         transaction.put(LogicalDatastoreType.CONFIGURATION, instanceIdentifier, object);
97         transaction.commit();
98     }
99
100     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks
101             .Network getNetworkForSpanLoss() {
102
103         Map<LinkConcatenationKey,LinkConcatenation> linkConcentationValues = new HashMap<>();
104         LinkConcatenation linkConcatenation = new LinkConcatenationBuilder()
105             .addAugmentation(new LinkConcatenation1Builder()
106                 .setFiberType(FiberType.Truewave)
107                 .setPmd(new FiberPmd(BigDecimal.ONE))
108                 .build())
109             .setSRLGId(Uint32.valueOf(1))
110             .setSRLGLength(BigDecimal.valueOf(1))
111             .build();
112         LinkConcatenation linkConcatenation2 = new LinkConcatenationBuilder()
113             .addAugmentation(new LinkConcatenation1Builder()
114                 .setFiberType(FiberType.Truewave)
115                 .setPmd(new FiberPmd(BigDecimal.ONE))
116                 .build())
117             .setSRLGId(Uint32.valueOf(1))
118             .setSRLGLength(BigDecimal.valueOf(1))
119             .build();
120         linkConcentationValues.put(linkConcatenation.key(),linkConcatenation);
121         linkConcentationValues.put(linkConcatenation2.key(),linkConcatenation2);
122         // create 2 openroadm-topology degree nodes, end points of the link to be
123         // measured
124         SupportingNode supportingNodeA = new SupportingNodeBuilder().setNetworkRef(new NetworkId("openroadm-network"))
125                 .setNodeRef(new NodeId("ROADM-A1")).build();
126         Node ietfNodeA = new NodeBuilder().setNodeId(new NodeId("ROADM-A1-DEG2"))
127                 .setSupportingNode(Map.of(supportingNodeA.key(),supportingNodeA))
128                 .addAugmentation(getNode1AugImpl()).build();
129         Map<SupportingNodeKey,SupportingNode> supportingNodeListC = new HashMap<>();
130         SupportingNode supportingNode = new SupportingNodeBuilder().setNetworkRef(new NetworkId("openroadm-network"))
131                 .setNodeRef(new NodeId("ROADM-C1")).build();
132         supportingNodeListC.put(supportingNode.key(),supportingNode);
133         SupportingNode supportingNode2 = new SupportingNodeBuilder().setNetworkRef(new NetworkId("clli-network"))
134                 .setNodeRef(new NodeId("ROADM-C2")).build();
135         supportingNodeListC.put(supportingNode2.key(),supportingNode2);
136
137         Node ietfNodeC = new NodeBuilder().setNodeId(new NodeId("ROADM-C1-DEG1")).setSupportingNode(supportingNodeListC)
138                 .addAugmentation(getNode1AugImpl())
139                 .addAugmentation(getNode1())
140                 .build();
141         Map<NodeKey,Node> ietfNodeList = new HashMap<>();
142         ietfNodeList.put(ietfNodeA.key(),ietfNodeA);
143         ietfNodeList.put(ietfNodeC.key(),ietfNodeC);
144
145         Map<AmplifiedLinkKey,AmplifiedLink>
146                 amplifiedLinkValues = new HashMap<>();
147         org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified.link.attributes.AmplifiedLink al =
148                 new org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified.link.attributes
149                         .AmplifiedLinkBuilder().setSectionElement(new SectionElementBuilder()
150                         .setSectionElement(new org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210
151                                 .amplified.link.attributes.amplified.link.section.element.section.element
152                                 .SpanBuilder()
153                                 .setSpan(
154                                         new org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified
155                                                 .link.attributes.amplified.link.section.element.section
156                                                 .element.span.SpanBuilder()
157                                                 .setAdministrativeState(AdminStates.InService)
158                                                 .setAutoSpanloss(true)
159                                                 .setEngineeredSpanloss(new RatioDB(BigDecimal.ONE))
160                                                 .setLinkConcatenation(linkConcentationValues)
161                                                 .setSpanlossBase(new RatioDB(BigDecimal.ONE))
162                                                 .setSpanlossCurrent(new RatioDB(BigDecimal.ONE))
163                                                 .build())
164                                 .build())
165                         .build())
166                         .setSectionEltNumber(Uint16.valueOf(1)).build();
167         org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified.link.attributes.AmplifiedLink al2 =
168                 new org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified.link.attributes
169                         .AmplifiedLinkBuilder().setSectionElement(new SectionElementBuilder()
170                         .setSectionElement(
171                                 new org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.amplified.link
172                                         .attributes.amplified.link.section.element.section.element.SpanBuilder()
173                                         .setSpan(
174                                                 new org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210
175                                                         .amplified.link
176                                                         .attributes.amplified.link.section.element.section.element.span
177                                                         .SpanBuilder()
178                                                         .setAdministrativeState(AdminStates.InService)
179                                                         .setAutoSpanloss(true)
180                                                         .setEngineeredSpanloss(new RatioDB(BigDecimal.ONE))
181                                                         .setLinkConcatenation(linkConcentationValues)
182                                                         .setSpanlossBase(new RatioDB(BigDecimal.ONE))
183                                                         .setSpanlossCurrent(new RatioDB(BigDecimal.ONE))
184                                                         .build())
185                                         .build())
186                         .build())
187                         .setSectionEltNumber(Uint16.valueOf(1)).build();
188         amplifiedLinkValues.put(al.key(),al);
189         amplifiedLinkValues.put(al2.key(),al2);
190         Augmentation<Link> aug11 = new Link1Builder()
191                 .setAmplified(true)
192                 .setOMSAttributes(new OMSAttributesBuilder()
193                         .setAmplifiedLink(new AmplifiedLinkBuilder().setAmplifiedLink(amplifiedLinkValues).build())
194                         .setSpan(new SpanBuilder().build())
195                         .build())
196                 .build();
197         org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Link1 aug12 =
198                 new org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Link1Builder()
199                         .setOppositeLink(new LinkId("link 1"))
200                         .setLinkType(OpenroadmLinkType.ROADMTOROADM).build();
201         Augmentation<Link> aug21 = new Link1Builder()
202                 .setAmplified(true)
203                 .setOMSAttributes(new OMSAttributesBuilder()
204                         .setAmplifiedLink(new AmplifiedLinkBuilder().setAmplifiedLink(amplifiedLinkValues).build())
205                         .setSpan(new SpanBuilder().build())
206                         .build())
207                 .build();
208         org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Link1 aug22 =
209                 new org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Link1Builder()
210                         .setLinkType(OpenroadmLinkType.ROADMTOROADM).build();
211         // create the roadm-to-roadm link to be measured
212         Link roadm2roadmLink = new LinkBuilder().setLinkId(new LinkId("ROADM-A1-to-ROADM-C1"))
213                 .setSource(new SourceBuilder().setSourceNode(ietfNodeA.getNodeId())
214                         .setSourceTp(new TpId("DEG2-TTP-TXRX")).build())
215                 .setDestination(new DestinationBuilder().setDestNode(ietfNodeC.getNodeId())
216                         .setDestTp(new TpId("DEG1-TTP-TXRX")).build())
217                 .addAugmentation(aug11)
218                 .addAugmentation(aug12)
219                 .addAugmentation(aug21)
220                 .addAugmentation(aug22)
221                 .build();
222         // create the ietf network
223         Network1 openroadmAugmToIetfNetwork = new Network1Builder()
224                 .setLink(Map.of(roadm2roadmLink.key(),roadm2roadmLink)).build();
225         // openroadm Topology builder
226         NetworkBuilder ietfNetworkBldr = new NetworkBuilder()
227                 .setNetworkId(new NetworkId("openroadm-topology"))
228                 .setNode(ietfNodeList)
229                 .addAugmentation(openroadmAugmToIetfNetwork);
230
231         return ietfNetworkBldr.build();
232     }
233
234     private static Augmentation<Node> getNode1AugImpl() {
235         return  new Node1Builder().setNodeType(OpenroadmNodeType.DEGREE).build();
236     }
237
238     public static Mapping getMapping1() {
239         return new MappingBuilder().setLogicalConnectionPoint("DEG2-TTP-TXRX").setSupportingOts("OTS-DEG2-TTP-TXRX")
240                 .build();
241     }
242
243     public static Mapping getMapping2() {
244         return new MappingBuilder().setLogicalConnectionPoint("DEG1-TTP-TXRX").setSupportingOts("OTS-DEG1-TTP-TXRX")
245                 .build();
246     }
247
248     public static Optional<CurrentPmList> getCurrentPmListA() {
249         Measurement measurementA = new MeasurementBuilder()
250                 .setGranularity(org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev171215.PmGranularity._15min)
251                 .setPmParameterValue(new PmDataType(new BigDecimal("-3.5")))
252                 .setValidity(Validity.Complete)
253                 .build();
254         CurrentPm cpA = new CurrentPmBuilder()
255                 .setType(org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev171215.PmNamesEnum
256                         .OpticalPowerOutput)
257                 .setMeasurement(Map.of(measurementA.key(),measurementA))
258                 .build();
259         InstanceIdentifier<Interface> interfaceIIDA = InstanceIdentifier.create(OrgOpenroadmDevice.class)
260                 .child(Interface.class, new InterfaceKey("OTS-DEG2-TTP-TXRX"));
261         CurrentPmEntry currentPmEntryA = new CurrentPmEntryBuilder()
262                 .setCurrentPm(Map.of(cpA.key(),cpA))
263                 .setPmResourceInstance(interfaceIIDA)
264                 .setPmResourceType(
265                         org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum
266                                 .Interface)
267                 .setPmResourceTypeExtension("")
268                 .setRetrievalTime(new DateAndTime("2018-06-07T13:22:58+00:00"))
269                 .build();
270         return Optional.of(new CurrentPmListBuilder()
271                 .setCurrentPmEntry(Map.of(currentPmEntryA.key(),currentPmEntryA)).build());
272     }
273
274     public static Optional<CurrentPmList> getCurrentPmListC() {
275         Measurement measurementC = new MeasurementBuilder()
276                 .setGranularity(org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev171215.PmGranularity._15min)
277                 .setPmParameterValue(new PmDataType(new BigDecimal("-18.1")))
278                 .setValidity(Validity.Complete)
279                 .build();
280         Map<MeasurementKey,Measurement> measurementListC = new HashMap<>();
281         measurementListC.put(measurementC.key(),measurementC);
282         CurrentPm cpC = new CurrentPmBuilder()
283                 .setType(org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev171215.PmNamesEnum
284                         .OpticalPowerInput)
285                 .setMeasurement(measurementListC)
286                 .build();
287         InstanceIdentifier<Interface> interfaceIIDC = InstanceIdentifier.create(OrgOpenroadmDevice.class)
288                 .child(Interface.class, new InterfaceKey("OTS-DEG1-TTP-TXRX"));
289         CurrentPmEntry currentPmEntryC = new CurrentPmEntryBuilder()
290                 .setCurrentPm(Map.of(cpC.key(),cpC))
291                 .setPmResourceInstance(interfaceIIDC)
292                 .setPmResourceType(
293                         org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum
294                                 .Interface)
295                 .setPmResourceTypeExtension("")
296                 .setRetrievalTime(new DateAndTime("2018-06-07T13:22:58+00:00"))
297                 .build();
298         return Optional.of(new CurrentPmListBuilder()
299                 .setCurrentPmEntry(Map.of(currentPmEntryC.key(),currentPmEntryC)).build());
300     }
301
302     private static org.opendaylight
303             .yang.gen.v1.http.org.openroadm.network.topology.rev211210.Node1 getNode1() {
304         return new org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.Node1Builder()
305                 .setSrgAttributes(getSrgAttributes())
306                 .setDegreeAttributes(getDegAttributes())
307                 .build();
308     }
309
310     private static DegreeAttributes getDegAttributes() {
311         return new DegreeAttributesBuilder()
312                 .setAvailFreqMaps(GridUtils.initFreqMaps4FixedGrid2Available())
313                 .build();
314     }
315
316     private static  SrgAttributes getSrgAttributes() {
317         return new SrgAttributesBuilder().setAvailFreqMaps(GridUtils.initFreqMaps4FixedGrid2Available()).build();
318     }
319
320
321 }