Merge "Ensure that statistics gathering is terminated"
[openflowplugin.git] / openflowplugin-impl / src / test / java / org / opendaylight / openflowplugin / impl / statistics / StatisticsContextImplTest.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
9 package org.opendaylight.openflowplugin.impl.statistics;
10
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.mockito.Mockito.times;
14 import static org.mockito.Mockito.verify;
15 import static org.mockito.Mockito.when;
16
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import java.util.Collections;
20 import java.util.concurrent.ExecutionException;
21 import org.junit.Assert;
22 import org.junit.Before;
23 import org.junit.Test;
24 import org.junit.runner.RunWith;
25 import org.mockito.Matchers;
26 import org.mockito.Mockito;
27 import org.mockito.runners.MockitoJUnitRunner;
28 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
29 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
30 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.EventIdentifier;
31 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProviderFactory;
32 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
33 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
36 import org.opendaylight.yangtools.yang.common.RpcResult;
37 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
40
41 @RunWith(MockitoJUnitRunner.class)
42 public class StatisticsContextImplTest extends StatisticsContextImpMockInitiation {
43
44     private static final Logger LOG = LoggerFactory.getLogger(StatisticsContextImplTest.class);
45
46     private static final Long TEST_XID = 55L;
47     private StatisticsContextImpl<MultipartReply> statisticsContext;
48     private ConvertorManager convertorManager;
49
50     @Before
51     public void setUp() throws Exception {
52         convertorManager = ConvertorManagerFactory.createDefaultManager();
53         when(mockedDeviceInfo.reserveXidForDeviceMessage()).thenReturn(TEST_XID);
54         Mockito.when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
55         initStatisticsContext();
56     }
57
58     private void initStatisticsContext() {
59         statisticsContext = new StatisticsContextImpl<MultipartReply>(
60                 true, mockedDeviceContext, convertorManager, mockedStatisticsManager,
61                 MultipartWriterProviderFactory.createDefaultProvider(mockedDeviceContext));
62
63         statisticsContext.setStatisticsGatheringService(mockedStatisticsGatheringService);
64         statisticsContext.setStatisticsGatheringOnTheFlyService(mockedStatisticsOnFlyGatheringService);
65     }
66
67     @Test
68     public void testCreateRequestContext() {
69         final RequestContext<Object> requestContext = statisticsContext.createRequestContext();
70         assertNotNull(requestContext);
71         assertEquals(TEST_XID, requestContext.getXid().getValue());
72         Assert.assertFalse(requestContext.getFuture().isDone());
73     }
74
75     /**
76      * There is nothing to check in close method
77      */
78     @Test
79     public void testClose() throws Exception {
80         final StatisticsContextImpl<MultipartReply> statisticsContext = new StatisticsContextImpl<MultipartReply>(
81                 true, mockedDeviceContext, convertorManager, mockedStatisticsManager,
82                 MultipartWriterProviderFactory.createDefaultProvider(mockedDeviceContext));
83
84         final RequestContext<Object> requestContext = statisticsContext.createRequestContext();
85         statisticsContext.close();
86         try {
87             Assert.assertTrue(requestContext.getFuture().isDone());
88             final RpcResult<?> rpcResult = requestContext.getFuture().get();
89             Assert.assertFalse(rpcResult.isSuccessful());
90             Assert.assertFalse(rpcResult.isSuccessful());
91         } catch (final Exception e) {
92             LOG.error("request future value should be finished", e);
93             Assert.fail("request context closing failed");
94         }
95     }
96
97     @Test
98     public void testGatherDynamicData_none() throws Exception {
99         final ListenableFuture<Boolean> gatheringResult = statisticsContext.gatherDynamicData();
100         Assert.assertTrue(gatheringResult.isDone());
101         Assert.assertTrue(gatheringResult.get());
102         Mockito.verifyNoMoreInteractions(mockedStatisticsGatheringService, mockedStatisticsOnFlyGatheringService);
103     }
104
105     @Test
106     public void testGatherDynamicData_all() throws Exception {
107         Mockito.reset(mockedDeviceState);
108         when(mockedDeviceState.isTableStatisticsAvailable()).thenReturn(Boolean.TRUE);
109         when(mockedDeviceState.isFlowStatisticsAvailable()).thenReturn(Boolean.TRUE);
110         when(mockedDeviceState.isGroupAvailable()).thenReturn(Boolean.TRUE);
111         when(mockedDeviceState.isMetersAvailable()).thenReturn(Boolean.TRUE);
112         when(mockedDeviceState.isPortStatisticsAvailable()).thenReturn(Boolean.TRUE);
113         when(mockedDeviceState.isQueueStatisticsAvailable()).thenReturn(Boolean.TRUE);
114         when(mockedDeviceInfo.getNodeInstanceIdentifier()).thenReturn(dummyNodeII);
115         initStatisticsContext();
116
117         when(mockedStatisticsGatheringService.getStatisticsOfType(Matchers.any(EventIdentifier.class), Matchers.any(MultipartType.class)))
118                 .thenReturn(
119                         Futures.immediateFuture(RpcResultBuilder.success(Collections.<MultipartReply>emptyList()).build())
120                 );
121         when(mockedStatisticsOnFlyGatheringService.getStatisticsOfType(Matchers.any(EventIdentifier.class), Matchers.any(MultipartType.class)))
122                 .thenReturn(
123                         Futures.immediateFuture(RpcResultBuilder.success(Collections.<MultipartReply>emptyList()).build())
124                 );
125
126         final ListenableFuture<Boolean> gatheringResult = statisticsContext.gatherDynamicData();
127         Assert.assertTrue(gatheringResult.isDone());
128         Assert.assertTrue(gatheringResult.get());
129         verify(mockedStatisticsGatheringService, times(7))
130                 .getStatisticsOfType(Matchers.any(EventIdentifier.class), Matchers.any(MultipartType.class));
131         verify(mockedStatisticsOnFlyGatheringService)
132                 .getStatisticsOfType(Matchers.any(EventIdentifier.class), Matchers.any(MultipartType.class));
133         Mockito.verifyNoMoreInteractions(mockedStatisticsGatheringService, mockedStatisticsOnFlyGatheringService);
134     }
135
136     @Test
137     public void testDeviceConnectionCheck_WORKING() throws Exception {
138         final ListenableFuture<Boolean> deviceConnectionCheckResult = statisticsContext.deviceConnectionCheck();
139         Assert.assertTrue(deviceConnectionCheckResult.get());
140     }
141
142     @Test
143     public void testDeviceConnectionCheck_RIP() throws Exception {
144         Mockito.reset(mockedConnectionContext);
145         when(mockedConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.RIP);
146         final ListenableFuture<Boolean> deviceConnectionCheckResult = statisticsContext.deviceConnectionCheck();
147
148         try {
149             deviceConnectionCheckResult.get();
150             Assert.fail("connection in state RIP should have caused exception here");
151         } catch (final Exception e) {
152             LOG.debug("expected behavior for RIP connection achieved");
153             Assert.assertTrue(e instanceof ExecutionException);
154         }
155     }
156
157     @Test
158     public void testDeviceConnectionCheck_HANSHAKING() throws Exception {
159         Mockito.reset(mockedConnectionContext);
160         when(mockedConnectionContext.getConnectionState()).thenReturn(ConnectionContext.CONNECTION_STATE.HANDSHAKING);
161         final ListenableFuture<Boolean> deviceConnectionCheckResult = statisticsContext.deviceConnectionCheck();
162
163         try {
164             final Boolean checkPositive = deviceConnectionCheckResult.get();
165             Assert.assertTrue(checkPositive);
166         } catch (final Exception e) {
167             Assert.fail("connection in state HANDSHAKING should NOT have caused exception here");
168         }
169     }
170 }