openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/rpc/RpcManagerImplTest.java

   1 /**
   2  * Copyright (c) 2015 Cisco 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 package org.opendaylight.openflowplugin.impl.rpc;
   9
  10 import static org.mockito.Mockito.atLeastOnce;
  11 import static org.mockito.Mockito.never;
  12 import static org.mockito.Mockito.times;
  13 import static org.mockito.Mockito.verify;
  14
  15 import com.google.common.base.VerifyException;
  16 import java.util.concurrent.ConcurrentMap;
  17 import org.junit.Before;
  18 import org.junit.Rule;
  19 import org.junit.Test;
  20 import org.junit.rules.ExpectedException;
  21 import org.junit.runner.RunWith;
  22 import org.mockito.Matchers;
  23 import org.mockito.Mock;
  24 import org.mockito.Mockito;
  25 import org.mockito.runners.MockitoJUnitRunner;
  26 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  27 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  28 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
  29 import org.opendaylight.openflowplugin.api.OFConstants;
  30 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  31 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  32 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  33 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  34 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  35 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
  36 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
  37 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  38 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
  39 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  40 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
  41 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutputBuilder;
  48 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  49 import org.opendaylight.yangtools.yang.binding.RpcService;
  50
  51
  52 @RunWith(MockitoJUnitRunner.class)
  53 public class RpcManagerImplTest {
  54
  55     private static final int QUOTA_VALUE = 5;
  56     private RpcManagerImpl rpcManager;
  57
  58     @Mock
  59     private ProviderContext rpcProviderRegistry;
  60     @Mock
  61     private DeviceContext deviceContext;
  62     @Mock
  63     private DeviceInitializationPhaseHandler deviceINitializationPhaseHandler;
  64     @Mock
  65     private DeviceTerminationPhaseHandler deviceTerminationPhaseHandler;
  66     @Mock
  67     private BindingAwareBroker.RoutedRpcRegistration<RpcService> routedRpcRegistration;
  68     @Mock
  69     private DeviceState deviceState;
  70     @Mock
  71     private MessageSpy mockMsgSpy;
  72     @Mock
  73     private ConnectionContext connectionContext;
  74     @Mock
  75     private ItemLifeCycleRegistry itemLifeCycleRegistry;
  76     @Mock
  77     private MessageSpy messageSpy;
  78     @Mock
  79     private RpcContext removedContexts;
  80     @Mock
  81     private ConcurrentMap<DeviceInfo, RpcContext> contexts;
  82     @Mock
  83     private DeviceInfo deviceInfo;
  84     @Mock
  85     private LifecycleService lifecycleService;
  86     @Mock
  87     private ExtensionConverterProvider extensionConverterProvider;
  88     @Mock
  89     private ConvertorExecutor convertorExecutor;
  90     @Mock
  91     private NotificationPublishService notificationPublishService;
  92
  93     @Rule
  94     public ExpectedException expectedException = ExpectedException.none();
  95
  96     private KeyedInstanceIdentifier<Node, NodeKey> nodePath;
  97
  98     private NodeId nodeId = new NodeId("openflow-junit:1");
  99
 100     @Before
 101     public void setUp() {
 102         final NodeKey nodeKey = new NodeKey(nodeId);
 103         rpcManager = new RpcManagerImpl(rpcProviderRegistry, QUOTA_VALUE, extensionConverterProvider, convertorExecutor, notificationPublishService);
 104         rpcManager.setDeviceInitializationPhaseHandler(deviceINitializationPhaseHandler);
 105
 106         GetFeaturesOutput featuresOutput = new GetFeaturesOutputBuilder()
 107                 .setVersion(OFConstants.OFP_VERSION_1_3)
 108                 .build();
 109
 110         FeaturesReply features = featuresOutput;
 111
 112         Mockito.when(connectionContext.getFeatures()).thenReturn(features);
 113         Mockito.when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionContext);
 114         Mockito.when(deviceContext.getDeviceState()).thenReturn(deviceState);
 115         Mockito.when(deviceContext.getItemLifeCycleSourceRegistry()).thenReturn(itemLifeCycleRegistry);
 116         Mockito.when(deviceInfo.getNodeInstanceIdentifier()).thenReturn(nodePath);
 117         rpcManager.setDeviceTerminationPhaseHandler(deviceTerminationPhaseHandler);
 118         Mockito.when(connectionContext.getFeatures()).thenReturn(features);
 119         Mockito.when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionContext);
 120         Mockito.when(deviceContext.getDeviceState()).thenReturn(deviceState);
 121         Mockito.when(deviceContext.getItemLifeCycleSourceRegistry()).thenReturn(itemLifeCycleRegistry);
 122         Mockito.when(deviceInfo.getNodeInstanceIdentifier()).thenReturn(nodePath);
 123         Mockito.when(deviceContext.getMessageSpy()).thenReturn(messageSpy);
 124         Mockito.when(deviceInfo.getNodeId()).thenReturn(nodeKey.getId());
 125         Mockito.when(rpcProviderRegistry.addRoutedRpcImplementation(
 126                 Matchers.any(), Matchers.any(RpcService.class)))
 127                 .thenReturn(routedRpcRegistration);
 128         Mockito.when(contexts.remove(deviceInfo)).thenReturn(removedContexts);
 129         Mockito.when(lifecycleService.getDeviceContext()).thenReturn(deviceContext);
 130     }
 131
 132     @Test
 133     public void onDeviceContextLevelUpTwice() throws Exception {
 134         rpcManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 135         expectedException.expect(VerifyException.class);
 136         rpcManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 137     }
 138
 139     @Test
 140     public void testOnDeviceContextLevelUpMaster() throws Exception {
 141         rpcManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 142         verify(deviceINitializationPhaseHandler).onDeviceContextLevelUp(deviceInfo, lifecycleService);
 143     }
 144
 145     @Test
 146     public void testOnDeviceContextLevelUpSlave() throws Exception {
 147         rpcManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 148         verify(deviceINitializationPhaseHandler).onDeviceContextLevelUp(deviceInfo, lifecycleService);
 149     }
 150
 151     @Test
 152     public void testOnDeviceContextLevelUpOther() throws Exception {
 153         rpcManager.onDeviceContextLevelUp(deviceInfo, lifecycleService);
 154         verify(deviceINitializationPhaseHandler).onDeviceContextLevelUp(deviceInfo, lifecycleService);
 155     }
 156
 157     @Test
 158     public void testOnDeviceContextLevelDown() throws Exception {
 159         rpcManager.onDeviceContextLevelDown(deviceInfo);
 160         verify(deviceTerminationPhaseHandler).onDeviceContextLevelDown(deviceInfo);
 161     }
 162
 163     /**
 164      * On non null context close and onDeviceContextLevelDown should be called
 165      */
 166     @Test
 167     public void onDeviceContextLevelDown1() {
 168         rpcManager.addRecordToContexts(deviceInfo, removedContexts);
 169         rpcManager.onDeviceContextLevelDown(deviceInfo);
 170         verify(removedContexts,times(1)).close();
 171         verify(deviceTerminationPhaseHandler,times(1)).onDeviceContextLevelDown(deviceInfo);
 172     }
 173
 174
 175     /**
 176      * On null context only onDeviceContextLevelDown should be called
 177      */
 178     @Test
 179     public void onDeviceContextLevelDown2() {
 180         rpcManager.onDeviceContextLevelDown(deviceInfo);
 181         verify(removedContexts,never()).close();
 182         verify(deviceTerminationPhaseHandler,times(1)).onDeviceContextLevelDown(deviceInfo);
 183
 184     }
 185
 186     @Test
 187     public void close() {
 188         rpcManager.addRecordToContexts(deviceInfo,removedContexts);
 189         rpcManager.close();
 190         verify(removedContexts,atLeastOnce()).close();
 191     }
 192 }