interfacemanager/interfacemanager-impl/src/test/java/org/opendaylight/genius/interfacemanager/test/TunnelInterfaceConfigurationTest.java

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. 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.genius.interfacemanager.test;
  10
  11 import static org.mockito.Matchers.any;
  12 import static org.mockito.Mockito.doReturn;
  13 import static org.mockito.Mockito.verify;
  14 import static org.mockito.Mockito.when;
  15
  16 import com.google.common.base.Optional;
  17 import com.google.common.util.concurrent.Futures;
  18 import java.math.BigInteger;
  19 import java.util.concurrent.Future;
  20 import org.junit.After;
  21 import org.junit.Before;
  22 import org.junit.Test;
  23 import org.junit.runner.RunWith;
  24 import org.mockito.Mock;
  25 import org.mockito.Mockito;
  26 import org.mockito.runners.MockitoJUnitRunner;
  27 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  28 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  29 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  30 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  31 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  32 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  33 import org.opendaylight.genius.interfacemanager.IfmConstants;
  34 import org.opendaylight.genius.interfacemanager.IfmUtil;
  35 import org.opendaylight.genius.interfacemanager.commons.InterfaceMetaUtils;
  36 import org.opendaylight.genius.interfacemanager.renderer.ovs.confighelpers.OvsInterfaceConfigAddHelper;
  37 import org.opendaylight.genius.interfacemanager.renderer.ovs.confighelpers.OvsInterfaceConfigRemoveHelper;
  38 import org.opendaylight.genius.interfacemanager.renderer.ovs.confighelpers.OvsInterfaceConfigUpdateHelper;
  39 import org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.BatchingUtils;
  40 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.AlivenessMonitorService;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutputBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntry;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntryKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntry;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntryBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntryKey;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntry;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntryBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntryKey;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
  67 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  68 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  70 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  71 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  72 import org.opendaylight.yangtools.yang.common.RpcResult;
  73 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  74 import org.powermock.api.mockito.PowerMockito;
  75 import org.powermock.core.classloader.annotations.PrepareForTest;
  76 import org.powermock.modules.junit4.PowerMockRunner;
  77
  78 @RunWith(PowerMockRunner.class)
  79 @PrepareForTest(BatchingUtils.class)
  80 public class TunnelInterfaceConfigurationTest {
  81     BigInteger dpId = BigInteger.valueOf(1);
  82     NodeConnectorId nodeConnectorId = null;
  83     NodeConnector nodeConnector = null;
  84     Interface tunnelInterfaceEnabled = null;
  85     Interface tunnelInterfaceDisabled = null;
  86     ParentRefs parentRefs = null;
  87     InstanceIdentifier<Interface> interfaceInstanceIdentifier = null;
  88     InstanceIdentifier<NodeConnector> nodeConnectorInstanceIdentifier = null;
  89     InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> interfaceStateIdentifier = null;
  90     org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface stateInterface;
  91
  92     org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntryKey BridgeRefEntryKey;
  93     InstanceIdentifier<BridgeRefEntry> dpnBridgeEntryIid = null;
  94     BridgeEntryKey bridgeEntryKey = null;
  95     BridgeEntry bridgeEntry = null;
  96     InstanceIdentifier<BridgeEntry> bridgeEntryIid = null;
  97     InstanceIdentifier<BridgeInterfaceEntry> bridgeInterfaceEntryInstanceIdentifier;
  98     BridgeInterfaceEntry bridgeInterfaceEntry;
  99     BridgeInterfaceEntryKey bridgeInterfaceEntryKey;
 100     BridgeRefEntry bridgeRefEntry = null;
 101     OvsdbBridgeAugmentation ovsdbBridgeAugmentation;
 102     InstanceIdentifier<OvsdbBridgeAugmentation> ovsdbBridgeAugmentationInstanceIdentifier;
 103     InstanceIdentifier<TerminationPoint> terminationPointInstanceIdentifier;
 104     TerminationPoint terminationPoint;
 105
 106     @Mock DataBroker dataBroker;
 107     @Mock IdManagerService idManager;
 108     @Mock AlivenessMonitorService alivenessMonitorService;
 109     @Mock ListenerRegistration<DataChangeListener> dataChangeListenerRegistration;
 110     @Mock ReadOnlyTransaction mockReadTx;
 111     @Mock WriteTransaction mockWriteTx;
 112     @Mock IMdsalApiManager mdsalApiManager;
 113     @Mock BatchingUtils batchingUtils;
 114     OvsInterfaceConfigAddHelper addHelper;
 115     OvsInterfaceConfigRemoveHelper removeHelper;
 116     OvsInterfaceConfigUpdateHelper updateHelper;
 117
 118     @Before
 119     public void setUp() throws Exception {
 120         PowerMockito.mockStatic(BatchingUtils.class);
 121         when(dataBroker.registerDataChangeListener(
 122                 any(LogicalDatastoreType.class),
 123                 any(InstanceIdentifier.class),
 124                 any(DataChangeListener.class),
 125                 any(DataChangeScope.class)))
 126                 .thenReturn(dataChangeListenerRegistration);
 127         setupMocks();
 128     }
 129
 130     private void setupMocks() {
 131         nodeConnectorId = InterfaceManagerTestUtil.buildNodeConnectorId(BigInteger.valueOf(1), 2);
 132         nodeConnector = InterfaceManagerTestUtil.buildNodeConnector(nodeConnectorId);
 133         tunnelInterfaceEnabled = InterfaceManagerTestUtil.buildTunnelInterface(dpId, InterfaceManagerTestUtil.tunnelInterfaceName, "Test Interface1", true, TunnelTypeGre.class
 134                 , "192.168.56.101", "192.168.56.102");
 135         tunnelInterfaceDisabled = InterfaceManagerTestUtil.buildTunnelInterface(dpId, InterfaceManagerTestUtil.tunnelInterfaceName, "Test Interface1", false, TunnelTypeGre.class
 136                 , "192.168.56.101", "192.168.56.102");
 137         interfaceInstanceIdentifier = IfmUtil.buildId(InterfaceManagerTestUtil.tunnelInterfaceName);
 138         nodeConnectorInstanceIdentifier = InterfaceManagerTestUtil.getNcIdent("openflow:1", nodeConnectorId);
 139         interfaceStateIdentifier = IfmUtil.buildStateInterfaceId(tunnelInterfaceEnabled.getName());
 140         stateInterface = InterfaceManagerTestUtil.buildStateInterface(InterfaceManagerTestUtil.tunnelInterfaceName, nodeConnectorId);
 141         parentRefs = tunnelInterfaceEnabled.getAugmentation(ParentRefs.class);
 142         BridgeRefEntryKey = new BridgeRefEntryKey(parentRefs.getDatapathNodeIdentifier());
 143         dpnBridgeEntryIid = InterfaceMetaUtils.getBridgeRefEntryIdentifier(BridgeRefEntryKey);
 144         bridgeEntryKey = new BridgeEntryKey(parentRefs.getDatapathNodeIdentifier());
 145
 146         bridgeInterfaceEntryKey = new BridgeInterfaceEntryKey(InterfaceManagerTestUtil.tunnelInterfaceName);
 147         bridgeInterfaceEntryInstanceIdentifier = InterfaceMetaUtils.getBridgeInterfaceEntryIdentifier(bridgeEntryKey,
 148                 bridgeInterfaceEntryKey);
 149         bridgeInterfaceEntry =
 150                 new BridgeInterfaceEntryBuilder().setKey(bridgeInterfaceEntryKey)
 151                         .setInterfaceName(tunnelInterfaceEnabled.getName()).build();
 152
 153         bridgeEntryIid = InterfaceMetaUtils.getBridgeEntryIdentifier(bridgeEntryKey);
 154         bridgeEntry = InterfaceManagerTestUtil.buildBridgeEntry(dpId, bridgeInterfaceEntry);
 155
 156         Node node = new NodeBuilder().setKey(null).setNodeId(null).build();
 157         ovsdbBridgeAugmentationInstanceIdentifier = InterfaceManagerTestUtil.getOvsdbAugmentationInstanceIdentifier(
 158                 InterfaceManagerTestUtil.tunnelInterfaceName, node);
 159         ovsdbBridgeAugmentation = InterfaceManagerTestUtil.getOvsdbBridgeRef("s1");
 160         bridgeRefEntry = new BridgeRefEntryBuilder().setKey(BridgeRefEntryKey).setDpid(dpId).
 161                 setBridgeReference(new OvsdbBridgeRef(ovsdbBridgeAugmentationInstanceIdentifier)).build();
 162
 163         terminationPointInstanceIdentifier = InterfaceManagerTestUtil.getTerminationPointId(ovsdbBridgeAugmentationInstanceIdentifier,
 164                 InterfaceManagerTestUtil.tunnelInterfaceName);
 165         terminationPoint = InterfaceManagerTestUtil.getTerminationPoint(ovsdbBridgeAugmentationInstanceIdentifier, ovsdbBridgeAugmentation,
 166                 InterfaceManagerTestUtil.tunnelInterfaceName, 0, InterfaceTypeGre.class, tunnelInterfaceEnabled);
 167         // Setup mocks
 168         when(dataBroker.newReadOnlyTransaction()).thenReturn(mockReadTx);
 169         when(dataBroker.newWriteOnlyTransaction()).thenReturn(mockWriteTx);
 170     }
 171
 172     @After
 173     public void tearDown(){
 174         InterfaceManagerTestUtil.clearInterfaceCaches();
 175     }
 176
 177     @Test
 178     public void testAddGreInterfaceWhenSwitchIsNotConnected() {
 179         Optional<Interface> expectedInterface = Optional.of(tunnelInterfaceEnabled);
 180         Optional.of(stateInterface);
 181
 182         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 183                 LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 184         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 185                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 186         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 187                 LogicalDatastoreType.OPERATIONAL, dpnBridgeEntryIid);
 188
 189         addHelper.addConfiguration(dataBroker, parentRefs, tunnelInterfaceEnabled, idManager,
 190                 alivenessMonitorService, mdsalApiManager);
 191
 192         //Add some verifications
 193         PowerMockito.verifyStatic(Mockito.times(1));
 194         BatchingUtils.write(bridgeInterfaceEntryInstanceIdentifier,bridgeInterfaceEntry,
 195                 BatchingUtils.EntityType.DEFAULT_CONFIG );
 196     }
 197
 198     @Test
 199     public void testAddGreInterfaceWhenSwitchIsConnected() {
 200         Optional<BridgeRefEntry> expectedBridgeRefEntry = Optional.of(bridgeRefEntry);
 201         Optional<OvsdbBridgeAugmentation> expectedOvsdbBridgeAugmentation = Optional.of(ovsdbBridgeAugmentation);
 202         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 203                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 204         doReturn(Futures.immediateCheckedFuture(expectedBridgeRefEntry)).when(mockReadTx).read(
 205                 LogicalDatastoreType.OPERATIONAL, dpnBridgeEntryIid);
 206         doReturn(Futures.immediateCheckedFuture(expectedOvsdbBridgeAugmentation)).when(mockReadTx).read(
 207                 LogicalDatastoreType.OPERATIONAL, ovsdbBridgeAugmentationInstanceIdentifier);
 208
 209         addHelper.addConfiguration(dataBroker, parentRefs, tunnelInterfaceEnabled, idManager,
 210                 alivenessMonitorService, mdsalApiManager);
 211
 212         //Add some verifications
 213         PowerMockito.verifyStatic(Mockito.times(1));
 214         BatchingUtils.write(bridgeInterfaceEntryInstanceIdentifier,bridgeInterfaceEntry, BatchingUtils.EntityType.DEFAULT_CONFIG );
 215         PowerMockito.verifyStatic(Mockito.times(1));
 216         BatchingUtils.write(terminationPointInstanceIdentifier,terminationPoint, BatchingUtils.EntityType.TOPOLOGY_CONFIG);
 217     }
 218
 219
 220     @Test
 221     public void testDeleteGreInterfaceWhenSwitchIsConnected() {
 222         Optional<BridgeRefEntry> expectedBridgeRefEntry = Optional.of(bridgeRefEntry);
 223         Optional<BridgeEntry> expectedBridgeEntry = Optional.of(bridgeEntry);
 224         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedInterfaceState = Optional.of(stateInterface);
 225         doReturn(Futures.immediateCheckedFuture(expectedBridgeRefEntry)).when(mockReadTx).read(
 226                 LogicalDatastoreType.OPERATIONAL, dpnBridgeEntryIid);
 227         doReturn(Futures.immediateCheckedFuture(expectedBridgeEntry)).when(mockReadTx).read(
 228                 LogicalDatastoreType.CONFIGURATION, bridgeEntryIid);
 229         doReturn(Futures.immediateCheckedFuture(expectedInterfaceState)).when(mockReadTx).read(
 230                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 231
 232         AllocateIdOutput expectedId = new AllocateIdOutputBuilder().setIdValue(Long.valueOf("100")).build();
 233         Future<RpcResult<AllocateIdOutput>> idOutputOptional = RpcResultBuilder.success(expectedId).buildFuture();
 234         AllocateIdInput getIdInput = new AllocateIdInputBuilder()
 235                 .setPoolName(IfmConstants.IFM_IDPOOL_NAME)
 236                 .setIdKey(tunnelInterfaceEnabled.getName()).build();
 237         doReturn(idOutputOptional).when(idManager).allocateId(getIdInput);
 238         ReleaseIdInput releaseIdInput = new ReleaseIdInputBuilder()
 239                 .setPoolName(IfmConstants.IFM_IDPOOL_NAME)
 240                 .setIdKey(tunnelInterfaceEnabled.getName()).build();
 241         doReturn(Futures.immediateFuture(RpcResultBuilder.<Void>success().build())).when(idManager).releaseId(releaseIdInput);
 242
 243         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder ifaceBuilder = new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder();
 244         ifaceBuilder.setOperStatus(OperStatus.Down);
 245         ifaceBuilder.setKey(IfmUtil.getStateInterfaceKeyFromName(tunnelInterfaceEnabled.getName()));
 246         stateInterface = ifaceBuilder.build();
 247
 248         removeHelper.removeConfiguration(dataBroker, alivenessMonitorService, tunnelInterfaceEnabled, idManager,
 249                 mdsalApiManager, parentRefs);
 250
 251         //Add some verifications
 252         verify(mockWriteTx).delete(LogicalDatastoreType.CONFIGURATION, bridgeEntryIid);
 253         verify(mockWriteTx).delete(LogicalDatastoreType.CONFIGURATION, terminationPointInstanceIdentifier);
 254     }
 255
 256
 257     @Test
 258     public void testUpdateAdminStateForGreInterface() {
 259         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface>
 260                 expectedStateInterface = Optional.of(stateInterface);
 261         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 262                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 263
 264         updateHelper.updateConfiguration(dataBroker, alivenessMonitorService, idManager, mdsalApiManager,
 265                 tunnelInterfaceDisabled,tunnelInterfaceEnabled);
 266
 267         //verify whether operational data store is updated with the new oper state.
 268         InterfaceBuilder ifaceBuilder = new InterfaceBuilder();
 269         ifaceBuilder.setOperStatus(OperStatus.Down);
 270         ifaceBuilder.setKey(IfmUtil.getStateInterfaceKeyFromName(stateInterface.getName()));
 271
 272         verify(mockWriteTx).merge(LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier,
 273                 ifaceBuilder.build());
 274     }
 275     @Test
 276     public void testEnableAdminStateForGreInterface() {
 277         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface>
 278                 expectedStateInterface = Optional.of(stateInterface);
 279         Optional<NodeConnector>expectedNodeConnector = Optional.of(nodeConnector);
 280
 281         doReturn(Futures.immediateCheckedFuture(expectedNodeConnector)).when(mockReadTx).read(
 282                 LogicalDatastoreType.OPERATIONAL, nodeConnectorInstanceIdentifier);
 283         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 284                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 285
 286         updateHelper.updateConfiguration(dataBroker, alivenessMonitorService, idManager, mdsalApiManager,
 287                 tunnelInterfaceEnabled,tunnelInterfaceDisabled);
 288
 289         //verify whether operational data store is updated with the new oper state.
 290         InterfaceBuilder ifaceBuilder = new InterfaceBuilder();
 291         ifaceBuilder.setOperStatus(OperStatus.Down);
 292         ifaceBuilder.setKey(IfmUtil.getStateInterfaceKeyFromName(stateInterface.getName()));
 293
 294         verify(mockWriteTx).merge(LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier,
 295                 ifaceBuilder.build());
 296     }
 297 }