-
- //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(IO_EXCEPTION_MSG);
- }
-
- @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
- verifySessionConfigurationOrderForChannelShellOpening(
- 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(IO_EXCEPTION_MSG);
- }
-
- @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(IO_EXCEPTION_MSG);
- }
-
- @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
- verifySessionConfigurationOrderForChannelShellOpening(
- 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(IO_EXCEPTION_MSG);
- }
-
- @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
- verifySessionConfigurationOrderForChannelShellOpening(inOrder, USER, HOST, PASS, PORT_NUM, SESSION_TIMEOUT);
- }
-
- private void verifySessionConfigurationOrderForChannelShellOpening(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
- public void closeConnection_shouldBeIdempotent_whenRunTwiceOnConnectedInstance() throws Exception {
- //given
- provideConnectedSubsystemInstance();
-
- //when
- cut.closeConnection();
- cut.closeConnection();
-
- //then
- assertFalse(cut.isConnected());
- }
-
- @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();
- }
-
- private void provideConnectedSubsystemInstance() throws Exception {
- given(channelSubsystem.getInputStream()).willReturn(channelIs);
- cut.connect(HOST, USER, PASS, SESSION_TIMEOUT, PORT_NUM, SUBSYSTEM);
- assertTrue(cut.isConnected());
- }
-
- //receiveUntil tests begin
- @Test(expected = IllegalStateException.class)
- public void receiveUntil_shouldThrowIllegalStateException_whenInstanceIsNotConnected() throws Exception {
- //given
- assertFalse(cut.isConnected());
-
- //when
- cut.receiveUntil(SEARCH_STR, READ_TIMEOUT, "");
-
- //then
- fail("IllegalStateException should be thrown");
- }
-
- @Test(expected = IllegalStateException.class)
- public void receiveUntil_shouldThrowIllegalStateException_whenJschReaderStreamIsNotAvailable() throws Exception {
- //given
- provideConnectedSubsystemInstance();
- given(channelIs.available()).willReturn(0);
-
- //when
- cut.receiveUntil(SEARCH_STR, READ_TIMEOUT, "");
-
- //then
- fail("IllegalStateException should be thrown");
- }
-
- @Test(expected = TimedOutException.class)
- public void receiveUntil_shouldThrowTimedOutException_whenSessionFails() throws Exception {
- //given
- given(channelSubsystem.getInputStream()).willReturn(IOUtils.toInputStream("test input stream:~#", "UTF-8"));
- cut.connect(HOST, USER, PASS, SESSION_TIMEOUT, PORT_NUM, SUBSYSTEM);
- assertTrue(cut.isConnected());
- doThrow(new JSchException("Session is not available")).when(session).setTimeout(anyInt());
-
- //when
- cut.receiveUntil(SEARCH_STR, READ_TIMEOUT, "");
-
- //then
- fail("TimedOutException should be thrown");
- }
-
- @Test(expected = TimedOutException.class)
- public void receiveUntil_shouldThrowTimedOutException_whenReadFails() throws Exception {
- //given
- provideConnectedSubsystemInstance();
- given(channelIs.available()).willReturn(1);
- given(channelIs.read(any(), anyInt(), anyInt())).willThrow(new IOException("Could not read stream"));
-
- //when
- cut.receiveUntil(SEARCH_STR, READ_TIMEOUT, "");
-
- //then
- fail("TimedOutException should be thrown");
- }
-
- @Test(expected = TimedOutException.class)
- public void receiveUntil_shouldThrowException_whenTimeoutIsReached() throws Exception {
- //given
- String streamContent = "test input stream:~#";
- provideConnectedSubsystemInstanceWithStreamContent(streamContent);
-
- //when
- cut.receiveUntil(SEARCH_STR, -1000, " Some fake command\n");
-
- //then
- fail("TimedOutException should be thrown");
- }
-
- @Test(expected = TimedOutException.class)
- public void receiveUntil_shouldThrowException_whenReachedEndOfStream_andCouldNotReadMoreBytes() throws Exception {
- //given
- provideConnectedSubsystemInstance();
- given(channelIs.available()).willReturn(1);
- given(channelIs.read(any(), anyInt(), anyInt())).willReturn(-1);
-
- //when
- cut.receiveUntil(SEARCH_STR, READ_TIMEOUT, "");
-
- //then
- fail("TimedOutException should be thrown");
- }
-
- @Test
- public void receiveUntil_shouldReadUnderlyingStream_andStripOffFirstLine() throws Exception {
- //given
- String command = "Command" + SshJcraftWrapper.EOL;
- String reply = "Reply" + SshJcraftWrapper.EOL;
- String streamContent = command + reply + PROMPT;
- provideConnectedSubsystemInstanceWithStreamContent(streamContent);
-
- //when
- String result = cut.receiveUntil(PROMPT, SESSION_TIMEOUT, command);
-
- //then
- assertEquals(reply + PROMPT, result);
- }
-
- @Test
- public void receiveUntil_shouldReadUnderlyingStream_andReturnWholeReadString() throws Exception {
- //given
- String streamContent = "Command and Reply in just one line" + PROMPT;
- provideConnectedSubsystemInstanceWithStreamContent(streamContent);
-
- //when
- String result = cut.receiveUntil(PROMPT, SESSION_TIMEOUT, streamContent);
-
- //then
- assertEquals(streamContent, result);
- }
-
- @Test
- public void receiveUntil_shouldCutOffSpecialCharactersFromStream() throws Exception {
- //given
- char special1 = Character.UNASSIGNED;
- char special2 = Character.ENCLOSING_MARK;
- char special3 = Character.LINE_SEPARATOR;
- char special4 = Character.MODIFIER_SYMBOL;
- StringBuilder sb = new StringBuilder("Command");
- sb.append(special1).append("With").append(special2).append("Special")
- .append(special3).append("Characters").append(special4).append("Set").append(PROMPT);
-
- provideConnectedSubsystemInstanceWithStreamContent(sb.toString());
-
- //when
- String result = cut.receiveUntil(PROMPT, SESSION_TIMEOUT, "");
-
- //then
- assertEquals("CommandWithSpecialCharactersSet" + PROMPT, result);
- }
-
- @Test
- public void receiveUntil_shouldReadUnderlyingStream_untilCLIDelimiterFound_whenProperDelimiterSet()
- throws Exception {
- //given
- String cliDelimiter = "#$";
- String delimiters = PROMPT + SshJcraftWrapper.DELIMITERS_SEPARATOR + cliDelimiter;
- String streamContent = "Command for CLI invocation #";
- provideConnectedSubsystemInstanceWithStreamContent(streamContent);
-
- //when
- String result = cut.receiveUntil(delimiters, SESSION_TIMEOUT, streamContent);
-
- //then
- assertEquals(streamContent, result);
- }
-
- @Test
- public void receiveUntil_shouldReadUnderlyingStream_untilCLIDelimiterFound_whenCLICommandSet() throws Exception {
- //given
- String streamContent = "Command for CLI invocation #";
- provideConnectedSubsystemInstanceWithStreamContent(streamContent);
- cut.setRouterCommandType("CLI");
-
- //when
- String result = cut.receiveUntil("", SESSION_TIMEOUT, streamContent);
-
- //then
- assertEquals(streamContent, result);
- }
-
- @Test
- public void receiveUntil_shouldReadUnderlyingStream_untilCLIDelimiterFound_forShowConfigCommand() throws Exception {
- //given
- String streamContent = "show config\nconfig content#";
- provideConnectedSubsystemInstanceWithStreamContent(streamContent);
-
- //when
- String result = cut.receiveUntil("#", SESSION_TIMEOUT, streamContent);
-
- //then
- assertEquals("config content#", result);
- }
-
- @Test
- public void receiveUntil_shouldWriteOutputToRouterFile_whenReadingIOSXRswConfigFile_confirmFromFile()
- throws Exception {
- receiveUntil_shouldWriteOutputToRouterFile_whenReadingIOSXRswConfigFile();
- }
-
- @Test
- public void receiveUntil_shouldWriteOutputToRouterFile_whenReadingIOSXRswConfigFile_confirmFromBuffer()
- throws Exception {
- //given
- int biggerBufferSize = 32;
- cut = new SshJcraftWrapper(jSchMock, READ_INTERVAL_MS, biggerBufferSize);
-
- receiveUntil_shouldWriteOutputToRouterFile_whenReadingIOSXRswConfigFile();
- }
-
- private void receiveUntil_shouldWriteOutputToRouterFile_whenReadingIOSXRswConfigFile() throws Exception {
- //given
- String routerName = "router";
- String command = "RP/0/RP0/CPU0: " + routerName + " #IOS_XR_uploadedSwConfigCmd";
- String configFileEnding = "\nXML>";
- String streamContent = "Config file\ncontent" + configFileEnding;
- provideConnectedSubsystemInstanceWithStreamContent(streamContent);
-
- //when
- String result = cut.receiveUntil("", SESSION_TIMEOUT, command);
-
- //then
- assertNull(result); //TO-DO: it would be better to return empty string in this situation
- assertFileExist(routerName);
-
- //after
- teardownFile(routerName);
- }
-
- private void provideConnectedSubsystemInstanceWithStreamContent(String streamContent) throws Exception {
- given(channelSubsystem.getInputStream()).willReturn(IOUtils.toInputStream(streamContent, "UTF-8"));
- cut.connect(HOST, USER, PASS, SESSION_TIMEOUT, PORT_NUM, SUBSYSTEM);
- assertTrue(cut.isConnected());
- }
-
- private void teardownFile(String routerName) {
- File file = new File(routerName);
- if (file.exists() && file.isFile()) {
- file.delete();
- }
- }
-
- private void assertFileExist(String fileName) {
- File file = new File(fileName);
- assertTrue(file.exists());
- assertTrue(file.isFile());
- }
-
- @Test
- public void send_withReceive_shouldWriteCommandToChannelOutputStream_andReturnReceivedCommand() throws Exception {
- //given
- String command = "sdc";
- String delimiter = ":";
- InOrder inOrder = inOrder(channelOs);
- provideConnectedSubsystemInstanceWithStreamContent(command + delimiter);
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
-
- //when
- String result = cut.send(command, delimiter);
-
- //then
- verifySdcCommandSent(inOrder);
- assertEquals(command + delimiter, result);
- }
-
- @Test
- public void send_shouldWriteCommandToChannelOutputStream() throws Exception {
- //given
- String command = "sdc";
- InOrder inOrder = inOrder(channelOs);
- provideConnectedSubsystemInstance();
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
-
- //when
- cut.send(command);
-
- //then
- verifySdcCommandSent(inOrder);
- }
-
- private void verifySdcCommandSent(InOrder inOrder) throws IOException {
- inOrder.verify(channelOs).write('s');
- inOrder.verify(channelOs).write('d');
- inOrder.verify(channelOs).write('c');
- inOrder.verify(channelOs, atLeastOnce()).flush();
- inOrder.verify(channelOs, atLeastOnce()).close();
- inOrder.verifyNoMoreInteractions();
- }
-
- @Test
- public void send_withReceive_shouldWriteCommandInChunksToChannelOutputStream_andReturnReceivedCommand()
- throws Exception {
- //given
- cut = new SshJcraftWrapper(jSchMock, READ_INTERVAL_MS, 1);
- cut.setCharsChunkSize(1);
- String command = "sdc";
- String delimiter = ":";
- int timeout = 9000;
- provideConnectedSubsystemInstanceWithStreamContent(command + delimiter + SshJcraftWrapper.EOL);
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
- InOrder inOrder = inOrder(channelOs, session);
-
- //when
- String result = cut.send(command, delimiter);
-
- //then
- verifySdcCommandSentInChunk(inOrder, timeout);
- assertEquals(command + delimiter, result);
- }
-
- @Test
- public void send_shouldWriteCommandInChunksToChannelOutputStream() throws Exception {
- //given
- cut = new SshJcraftWrapper(jSchMock, READ_INTERVAL_MS, 1);
- cut.setCharsChunkSize(1);
- String command = "sdc";
- int timeout = 9000;
- provideConnectedSubsystemInstanceWithStreamContent(command + SshJcraftWrapper.EOL);
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
- InOrder inOrder = inOrder(channelOs, session);
-
- //when
- cut.send(command);
-
- //then
- verifySdcCommandSentInChunk(inOrder, timeout);
- }
-
- private void verifySdcCommandSentInChunk(InOrder inOrder, int timeout) throws Exception {
- inOrder.verify(channelOs).write('s');
- inOrder.verify(channelOs).flush();
- inOrder.verify(session).setTimeout(timeout);
- inOrder.verify(channelOs).write('d');
- inOrder.verify(channelOs).flush();
- inOrder.verify(session).setTimeout(timeout);
- inOrder.verify(channelOs).write('c');
- inOrder.verify(channelOs).flush();
- inOrder.verify(session).setTimeout(timeout);
- inOrder.verify(channelOs, atLeastOnce()).flush();
- inOrder.verify(channelOs, atLeastOnce()).close();
- inOrder.verifyNoMoreInteractions();
- }
-
- @Test
- public void send_withReceive_shouldReturnActualResult_whenTimeoutReached() throws Exception {
- //given
- cut = new SshJcraftWrapper(jSchMock, READ_INTERVAL_MS, 1);
- cut.setCharsChunkSize(1);
- cut.setSessionTimeoutMs(-1);
- String command = "sdc";
- String delimiter = ":";
- provideConnectedSubsystemInstanceWithStreamContent(command + SshJcraftWrapper.EOL);
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
-
- //when
- String result = cut.send(command, delimiter);
-
- //then
- assertEquals(StringUtils.EMPTY, result);
- }
-
- @Test
- public void send_withReceive_shouldReturnActualResult_whenCouldNotSetSessionTimeout() throws Exception {
- //given
- cut = new SshJcraftWrapper(jSchMock, READ_INTERVAL_MS, 1);
- cut.setCharsChunkSize(1);
- String command = "sdc";
- String delimiter = ":";
- provideConnectedSubsystemInstanceWithStreamContent(command + SshJcraftWrapper.EOL);
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
- doThrow(new JSchException("failed to set session timeout")).when(session).setTimeout(anyInt());
-
- //when
- String result = cut.send(command, delimiter);
-
- //then
- assertEquals(StringUtils.EMPTY, result);
- }
-
- @Test
- public void sendChar_shouldWriteCharacterToChannelOutputStream() throws Exception {
- //given
- int charNum = 100;
- provideConnectedSubsystemInstance();
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
- InOrder inOrder = inOrder(channelOs);
-
- //when
- cut.sendChar(charNum);
-
- //then
- inOrder.verify(channelOs).write(charNum);
- inOrder.verify(channelOs, atLeastOnce()).flush();
- inOrder.verify(channelOs, atLeastOnce()).close();
- inOrder.verifyNoMoreInteractions();
- }
-
- @Test(expected = IOException.class)
- public void sendChar_shouldRethrowIOException_whenOccurs() throws Exception {
- //given
- int charNum = 100;
- provideConnectedSubsystemInstance();
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
- doThrow(new IOException()).when(channelOs).write(charNum);
-
- //when
- cut.sendChar(charNum);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test
- public void send_withByteBuffer_shouldWriteBufferToChannelOutputStream() throws Exception {
- //given
- byte[] buffer = "Command".getBytes();
- int offset = 5;
- provideConnectedSubsystemInstance();
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
- InOrder inOrder = inOrder(channelOs);
-
- //when
- cut.send(buffer, offset, buffer.length);
-
- //then
- inOrder.verify(channelOs).write(buffer, offset, buffer.length);
- inOrder.verify(channelOs, atLeastOnce()).flush();
- inOrder.verify(channelOs, atLeastOnce()).close();
- inOrder.verifyNoMoreInteractions();
- }
-
- @Test(expected = IOException.class)
- public void send_withByteBuffer_shouldRethrowIOException_whenOccurs() throws Exception {
- //given
- byte[] buffer = "Command".getBytes();
- int offset = 5;
- provideConnectedSubsystemInstance();
- given(channelSubsystem.getOutputStream()).willReturn(channelOs);
- doThrow(new IOException()).when(channelOs).write(buffer, offset, buffer.length);
-
- //when
- cut.send(buffer, offset, buffer.length);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test
- public void getSftpConnection_shouldSetupSessionWithProperInvocationOrder() throws Exception {
- //given
- SshJcraftWrapper instance = spy(cut);
- given(instance.openSftpChannel(session)).willReturn(channelSftp);
- InOrder inOrder = inOrder(session, channelSftp, instance);
-
- //when
- ChannelSftp result = instance.getSftpConnection(HOST, USER, PASS);
-
- //then
- verify(jSchMock).getSession(USER, HOST, SshJcraftWrapper.DEFAULT_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(SESSION_TIMEOUT);
- inOrder.verify(instance).openSftpChannel(session);
- inOrder.verify(channelSftp).connect();
- inOrder.verifyNoMoreInteractions();
- assertEquals(channelSftp, result);
- }
-
- @Test
- public void sftp_get_shouldReadFromChannelInputStream_andCloseConnection() throws Exception {
- //given
- String streamContent = "test input stream content";
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- given(channelSftp.get(REMOTE_PATH)).willReturn(IOUtils.toInputStream(streamContent, "UTF-8"));
-
- //when
- String result = spyInstance.get(REMOTE_PATH, HOST, USER, PASS);
-
- //then
- assertEquals(streamContent, result);
- verify(channelSftp).disconnect();
- verify(session).disconnect();
- }
-
- @Test(expected = IOException.class)
- public void sftp_get_shouldThrowIOException_whenJschFails() throws Exception {
- //given
- SshJcraftWrapper spyInstance = spy(cut);
- doThrow(new JSchException()).when(spyInstance).openSftpChannel(session);
-
- //when
- spyInstance.get(REMOTE_PATH, HOST, USER, PASS);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test(expected = IOException.class)
- public void sftp_get_shouldThrowIOException_whenSftpOperationFails() throws Exception {
- //given
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- doThrow(new SftpException(0, "sftp error")).when(channelSftp).get(REMOTE_PATH);
-
- //when
- spyInstance.get(REMOTE_PATH, HOST, USER, PASS);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test
- public void sftp_get_shouldCloseSessionAndChannel_whenExceptionOccursOnConnectedInstance() throws Exception {
- //given
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- doThrow(new SftpException(0, "sftp error")).when(channelSftp).get(REMOTE_PATH);
- boolean ioException = false;
-
- //when
- try {
- spyInstance.get(REMOTE_PATH, HOST, USER, PASS);
- } catch (IOException e) {
- ioException = true;
- }
-
- //then
- assertTrue(ioException);
- verify(channelSftp).disconnect();
- verify(session).disconnect();
- }
-
- @Test
- public void sftp_get_shouldSkipClosingSessionAndChannel_whenExceptionOccursOnNotConnectedInstance() throws Exception {
- //given
- doThrow(new JSchException()).when(jSchMock).getSession(anyString(), anyString(), anyInt());
- boolean ioException = false;
-
- //when
- try {
- cut.get(REMOTE_PATH, HOST, USER, PASS);
- } catch (IOException e) {
- ioException = true;
- }
-
- //then
- assertTrue(ioException);
- verify(channelSftp, never()).disconnect();
- verify(session, never()).disconnect();
- }
-
- @Test
- public void sftp_put_withIs_shouldRemoveOldFilesFromDestinationPath_andPutNewData() throws Exception {
- //given
- InputStream is = IOUtils.toInputStream("test input stream content", "UTF-8");
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- InOrder inOrder = inOrder(channelSftp, session);
-
- //when
- spyInstance.put(is, REMOTE_PATH, HOST, USER, PASS);
-
- //then
- inOrder.verify(channelSftp).rm(REMOTE_PATH + "*");
- inOrder.verify(channelSftp).put(is, REMOTE_PATH, ChannelSftp.OVERWRITE);
- inOrder.verify(channelSftp).disconnect();
- inOrder.verify(session).disconnect();
- inOrder.verifyNoMoreInteractions();
- }
-
- @Test
- public void sftp_put_withIs_shouldContinueInsertingNewData_whenFileNotFoundDuringRemoval() throws Exception {
- //given
- InputStream is = IOUtils.toInputStream("test input stream content", "UTF-8");
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- doThrow(new SftpException(ChannelSftp.SSH_FX_NO_SUCH_FILE, "No such file/dir"))
- .when(channelSftp).rm(REMOTE_PATH + "*");
-
- //when
- spyInstance.put(is, REMOTE_PATH, HOST, USER, PASS);
-
- //then
- verify(channelSftp).rm(REMOTE_PATH + "*");
- verify(channelSftp).put(is, REMOTE_PATH, ChannelSftp.OVERWRITE);
- }
-
- @Test(expected = IOException.class)
- public void sftp_put_withIs_shouldThrowIOException_whenSftpFails() throws Exception {
- //given
- InputStream is = IOUtils.toInputStream("test input stream content", "UTF-8");
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- doThrow(new SftpException(ChannelSftp.SSH_FX_FAILURE, "general error"))
- .when(channelSftp).rm(anyString());
-
- //when
- spyInstance.put(is, REMOTE_PATH, HOST, USER, PASS);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test(expected = IOException.class)
- public void sftp_put_withIs_shouldThrowIOException_whenJschFails() throws Exception {
- //given
- InputStream is = IOUtils.toInputStream("test input stream content", "UTF-8");
- SshJcraftWrapper spyInstance = spy(cut);
- doThrow(new JSchException()).when(spyInstance).openSftpChannel(session);
-
- //when
- spyInstance.put(is, REMOTE_PATH, HOST, USER, PASS);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test
- public void sftp_put_withSourcePath_shouldPutSrcPathToDestinationPath_andDisconnectAfterwards() throws Exception {
- //given
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
-
- //when
- spyInstance.put(SOURCE_PATH, REMOTE_PATH);
-
- //then
- verify(channelSftp).put(SOURCE_PATH, REMOTE_PATH, ChannelSftp.OVERWRITE);
- verify(channelSftp).disconnect();
- verify(session).disconnect();
- }
-
- @Test(expected = IOException.class)
- public void sftp_put_withSourcePath_shouldThrowIOException_whenSftpFails() throws Exception {
- //given
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- doThrow(new SftpException(ChannelSftp.SSH_FX_FAILURE, "general error"))
- .when(channelSftp).put(anyString(), anyString(), anyInt());
-
- //when
- spyInstance.put(SOURCE_PATH, REMOTE_PATH);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test(expected = IOException.class)
- public void sftp_put_withSourcePath_shouldThrowIOException_whenJschFails() throws Exception {
- //given
- SshJcraftWrapper spyInstance = spy(cut);
- doThrow(new JSchException()).when(spyInstance).openSftpChannel(session);
-
- //when
- spyInstance.put(SOURCE_PATH, REMOTE_PATH);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test
- public void sftpPutStringData_shouldPutInputStreamToRemotePath() throws Exception {
- //given
- String inputData = "Test data";
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
-
- //when
- spyInstance.sftpPutStringData(inputData, REMOTE_PATH);
-
- //then
- verify(channelSftp).put(any(InputStream.class), eq(REMOTE_PATH), eq(ChannelSftp.OVERWRITE));
- verify(channelSftp).disconnect();
- verify(session).disconnect();
- }
-
- @Test(expected = IOException.class)
- public void sftpPutStringData_shouldThrowIOException_whenJschFails() throws Exception {
- //given
- String inputData = "Test data";
- SshJcraftWrapper spyInstance = spy(cut);
- doThrow(new JSchException()).when(spyInstance).openSftpChannel(session);
-
- //when
- spyInstance.sftpPutStringData(inputData, REMOTE_PATH);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test(expected = IOException.class)
- public void sftpPutStringData_shouldThrowIOException_whenSftpFails() throws Exception {
- //given
- String inputData = "Test data";
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- doThrow(new SftpException(ChannelSftp.SSH_FX_FAILURE, "general error"))
- .when(channelSftp).put(any(InputStream.class), anyString(), anyInt());
-
- //when
- spyInstance.sftpPutStringData(inputData, REMOTE_PATH);
-
- //then
- fail(IO_EXCEPTION_MSG);
- }
-
- @Test
- public void sftpGet_shouldReadFromChannelInputStream_withInstanceCredentials() throws Exception {
- //given
- String remoteStreamContent = "test input stream content";
- SshJcraftWrapper spyInstance = spy(cut);
- given(spyInstance.openSftpChannel(session)).willReturn(channelSftp);
- given(channelSftp.get(REMOTE_PATH)).willReturn(IOUtils.toInputStream(remoteStreamContent, "UTF-8"));
-
- //when
- String result = spyInstance.sftpGet(REMOTE_PATH);
-
- //then
- assertEquals(remoteStreamContent, result);
- }