sshd-core/src/test/java/org/apache/sshd/SftpTest.java - mina-sshd - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.
  */
 package org.apache.sshd;

 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.URI;
 import java.util.Arrays;
 import java.util.EnumSet;
 import java.util.Vector;

 import com.jcraft.jsch.ChannelSftp;
 import com.jcraft.jsch.JSch;
 import org.apache.sshd.client.SftpClient;
 import org.apache.sshd.common.NamedFactory;
 import org.apache.sshd.server.Command;
 import org.apache.sshd.server.command.ScpCommandFactory;
 import org.apache.sshd.server.sftp.SftpSubsystem;
 import org.apache.sshd.util.BaseTest;
 import org.apache.sshd.util.BogusPasswordAuthenticator;
 import org.apache.sshd.util.EchoShellFactory;
 import org.apache.sshd.util.JSchLogger;
 import org.apache.sshd.util.SimpleUserInfo;
 import org.apache.sshd.util.Utils;
 import org.junit.After;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Ignore;
 import org.junit.Test;

 import static junit.framework.Assert.assertNotNull;
 import static junit.framework.Assert.assertNull;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;

 public class SftpTest extends BaseTest {

     private SshServer sshd;
     private int port;
     private com.jcraft.jsch.Session session;

     @Before
     public void setUp() throws Exception {
         port = Utils.getFreePort();

         sshd = SshServer.setUpDefaultServer();
         sshd.setPort(port);
         sshd.setKeyPairProvider(Utils.createTestHostKeyProvider());
         sshd.setSubsystemFactories(Arrays.<NamedFactory<Command>>asList(new SftpSubsystem.Factory()));
         sshd.setCommandFactory(new ScpCommandFactory());
         sshd.setShellFactory(new EchoShellFactory());
         sshd.setPasswordAuthenticator(new BogusPasswordAuthenticator());
         sshd.start();

         JSchLogger.init();
         JSch sch = new JSch();
         session = sch.getSession("sshd", "localhost", port);
         session.setUserInfo(new SimpleUserInfo("sshd"));
         session.connect();
     }

     @After
     public void tearDown() throws Exception {
         session.disconnect();
         sshd.stop();
     }

     @Test
     @Ignore
     public void testExternal() throws Exception {
         System.out.println("SFTP subsystem available on port " + port);
         Thread.sleep(5 * 60000);
     }

     @Test
     public void testClient() throws Exception {
         SshClient client = SshClient.setUpDefaultClient();
         client.start();
         ClientSession session = client.connect("localhost", port).await().getSession();
         session.authPassword("x", "x").await();

         Utils.deleteRecursive(new File("target/sftp"));
         new File("target/sftp").mkdirs();
         new File("target/sftp/client/test.txt").delete();
         new File("target/sftp/client").delete();

         SftpClient sftp = session.createSftpClient();

         sftp.mkdir("target/sftp/client");

         SftpClient.Handle h = sftp.open("target/sftp/client/test.txt", EnumSet.of(SftpClient.OpenMode.Write));
         byte[] d = "0123456789\n".getBytes();
         sftp.write(h, 0, d, 0, d.length);
         sftp.write(h, d.length, d, 0, d.length);

         SftpClient.Attributes attrs = sftp.stat(h);
         Assert.assertNotNull(attrs);

         sftp.close(h);

         h = sftp.openDir("target/sftp/client");
         SftpClient.DirEntry[] dir = sftp.readDir(h);
         assertNotNull(dir);
         assertEquals(1, dir.length);
         assertNull(sftp.readDir(h));
         sftp.close(h);

         sftp.remove("target/sftp/client/test.txt");

         OutputStream os = sftp.write("target/sftp/client/test.txt");
         os.write(new byte[1024 * 128]);
         os.close();

         InputStream is = sftp.read("target/sftp/client/test.txt");
         is.read(new byte[1024 * 128]);
         int i = is.read();
         is.close();

         int nb = 0;
         for (SftpClient.DirEntry entry : sftp.readDir("target/sftp/client")) {
             nb++;
         }
         assertEquals(1, nb);

         sftp.remove("target/sftp/client/test.txt");

         sftp.rmdir("target/sftp/client/");

         sftp.close();

         client.stop();
     }

     @Test
     public void testSftp() throws Exception {
         String d = "0123456789\n";

         File root = new File("target/sftp");
         File target = new File("target/sftp/out.txt");
         Utils.deleteRecursive(root);
         root.mkdirs();
         assertTrue(root.exists());

         for (int j = 10; j <= 10; j++) {
             String data = "";
             for (int i = 0; i < j; i++) {
                 data = data + d;
             }

             target.delete();
             assertFalse(target.exists());
             sendFile("target/sftp/out.txt", data);
             assertFileLength(target, data.length(), 5000);

             target.delete();
             assertFalse(target.exists());
         }
         root.delete();
     }

     @Test
     public void testReadWriteWithOffset() throws Exception {
         File root = new File("target/sftp");
         String unixPath = "target/sftp/out.txt";
         File target = new File(unixPath);
         Utils.deleteRecursive(root);
         root.mkdirs();
         assertTrue(root.exists());

         ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
         c.connect();
         c.put(new ByteArrayInputStream("0123456789".getBytes()), unixPath);

         assertTrue(target.exists());
         assertEquals("0123456789", readFile(unixPath));

         OutputStream os = c.put(unixPath, null, ChannelSftp.APPEND, -5);
         os.write("a".getBytes());
         os.close();
         c.disconnect();

         assertTrue(target.exists());
         assertEquals("01234a", readFile(unixPath));

         target.delete();
         assertFalse(target.exists());
         root.delete();
     }

     @Test
     public void testReadDir() throws Exception {
         ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
         c.connect();

         URI url = getClass().getClassLoader().getResource(SshClient.class.getName().replace('.', '/') + ".class").toURI();
         URI base = new File(System.getProperty("user.dir")).getAbsoluteFile().toURI();
         String path = new File(base.relativize(url).getPath()).getParent() + "/";
         path = path.replace('\\', '/');
         Vector res = c.ls(path);
         for (Object f : res) {
             System.out.println(f.toString());
         }
     }

     @Test
     public void testRealPath() throws Exception {
         ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
         c.connect();

         URI url = getClass().getClassLoader().getResource(SshClient.class.getName().replace('.', '/') + ".class").toURI();
         URI base = new File(System.getProperty("user.dir")).getAbsoluteFile().toURI();
         String path = new File(base.relativize(url).getPath()).getParent() + "/";
         path = path.replace('\\', '/');
         String real = c.realpath(path + "/foobar");
         System.out.println(real);
     }

     @Test
     public void testCreateSymbolicLink() throws Exception {
         // Do not execute on windows as the file system does not support symlinks
         if (System.getProperty("os.name").toLowerCase().contains("win")) {
             return;
         }

         File root = new File("target/sftp");
         String unixPath = "target/sftp/out.txt";
         String linkUnixPath = "target/sftp/link.txt";
         File target = new File(unixPath);
         File link = new File(linkUnixPath);
         Utils.deleteRecursive(root);
         root.mkdirs();
         assertTrue(root.exists());

         ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
         c.connect();
         c.put(new ByteArrayInputStream("0123456789".getBytes()), unixPath);

         assertTrue(target.exists());
         assertEquals("0123456789", readFile(unixPath));

         c.symlink(unixPath, linkUnixPath);

         assertTrue(link.exists());
         assertEquals("0123456789", readFile(linkUnixPath));

         String str1 = c.readlink(linkUnixPath);
         String str2 = c.realpath(unixPath);
         assertEquals(str1, str2);
     }

     protected void assertFileLength(File file, long length, long timeout) throws Exception {
         boolean ok = false;
         while (timeout > 0) {
             if (file.exists() && file.length() == length) {
                 if (!ok) {
                     ok = true;
                 } else {
                     return;
                 }
             } else {
                 ok = false;
             }
             Thread.sleep(100);
             timeout -= 100;
         }
         assertTrue(file.exists());
         assertEquals(length, file.length());
     }

     protected String readFile(String path) throws Exception {
         ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
         c.connect();
         ByteArrayOutputStream bos = new ByteArrayOutputStream();
         InputStream is = c.get(path);
         try {
             byte[] buffer = new byte[256];
             int count;
             while (-1 != (count = is.read(buffer))) {
                 bos.write(buffer, 0, count);
             }
         } finally {
             is.close();
         }

         c.disconnect();
         return new String(bos.toByteArray());
     }

     protected void sendFile(String path, String data) throws Exception {
         ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
         c.connect();
         c.put(new ByteArrayInputStream(data.getBytes()), path);
         c.disconnect();
     }

 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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.
	*/
	package org.apache.sshd;

	import java.io.ByteArrayInputStream;
	import java.io.ByteArrayOutputStream;
	import java.io.File;
	import java.io.InputStream;
	import java.io.OutputStream;
	import java.net.URI;
	import java.util.Arrays;
	import java.util.EnumSet;
	import java.util.Vector;

	import com.jcraft.jsch.ChannelSftp;
	import com.jcraft.jsch.JSch;
	import org.apache.sshd.client.SftpClient;
	import org.apache.sshd.common.NamedFactory;
	import org.apache.sshd.server.Command;
	import org.apache.sshd.server.command.ScpCommandFactory;
	import org.apache.sshd.server.sftp.SftpSubsystem;
	import org.apache.sshd.util.BaseTest;
	import org.apache.sshd.util.BogusPasswordAuthenticator;
	import org.apache.sshd.util.EchoShellFactory;
	import org.apache.sshd.util.JSchLogger;
	import org.apache.sshd.util.SimpleUserInfo;
	import org.apache.sshd.util.Utils;
	import org.junit.After;
	import org.junit.Assert;
	import org.junit.Before;
	import org.junit.Ignore;
	import org.junit.Test;

	import static junit.framework.Assert.assertNotNull;
	import static junit.framework.Assert.assertNull;
	import static org.junit.Assert.assertEquals;
	import static org.junit.Assert.assertFalse;
	import static org.junit.Assert.assertTrue;

	public class SftpTest extends BaseTest {

	private SshServer sshd;
	private int port;
	private com.jcraft.jsch.Session session;

	@Before
	public void setUp() throws Exception {
	port = Utils.getFreePort();

	sshd = SshServer.setUpDefaultServer();
	sshd.setPort(port);
	sshd.setKeyPairProvider(Utils.createTestHostKeyProvider());
	sshd.setSubsystemFactories(Arrays.<NamedFactory<Command>>asList(new SftpSubsystem.Factory()));
	sshd.setCommandFactory(new ScpCommandFactory());
	sshd.setShellFactory(new EchoShellFactory());
	sshd.setPasswordAuthenticator(new BogusPasswordAuthenticator());
	sshd.start();

	JSchLogger.init();
	JSch sch = new JSch();
	session = sch.getSession("sshd", "localhost", port);
	session.setUserInfo(new SimpleUserInfo("sshd"));
	session.connect();
	}

	@After
	public void tearDown() throws Exception {
	session.disconnect();
	sshd.stop();
	}

	@Test
	@Ignore
	public void testExternal() throws Exception {
	System.out.println("SFTP subsystem available on port " + port);
	Thread.sleep(5 * 60000);
	}

	@Test
	public void testClient() throws Exception {
	SshClient client = SshClient.setUpDefaultClient();
	client.start();
	ClientSession session = client.connect("localhost", port).await().getSession();
	session.authPassword("x", "x").await();

	Utils.deleteRecursive(new File("target/sftp"));
	new File("target/sftp").mkdirs();
	new File("target/sftp/client/test.txt").delete();
	new File("target/sftp/client").delete();

	SftpClient sftp = session.createSftpClient();

	sftp.mkdir("target/sftp/client");

	SftpClient.Handle h = sftp.open("target/sftp/client/test.txt", EnumSet.of(SftpClient.OpenMode.Write));
	byte[] d = "0123456789\n".getBytes();
	sftp.write(h, 0, d, 0, d.length);
	sftp.write(h, d.length, d, 0, d.length);

	SftpClient.Attributes attrs = sftp.stat(h);
	Assert.assertNotNull(attrs);

	sftp.close(h);

	h = sftp.openDir("target/sftp/client");
	SftpClient.DirEntry[] dir = sftp.readDir(h);
	assertNotNull(dir);
	assertEquals(1, dir.length);
	assertNull(sftp.readDir(h));
	sftp.close(h);

	sftp.remove("target/sftp/client/test.txt");

	OutputStream os = sftp.write("target/sftp/client/test.txt");
	os.write(new byte[1024 * 128]);
	os.close();

	InputStream is = sftp.read("target/sftp/client/test.txt");
	is.read(new byte[1024 * 128]);
	int i = is.read();
	is.close();

	int nb = 0;
	for (SftpClient.DirEntry entry : sftp.readDir("target/sftp/client")) {
	nb++;
	}
	assertEquals(1, nb);

	sftp.remove("target/sftp/client/test.txt");

	sftp.rmdir("target/sftp/client/");

	sftp.close();

	client.stop();
	}

	@Test
	public void testSftp() throws Exception {
	String d = "0123456789\n";

	File root = new File("target/sftp");
	File target = new File("target/sftp/out.txt");
	Utils.deleteRecursive(root);
	root.mkdirs();
	assertTrue(root.exists());

	for (int j = 10; j <= 10; j++) {
	String data = "";
	for (int i = 0; i < j; i++) {
	data = data + d;
	}

	target.delete();
	assertFalse(target.exists());
	sendFile("target/sftp/out.txt", data);
	assertFileLength(target, data.length(), 5000);

	target.delete();
	assertFalse(target.exists());
	}
	root.delete();
	}

	@Test
	public void testReadWriteWithOffset() throws Exception {
	File root = new File("target/sftp");
	String unixPath = "target/sftp/out.txt";
	File target = new File(unixPath);
	Utils.deleteRecursive(root);
	root.mkdirs();
	assertTrue(root.exists());

	ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
	c.connect();
	c.put(new ByteArrayInputStream("0123456789".getBytes()), unixPath);

	assertTrue(target.exists());
	assertEquals("0123456789", readFile(unixPath));

	OutputStream os = c.put(unixPath, null, ChannelSftp.APPEND, -5);
	os.write("a".getBytes());
	os.close();
	c.disconnect();

	assertTrue(target.exists());
	assertEquals("01234a", readFile(unixPath));

	target.delete();
	assertFalse(target.exists());
	root.delete();
	}

	@Test
	public void testReadDir() throws Exception {
	ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
	c.connect();

	URI url = getClass().getClassLoader().getResource(SshClient.class.getName().replace('.', '/') + ".class").toURI();
	URI base = new File(System.getProperty("user.dir")).getAbsoluteFile().toURI();
	String path = new File(base.relativize(url).getPath()).getParent() + "/";
	path = path.replace('\\', '/');
	Vector res = c.ls(path);
	for (Object f : res) {
	System.out.println(f.toString());
	}
	}

	@Test
	public void testRealPath() throws Exception {
	ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
	c.connect();

	URI url = getClass().getClassLoader().getResource(SshClient.class.getName().replace('.', '/') + ".class").toURI();
	URI base = new File(System.getProperty("user.dir")).getAbsoluteFile().toURI();
	String path = new File(base.relativize(url).getPath()).getParent() + "/";
	path = path.replace('\\', '/');
	String real = c.realpath(path + "/foobar");
	System.out.println(real);
	}

	@Test
	public void testCreateSymbolicLink() throws Exception {
	// Do not execute on windows as the file system does not support symlinks
	if (System.getProperty("os.name").toLowerCase().contains("win")) {
	return;
	}

	File root = new File("target/sftp");
	String unixPath = "target/sftp/out.txt";
	String linkUnixPath = "target/sftp/link.txt";
	File target = new File(unixPath);
	File link = new File(linkUnixPath);
	Utils.deleteRecursive(root);
	root.mkdirs();
	assertTrue(root.exists());

	ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
	c.connect();
	c.put(new ByteArrayInputStream("0123456789".getBytes()), unixPath);

	assertTrue(target.exists());
	assertEquals("0123456789", readFile(unixPath));

	c.symlink(unixPath, linkUnixPath);

	assertTrue(link.exists());
	assertEquals("0123456789", readFile(linkUnixPath));

	String str1 = c.readlink(linkUnixPath);
	String str2 = c.realpath(unixPath);
	assertEquals(str1, str2);
	}

	protected void assertFileLength(File file, long length, long timeout) throws Exception {
	boolean ok = false;
	while (timeout > 0) {
	if (file.exists() && file.length() == length) {
	if (!ok) {
	ok = true;
	} else {
	return;
	}
	} else {
	ok = false;
	}
	Thread.sleep(100);
	timeout -= 100;
	}
	assertTrue(file.exists());
	assertEquals(length, file.length());
	}

	protected String readFile(String path) throws Exception {
	ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
	c.connect();
	ByteArrayOutputStream bos = new ByteArrayOutputStream();
	InputStream is = c.get(path);
	try {
	byte[] buffer = new byte[256];
	int count;
	while (-1 != (count = is.read(buffer))) {
	bos.write(buffer, 0, count);
	}
	} finally {
	is.close();
	}

	c.disconnect();
	return new String(bos.toByteArray());
	}

	protected void sendFile(String path, String data) throws Exception {
	ChannelSftp c = (ChannelSftp) session.openChannel("sftp");
	c.connect();
	c.put(new ByteArrayInputStream(data.getBytes()), path);
	c.disconnect();
	}

	}