opendaylight/md-sal/sal-netconf-connector/src/test/java/org/opendaylight/controller/sal/connect/netconf/sal/KeepaliveSalFacadeTest.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 package org.opendaylight.controller.sal.connect.netconf.sal;
   9
  10 import static org.mockito.Matchers.any;
  11 import static org.mockito.Mockito.doAnswer;
  12 import static org.mockito.Mockito.doNothing;
  13 import static org.mockito.Mockito.doReturn;
  14 import static org.mockito.Mockito.mock;
  15 import static org.mockito.Mockito.timeout;
  16 import static org.mockito.Mockito.times;
  17 import static org.mockito.Mockito.verify;
  18
  19 import java.net.InetSocketAddress;
  20 import java.util.concurrent.Executors;
  21
  22 import org.junit.After;
  23 import org.junit.Before;
  24 import org.junit.Test;
  25 import org.mockito.Mock;
  26 import org.mockito.MockitoAnnotations;
  27 import org.mockito.invocation.InvocationOnMock;
  28 import org.mockito.stubbing.Answer;
  29 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  30 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  31 import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
  32 import org.opendaylight.controller.sal.connect.api.RemoteDeviceHandler;
  33 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfDeviceCommunicator;
  34 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfSessionPreferences;
  35 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
  36 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  37 import org.opendaylight.yangtools.yang.common.RpcError;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  41 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  43
  44 import com.google.common.util.concurrent.Futures;
  45
  46 public class KeepaliveSalFacadeTest {
  47
  48     private static final RemoteDeviceId REMOTE_DEVICE_ID = new RemoteDeviceId("test", new InetSocketAddress("localhost", 22));
  49
  50     @Mock
  51     private RemoteDeviceHandler<NetconfSessionPreferences> underlyingSalFacade;
  52
  53     private static java.util.concurrent.ScheduledExecutorService executorService;
  54
  55     @Mock
  56     private NetconfDeviceCommunicator listener;
  57     @Mock
  58     private DOMRpcService deviceRpc;
  59
  60     private DOMRpcService proxyRpc;
  61
  62     @Before
  63     public void setUp() throws Exception {
  64         executorService = Executors.newScheduledThreadPool(1);
  65
  66         MockitoAnnotations.initMocks(this);
  67
  68         doNothing().when(listener).disconnect();
  69         doReturn("mockedRpc").when(deviceRpc).toString();
  70         doNothing().when(underlyingSalFacade).onDeviceConnected(
  71                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
  72     }
  73
  74     @After
  75     public void tearDown() throws Exception {
  76         executorService.shutdownNow();
  77     }
  78
  79     @Test
  80     public void testKeepaliveSuccess() throws Exception {
  81         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
  82                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
  83
  84         doReturn(Futures.immediateCheckedFuture(result)).when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
  85
  86         final KeepaliveSalFacade keepaliveSalFacade =
  87                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorService, 1L);
  88         keepaliveSalFacade.setListener(listener);
  89
  90         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
  91
  92         verify(underlyingSalFacade).onDeviceConnected(
  93                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
  94
  95         verify(deviceRpc, timeout(15000).times(5)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
  96     }
  97
  98     @Test
  99     public void testKeepaliveFail() throws Exception {
 100         final DOMRpcResult result = new DefaultDOMRpcResult(Builders.containerBuilder().withNodeIdentifier(
 101                 new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME)).build());
 102
 103         RpcError error = mock(RpcError.class);
 104         doReturn("Failure").when(error).toString();
 105
 106         final DOMRpcResult resultFailwithResultAndError = new DefaultDOMRpcResult(mock(NormalizedNode.class), error);
 107
 108         doReturn(Futures.immediateCheckedFuture(result))
 109                 .doReturn(Futures.immediateCheckedFuture(resultFailwithResultAndError))
 110                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 111                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 112
 113         final KeepaliveSalFacade keepaliveSalFacade =
 114                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorService, 1L);
 115         keepaliveSalFacade.setListener(listener);
 116
 117         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 118
 119         verify(underlyingSalFacade).onDeviceConnected(
 120                 any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 121
 122         // 1 failed that results in disconnect
 123         verify(listener, timeout(15000).times(1)).disconnect();
 124         // 3 attempts total
 125         verify(deviceRpc, times(3)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 126
 127         // Reconnect with same keepalive responses
 128         doReturn(Futures.immediateCheckedFuture(result))
 129                 .doReturn(Futures.immediateCheckedFuture(resultFailwithResultAndError))
 130                 .doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 131                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 132
 133         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 134
 135         // 1 failed that results in disconnect, 2 total with previous fail
 136         verify(listener, timeout(15000).times(2)).disconnect();
 137         // 6 attempts now total
 138         verify(deviceRpc, times(3 * 2)).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 139
 140
 141         final DOMRpcResult resultFailwithError = new DefaultDOMRpcResult(error);
 142
 143         doReturn(Futures.immediateCheckedFuture(resultFailwithError))
 144                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 145
 146         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 147
 148         // 1 failed that results in disconnect, 3 total with previous fail
 149         verify(listener, timeout(15000).times(3)).disconnect();
 150     }
 151
 152     @Test
 153     public void testNonKeepaliveRpcFailure() throws Exception {
 154         doAnswer(new Answer() {
 155             @Override
 156             public Object answer(final InvocationOnMock invocationOnMock) throws Throwable {
 157                 proxyRpc = (DOMRpcService) invocationOnMock.getArguments()[2];
 158                 return null;
 159             }
 160         }).when(underlyingSalFacade).onDeviceConnected(any(SchemaContext.class), any(NetconfSessionPreferences.class), any(DOMRpcService.class));
 161
 162         doReturn(Futures.immediateFailedCheckedFuture(new IllegalStateException("illegal-state")))
 163                 .when(deviceRpc).invokeRpc(any(SchemaPath.class), any(NormalizedNode.class));
 164
 165         final KeepaliveSalFacade keepaliveSalFacade =
 166                 new KeepaliveSalFacade(REMOTE_DEVICE_ID, underlyingSalFacade, executorService, 100L);
 167         keepaliveSalFacade.setListener(listener);
 168
 169         keepaliveSalFacade.onDeviceConnected(null, null, deviceRpc);
 170
 171         proxyRpc.invokeRpc(mock(SchemaPath.class), mock(NormalizedNode.class));
 172
 173         verify(listener, times(1)).disconnect();
 174     }
 175 }