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