Fix opendaylight-flow-types.yang cases
[openflowplugin.git] / openflowplugin-impl / src / test / java / org / opendaylight / openflowplugin / impl / statistics / StatisticsManagerImplTest.java
index eeae62c67e9e9d83bd3c7229376e426df4efa524..719e35d2d13631cefcbf9728a3147dfbdcddde25 100644 (file)
+/**
+ * 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
+ */
 package org.opendaylight.openflowplugin.impl.statistics;
 
-import io.netty.util.HashedWheelTimer;
-import junit.framework.TestCase;
+import static org.junit.Assert.assertNotNull;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.lang.reflect.Field;
+import java.math.BigInteger;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.Matchers;
 import org.mockito.Mock;
+import org.mockito.Mockito;
 import org.mockito.runners.MockitoJUnitRunner;
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
+import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
+import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
 import org.opendaylight.openflowplugin.api.OFConstants;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
-import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
+import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.ReconciliationFrameworkRegistrar;
+import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
+import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
+import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
-
-import java.math.BigInteger;
-
-import static org.mockito.Matchers.eq;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.when;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfigBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.ChangeStatisticsWorkModeOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.GetStatisticsWorkModeOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsManagerControlService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.sm.control.rev150812.StatisticsWorkMode;
+import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 
 @RunWith(MockitoJUnitRunner.class)
-public class StatisticsManagerImplTest extends TestCase {
+public class StatisticsManagerImplTest {
+
+    private static final Logger LOG = LoggerFactory.getLogger(StatisticsManagerImplTest.class);
 
-    private static final BigInteger DUMMY_DATAPATH_ID = new BigInteger("444");
-    private static final Short DUMMY_VERSION = OFConstants.OFP_VERSION_1_3;
+    public static final NodeId NODE_ID = new NodeId("ofp-unit-dummy-node-id");
 
     @Mock
-    RequestContextStack mockedRequestContextStack;
+    private ConnectionContext mockedPrimConnectionContext;
+    @Mock
+    private FeaturesReply mockedFeatures;
+    @Mock
+    private ConnectionAdapter mockedConnectionAdapter;
+    @Mock
+    private MessageSpy mockedMessagSpy;
     @Mock
-    ConnectionContext mockedPrimConnectionContext;
+    private DeviceContext mockedDeviceContext;
     @Mock
-    FeaturesReply mockedFeatures;
+    private DeviceState mockedDeviceState;
     @Mock
-    ConnectionAdapter mockedConnectionAdapter;
+    private DeviceInfo mockedDeviceInfo;
     @Mock
-    MessageSpy mockedMessagSpy;
+    private RpcProviderRegistry rpcProviderRegistry;
     @Mock
-    DeviceContext mockedDeviceContext;
+    private OutboundQueue outboundQueue;
     @Mock
-    DeviceState mockedDeviceState;
+    private MultiMsgCollector multiMagCollector;
     @Mock
-    DeviceInitializationPhaseHandler mockedDevicePhaseHandler;
+    private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> serviceControlRegistration;
+    @Mock
+    private DeviceInfo deviceInfo;
+    @Mock
+    private DataBroker dataBroker;
+    @Mock
+    private ReconciliationFrameworkRegistrar reconciliationFrameworkRegistrar;
+
+    private RequestContext<List<MultipartReply>> currentRequestContext;
+    private StatisticsManagerImpl statisticsManager;
+
 
     @Before
     public void initialization() {
-        when(mockedFeatures.getDatapathId()).thenReturn(DUMMY_DATAPATH_ID);
-        when(mockedFeatures.getVersion()).thenReturn(DUMMY_VERSION);
+        final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
+                .create(Nodes.class)
+                .child(Node.class, new NodeKey(new NodeId("openflow:10")));
 
         when(mockedPrimConnectionContext.getFeatures()).thenReturn(mockedFeatures);
         when(mockedPrimConnectionContext.getConnectionAdapter()).thenReturn(mockedConnectionAdapter);
         when(mockedPrimConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.WORKING);
+        when(mockedPrimConnectionContext.getNodeId()).thenReturn(NODE_ID);
+        when(mockedPrimConnectionContext.getOutboundQueueProvider()).thenReturn(outboundQueue);
+
+        when(mockedDeviceState.isFlowStatisticsAvailable()).thenReturn(Boolean.TRUE);
+        when(mockedDeviceState.isGroupAvailable()).thenReturn(Boolean.TRUE);
+        when(mockedDeviceState.isMetersAvailable()).thenReturn(Boolean.TRUE);
+        when(mockedDeviceState.isPortStatisticsAvailable()).thenReturn(Boolean.TRUE);
+        when(mockedDeviceState.isQueueStatisticsAvailable()).thenReturn(Boolean.TRUE);
+        when(mockedDeviceState.isTableStatisticsAvailable()).thenReturn(Boolean.TRUE);
+        when(mockedDeviceInfo.getNodeInstanceIdentifier()).thenReturn(nodePath);
+        when(mockedDeviceInfo.getDatapathId()).thenReturn(BigInteger.TEN);
+        when(mockedDeviceInfo.getNodeId()).thenReturn(NODE_ID);
 
+        when(mockedDeviceContext.getDeviceInfo()).thenReturn(mockedDeviceInfo);
         when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockedPrimConnectionContext);
         when(mockedDeviceContext.getMessageSpy()).thenReturn(mockedMessagSpy);
-        when(mockedDeviceContext.getDeviceFlowRegistry()).thenReturn(new DeviceFlowRegistryImpl());
+        when(mockedDeviceContext.getDeviceFlowRegistry())
+            .thenReturn(new DeviceFlowRegistryImpl(OFConstants.OFP_VERSION_1_3, dataBroker, nodePath));
         when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
-        when(mockedDeviceContext.getTimer()).thenReturn(mock(HashedWheelTimer.class));
+        when(mockedDeviceContext.getMultiMsgCollector(
+            Matchers.<RequestContext<List<MultipartReply>>>any())).thenAnswer(
+                invocation -> {
+                    currentRequestContext = (RequestContext<List<MultipartReply>>) invocation.getArguments()[0];
+                    return multiMagCollector;
+                });
+        when(rpcProviderRegistry.addRpcImplementation(
+                Matchers.eq(StatisticsManagerControlService.class),
+                Matchers.<StatisticsManagerControlService>any())).thenReturn(serviceControlRegistration);
+
+        final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
+        final long basicTimerDelay = 3000L;
+        final long maximumTimerDelay = 900000L;
+
+        statisticsManager = new StatisticsManagerImpl(
+                new OpenflowProviderConfigBuilder()
+                        .setBasicTimerDelay(new NonZeroUint32Type(basicTimerDelay))
+                        .setMaximumTimerDelay(new NonZeroUint32Type(maximumTimerDelay))
+                        .setIsStatisticsPollingOn(false)
+                        .build(), rpcProviderRegistry,
+                convertorManager,
+                MoreExecutors.newDirectExecutorService());
+    }
+
+    private static Map<DeviceInfo, StatisticsContext> getContextsMap(final StatisticsManagerImpl statisticsManager)
+            throws NoSuchFieldException, IllegalAccessException {
+        // HACK: contexts map for testing shall be accessed in some more civilized way
+        final Field contextsField = StatisticsManagerImpl.class.getDeclaredField("contexts");
+        assertNotNull(contextsField);
+        contextsField.setAccessible(true);
+        return (Map<DeviceInfo, StatisticsContext>) contextsField.get(statisticsManager);
+    }
+
+    @Test
+    public void testGetStatisticsWorkMode() throws Exception {
+        final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode(null);
+        Assert.assertTrue(workMode.isDone());
+        Assert.assertTrue(workMode.get().isSuccessful());
+        assertNotNull(workMode.get().getResult());
+        Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
     }
 
+    /**
+     * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry.
+     *
+     */
     @Test
-    public void testOnDeviceContextLevelUp() throws Exception {
-        final StatisticsManagerImpl statisticsManager = new StatisticsManagerImpl();
-        statisticsManager.setDeviceInitializationPhaseHandler(mockedDevicePhaseHandler);
-        statisticsManager.onDeviceContextLevelUp(mockedDeviceContext);
-        verify(mockedDeviceState).setDeviceSynchronized(eq(true));
+    public void testChangeStatisticsWorkMode1() throws Exception {
+        final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
 
-        statisticsManager.onDeviceContextClosed(mockedDeviceContext);
+        getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
+
+        final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
+                new ChangeStatisticsWorkModeInputBuilder()
+                        .setMode(StatisticsWorkMode.FULLYDISABLED);
+
+        final ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode = statisticsManager
+                .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
+
+        checkWorkModeChangeOutcome(workMode);
+        verify(statisticContext).disableGathering();
+    }
+
+    private static void checkWorkModeChangeOutcome(ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode)
+            throws InterruptedException, ExecutionException {
+        Assert.assertTrue(workMode.isDone());
+        Assert.assertTrue(workMode.get().isSuccessful());
+    }
+
+
+    /**
+     * Switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry.
+     *
+     */
+    @Test
+    public void testChangeStatisticsWorkMode2() throws Exception {
+        final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
+
+        getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
+
+        final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
+                new ChangeStatisticsWorkModeInputBuilder()
+                        .setMode(StatisticsWorkMode.FULLYDISABLED);
+
+        ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode = statisticsManager
+            .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
+        checkWorkModeChangeOutcome(workMode);
+
+        verify(statisticContext).disableGathering();
+    }
+
+    /**
+     * Tests switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
+     * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout.
+     *
+     */
+    @Test
+    public void testChangeStatisticsWorkMode3() throws Exception {
+        final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
+
+        getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
+
+        final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
+                new ChangeStatisticsWorkModeInputBuilder()
+                        .setMode(StatisticsWorkMode.FULLYDISABLED);
+
+        ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode;
+        workMode = statisticsManager.changeStatisticsWorkMode(
+                changeStatisticsWorkModeInputBld.build());
+        checkWorkModeChangeOutcome(workMode);
+
+        verify(statisticContext).disableGathering();
+
+        changeStatisticsWorkModeInputBld.setMode(StatisticsWorkMode.COLLECTALL);
+        workMode = statisticsManager.changeStatisticsWorkMode(
+                changeStatisticsWorkModeInputBld.build());
+        checkWorkModeChangeOutcome(workMode);
+
+        verify(statisticContext).enableGathering();
+    }
+
+    @Test
+    public void testClose() throws Exception {
+        statisticsManager.close();
+        verify(serviceControlRegistration).close();
     }
-}
\ No newline at end of file
+}