Improve callhome-protocol unit tests
[netconf.git] / netconf / callhome-protocol / src / test / java / org / opendaylight / netconf / callhome / protocol / MinaSshNettyChannelTest.java
1 /*
2  * Copyright (c) 2016 Brocade Communication Systems 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.netconf.callhome.protocol;
9
10 import static org.junit.Assert.assertTrue;
11 import static org.mockito.ArgumentMatchers.any;
12 import static org.mockito.Mockito.doReturn;
13 import static org.mockito.Mockito.mock;
14 import static org.mockito.Mockito.times;
15 import static org.mockito.Mockito.verify;
16
17 import io.netty.buffer.ByteBuf;
18 import io.netty.buffer.ByteBufAllocator;
19 import io.netty.buffer.EmptyByteBuf;
20 import io.netty.channel.ChannelHandler;
21 import io.netty.channel.ChannelHandlerContext;
22 import io.netty.channel.ChannelOutboundHandlerAdapter;
23 import io.netty.channel.ChannelPromise;
24 import java.io.IOException;
25 import org.junit.Before;
26 import org.junit.Test;
27 import org.opendaylight.netconf.shaded.sshd.client.channel.ClientChannel;
28 import org.opendaylight.netconf.shaded.sshd.client.session.ClientSession;
29 import org.opendaylight.netconf.shaded.sshd.common.io.IoInputStream;
30 import org.opendaylight.netconf.shaded.sshd.common.io.IoOutputStream;
31 import org.opendaylight.netconf.shaded.sshd.common.io.IoReadFuture;
32 import org.opendaylight.netconf.shaded.sshd.common.io.IoWriteFuture;
33 import org.opendaylight.netconf.shaded.sshd.common.util.buffer.Buffer;
34
35 public class MinaSshNettyChannelTest {
36     private CallHomeSessionContext mockContext;
37     private ClientSession mockSession;
38     private ClientChannel mockChannel;
39     private MinaSshNettyChannel instance;
40
41     @Before
42     public void setup() throws IOException {
43         IoReadFuture mockFuture = mock(IoReadFuture.class);
44         IoInputStream mockIn = mock(IoInputStream.class);
45         doReturn(mockFuture).when(mockIn).read(any(Buffer.class));
46         mockContext = mock(CallHomeSessionContext.class);
47         mockSession = mock(ClientSession.class);
48         mockChannel = mock(ClientChannel.class);
49         doReturn(mockIn).when(mockChannel).getAsyncOut();
50
51         IoOutputStream mockOut = mock(IoOutputStream.class);
52         doReturn(mockOut).when(mockChannel).getAsyncIn();
53
54         IoWriteFuture mockWrFuture = mock(IoWriteFuture.class);
55         doReturn(false).when(mockOut).isClosed();
56         doReturn(false).when(mockOut).isClosing();
57         doReturn(mockWrFuture).when(mockOut).writeBuffer(any(Buffer.class));
58         doReturn(null).when(mockWrFuture).addListener(any());
59
60         doReturn(mockFuture).when(mockFuture).addListener(any());
61
62         instance = new MinaSshNettyChannel(mockContext, mockSession, mockChannel);
63     }
64
65     @Test
66     public void ourChannelHandlerShouldBeFirstInThePipeline() {
67         // given
68         ChannelHandler firstHandler = instance.pipeline().first();
69         String firstName = firstHandler.getClass().getName();
70         // expect
71         assertTrue(firstName.contains("callhome"));
72     }
73
74     @Test
75     public void ourChannelHandlerShouldForwardWrites() throws Exception {
76         ChannelHandler mockHandler = mock(ChannelHandler.class);
77         ChannelHandlerContext ctx = mock(ChannelHandlerContext.class);
78         doReturn(mockHandler).when(ctx).handler();
79         ChannelPromise promise = mock(ChannelPromise.class);
80
81         // we would really like to just verify that the async handler write() was
82         // called but it is a final class, so no mocking. instead we set up the
83         // mock channel to have no async input, which will cause a failure later
84         // on the write promise that we use as a cheap way to tell that write()
85         // got called. ick.
86
87         doReturn(null).when(mockChannel).getAsyncIn();
88         doReturn(null).when(promise).setFailure(any(Throwable.class));
89
90         // Need to reconstruct instance to pick up null async in above
91         instance = new MinaSshNettyChannel(mockContext, mockSession, mockChannel);
92
93         // when
94         ChannelOutboundHandlerAdapter outadapter = (ChannelOutboundHandlerAdapter) instance.pipeline().first();
95         ByteBufAllocator mockAlloc = mock(ByteBufAllocator.class);
96         ByteBuf bytes = new EmptyByteBuf(mockAlloc);
97         outadapter.write(ctx, bytes, promise);
98
99         // then
100         verify(promise, times(1)).setFailure(any(Throwable.class));
101     }
102 }