added test case to SshJcraftWrapperTest
[appc.git] / appc-config / appc-config-adaptor / provider / src / test / java / org / onap / appc / ccadaptor / SshJcraftWrapperTest.java
index 2495c64..7bf6b77 100644 (file)
@@ -2,29 +2,31 @@
  * ============LICENSE_START=======================================================
  * ONAP : APPC
  * ================================================================================
- * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Copyright (C) 2017 Amdocs
  * =============================================================================
+ * Modifications Copyright (C) 2018 IBM.
+ * =============================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- * 
- * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ *
  * ============LICENSE_END=========================================================
  */
-
 package org.onap.appc.ccadaptor;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.fail;
@@ -32,24 +34,32 @@ import static org.mockito.BDDMockito.given;
 import static org.mockito.Matchers.any;
 import static org.mockito.Matchers.anyInt;
 import static org.mockito.Matchers.anyString;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.atLeastOnce;
 import static org.mockito.Mockito.doThrow;
 import static org.mockito.Mockito.inOrder;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoMoreInteractions;
 
+import com.jcraft.jsch.ChannelSftp;
 import com.jcraft.jsch.ChannelShell;
 import com.jcraft.jsch.ChannelSubsystem;
 import com.jcraft.jsch.JSch;
 import com.jcraft.jsch.JSchException;
 import com.jcraft.jsch.Session;
+import com.jcraft.jsch.SftpException;
 import com.jcraft.jsch.UserInfo;
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
 import java.net.URL;
 
+import org.apache.commons.lang.StringUtils;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Ignore;
@@ -58,43 +68,11 @@ import org.junit.runner.RunWith;
 import org.mockito.InOrder;
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
+import org.onap.appc.ccadaptor.SshJcraftWrapper.MyUserInfo;
 import org.apache.commons.io.IOUtils;
 
 @RunWith(MockitoJUnitRunner.class)
 public class SshJcraftWrapperTest {
-
-    private static final String USER = "username";
-    private static final String PASS = "pass";
-    private static final String HOST = "hostname";
-    private static final String SUBSYSTEM = "netconf";
-    private static final String PROMPT = "]]>]]>";
-    private static final int PORT_NUM = 23;
-    private static final int SESSION_TIMEOUT = 30_000;
-
-    private SshJcraftWrapper cut;
-    @Mock
-    private JSch jSchMock;
-    @Mock
-    private Session session;
-    @Mock
-    private ChannelShell channelShell;
-    @Mock
-    private ChannelSubsystem channelSubsystem;
-    @Mock
-    private InputStream channelIs;
-
-    @Before
-    public void setUpTest() throws Exception {
-        InputStream is = IOUtils.toInputStream("test input stream:~#", "UTF-8");
-        given(channelShell.getInputStream()).willReturn(is);
-        given(channelSubsystem.getInputStream()).willReturn(is);
-        given(session.openChannel(SshJcraftWrapper.CHANNEL_SHELL_TYPE)).willReturn(channelShell);
-        given(session.openChannel(SshJcraftWrapper.CHANNEL_SUBSYSTEM_TYPE)).willReturn(channelSubsystem);
-        given(jSchMock.getSession(anyString(), anyString(), anyInt())).willReturn(session);
-        cut = new SshJcraftWrapper(jSchMock);
-    }
-
-    @Ignore
     @Test
     public void TestCheckIfReceivedStringMatchesDelimeter(){
         SshJcraftWrapper wrapper = new SshJcraftWrapper();
@@ -103,7 +81,6 @@ public class SshJcraftWrapperTest {
         Assert.assertEquals(true, result);
     }
 
-    @Ignore
     @Test
     public void testRemoveWhiteSpaceAndNewLineCharactersAroundString(){
         SshJcraftWrapper wrapper = new SshJcraftWrapper();
@@ -111,38 +88,35 @@ public class SshJcraftWrapperTest {
         Assert.assertEquals("namespace", nameSpace);
     }
 
-    @Ignore
     @Test
     public void testStripOffCmdFromRouterResponse(){
         SshJcraftWrapper wrapper = new SshJcraftWrapper();
         String result = wrapper.stripOffCmdFromRouterResponse("test\nsuccess");
-        Assert.assertEquals("success\n", result);            
+        Assert.assertEquals("success\n", result);
     }
-    
+
     //@Test
     public void testGetLastFewLinesOfFile() throws FileNotFoundException, IOException{
         SshJcraftWrapper wrapper = new SshJcraftWrapper();
         URL path = SshJcraftWrapperTest.class.getResource("Test");
-        File file = new File(path.getFile());        
+        File file = new File(path.getFile());
         String value = wrapper.getLastFewLinesOfFile(file,1);
         Assert.assertEquals("\nTest data 3", value);
     }
 
-    @Ignore
     @Test(expected=Exception.class)
     public void testSetRouterCommandType() throws IOException{
         SshJcraftWrapper wrapper = new SshJcraftWrapper();
-        wrapper.setRouterCommandType("test");    
+        wrapper.setRouterCommandType("test");
         wrapper.receiveUntil("test", 2, "test");
     }
 
-    @Ignore
     @Test
     public void testValues() throws IOException{
         SshJcraftWrapper wrapper = new SshJcraftWrapper();
         wrapper.setEquipNameCode("testcode");
         wrapper.setRouterCommandType("testcommand");
-        String equipName = wrapper.getEquipNameCode();
+        String equipName =wrapper.getEquipNameCode();
         wrapper.getHostName();
         wrapper.getPassWord();
         wrapper.getRouterName();
@@ -151,304 +125,37 @@ public class SshJcraftWrapperTest {
         Assert.assertEquals("testcode", equipName);
     }
 
-    @Ignore
     @Test(expected=Exception.class)
     public void testSetRouterCommandType2() throws IOException{
         SshJcraftWrapper wrapper = new SshJcraftWrapper();
         wrapper.appendToRouterFile("test", 2);
-        StringBuilder sb = new StringBuilder();
-        sb.append("test");
-        wrapper.appendToRouterFile("Test.txt", sb);
-        wrapper.receiveUntilBufferFlush(3, 4, "test");        
+        StringBuffer buffer = new StringBuffer();
+        buffer.append("test");
+        wrapper.appendToRouterFile("Test.txt", buffer);
+        wrapper.receiveUntilBufferFlush(3, 4, "test");
     }
 
-    @Ignore
     @Test(expected=Exception.class)
     public void testSetRouterCommandType3() throws IOException{
         SshJcraftWrapper wrapper = new SshJcraftWrapper();
         wrapper.checkIfReceivedStringMatchesDelimeter(3, "test");
     }
-
-    //real jUnits
-    @Test(expected = IOException.class)
-    public void connect_shouldThrowIOException_whenJSchFails() throws Exception {
-        //given
-        given(jSchMock.getSession(anyString(), anyString(), anyInt())).willThrow(new JSchException());
-
-        //when
-        cut.connect(HOST, USER, PASS);
-
-        //then
-        fail("IOException should be thrown");
-    }
-
-    @Test
-    public void connect_shouldSetVariables() throws Exception {
-        //when
-        cut.connect(HOST, USER, PASS);
-
-        //then
-        assertEquals(HOST, cut.getHostName());
-        assertEquals(HOST, cut.getRouterName());
-        assertEquals(USER, cut.getUserName());
-        assertEquals(PASS, cut.getPassWord());
-    }
-
-    @Test
-    public void connect_shouldSetUpSessionWithProperInvocationOrder() throws Exception {
-        //given
-        InOrder inOrder =  inOrder(session, channelShell);
-
-        //when
-        cut.connect(HOST, USER, PASS);
-
-        //then
-        verifySessionConfigurationOrderForChannelShellOpenning(
-            inOrder, USER, HOST, PASS, SshJcraftWrapper.DEFAULT_PORT, SESSION_TIMEOUT);
-    }
-
-    @Test
-    public void connect_shouldFinishSuccessfully_whenExceptionThrownDuringReceivingPhase() throws Exception {
-        //given
-        doThrow(new JSchException()).when(session).setTimeout(anyInt());
-
-        //when
-        cut.connect(HOST, USER, PASS);
-
-        //then
-        verify(session).setTimeout(anyInt());
-    }
-
-    @Test(expected = IOException.class)
-    public void connect_withSubsystem_shouldThrowIOException_whenJSchFails() throws Exception {
-        //given
-        given(jSchMock.getSession(anyString(), anyString(), anyInt())).willThrow(new JSchException());
-
-        //when
-        cut.connect(HOST, USER, PASS, SESSION_TIMEOUT, PORT_NUM, SUBSYSTEM);
-
-        //then
-        fail("IOException should be thrown");
-    }
-
-    @Test
-    public void connect_withSubsystem_shouldSetRouterName() throws Exception {
-        //when
-        cut.connect(HOST, USER, PASS, SESSION_TIMEOUT, PORT_NUM, SUBSYSTEM);
-
-        //then
-        assertEquals(HOST, cut.getRouterName());
-    }
-
-    @Test
-    public void connect_withSubsystem_shouldSetUpSessionWithProperInvocationOrder() throws Exception {
-        //given
-        InOrder inOrder =  inOrder(session, channelSubsystem);
-
-        //when
-        cut.connect(HOST, USER, PASS, SESSION_TIMEOUT, PORT_NUM, SUBSYSTEM);
-
-        //then
-        verify(jSchMock).getSession(USER, HOST, PORT_NUM);
-        inOrder.verify(session).setPassword(PASS);
-        inOrder.verify(session).setUserInfo(any(UserInfo.class));
-        inOrder.verify(session).setConfig(SshJcraftWrapper.STRICT_HOST_CHECK_KEY, SshJcraftWrapper.STRICT_HOST_CHECK_VALUE);
-        inOrder.verify(session).connect(SESSION_TIMEOUT);
-        inOrder.verify(session).setServerAliveCountMax(0);
-        inOrder.verify(session).openChannel(SshJcraftWrapper.CHANNEL_SUBSYSTEM_TYPE);
-        inOrder.verify(channelSubsystem).getInputStream();
-        inOrder.verify(channelSubsystem).connect(anyInt());
-        inOrder.verifyNoMoreInteractions();
-        verifyNoMoreInteractions(jSchMock);
-    }
-
-    @Test(expected = IOException.class)
-    public void connect_withPrompt_shouldThrowIOException_whenJSchFails() throws Exception {
-        //given
-        given(jSchMock.getSession(anyString(), anyString(), anyInt())).willThrow(new JSchException());
-
-        //when
-        cut.connect(HOST, USER, PASS, PROMPT, SESSION_TIMEOUT);
-
-        //then
-        fail("IOException should be thrown");
-    }
-
-    @Test
-    public void connect_withPrompt_shouldSetVariables() throws Exception {
-        //when
-        cut.connect(HOST, USER, PASS, PROMPT, SESSION_TIMEOUT);
-
-        //then
-        assertEquals(HOST, cut.getHostName());
-        assertEquals(HOST, cut.getRouterName());
-        assertEquals(USER, cut.getUserName());
-        assertEquals(PASS, cut.getPassWord());
-    }
-
-    @Test
-    public void connect_withPrompt_shouldFinishSuccessfully_whenExceptionThrownDuringReceivingPhase() throws Exception {
-        //given
-        doThrow(new JSchException()).when(session).setTimeout(anyInt());
-
-        //when
-        cut.connect(HOST, USER, PASS, PROMPT, SESSION_TIMEOUT);
-
-        //then
-        verify(session).setTimeout(anyInt());
-    }
-
-    @Test
-    public void connect_withPrompt_shouldSetUpSessionWithProperInvocationOrder() throws Exception {
-        //given
-        InOrder inOrder =  inOrder(session, channelShell);
-
-        //when
-        cut.connect(HOST, USER, PASS, PROMPT, SESSION_TIMEOUT);
-
-        //then
-        verifySessionConfigurationOrderForChannelShellOpenning(
-            inOrder, USER, HOST, PASS, SshJcraftWrapper.DEFAULT_PORT, SESSION_TIMEOUT);
-    }
-
-    @Test(expected = IOException.class)
-    public void connect_withPort_shouldThrowIOException_whenJSchFails() throws Exception {
-        //given
-        given(jSchMock.getSession(anyString(), anyString(), anyInt())).willThrow(new JSchException());
-
-        //when
-        cut.connect(HOST, USER, PASS, PROMPT, SESSION_TIMEOUT, PORT_NUM);
-
-        //then
-        fail("IOException should be thrown");
-    }
-
-    @Test
-    public void connect_withPort_shouldSetVariables() throws Exception {
-        //when
-        cut.connect(HOST, USER, PASS, PROMPT, SESSION_TIMEOUT, PORT_NUM);
-
-        //then
-        assertEquals(HOST, cut.getHostName());
-        assertEquals(HOST, cut.getRouterName());
-        assertEquals(USER, cut.getUserName());
-        assertEquals(PASS, cut.getPassWord());
-    }
-
-    @Test
-    public void connect_withPort_shouldFinishSuccessfully_whenExceptionThrownDuringReceivingPhase() throws Exception {
-        //given
-        doThrow(new JSchException()).when(session).setTimeout(anyInt());
-
-        //when
-        cut.connect(HOST, USER, PASS, PROMPT, SESSION_TIMEOUT, PORT_NUM);
-
-        //then
-        verify(session).setTimeout(anyInt());
-    }
-
-    @Test
-    public void connect_withPort_shouldSetUpSessionWithProperInvocationOrder() throws Exception {
-        //given
-        InOrder inOrder =  inOrder(session, channelShell);
-
-        //when
-        cut.connect(HOST, USER, PASS, PROMPT, SESSION_TIMEOUT, PORT_NUM);
-
-        //then
-        verifySessionConfigurationOrderForChannelShellOpenning(inOrder, USER, HOST, PASS, PORT_NUM, SESSION_TIMEOUT);
-    }
-
-    private void verifySessionConfigurationOrderForChannelShellOpenning(InOrder inOrder, String user, String host, String pass, int port, int sessionTimeout) throws Exception {
-        verify(jSchMock).getSession(user, host, port);
-        inOrder.verify(session).setPassword(pass);
-        inOrder.verify(session).setUserInfo(any(UserInfo.class));
-        inOrder.verify(session).setConfig(SshJcraftWrapper.STRICT_HOST_CHECK_KEY, SshJcraftWrapper.STRICT_HOST_CHECK_VALUE);
-        inOrder.verify(session).connect(sessionTimeout);
-        inOrder.verify(session).setServerAliveCountMax(0);
-        inOrder.verify(session).openChannel(SshJcraftWrapper.CHANNEL_SHELL_TYPE);
-        inOrder.verify(channelShell).getInputStream();
-        inOrder.verify(channelShell).connect();
-        inOrder.verify(session).setTimeout(anyInt());
-        inOrder.verifyNoMoreInteractions();
-        verifyNoMoreInteractions(jSchMock);
-    }
-
-    @Test
-    public void closeConnection_shouldCloseReaderChannelAndSession_inAGivenOrder() throws Exception {
-        //given
-        provideConnectedSubsystemInstance();
-        InOrder inOrder = inOrder(channelIs, channelSubsystem, session);
-
-        //when
-        cut.closeConnection();
-
-        //then
-        inOrder.verify(channelIs).close();
-        inOrder.verify(channelSubsystem).disconnect();
-        inOrder.verify(session).disconnect();
-        inOrder.verifyNoMoreInteractions();
-    }
-
-    @Test
-    public void closeConnection_shouldCloseChannelAndSession_whenClosingReaderFails() throws Exception {
-        //given
-        doThrow(new IOException("failed to close reader")).when(channelIs).close();
-        provideConnectedSubsystemInstance();
-
-        //when
-        cut.closeConnection();
-
-        //then
-        verify(channelIs).close();
-        verify(channelSubsystem).disconnect();
-        verify(session).disconnect();
-    }
-
-    @Test
-    public void closeConnection_shouldBeIdempotent_whenRunOnNewInstance() throws Exception {
-        //given
-        assertFalse(cut.isConnected());
-
-        //when
-        cut.closeConnection();
-
-        //then
-        assertFalse(cut.isConnected());
+    
+    @Test(expected=IOException.class)
+    public void testConnect() throws IOException{
+        SshJcraftWrapper wrapper = new SshJcraftWrapper();
+        wrapper.connect("testHost", "testUser", "testPswd", "3000", 1000);
     }
-
+    
     @Test
-    public void closeConnection_shouldBeIdempotent_whenRunTwiceOnConnectedInstance() throws Exception {
-        //given
-        provideConnectedSubsystemInstance();
-
-        //when
-        cut.closeConnection();
-        cut.closeConnection();
-
-        //then
-        assertFalse(cut.isConnected());
+    public void testMyUserInfoGetPassword() {
+        MyUserInfo myUserInfo=new MyUserInfo();
+        assertNull(myUserInfo.getPassword());
     }
-
+    
     @Test
-    public void closeConnection_shouldCloseResourcesOnce_whenRunTwiceOnConnectedInstance() throws Exception {
-        //given
-        provideConnectedSubsystemInstance();
-
-        //when
-        cut.closeConnection();
-        cut.closeConnection();
-
-        //then
-        verify(channelIs, times(1)).close();
-        verify(channelSubsystem, times(1)).disconnect();
-        verify(session, times(1)).disconnect();
+    public void testMyUserInfoPromptYesNo() {
+        MyUserInfo myUserInfo=new MyUserInfo();
+        assertFalse(myUserInfo.promptYesNo(""));
     }
-
-    private void provideConnectedSubsystemInstance() throws Exception {
-        given(channelSubsystem.getInputStream()).willReturn(channelIs);
-        cut.connect(HOST, USER, PASS, SESSION_TIMEOUT, PORT_NUM, SUBSYSTEM);
-        assertTrue(cut.isConnected());
-    }
-
 }