interfacemgr/interfacemgr-impl/src/test/java/org/opendaylight/vpnservice/interfacemgr/test/VlanInterfaceConfigurationTest.java

   1 /*
   2  * Copyright (c) 2015 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.vpnservice.interfacemgr.test;
  10
  11 import static org.mockito.Matchers.any;
  12 import static org.mockito.Mockito.*;
  13
  14 import com.google.common.base.Optional;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17
  18 import java.math.BigInteger;
  19
  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.idmanager.IdManager;
  34 import org.opendaylight.vpnservice.interfacemgr.IfmUtil;
  35 import org.opendaylight.vpnservice.interfacemgr.commons.InterfaceMetaUtils;
  36 import org.opendaylight.vpnservice.interfacemgr.renderer.ovs.confighelpers.OvsInterfaceConfigAddHelper;
  37 import org.opendaylight.vpnservice.interfacemgr.renderer.ovs.confighelpers.OvsInterfaceConfigRemoveHelper;
  38 import org.opendaylight.vpnservice.mdsalutil.interfaces.IMdsalApiManager;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.alivenessmonitor.rev150629.AlivenessMonitorService;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutputBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info.InterfaceParentEntry;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info.InterfaceParentEntryKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info._interface.parent.entry.InterfaceChildEntry;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info._interface.parent.entry.InterfaceChildEntryBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info._interface.parent.entry.InterfaceChildEntryKey;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.ParentRefs;
  54 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  55 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  56 import org.opendaylight.yangtools.yang.common.RpcResult;
  57 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  58
  59 @RunWith(MockitoJUnitRunner.class)
  60 public class VlanInterfaceConfigurationTest {
  61
  62     @Mock
  63     DataBroker dataBroker;
  64     @Mock
  65     AlivenessMonitorService alivenessMonitorService;
  66     @Mock IdManager idManager;
  67     @Mock ListenerRegistration<DataChangeListener> dataChangeListenerRegistration;
  68     @Mock ReadOnlyTransaction mockReadTx;
  69     @Mock WriteTransaction mockWriteTx;
  70     @Mock IMdsalApiManager mdsalApiManager;
  71     OvsInterfaceConfigAddHelper addHelper;
  72     OvsInterfaceConfigRemoveHelper removeHelper;
  73
  74     NodeConnectorId nodeConnectorId;
  75     NodeConnector nodeConnector;
  76     Interface vlanInterfaceEnabled;
  77     Interface vlanInterfaceDisabled;
  78     InstanceIdentifier<Interface> interfaceInstanceIdentifier;
  79     InstanceIdentifier<NodeConnector> nodeConnectorInstanceIdentifier;
  80     InstanceIdentifier<InterfaceParentEntry> interfaceParentEntryIdentifier = null;
  81     InterfaceChildEntry interfaceChildEntry = null;
  82     InstanceIdentifier<InterfaceChildEntry> interfaceChildEntryInstanceIdentifier;
  83     InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> interfaceStateIdentifier;
  84     org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface stateInterface;
  85
  86     @Before
  87     public void setUp() throws Exception {
  88         when(dataBroker.registerDataChangeListener(
  89                 any(LogicalDatastoreType.class),
  90                 any(InstanceIdentifier.class),
  91                 any(DataChangeListener.class),
  92                 any(DataChangeScope.class)))
  93                 .thenReturn(dataChangeListenerRegistration);
  94         setupMocks();
  95     }
  96
  97     @After
  98     public void cleanUp(){
  99     }
 100
 101     private void setupMocks() {
 102         nodeConnectorId = InterfaceManagerTestUtil.buildNodeConnectorId(BigInteger.valueOf(1), 1);
 103         nodeConnector = InterfaceManagerTestUtil.buildNodeConnector(nodeConnectorId);
 104         vlanInterfaceEnabled = InterfaceManagerTestUtil.buildInterface(InterfaceManagerTestUtil.interfaceName, "Test Vlan Interface1", true, L2vlan.class, BigInteger.valueOf(1));
 105         vlanInterfaceDisabled = InterfaceManagerTestUtil.buildInterface(InterfaceManagerTestUtil.interfaceName, "Test Vlan Interface1", false, L2vlan.class, BigInteger.valueOf(1));
 106         interfaceInstanceIdentifier = IfmUtil.buildId(InterfaceManagerTestUtil.interfaceName);
 107         nodeConnectorInstanceIdentifier = InterfaceManagerTestUtil.getNcIdent("openflow:1", nodeConnectorId);
 108         interfaceStateIdentifier = IfmUtil.buildStateInterfaceId(vlanInterfaceEnabled.getName());
 109         stateInterface = InterfaceManagerTestUtil.buildStateInterface(InterfaceManagerTestUtil.interfaceName, nodeConnectorId);
 110         AllocateIdOutput output = new AllocateIdOutputBuilder().setIdValue((long)1).build();
 111         RpcResultBuilder<AllocateIdOutput> allocateIdRpcBuilder = RpcResultBuilder.success();
 112         allocateIdRpcBuilder.withResult(output);
 113         ListenableFuture<RpcResult<AllocateIdOutput>> future = Futures.immediateFuture(allocateIdRpcBuilder.build());
 114         interfaceParentEntryIdentifier = InterfaceMetaUtils.getInterfaceParentEntryIdentifier(
 115                 new InterfaceParentEntryKey(InterfaceManagerTestUtil.interfaceName));
 116         interfaceChildEntryInstanceIdentifier = InterfaceMetaUtils.getInterfaceChildEntryIdentifier(new InterfaceParentEntryKey("s1-eth1"),
 117                 new InterfaceChildEntryKey(vlanInterfaceEnabled.getName()));
 118         interfaceChildEntry = new InterfaceChildEntryBuilder().setKey(new InterfaceChildEntryKey(vlanInterfaceEnabled.getName())).
 119                 setChildInterface(vlanInterfaceEnabled.getName()).build();
 120         // Setup mocks
 121         when(dataBroker.newReadOnlyTransaction()).thenReturn(mockReadTx);
 122         when(dataBroker.newWriteOnlyTransaction()).thenReturn(mockWriteTx);
 123
 124         when(idManager.allocateId(any(AllocateIdInput.class))).thenReturn(future);
 125     }
 126
 127     @Test
 128     public void testAddVlanInterfaceWhenSwitchIsNotConnected() {
 129         Optional<Interface> expectedInterface = Optional.of(vlanInterfaceEnabled);
 130         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateInterface = Optional.of(stateInterface);
 131
 132         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 133                         LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 134         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 135                LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 136         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 137                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 138
 139         addHelper.addConfiguration(dataBroker, vlanInterfaceEnabled.getAugmentation(ParentRefs.class), vlanInterfaceEnabled, idManager,
 140                 alivenessMonitorService, mdsalApiManager);
 141
 142         //Nothing to verify, since when switch is not connected we don't do any datastore operation
 143
 144     }
 145
 146     @Test
 147     public void testAddVlanInterfaceWhenSwitchIsConnected() {
 148         Optional<Interface> expectedInterface = Optional.of(vlanInterfaceEnabled);
 149         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface>
 150                 expectedStateInterface = Optional.of(stateInterface);
 151
 152         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 153                 LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 154         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 155                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 156         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 157                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 158
 159         addHelper.addConfiguration(dataBroker, vlanInterfaceEnabled.getAugmentation(ParentRefs.class), vlanInterfaceEnabled, idManager,
 160                 alivenessMonitorService, mdsalApiManager);
 161
 162         //Nothing to verify, since when adminstate is enabled and switch opstate is already up,
 163         //we don't do any datastore operation
 164     }
 165
 166     @Test
 167     public void testAddVlanInterfaceWhenAdminStateDisabled() {
 168         Optional<Interface> expectedInterface = Optional.of(vlanInterfaceEnabled);
 169         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateInterface =
 170                 Optional.of(stateInterface);
 171
 172         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 173                 LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 174         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 175                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 176         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 177                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 178
 179         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();
 180         ifaceBuilder.setOperStatus(OperStatus.Down);
 181         ifaceBuilder.setKey(IfmUtil.getStateInterfaceKeyFromName(vlanInterfaceEnabled.getName()));
 182         ifaceBuilder.setType(L2vlan.class);
 183         stateInterface = ifaceBuilder.build();
 184
 185         addHelper.addConfiguration(dataBroker, vlanInterfaceDisabled.getAugmentation(ParentRefs.class), vlanInterfaceDisabled, idManager,
 186                 alivenessMonitorService, mdsalApiManager);
 187
 188         //verification
 189         verify(mockWriteTx).put(LogicalDatastoreType.CONFIGURATION, interfaceChildEntryInstanceIdentifier, interfaceChildEntry, true);
 190     }
 191
 192     @Test
 193     public void testDeleteVlanInterface() {
 194         Optional<Interface> expected = Optional.of(vlanInterfaceEnabled);
 195         Optional<NodeConnector> expectedNc = Optional.of(nodeConnector);
 196         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateIf = Optional.of(stateInterface);
 197         doReturn(Futures.immediateCheckedFuture(expected)).when(mockReadTx).read(
 198                         LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 199         doReturn(Futures.immediateCheckedFuture(expectedNc)).when(mockReadTx).read(
 200                         LogicalDatastoreType.OPERATIONAL, nodeConnectorInstanceIdentifier);
 201         doReturn(Futures.immediateCheckedFuture(expectedStateIf)).when(mockReadTx).read(
 202                         LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 203         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 204                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 205
 206         removeHelper.removeConfiguration(dataBroker,alivenessMonitorService, vlanInterfaceEnabled, idManager,
 207                 mdsalApiManager, vlanInterfaceEnabled.getAugmentation(ParentRefs.class));
 208
 209         //verification
 210         verify(mockWriteTx).delete(LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 211     }
 212 }