openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/services/ServiceMocking.java

   1 package org.opendaylight.openflowplugin.impl.services;
   2
   3 import static org.mockito.Mockito.when;
   4 import com.google.common.util.concurrent.Futures;
   5 import com.google.common.util.concurrent.ListenableFuture;
   6 import java.math.BigInteger;
   7 import java.util.List;
   8 import org.junit.Before;
   9 import org.junit.runner.RunWith;
  10 import org.mockito.Matchers;
  11 import org.mockito.Mock;
  12 import org.mockito.runners.MockitoJUnitRunner;
  13 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  14 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  15 import org.opendaylight.openflowplugin.api.OFConstants;
  16 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  17 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  18 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  19 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  20 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  21 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  22 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  23 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  24 import org.opendaylight.openflowplugin.impl.device.DeviceContextImpl;
  25 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.common.RpcResult;
  36 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  37
  38 @RunWith(MockitoJUnitRunner.class)
  39 public abstract class ServiceMocking {
  40     private static final BigInteger DUMMY_DATAPATH_ID = new BigInteger("444");
  41     private static final Short DUMMY_VERSION = OFConstants.OFP_VERSION_1_3;
  42     private static final Long DUMMY_XID_VALUE = 2121L;
  43     private static final Xid DUMMY_XID = new Xid(DUMMY_XID_VALUE);
  44
  45     protected static final String DUMMY_NODE_ID = "dummyNodeID";
  46     private static final KeyedInstanceIdentifier<Node, NodeKey> NODE_II
  47             = InstanceIdentifier.create(Nodes.class).child(Node.class, new NodeKey(new NodeId(DUMMY_NODE_ID)));
  48
  49
  50     @Mock
  51     protected RequestContextStack mockedRequestContextStack;
  52     @Mock
  53     protected ConnectionContext mockedPrimConnectionContext;
  54     @Mock
  55     protected FeaturesReply mockedFeatures;
  56     @Mock
  57     protected GetFeaturesOutput mockedFeaturesOutput;
  58     @Mock
  59     protected ConnectionAdapter mockedConnectionAdapter;
  60     @Mock
  61     protected MessageSpy mockedMessagSpy;
  62     @Mock
  63     protected DeviceContextImpl mockedDeviceContext;
  64     @Mock
  65     protected DeviceState mockedDeviceState;
  66     @Mock
  67     protected DeviceInitializationPhaseHandler mockedDevicePhaseHandler;
  68     @Mock
  69     protected RequestContext mockedRequestContext;
  70     @Mock
  71     protected OutboundQueue mockedOutboundQueue;
  72     @Mock
  73     protected MultiMsgCollector multiMessageCollector;
  74
  75     @Before
  76     public void initialization() {
  77         when(mockedRequestContextStack.createRequestContext()).thenReturn(mockedRequestContext);
  78         when(mockedRequestContext.getXid()).thenReturn(DUMMY_XID);
  79
  80         when(mockedFeatures.getDatapathId()).thenReturn(DUMMY_DATAPATH_ID);
  81         when(mockedFeatures.getVersion()).thenReturn(DUMMY_VERSION);
  82
  83         when(mockedFeaturesOutput.getDatapathId()).thenReturn(DUMMY_DATAPATH_ID);
  84         when(mockedFeaturesOutput.getVersion()).thenReturn(DUMMY_VERSION);
  85
  86         when(mockedPrimConnectionContext.getFeatures()).thenReturn(mockedFeatures);
  87         when(mockedPrimConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
  88         when(mockedPrimConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.WORKING);
  89         when(mockedPrimConnectionContext.getOutboundQueueProvider()).thenReturn(mockedOutboundQueue);
  90
  91         when(mockedDeviceState.getNodeInstanceIdentifier()).thenReturn(NODE_II);
  92         when(mockedDeviceState.getFeatures()).thenReturn(mockedFeaturesOutput);
  93
  94         when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockedPrimConnectionContext);
  95         when(mockedDeviceContext.getMessageSpy()).thenReturn(mockedMessagSpy);
  96         when(mockedDeviceContext.getDeviceFlowRegistry()).thenReturn(new DeviceFlowRegistryImpl());
  97         when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
  98         when(mockedDeviceContext.getMultiMsgCollector(Matchers.<RequestContext<List<MultipartReply>>>any())).thenReturn(multiMessageCollector);
  99
 100         setup();
 101     }
 102
 103     protected void setup() {
 104         //NOOP - to be overloaded
 105     }
 106
 107
 108     protected  <T> void mockSuccessfulFuture() {
 109         ListenableFuture<RpcResult<T>> dummySuccessfulFuture = Futures.immediateFuture(RpcResultBuilder.success((T) null).build());
 110         when(mockedRequestContext.getFuture()).thenReturn(dummySuccessfulFuture);
 111     }
 112
 113 }