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