-/**
- * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
+/*
+ *
+ * * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
+ * *
+ * * This program and the accompanying materials are made available under the
+ * * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * * and is available at http://www.eclipse.org/legal/epl-v10.html
+ *
*
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
*/
+
package org.opendaylight.openflowplugin.impl.device;
-import org.junit.After;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.doThrow;
+import static org.mockito.Mockito.inOrder;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.FutureCallback;
+import java.lang.reflect.Field;
+import java.math.BigInteger;
+import java.util.Collections;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.TimeUnit;
+
+import com.google.common.util.concurrent.Futures;
+import io.netty.util.TimerTask;
import org.junit.Assert;
import org.junit.Before;
-import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
-import org.mockito.ArgumentCaptor;
+import org.mockito.InOrder;
+import org.mockito.Matchers;
import org.mockito.Mock;
import org.mockito.Mockito;
+import org.mockito.invocation.InvocationOnMock;
import org.mockito.runners.MockitoJUnitRunner;
+import org.mockito.stubbing.Answer;
+import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
+import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
+import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
+import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
+import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandler;
+import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
+import org.opendaylight.openflowplugin.api.OFConstants;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.rpc.RpcManager;
+import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
+import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
+import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
+import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
+import org.opendaylight.openflowplugin.openflow.md.util.OpenflowPortsUtil;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCase;
-
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.features.reply.PhyPortBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
-/**
- * test of {@link DeviceManagerImpl} - lightweight version, using basic ways (TDD)
- */
@RunWith(MockitoJUnitRunner.class)
public class DeviceManagerImplTest {
- private DeviceManagerImpl deviceManager;
+ private static final long TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA = 2000l;
+ private static final int barrierCountLimit = 25600;
+ private static final int barrierIntervalNanos = 500;
+
+ @Mock
+ CheckedFuture<Void, TransactionCommitFailedException> mockedFuture;
+ @Mock
+ private FeaturesReply mockFeatures;
+ @Mock
+ private OutboundQueue outboundQueueProvider;
+ @Mock
+ private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
@Mock
- private ConnectionContext connectionContext;
+ private DeviceTerminationPhaseHandler deviceTerminationPhaseHandler;
@Mock
- private ConnectionAdapter connectionAdapter;
+ private TranslatorLibrary translatorLibrary;
@Mock
- private FeaturesReply features;
+ private ConnectionContext mockConnectionContext;
@Mock
- private DataBroker dataBroker;
+ private ConnectionAdapter mockedConnectionAdapter;
@Mock
- private RpcManager rpcManager;
+ private DeviceContextImpl mockedDeviceContext;
@Mock
- private WriteTransaction wTx;
+ private NodeId mockedNodeId;
+ @Mock
+ private LifecycleConductor lifecycleConductor;
@Mock
private MessageIntelligenceAgency messageIntelligenceAgency;
- /**
- * @throws java.lang.Exception
- */
@Before
public void setUp() throws Exception {
- Mockito.when(connectionContext.getConnectionAdapter()).thenReturn(connectionAdapter);
- Mockito.when(connectionContext.getFeatures()).thenReturn(features);
- Mockito.when(features.getVersion()).thenReturn((short) 42);
- Mockito.when(dataBroker.newWriteOnlyTransaction()).thenReturn(wTx);
- deviceManager = new DeviceManagerImpl(dataBroker, messageIntelligenceAgency);
+ OpenflowPortsUtil.init();
+
+ when(mockConnectionContext.getNodeId()).thenReturn(new NodeId("dummyNodeId"));
+ when(mockConnectionContext.getFeatures()).thenReturn(mockFeatures);
+ when(mockConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
+ when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockConnectionContext);
+
+ final Capabilities capabilitiesV13 = mock(Capabilities.class);
+ final CapabilitiesV10 capabilitiesV10 = mock(CapabilitiesV10.class);
+ when(mockFeatures.getCapabilities()).thenReturn(capabilitiesV13);
+ when(mockFeatures.getCapabilitiesV10()).thenReturn(capabilitiesV10);
+ when(mockFeatures.getDatapathId()).thenReturn(BigInteger.valueOf(21L));
+
+ when(lifecycleConductor.getMessageIntelligenceAgency()).thenReturn(messageIntelligenceAgency);
}
- /**
- * @throws java.lang.Exception
- */
- @After
- public void tearDown() throws Exception {
+ @Test(expected = IllegalStateException.class)
+ public void onDeviceContextLevelUpFailTest() throws Exception {
+ onDeviceContextLevelUp(true);
}
- /**
- * Test method for {@link org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl#deviceConnected(org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext)}.
- */
@Test
- @Ignore // FIXME : fix the test ASAP
- public void testDeviceConnected() {
- deviceManager.deviceConnected(connectionContext);
+ public void onDeviceContextLevelUpSuccessTest() throws Exception {
+ onDeviceContextLevelUp(false);
+ }
+
+ private DeviceManagerImpl prepareDeviceManager() {
+ return prepareDeviceManager(false);
+ }
+
+ private DeviceManagerImpl prepareDeviceManager(final boolean withException) {
+ final DataBroker mockedDataBroker = mock(DataBroker.class);
+ final WriteTransaction mockedWriteTransaction = mock(WriteTransaction.class);
+
+ final BindingTransactionChain mockedTxChain = mock(BindingTransactionChain.class);
+ final WriteTransaction mockedWTx = mock(WriteTransaction.class);
+ when(mockedTxChain.newWriteOnlyTransaction()).thenReturn(mockedWTx);
+ when(mockedDataBroker.createTransactionChain(any(TransactionChainListener.class))).thenReturn
+ (mockedTxChain);
+ when(mockedDataBroker.newWriteOnlyTransaction()).thenReturn(mockedWriteTransaction);
+
+ when(mockedWriteTransaction.submit()).thenReturn(mockedFuture);
+
+ final DeviceManagerImpl deviceManager = new DeviceManagerImpl(mockedDataBroker,
+ TEST_VALUE_GLOBAL_NOTIFICATION_QUOTA, false, barrierIntervalNanos, barrierCountLimit, lifecycleConductor);
- final ArgumentCaptor<MultipartRequestInput> mpInputCaptor = ArgumentCaptor.forClass(MultipartRequestInput.class);
- Mockito.verify(connectionAdapter).multipartRequest(mpInputCaptor.capture());
+ deviceManager.setDeviceInitializationPhaseHandler(deviceInitPhaseHandler);
+ deviceManager.setDeviceTerminationPhaseHandler(deviceTerminationPhaseHandler);
- Assert.assertTrue(mpInputCaptor.getAllValues().get(0).getMultipartRequestBody() instanceof MultipartRequestDescCase);
- //Assert.assertTrue(mpInputCaptor.getAllValues().get(1).getMultipartRequestBody() instanceof MultipartRequestGroupDescCase);
+ return deviceManager;
+ }
+
+ public void onDeviceContextLevelUp(final boolean withException) throws Exception {
+ final DeviceManagerImpl deviceManager = prepareDeviceManager(withException);
+ final DeviceState mockedDeviceState = mock(DeviceState.class);
+ when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
+ when(mockedDeviceState.getNodeId()).thenReturn(mockedNodeId);
+
+ if (withException) {
+ doThrow(new IllegalStateException("dummy")).when(mockedDeviceContext).initialSubmitTransaction();
+ }
+ deviceManager.addDeviceContextToMap(mockedNodeId, mockedDeviceContext);
+ deviceManager.onDeviceContextLevelUp(mockedDeviceContext.getDeviceState().getNodeId());
+ if (withException) {
+ verify(mockedDeviceContext).close();
+ } else {
+ verify(mockedDeviceContext).initialSubmitTransaction();
+ verify(mockedDeviceContext).onPublished();
+ }
}
- /**
- * Test method for {@link org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl#sendMessage(org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.openflowplugin.api.openflow.device.RequestContext)}.
- */
@Test
- public void testSendMessage() {
+ public void deviceConnectedTest() throws Exception{
+ final DeviceManagerImpl deviceManager = prepareDeviceManager();
+ injectMockTranslatorLibrary(deviceManager);
+ final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
+
+ deviceManager.deviceConnected(mockConnectionContext);
+
+ final InOrder order = inOrder(mockConnectionContext);
+ order.verify(mockConnectionContext).getFeatures();
+ order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
+ order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
+ Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
+ order.verify(mockConnectionContext).getNodeId();
+ verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<NodeId>any());
}
- /**
- * Test method for {@link org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl#sendRequest(org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.openflowplugin.api.openflow.device.RequestContext)}.
- */
@Test
- public void testSendRequest() {
+ public void deviceConnectedV10Test() throws Exception{
+ final DeviceManagerImpl deviceManager = prepareDeviceManager();
+ injectMockTranslatorLibrary(deviceManager);
+ final ConnectionContext mockConnectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_0);
+
+ final PhyPortBuilder phyPort = new PhyPortBuilder()
+ .setPortNo(41L);
+ when(mockFeatures.getPhyPort()).thenReturn(Collections.singletonList(phyPort.build()));
+ final MessageTranslator<Object, Object> mockedTranslator = mock(MessageTranslator.class);
+ when(mockedTranslator.translate(Matchers.<Object>any(), Matchers.<DeviceState>any(), Matchers.any()))
+ .thenReturn(null);
+ when(translatorLibrary.lookupTranslator(Matchers.<TranslatorKey>any())).thenReturn(mockedTranslator);
+
+ deviceManager.deviceConnected(mockConnectionContext);
+
+ final InOrder order = inOrder(mockConnectionContext);
+ order.verify(mockConnectionContext).getFeatures();
+ order.verify(mockConnectionContext).setOutboundQueueProvider(any(OutboundQueueProvider.class));
+ order.verify(mockConnectionContext).setOutboundQueueHandleRegistration(
+ Mockito.<OutboundQueueHandlerRegistration<OutboundQueueProvider>>any());
+ order.verify(mockConnectionContext).getNodeId();
+ verify(deviceInitPhaseHandler).onDeviceContextLevelUp(Matchers.<NodeId>any());
}
- /**
- * Test method for {@link org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl#addRequestContextReadyHandler(org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextReadyHandler)}.
- */
@Test
- public void testAddRequestContextReadyHandler() {
+ public void deviceDisconnectedTest() throws Exception {
+ final DeviceState deviceState = mock(DeviceState.class);
+
+ final DeviceManagerImpl deviceManager = prepareDeviceManager();
+ injectMockTranslatorLibrary(deviceManager);
+
+ final ConnectionContext connectionContext = buildMockConnectionContext(OFConstants.OFP_VERSION_1_3);
+ when(connectionContext.getNodeId()).thenReturn(mockedNodeId);
+
+ final DeviceContext deviceContext = mock(DeviceContext.class);
+ when(deviceContext.shuttingDownDataStoreTransactions()).thenReturn(Futures.immediateCheckedFuture(null));
+ when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionContext);
+ when(deviceContext.getDeviceState()).thenReturn(deviceState);
+
+ final ConcurrentHashMap<NodeId, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
+ deviceContexts.put(mockedNodeId, deviceContext);
+
+ deviceManager.onDeviceDisconnected(connectionContext);
+
+ verify(lifecycleConductor).newTimeout(Mockito.<TimerTask>any(), Mockito.anyLong(), Mockito.<TimeUnit>any());
+ }
+
+ protected ConnectionContext buildMockConnectionContext(final short ofpVersion) {
+ when(mockFeatures.getVersion()).thenReturn(ofpVersion);
+ when(outboundQueueProvider.reserveEntry()).thenReturn(43L);
+ Mockito.doAnswer(new Answer<Void>() {
+ @Override
+ public Void answer(final InvocationOnMock invocation) throws Throwable {
+ final FutureCallback<OfHeader> callBack = (FutureCallback<OfHeader>) invocation.getArguments()[2];
+ callBack.onSuccess(null);
+ return null;
+ }
+ })
+ .when(outboundQueueProvider)
+ .commitEntry(Matchers.anyLong(), Matchers.<MultipartRequestInput>any(), Matchers.<FutureCallback<OfHeader>>any());
+
+ when(mockedConnectionAdapter.registerOutboundQueueHandler(Matchers.<OutboundQueueHandler>any(), Matchers.anyInt(), Matchers.anyLong()))
+ .thenAnswer(new Answer<OutboundQueueHandlerRegistration<OutboundQueueHandler>>() {
+ @Override
+ public OutboundQueueHandlerRegistration<OutboundQueueHandler> answer(final InvocationOnMock invocation) throws Throwable {
+ final OutboundQueueHandler handler = (OutboundQueueHandler) invocation.getArguments()[0];
+ handler.onConnectionQueueChanged(outboundQueueProvider);
+ return null;
+ }
+ });
+
+ when(mockConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueueProvider);
+ return mockConnectionContext;
+ }
+
+ private void injectMockTranslatorLibrary(final DeviceManagerImpl deviceManager) {
+ deviceManager.setTranslatorLibrary(translatorLibrary);
}
@Test
- public void testHookRequest() {
+ public void testClose() throws Exception {
+ final DeviceContext deviceContext = mock(DeviceContext.class);
+ final DeviceManagerImpl deviceManager = prepareDeviceManager();
+ final ConcurrentHashMap<NodeId, DeviceContext> deviceContexts = getContextsCollection(deviceManager);
+ deviceContexts.put(mockedNodeId, deviceContext);
+ Assert.assertEquals(1, deviceContexts.size());
+
+ deviceManager.close();
+
+ verify(deviceContext).shutdownConnection();
+ verify(deviceContext, Mockito.never()).close();
+ }
+ private static ConcurrentHashMap<NodeId, DeviceContext> getContextsCollection(final DeviceManagerImpl deviceManager) throws NoSuchFieldException, IllegalAccessException {
+ // HACK: contexts collection for testing shall be accessed in some more civilized way
+ final Field contextsField = DeviceManagerImpl.class.getDeclaredField("deviceContexts");
+ Assert.assertNotNull(contextsField);
+ contextsField.setAccessible(true);
+ return (ConcurrentHashMap<NodeId, DeviceContext>) contextsField.get(deviceManager);
}
}
Code Review / openflowplugin.git / blobdiff