olm/src/test/java/org/opendaylight/transportpce/olm/util/OlmTransactionUtils.java

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