vpnservice/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 com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import org.junit.After;
  15 import org.junit.Before;
  16 import org.junit.Test;
  17 import org.junit.runner.RunWith;
  18 import org.mockito.Mock;
  19 import org.mockito.runners.MockitoJUnitRunner;
  20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  21 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  22 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  24 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.idmanager.IdManager;
  27 import org.opendaylight.vpnservice.interfacemgr.IfmUtil;
  28 import org.opendaylight.vpnservice.interfacemgr.commons.InterfaceMetaUtils;
  29 import org.opendaylight.vpnservice.interfacemgr.renderer.ovs.confighelpers.*;
  30 import org.opendaylight.vpnservice.mdsalutil.interfaces.IMdsalApiManager;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.alivenessmonitor.rev150629.AlivenessMonitorService;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdInput;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.AllocateIdOutputBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info.InterfaceParentEntry;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info.InterfaceParentEntryBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info.InterfaceParentEntryKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info._interface.parent.entry.InterfaceChildEntry;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info._interface.parent.entry.InterfaceChildEntryBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._interface.child.info._interface.parent.entry.InterfaceChildEntryKey;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.IfL2vlan;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.ParentRefs;
  48 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.opendaylight.yangtools.yang.common.RpcResult;
  51 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  52
  53 import java.math.BigInteger;
  54 import java.util.ArrayList;
  55 import java.util.List;
  56
  57 import static org.mockito.Matchers.any;
  58 import static org.mockito.Mockito.*;
  59
  60 @RunWith(MockitoJUnitRunner.class)
  61 public class VlanInterfaceConfigurationTest {
  62
  63     @Mock
  64     DataBroker dataBroker;
  65     @Mock
  66     AlivenessMonitorService alivenessMonitorService;
  67     @Mock IdManager idManager;
  68     @Mock ListenerRegistration<DataChangeListener> dataChangeListenerRegistration;
  69     @Mock ReadOnlyTransaction mockReadTx;
  70     @Mock WriteTransaction mockWriteTx;
  71     @Mock IMdsalApiManager mdsalApiManager;
  72     OvsInterfaceConfigAddHelper addHelper;
  73     OvsInterfaceConfigRemoveHelper removeHelper;
  74     OvsVlanMemberConfigAddHelper memberConfigAddHelper;
  75     OvsVlanMemberConfigRemoveHelper memberConfigRemoveHelper;
  76     OvsVlanMemberConfigUpdateHelper memberConfigUpdateHelper;
  77
  78     NodeConnectorId nodeConnectorId;
  79     NodeConnector nodeConnector;
  80     Interface vlanInterfaceEnabled;
  81     Interface vlanInterfaceDisabled;
  82     InstanceIdentifier<Interface> interfaceInstanceIdentifier;
  83     InstanceIdentifier<NodeConnector> nodeConnectorInstanceIdentifier;
  84     InstanceIdentifier<InterfaceParentEntry> interfaceParentEntryIdentifier = null;
  85     InterfaceParentEntry interfaceParentEntry;
  86     InterfaceChildEntry interfaceChildEntry = null;
  87     InstanceIdentifier<InterfaceChildEntry> interfaceChildEntryInstanceIdentifier;
  88     InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> interfaceStateIdentifier;
  89     org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface stateInterface;
  90
  91     @Before
  92     public void setUp() throws Exception {
  93         when(dataBroker.registerDataChangeListener(
  94                 any(LogicalDatastoreType.class),
  95                 any(InstanceIdentifier.class),
  96                 any(DataChangeListener.class),
  97                 any(DataChangeScope.class)))
  98                 .thenReturn(dataChangeListenerRegistration);
  99         setupMocks();
 100     }
 101
 102     @After
 103     public void cleanUp(){
 104     }
 105
 106     private void setupMocks() {
 107         nodeConnectorId = InterfaceManagerTestUtil.buildNodeConnectorId(BigInteger.valueOf(1), 1);
 108         nodeConnector = InterfaceManagerTestUtil.buildNodeConnector(nodeConnectorId);
 109         vlanInterfaceEnabled = InterfaceManagerTestUtil.buildInterface(InterfaceManagerTestUtil.interfaceName, "Test Vlan Interface1", true, L2vlan.class, BigInteger.valueOf(1));
 110         vlanInterfaceDisabled = InterfaceManagerTestUtil.buildInterface(InterfaceManagerTestUtil.interfaceName, "Test Vlan Interface1", false, L2vlan.class, BigInteger.valueOf(1));
 111         interfaceInstanceIdentifier = IfmUtil.buildId(InterfaceManagerTestUtil.interfaceName);
 112         nodeConnectorInstanceIdentifier = InterfaceManagerTestUtil.getNcIdent("openflow:1", nodeConnectorId);
 113         interfaceStateIdentifier = IfmUtil.buildStateInterfaceId(vlanInterfaceEnabled.getName());
 114         stateInterface = InterfaceManagerTestUtil.buildStateInterface(InterfaceManagerTestUtil.interfaceName, nodeConnectorId);
 115         AllocateIdOutput output = new AllocateIdOutputBuilder().setIdValue((long)1).build();
 116         RpcResultBuilder<AllocateIdOutput> allocateIdRpcBuilder = RpcResultBuilder.success();
 117         allocateIdRpcBuilder.withResult(output);
 118         ListenableFuture<RpcResult<AllocateIdOutput>> future = Futures.immediateFuture(allocateIdRpcBuilder.build());
 119         interfaceParentEntryIdentifier = InterfaceMetaUtils.getInterfaceParentEntryIdentifier(
 120                 new InterfaceParentEntryKey(InterfaceManagerTestUtil.interfaceName));
 121         interfaceChildEntryInstanceIdentifier = InterfaceMetaUtils.getInterfaceChildEntryIdentifier(new InterfaceParentEntryKey("s1-eth1"),
 122                 new InterfaceChildEntryKey(vlanInterfaceEnabled.getName()));
 123         interfaceChildEntry = new InterfaceChildEntryBuilder().setKey(new InterfaceChildEntryKey(vlanInterfaceEnabled.getName())).
 124                 setChildInterface(vlanInterfaceEnabled.getName()).build();
 125
 126         InterfaceParentEntryBuilder ifaceParentEntryBuilder = new InterfaceParentEntryBuilder();
 127         List<InterfaceChildEntry> ifaceChildEntryList= new ArrayList<>();
 128         ifaceChildEntryList.add(interfaceChildEntry);
 129         interfaceParentEntry = ifaceParentEntryBuilder.setInterfaceChildEntry(ifaceChildEntryList).build();
 130
 131         // Setup mocks
 132         when(dataBroker.newReadOnlyTransaction()).thenReturn(mockReadTx);
 133         when(dataBroker.newWriteOnlyTransaction()).thenReturn(mockWriteTx);
 134
 135         when(idManager.allocateId(any(AllocateIdInput.class))).thenReturn(future);
 136     }
 137
 138     @Test
 139     public void testAddVlanInterfaceWhenSwitchIsNotConnected() {
 140         Optional<Interface> expectedInterface = Optional.of(vlanInterfaceEnabled);
 141         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateInterface = Optional.of(stateInterface);
 142
 143         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 144                         LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 145         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 146                LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 147         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 148                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 149
 150         addHelper.addConfiguration(dataBroker, vlanInterfaceEnabled.getAugmentation(ParentRefs.class), vlanInterfaceEnabled, idManager,
 151                 alivenessMonitorService, mdsalApiManager);
 152
 153         //Nothing to verify, since when switch is not connected we don't do any datastore operation
 154
 155     }
 156
 157     @Test
 158     public void testAddVlanInterfaceWhenSwitchIsConnected() {
 159         Optional<Interface> expectedInterface = Optional.of(vlanInterfaceEnabled);
 160         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface>
 161                 expectedStateInterface = Optional.of(stateInterface);
 162
 163         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 164                 LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 165         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 166                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 167         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 168                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 169
 170         addHelper.addConfiguration(dataBroker, vlanInterfaceEnabled.getAugmentation(ParentRefs.class), vlanInterfaceEnabled, idManager,
 171                 alivenessMonitorService, mdsalApiManager);
 172
 173         //Nothing to verify, since when adminstate is enabled and switch opstate is already up,
 174         //we don't do any datastore operation
 175     }
 176
 177     @Test
 178     public void testAddVlanInterfaceWhenAdminStateDisabled() {
 179         Optional<Interface> expectedInterface = Optional.of(vlanInterfaceEnabled);
 180         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateInterface =
 181                 Optional.of(stateInterface);
 182
 183         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 184                 LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 185         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 186                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 187         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 188                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 189
 190         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();
 191         ifaceBuilder.setOperStatus(OperStatus.Down);
 192         ifaceBuilder.setKey(IfmUtil.getStateInterfaceKeyFromName(vlanInterfaceEnabled.getName()));
 193         ifaceBuilder.setType(L2vlan.class);
 194         stateInterface = ifaceBuilder.build();
 195
 196         addHelper.addConfiguration(dataBroker, vlanInterfaceDisabled.getAugmentation(ParentRefs.class), vlanInterfaceDisabled, idManager,
 197                 alivenessMonitorService, mdsalApiManager);
 198
 199         //verification
 200         verify(mockWriteTx).put(LogicalDatastoreType.CONFIGURATION, interfaceChildEntryInstanceIdentifier, interfaceChildEntry, true);
 201     }
 202
 203     @Test
 204     public void testDeleteVlanInterface() {
 205         Optional<Interface> expected = Optional.of(vlanInterfaceEnabled);
 206         Optional<NodeConnector> expectedNc = Optional.of(nodeConnector);
 207         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateIf = Optional.of(stateInterface);
 208         doReturn(Futures.immediateCheckedFuture(expected)).when(mockReadTx).read(
 209                         LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 210         doReturn(Futures.immediateCheckedFuture(expectedNc)).when(mockReadTx).read(
 211                         LogicalDatastoreType.OPERATIONAL, nodeConnectorInstanceIdentifier);
 212         doReturn(Futures.immediateCheckedFuture(expectedStateIf)).when(mockReadTx).read(
 213                         LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 214         doReturn(Futures.immediateCheckedFuture(Optional.absent())).when(mockReadTx).read(
 215                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 216
 217         removeHelper.removeConfiguration(dataBroker,alivenessMonitorService, vlanInterfaceEnabled, idManager,
 218                 mdsalApiManager, vlanInterfaceEnabled.getAugmentation(ParentRefs.class));
 219
 220         //verification
 221         verify(mockWriteTx).delete(LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 222     }
 223
 224     @Test
 225     public void testAddMemberConfiguration(){
 226
 227         Optional<Interface> expectedInterface = Optional.of(vlanInterfaceEnabled);
 228         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateInterface = Optional.of(stateInterface);
 229
 230         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 231                 LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 232         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 233                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 234
 235         memberConfigAddHelper.addConfiguration(dataBroker, vlanInterfaceEnabled.getAugmentation(ParentRefs.class), vlanInterfaceEnabled, null, idManager);
 236     }
 237
 238     @Test
 239     public void testRemoveMemberConfiguration(){
 240
 241         Optional<InterfaceParentEntry> expectedParentEntry = Optional.of(interfaceParentEntry);
 242         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateInterface = Optional.of(stateInterface);
 243
 244         doReturn(Futures.immediateCheckedFuture(expectedParentEntry)).when(mockReadTx).read(
 245                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 246         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 247                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 248
 249         memberConfigRemoveHelper.removeConfiguration(dataBroker, vlanInterfaceEnabled.getAugmentation(ParentRefs.class), vlanInterfaceEnabled, null, idManager);
 250     }
 251
 252     @Test
 253     public void testUpdateMemberConfiguration(){
 254
 255         Optional<InterfaceChildEntry> expectedChildEntry = Optional.of(interfaceChildEntry);
 256         Optional<InterfaceParentEntry> expectedParentEntry = Optional.of(interfaceParentEntry);
 257         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> expectedStateInterface = Optional.of(stateInterface);
 258         Optional<Interface> expectedInterface = Optional.of(vlanInterfaceEnabled);
 259
 260         doReturn(Futures.immediateCheckedFuture(expectedChildEntry)).when(mockReadTx).read(
 261                 LogicalDatastoreType.CONFIGURATION, interfaceChildEntryInstanceIdentifier);
 262         doReturn(Futures.immediateCheckedFuture(expectedParentEntry)).when(mockReadTx).read(
 263                 LogicalDatastoreType.CONFIGURATION, interfaceParentEntryIdentifier);
 264         doReturn(Futures.immediateCheckedFuture(expectedStateInterface)).when(mockReadTx).read(
 265                 LogicalDatastoreType.OPERATIONAL, interfaceStateIdentifier);
 266         doReturn(Futures.immediateCheckedFuture(expectedInterface)).when(mockReadTx).read(
 267                 LogicalDatastoreType.CONFIGURATION, interfaceInstanceIdentifier);
 268
 269         memberConfigUpdateHelper.updateConfiguration(dataBroker, alivenessMonitorService, vlanInterfaceEnabled.getAugmentation(ParentRefs.class), vlanInterfaceDisabled, vlanInterfaceEnabled.getAugmentation(IfL2vlan.class), vlanInterfaceEnabled, idManager, mdsalApiManager);
 270     }
 271 }