Switch to MD-SAL APIs
[openflowplugin.git] / openflowplugin-impl / src / test / java / org / opendaylight / openflowplugin / impl / statistics / StatisticsManagerImplTest.java
index e210793a821ec90555bd7bc6ff32d2a14bdb22fd..ac53e5a2c82de1b75d38075e523af3fc2221ae3b 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -7,49 +7,39 @@
  */
 package org.opendaylight.openflowplugin.impl.statistics;
 
-import static org.mockito.Mockito.times;
+import static org.junit.Assert.assertNotNull;
+import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-import com.google.common.util.concurrent.Futures;
+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.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 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.ArgumentCaptor;
-import org.mockito.Captor;
-import org.mockito.Matchers;
+import org.mockito.ArgumentMatchers;
 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.mockito.junit.MockitoJUnitRunner;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.RpcProviderService;
 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.RequestContext;
-import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
-import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
-import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
-import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
+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;
@@ -57,19 +47,19 @@ 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 org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
 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.concepts.ObjectRegistration;
 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import io.netty.util.HashedWheelTimer;
-import io.netty.util.Timeout;
-
 
 @RunWith(MockitoJUnitRunner.class)
 public class StatisticsManagerImplTest {
@@ -93,23 +83,19 @@ public class StatisticsManagerImplTest {
     @Mock
     private DeviceInfo mockedDeviceInfo;
     @Mock
-    private DeviceTerminationPhaseHandler mockedTerminationPhaseHandler;
-    @Mock
-    private RpcProviderRegistry rpcProviderRegistry;
+    private RpcProviderService rpcProviderRegistry;
     @Mock
     private OutboundQueue outboundQueue;
     @Mock
     private MultiMsgCollector multiMagCollector;
     @Mock
-    private ItemLifeCycleRegistry itemLifeCycleRegistry;
-    @Captor
-    private ArgumentCaptor<ItemLifecycleListener> itemLifeCycleListenerCapt;
-    @Mock
-    private BindingAwareBroker.RpcRegistration<StatisticsManagerControlService> serviceControlRegistration;
+    private ObjectRegistration<StatisticsManagerControlService> serviceControlRegistration;
     @Mock
     private DeviceInfo deviceInfo;
     @Mock
     private DataBroker dataBroker;
+    @Mock
+    private ReconciliationFrameworkRegistrar reconciliationFrameworkRegistrar;
 
     private RequestContext<List<MultipartReply>> currentRequestContext;
     private StatisticsManagerImpl statisticsManager;
@@ -121,94 +107,49 @@ public class StatisticsManagerImplTest {
                 .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(OFConstants.OFP_VERSION_1_3, dataBroker, nodePath));
-        when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
-        when(mockedDeviceContext.getMultiMsgCollector(
-                Matchers.<RequestContext<List<MultipartReply>>>any())).thenAnswer(
-                invocation -> {
-                    currentRequestContext = (RequestContext<List<MultipartReply>>) invocation.getArguments()[0];
-                    return multiMagCollector;
-                }
-        );
-        when(mockedDeviceContext.getItemLifeCycleSourceRegistry()).thenReturn(itemLifeCycleRegistry);
-        when(rpcProviderRegistry.addRpcImplementation(
-                Matchers.eq(StatisticsManagerControlService.class),
-                Matchers.<StatisticsManagerControlService>any())).thenReturn(serviceControlRegistration);
+        when(rpcProviderRegistry.registerRpcImplementation(
+                eq(StatisticsManagerControlService.class),
+                ArgumentMatchers.any())).thenReturn(serviceControlRegistration);
 
         final ConvertorManager convertorManager = ConvertorManagerFactory.createDefaultManager();
         final long basicTimerDelay = 3000L;
         final long maximumTimerDelay = 900000L;
-        statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, false, new HashedWheelTimer(),
-                convertorManager, basicTimerDelay, maximumTimerDelay);
-    }
 
-    @Test
-    public void testOnDeviceContextClosed() throws Exception {
-        final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
-        final Map<DeviceInfo, StatisticsContext> contextsMap = getContextsMap(statisticsManager);
-
-        contextsMap.put(deviceInfo, statisticContext);
-        Assert.assertEquals(1, contextsMap.size());
-
-        statisticsManager.setDeviceTerminationPhaseHandler(mockedTerminationPhaseHandler);
-        statisticsManager.onDeviceContextLevelDown(deviceInfo);
-        verify(statisticContext).close();
-        verify(mockedTerminationPhaseHandler).onDeviceContextLevelDown(deviceInfo);
-        Assert.assertEquals(1, contextsMap.size());
+        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");
-        Assert.assertNotNull(contextsField);
+        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();
+        final Future<RpcResult<GetStatisticsWorkModeOutput>> workMode = statisticsManager.getStatisticsWorkMode(null);
         Assert.assertTrue(workMode.isDone());
         Assert.assertTrue(workMode.get().isSuccessful());
-        Assert.assertNotNull(workMode.get().getResult());
+        assertNotNull(workMode.get().getResult());
         Assert.assertEquals(StatisticsWorkMode.COLLECTALL, workMode.get().getResult().getMode());
     }
 
     /**
-     * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry
+     * switching to {@link StatisticsWorkMode#FULLYDISABLED}; no pollTimeout and no lifecycleRegistry.
      *
-     * @throws Exception
      */
     @Test
     public void testChangeStatisticsWorkMode1() throws Exception {
         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
-        when(statisticContext.getPollTimeout()).thenReturn(
-                Optional.<Timeout>empty());
-        when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
-                Collections.<ItemLifeCycleSource>emptyList());
-
-        when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
-        when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
 
         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 
@@ -216,103 +157,69 @@ public class StatisticsManagerImplTest {
                 new ChangeStatisticsWorkModeInputBuilder()
                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 
-        final Future<RpcResult<Void>> workMode = statisticsManager
+        final ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode = statisticsManager
                 .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
 
         checkWorkModeChangeOutcome(workMode);
-        verify(itemLifeCycleRegistry).getLifeCycleSources();
-        verify(statisticContext).getPollTimeout();
+        verify(statisticContext).disableGathering();
     }
 
-    private static void checkWorkModeChangeOutcome(Future<RpcResult<Void>> workMode) throws InterruptedException, ExecutionException {
+    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
+     * Switching to {@link StatisticsWorkMode#FULLYDISABLED}; with pollTimeout and lifecycleRegistry.
      *
-     * @throws Exception
      */
     @Test
     public void testChangeStatisticsWorkMode2() throws Exception {
-        final Timeout pollTimeout = Mockito.mock(Timeout.class);
-        final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
-        when(statisticContext.getPollTimeout()).thenReturn(
-                Optional.of(pollTimeout));
-        when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
-                Collections.singletonList(itemLifecycleSource));
 
         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 
-        when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
-        when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
-//        when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
-
         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
                 new ChangeStatisticsWorkModeInputBuilder()
                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 
-        Future<RpcResult<Void>> workMode = statisticsManager.changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
+        ListenableFuture<RpcResult<ChangeStatisticsWorkModeOutput>> workMode = statisticsManager
+            .changeStatisticsWorkMode(changeStatisticsWorkModeInputBld.build());
         checkWorkModeChangeOutcome(workMode);
 
-        verify(itemLifeCycleRegistry).getLifeCycleSources();
-        verify(statisticContext).getPollTimeout();
-        verify(pollTimeout).cancel();
-        verify(itemLifecycleSource).setItemLifecycleListener(Matchers.<ItemLifecycleListener>any());
+        verify(statisticContext).disableGathering();
     }
 
     /**
-     * switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
-     * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout
+     * Tests switching to {@link StatisticsWorkMode#FULLYDISABLED} and back
+     * to {@link StatisticsWorkMode#COLLECTALL}; with lifecycleRegistry and pollTimeout.
      *
-     * @throws Exception
      */
     @Test
     public void testChangeStatisticsWorkMode3() throws Exception {
-        final Timeout pollTimeout = Mockito.mock(Timeout.class);
-        final ItemLifeCycleSource itemLifecycleSource = Mockito.mock(ItemLifeCycleSource.class);
-        Mockito.doNothing().when(itemLifecycleSource)
-                .setItemLifecycleListener(itemLifeCycleListenerCapt.capture());
-
         final StatisticsContext statisticContext = Mockito.mock(StatisticsContext.class);
-        when(statisticContext.getPollTimeout()).thenReturn(
-                Optional.of(pollTimeout));
-        when(statisticContext.getItemLifeCycleListener()).thenReturn(
-                Mockito.mock(ItemLifecycleListener.class));
-        when(itemLifeCycleRegistry.getLifeCycleSources()).thenReturn(
-                Collections.singletonList(itemLifecycleSource));
 
         getContextsMap(statisticsManager).put(deviceInfo, statisticContext);
 
-        when(statisticContext.gainDeviceContext()).thenReturn(mockedDeviceContext);
-        when(statisticContext.gainDeviceState()).thenReturn(mockedDeviceState);
-//        when(lifecycleService.getDeviceContext()).thenReturn(mockedDeviceContext);
-
         final ChangeStatisticsWorkModeInputBuilder changeStatisticsWorkModeInputBld =
                 new ChangeStatisticsWorkModeInputBuilder()
                         .setMode(StatisticsWorkMode.FULLYDISABLED);
 
-        Future<RpcResult<Void>> workMode;
+        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(itemLifeCycleRegistry, times(2)).getLifeCycleSources();
-        verify(statisticContext).getPollTimeout();
-        verify(pollTimeout).cancel();
-
-        final List<ItemLifecycleListener> itemLifeCycleListenerValues = itemLifeCycleListenerCapt.getAllValues();
-        Assert.assertEquals(2, itemLifeCycleListenerValues.size());
-        Assert.assertNotNull(itemLifeCycleListenerValues.get(0));
-        Assert.assertNull(itemLifeCycleListenerValues.get(1));
+        verify(statisticContext).enableGathering();
     }
 
     @Test
@@ -320,37 +227,4 @@ public class StatisticsManagerImplTest {
         statisticsManager.close();
         verify(serviceControlRegistration).close();
     }
-
-    @Test
-    public void testCalculateTimerDelay() throws Exception {
-        final TimeCounter timeCounter = Mockito.mock(TimeCounter.class);
-        when(timeCounter.getAverageTimeBetweenMarks()).thenReturn(2000L, (Long)4000L);
-        statisticsManager.calculateTimerDelay(timeCounter);
-        Assert.assertEquals(3000L, statisticsManager.getCurrentTimerDelay());
-        statisticsManager.calculateTimerDelay(timeCounter);
-        Assert.assertEquals(6000L, statisticsManager.getCurrentTimerDelay());
-    }
-
-    @Test
-    public void testPollStatistics() throws Exception {
-        final StatisticsContext statisticsContext = Mockito.mock(StatisticsContext.class);
-        final TimeCounter mockTimerCounter = Mockito.mock(TimeCounter.class);
-
-        statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
-        verify(mockedDeviceContext).getDeviceState();
-
-        statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
-
-        statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
-
-        when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateCheckedFuture(Boolean.TRUE));
-        when(statisticsContext.isSchedulingEnabled()).thenReturn(Boolean.TRUE);
-        statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
-        verify(mockTimerCounter).markStart();
-        verify(mockTimerCounter).addTimeMark();
-
-        when(statisticsContext.gatherDynamicData()).thenReturn(Futures.immediateFailedFuture(new Throwable("error msg")));
-        statisticsManager.pollStatistics(mockedDeviceContext.getDeviceState(), statisticsContext, mockTimerCounter, mockedDeviceInfo);
-        verify(mockTimerCounter,times(2)).addTimeMark();
-    }
 }