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