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