common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfacesImpl710.java

   1 /*
   2  * Copyright © 2020 AT&T 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.common.openroadminterfaces;
  10
  11 import com.google.common.util.concurrent.FluentFuture;
  12 import java.util.Optional;
  13 import java.util.concurrent.ExecutionException;
  14 import java.util.concurrent.Future;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.mdsal.common.api.CommitInfo;
  17 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  18 import org.opendaylight.transportpce.common.StringConstants;
  19 import org.opendaylight.transportpce.common.Timeouts;
  20 import org.opendaylight.transportpce.common.device.DeviceTransaction;
  21 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  22 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.circuit.pack.Ports;
  23 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.circuit.pack.PortsKey;
  24 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.circuit.packs.CircuitPacks;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.circuit.packs.CircuitPacksBuilder;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.circuit.packs.CircuitPacksKey;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.interfaces.grp.Interface;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.interfaces.grp.InterfaceBuilder;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.interfaces.grp.InterfaceKey;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.org.openroadm.device.container.OrgOpenroadmDevice;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.port.Interfaces;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.States;
  34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 public class OpenRoadmInterfacesImpl710 {
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterfacesImpl710.class);
  42
  43     private final DeviceTransactionManager deviceTransactionManager;
  44
  45     public OpenRoadmInterfacesImpl710(DeviceTransactionManager deviceTransactionManager) {
  46         this.deviceTransactionManager = deviceTransactionManager;
  47     }
  48
  49     public void postInterface(String nodeId, InterfaceBuilder ifBuilder) throws OpenRoadmInterfaceException {
  50         Future<Optional<DeviceTransaction>> deviceTxFuture = deviceTransactionManager.getDeviceTransaction(nodeId);
  51         DeviceTransaction deviceTx;
  52         try {
  53             Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
  54             if (deviceTxOpt.isPresent()) {
  55                 deviceTx = deviceTxOpt.get();
  56             } else {
  57                 throw new OpenRoadmInterfaceException(String.format("Device transaction was not found for node %s!",
  58                     nodeId));
  59             }
  60         } catch (InterruptedException | ExecutionException e) {
  61             throw new OpenRoadmInterfaceException(String.format("Failed to obtain device transaction for node %s!",
  62                 nodeId), e);
  63         }
  64
  65         InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(
  66             Interface.class, new InterfaceKey(ifBuilder.getName()));
  67         LOG.info("POST INTERF for {} : InterfaceBuilder : name = {} \t type = {}", nodeId, ifBuilder.getName(),
  68             ifBuilder.getType().toString());
  69         deviceTx.merge(LogicalDatastoreType.CONFIGURATION, interfacesIID, ifBuilder.build());
  70         FluentFuture<? extends @NonNull CommitInfo> txSubmitFuture =
  71             deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
  72         // TODO: instead of using this infinite loop coupled with this timeout,
  73         // it would be better to use a notification mechanism from the device to be advertised
  74         // that the new created interface is present in the device circuit-pack/port
  75         final Thread current = Thread.currentThread();
  76         Thread timer = new Thread() {
  77             public void run() {
  78                 try {
  79                     Thread.sleep(3000);
  80                     current.interrupt();
  81                 } catch (InterruptedException e) {
  82                     LOG.error("Timeout before the new created interface appears on the deivce circuit-pack port", e);
  83                 }
  84             }
  85         };
  86         try {
  87             txSubmitFuture.get();
  88             LOG.info("Successfully posted interface {} on node {}", ifBuilder.getName(), nodeId);
  89             boolean devicePortIsUptodated = false;
  90             while (!devicePortIsUptodated) {
  91                 devicePortIsUptodated = checkIfDevicePortIsUpdatedWithInterface(nodeId, ifBuilder);
  92             }
  93             LOG.info("{} - {} - interface {} updated on port {}", nodeId, ifBuilder.getSupportingCircuitPackName(),
  94                 ifBuilder.getName(), ifBuilder.getSupportingPort());
  95             timer.interrupt();
  96         } catch (InterruptedException | ExecutionException e) {
  97             throw new OpenRoadmInterfaceException(String.format("Failed to post interface %s on node %s!", ifBuilder
  98                 .getName(), nodeId), e);
  99         }
 100     }
 101
 102
 103     public Optional<Interface> getInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException {
 104         InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 105             .child(Interface.class, new InterfaceKey(interfaceName));
 106         return deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.CONFIGURATION,
 107             interfacesIID, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 108     }
 109
 110
 111     public synchronized void deleteInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException {
 112         LOG.info("deleting interface {} on device71 {}", interfaceName, nodeId);
 113         Optional<Interface> intf2DeleteOpt;
 114         try {
 115             intf2DeleteOpt = getInterface(nodeId, interfaceName);
 116         } catch (OpenRoadmInterfaceException e) {
 117             throw new OpenRoadmInterfaceException(String.format("Failed to check if interface %s exists on node %s!",
 118                 interfaceName, nodeId), e);
 119         }
 120         if (intf2DeleteOpt.isPresent()) {
 121             Interface intf2Delete = intf2DeleteOpt.get();
 122             // set the name and set the type. Having these two lines will post the interface with just
 123             // name, type and admin-state, without all the default values such as maint-testsignal
 124             //  delete the interfaces successfully
 125             // just build a new Interface builder without the arguments for inter2Delete
 126             InterfaceBuilder ifBuilder = new InterfaceBuilder()
 127                 .setAdministrativeState(AdminStates.OutOfService)
 128                 // Though these could be redundant, but 'when' statements are causing problem,
 129                 // when deleting the interfaces trying to be deleted
 130                 .setName(intf2Delete.getName())
 131                 .setType(intf2Delete.getType())
 132                 // CP name and the ports are needed, since the post interface is validated
 133                 .setSupportingCircuitPackName(intf2Delete.getSupportingCircuitPackName())
 134                 .setSupportingPort(intf2Delete.getSupportingPort());
 135
 136             // post interface with updated admin state
 137             try {
 138                 postInterface(nodeId, ifBuilder);
 139             } catch (OpenRoadmInterfaceException ex) {
 140                 throw new OpenRoadmInterfaceException(String.format("Failed to set state of interface %s to %s while"
 141                     + " deleting it!", interfaceName, AdminStates.OutOfService), ex);
 142             }
 143
 144             InstanceIdentifier<Interface> interfacesIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(
 145                 Interface.class, new InterfaceKey(interfaceName));
 146             Future<Optional<DeviceTransaction>> deviceTxFuture = this.deviceTransactionManager.getDeviceTransaction(
 147                 nodeId);
 148             DeviceTransaction deviceTx;
 149             try {
 150                 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 151                 if (deviceTxOpt.isPresent()) {
 152                     deviceTx = deviceTxOpt.get();
 153                 } else {
 154                     throw new OpenRoadmInterfaceException(String.format("Device transaction was not found for node %s!",
 155                         nodeId));
 156                 }
 157             } catch (InterruptedException | ExecutionException e) {
 158                 throw new OpenRoadmInterfaceException(String.format("Failed to obtain device transaction for node %s!",
 159                     nodeId), e);
 160             }
 161
 162             deviceTx.delete(LogicalDatastoreType.CONFIGURATION, interfacesIID);
 163             FluentFuture<? extends @NonNull CommitInfo> commit =
 164                 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 165
 166             try {
 167                 commit.get();
 168                 LOG.info("Successfully deleted {} on node {}", interfaceName, nodeId);
 169             } catch (InterruptedException | ExecutionException e) {
 170                 throw new OpenRoadmInterfaceException(String.format("Failed to delete interface %s on " + "node %s",
 171                     interfaceName, nodeId), e);
 172             }
 173             // change the equipment state on circuit pack if xpdr node
 174             if (intf2Delete.getName().contains(StringConstants.CLIENT_TOKEN) || intf2Delete.getName().contains(
 175                 StringConstants.NETWORK_TOKEN)) {
 176                 postEquipmentState(nodeId, intf2Delete.getSupportingCircuitPackName(), false);
 177             }
 178
 179         } else {
 180             LOG.info("Interface does not exist, cannot delete on node {}", nodeId);
 181         }
 182     }
 183
 184     public void postEquipmentState(String nodeId, String circuitPackName, boolean activate)
 185         throws OpenRoadmInterfaceException {
 186         InstanceIdentifier<CircuitPacks> circuitPackIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(
 187             CircuitPacks.class, new CircuitPacksKey(circuitPackName));
 188         Optional<CircuitPacks> cpOpt = this.deviceTransactionManager.getDataFromDevice(nodeId,
 189             LogicalDatastoreType.CONFIGURATION, circuitPackIID, Timeouts.DEVICE_READ_TIMEOUT,
 190             Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 191         CircuitPacks cp = null;
 192         if (cpOpt.isPresent()) {
 193             cp = cpOpt.get();
 194         } else {
 195             throw new OpenRoadmInterfaceException(String.format(
 196                 "Could not find CircuitPack %s in equipment config datastore for node %s", circuitPackName, nodeId));
 197         }
 198         CircuitPacksBuilder cpBldr = new CircuitPacksBuilder(cp);
 199         boolean change = false;
 200         if (activate) {
 201             if (cpBldr.getEquipmentState() != null
 202                 && !States.NotReservedInuse.equals(cpBldr.getEquipmentState())) {
 203                 cpBldr.setEquipmentState(States.NotReservedInuse);
 204                 change = true;
 205             }
 206         } else if ((cpBldr.getEquipmentState() != null
 207             && !States.NotReservedAvailable.equals(cpBldr.getEquipmentState()))) {
 208             cpBldr.setEquipmentState(States.NotReservedAvailable);
 209             change = true;
 210         }
 211         if (change) {
 212             Future<Optional<DeviceTransaction>> deviceTxFuture = this.deviceTransactionManager.getDeviceTransaction(
 213                 nodeId);
 214             DeviceTransaction deviceTx;
 215             try {
 216                 Optional<DeviceTransaction> deviceTxOpt = deviceTxFuture.get();
 217                 if (deviceTxOpt.isPresent()) {
 218                     deviceTx = deviceTxOpt.get();
 219                 } else {
 220                     throw new OpenRoadmInterfaceException(String.format("Device transaction was not found for node %s!",
 221                         nodeId));
 222                 }
 223             } catch (InterruptedException | ExecutionException e) {
 224                 throw new OpenRoadmInterfaceException(String.format("Failed to obtain device transaction for node %s!",
 225                     nodeId), e);
 226             }
 227             deviceTx.merge(LogicalDatastoreType.CONFIGURATION, circuitPackIID, cpBldr.build());
 228             FluentFuture<? extends @NonNull CommitInfo> txSubmitFuture =
 229                 deviceTx.commit(Timeouts.DEVICE_WRITE_TIMEOUT, Timeouts.DEVICE_WRITE_TIMEOUT_UNIT);
 230             try {
 231                 txSubmitFuture.get();
 232                 LOG.info("Successfully posted equipment state change on node {}", nodeId);
 233             } catch (InterruptedException | ExecutionException e) {
 234                 throw new OpenRoadmInterfaceException(String.format("Failed to post equipment state on node %s!",
 235                     nodeId), e);
 236             }
 237         }
 238     }
 239
 240     public String getSupportedInterface(String nodeId, String interf) {
 241         Optional<Interface> supInterfOpt;
 242         try {
 243             supInterfOpt = getInterface(nodeId, interf);
 244             if (supInterfOpt.isPresent()) {
 245                 return supInterfOpt.get().getSupportingInterfaceList().get(0);
 246             } else {
 247                 return null;
 248             }
 249         } catch (OpenRoadmInterfaceException e) {
 250             LOG.error("error getting Supported Interface of {} - {}", interf, nodeId, e);
 251             return null;
 252         }
 253     }
 254
 255     private boolean checkIfDevicePortIsUpdatedWithInterface(String nodeId, InterfaceBuilder ifBuilder) {
 256         KeyedInstanceIdentifier<Ports, PortsKey> portIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 257             .child(CircuitPacks.class, new CircuitPacksKey(ifBuilder.getSupportingCircuitPackName()))
 258             .child(Ports.class, new PortsKey(ifBuilder.getSupportingPort()));
 259         Ports port = deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL,
 260             portIID, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT).get();
 261         if (port.getInterfaces() == null) {
 262             return false;
 263         }
 264         for (Interfaces interf : port.getInterfaces()) {
 265             if (interf.getInterfaceName().equals(ifBuilder.getName())) {
 266                 return true;
 267             }
 268         }
 269         return false;
 270     }
 271 }