mpryahin commented on a change in pull request #1999:
URL: https://github.com/apache/hadoop/pull/1999#discussion_r427468540
##########
File path:
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/sftp/SFTPFileSystem.java
##########
@@ -516,16 +515,14 @@ public FSDataInputStream open(Path f, int bufferSize)
throws IOException {
disconnect(channel);
throw new IOException(String.format(E_PATH_DIR, f));
}
- InputStream is;
try {
// the path could be a symbolic link, so get the real path
absolute = new Path("/", channel.realpath(absolute.toUri().getPath()));
-
- is = channel.get(absolute.toUri().getPath());
} catch (SftpException e) {
throw new IOException(e);
}
- return new FSDataInputStream(new SFTPInputStream(is, statistics)){
+ return new FSDataInputStream(
+ new SFTPInputStream(channel, absolute, statistics)){
@Override
public void close() throws IOException {
super.close();
Review comment:
I'm afraid there'll be nothing to close in the finally block as the
`channel` is not opened here any longer. Am I missing something?
##########
File path:
hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/fs/contract/sftp/SFTPContract.java
##########
@@ -0,0 +1,108 @@
+/*
+ * 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.hadoop.fs.contract.sftp;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.FileSystemTestHelper;
+import org.apache.hadoop.fs.Path;
+import org.apache.hadoop.fs.contract.AbstractFSContract;
+import org.apache.hadoop.fs.sftp.SFTPFileSystem;
+import org.apache.sshd.common.NamedFactory;
+import org.apache.sshd.server.SshServer;
+import org.apache.sshd.server.auth.UserAuth;
+import org.apache.sshd.server.auth.password.UserAuthPasswordFactory;
+import org.apache.sshd.server.keyprovider.SimpleGeneratorHostKeyProvider;
+import org.apache.sshd.server.subsystem.sftp.SftpSubsystemFactory;
+
+public class SFTPContract extends AbstractFSContract {
+
+ private String testDataDir = new FileSystemTestHelper().getTestRootDir();
+ private Configuration conf;
+ public static final String CONTRACT_XML = "contract/sftp.xml";
+ private SshServer sshd;
+
+ public SFTPContract(Configuration conf) {
+ super(conf);
+ addConfResource(CONTRACT_XML);
+ this.conf = conf;
+ }
+
+ @Override
+ public void init() throws IOException {
+ sshd = SshServer.setUpDefaultServer();
+ // ask OS to assign a port
+ sshd.setPort(0);
+ sshd.setKeyPairProvider(new SimpleGeneratorHostKeyProvider());
+
+ List<NamedFactory<UserAuth>> userAuthFactories = new ArrayList<>();
+ userAuthFactories.add(new UserAuthPasswordFactory());
+
+ sshd.setUserAuthFactories(userAuthFactories);
+ sshd.setPasswordAuthenticator((username, password, session) ->
+ username.equals("user") && password.equals("password")
+ );
+
+ sshd.setSubsystemFactories(
+ Collections.singletonList(new SftpSubsystemFactory()));
+
+ sshd.start();
+ int port = sshd.getPort();
+
+ conf.setClass("fs.sftp.impl", SFTPFileSystem.class, FileSystem.class);
Review comment:
it's not set in core-default.xml, and if not specified here sftp urls
won't be able to be resolved by sftp schema. Could you please clarify a bit
what exactly you mean here? Thank you!
##########
File path:
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/sftp/SFTPInputStream.java
##########
@@ -15,86 +15,113 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
package org.apache.hadoop.fs.sftp;
+import java.io.EOFException;
import java.io.IOException;
import java.io.InputStream;
+import java.io.UncheckedIOException;
+import com.jcraft.jsch.ChannelSftp;
+import com.jcraft.jsch.SftpATTRS;
+import com.jcraft.jsch.SftpException;
+import org.apache.hadoop.fs.FSExceptionMessages;
import org.apache.hadoop.fs.FSInputStream;
import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.Path;
/** SFTP FileSystem input stream. */
class SFTPInputStream extends FSInputStream {
- public static final String E_SEEK_NOTSUPPORTED = "Seek not supported";
- public static final String E_NULL_INPUTSTREAM = "Null InputStream";
- public static final String E_STREAM_CLOSED = "Stream closed";
-
+ private final ChannelSftp channel;
+ private final Path path;
private InputStream wrappedStream;
private FileSystem.Statistics stats;
private boolean closed;
private long pos;
-
- SFTPInputStream(InputStream stream, FileSystem.Statistics stats) {
-
- if (stream == null) {
- throw new IllegalArgumentException(E_NULL_INPUTSTREAM);
+ private long nextPos;
+ private long contentLength;
+
+ SFTPInputStream(ChannelSftp channel, Path path, FileSystem.Statistics stats)
{
+ try {
+ this.channel = channel;
+ this.path = path;
+ this.stats = stats;
+ this.wrappedStream = channel.get(path.toUri().getPath());
+ SftpATTRS stat = channel.lstat(path.toString());
+ this.contentLength = stat.getSize();
+ } catch (SftpException e) {
+ throw new UncheckedIOException(new IOException(e));
Review comment:
I tried to keep the contract unchanged but it seems I dropped the ball:
Previously an inputstream instance was created in the
[SFTPFileSystem#open(Path f, int bufferSize)
](https://github.com/apache/hadoop/pull/1999/files#diff-8ca68dc8a67858d5cce25046f906605aL524)method
which threw `IOExpetion` in case of failure and its clients might deeply rely
on this behaviour. Now as an underlying inputstream creation was moved from
`SFTPFileSystem` into [FSDataInputStream
constructor](https://github.com/apache/hadoop/pull/1999/files#diff-a3ca2088031e534581a325dcb84161d4R51
) I should've added `IOExpetion` to the `FSDataInputStream` constructor
signature to keep things unchanged and backward compatible. Thanks a lot for
pointing out.
##########
File path:
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/sftp/SFTPInputStream.java
##########
@@ -15,86 +15,113 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
package org.apache.hadoop.fs.sftp;
+import java.io.EOFException;
import java.io.IOException;
import java.io.InputStream;
+import java.io.UncheckedIOException;
+import com.jcraft.jsch.ChannelSftp;
+import com.jcraft.jsch.SftpATTRS;
+import com.jcraft.jsch.SftpException;
+import org.apache.hadoop.fs.FSExceptionMessages;
import org.apache.hadoop.fs.FSInputStream;
import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.Path;
/** SFTP FileSystem input stream. */
class SFTPInputStream extends FSInputStream {
- public static final String E_SEEK_NOTSUPPORTED = "Seek not supported";
- public static final String E_NULL_INPUTSTREAM = "Null InputStream";
- public static final String E_STREAM_CLOSED = "Stream closed";
-
+ private final ChannelSftp channel;
+ private final Path path;
private InputStream wrappedStream;
private FileSystem.Statistics stats;
private boolean closed;
private long pos;
-
- SFTPInputStream(InputStream stream, FileSystem.Statistics stats) {
-
- if (stream == null) {
- throw new IllegalArgumentException(E_NULL_INPUTSTREAM);
+ private long nextPos;
+ private long contentLength;
+
+ SFTPInputStream(ChannelSftp channel, Path path, FileSystem.Statistics stats)
{
+ try {
+ this.channel = channel;
+ this.path = path;
+ this.stats = stats;
+ this.wrappedStream = channel.get(path.toUri().getPath());
+ SftpATTRS stat = channel.lstat(path.toString());
+ this.contentLength = stat.getSize();
+ } catch (SftpException e) {
+ throw new UncheckedIOException(new IOException(e));
}
- this.wrappedStream = stream;
- this.stats = stats;
+ }
- this.pos = 0;
- this.closed = false;
+ @Override
+ public synchronized void seek(long position) throws IOException {
+ checkNotClosed();
+ if (position < 0) {
+ throw new EOFException(FSExceptionMessages.NEGATIVE_SEEK);
+ }
+ nextPos = position;
}
@Override
- public void seek(long position) throws IOException {
- throw new IOException(E_SEEK_NOTSUPPORTED);
+ public synchronized int available() throws IOException {
+ checkNotClosed();
+ long remaining = contentLength - nextPos;
+ if (remaining > Integer.MAX_VALUE) {
+ return Integer.MAX_VALUE;
+ }
+ return (int) remaining;
+ }
+
+ private void seekInternal() throws IOException {
+ if (pos == nextPos) {
+ return;
+ }
+ if (nextPos > pos) {
+ long skipped = wrappedStream.skip(nextPos - pos);
+ pos = pos + skipped;
+ }
+ if (nextPos < pos) {
+ wrappedStream.close();
+ try {
+ wrappedStream = channel.get(path.toUri().getPath());
+ pos = wrappedStream.skip(nextPos);
+ } catch (SftpException e) {
+ throw new UncheckedIOException(new IOException(e));
Review comment:
my bad, i'll unwrap it. Thank you!
##########
File path:
hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/fs/contract/sftp/SFTPContract.java
##########
@@ -0,0 +1,108 @@
+/*
+ * 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.hadoop.fs.contract.sftp;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.FileSystemTestHelper;
+import org.apache.hadoop.fs.Path;
+import org.apache.hadoop.fs.contract.AbstractFSContract;
+import org.apache.hadoop.fs.sftp.SFTPFileSystem;
+import org.apache.sshd.common.NamedFactory;
+import org.apache.sshd.server.SshServer;
+import org.apache.sshd.server.auth.UserAuth;
+import org.apache.sshd.server.auth.password.UserAuthPasswordFactory;
+import org.apache.sshd.server.keyprovider.SimpleGeneratorHostKeyProvider;
+import org.apache.sshd.server.subsystem.sftp.SftpSubsystemFactory;
+
+public class SFTPContract extends AbstractFSContract {
+
+ private String testDataDir = new FileSystemTestHelper().getTestRootDir();
+ private Configuration conf;
+ public static final String CONTRACT_XML = "contract/sftp.xml";
+ private SshServer sshd;
+
+ public SFTPContract(Configuration conf) {
+ super(conf);
+ addConfResource(CONTRACT_XML);
+ this.conf = conf;
+ }
+
+ @Override
+ public void init() throws IOException {
+ sshd = SshServer.setUpDefaultServer();
+ // ask OS to assign a port
+ sshd.setPort(0);
+ sshd.setKeyPairProvider(new SimpleGeneratorHostKeyProvider());
+
+ List<NamedFactory<UserAuth>> userAuthFactories = new ArrayList<>();
+ userAuthFactories.add(new UserAuthPasswordFactory());
+
+ sshd.setUserAuthFactories(userAuthFactories);
+ sshd.setPasswordAuthenticator((username, password, session) ->
+ username.equals("user") && password.equals("password")
+ );
+
+ sshd.setSubsystemFactories(
+ Collections.singletonList(new SftpSubsystemFactory()));
+
+ sshd.start();
+ int port = sshd.getPort();
+
+ conf.setClass("fs.sftp.impl", SFTPFileSystem.class, FileSystem.class);
+ conf.setInt("fs.sftp.host.port", port);
+ conf.setBoolean("fs.sftp.impl.disable.cache", true);
+ }
+
+ @Override
+ public void teardown() throws IOException {
+ if (sshd != null) {
+ sshd.stop();
+ }
+ }
+
+ @Override
+ public FileSystem getTestFileSystem() throws IOException {
+ return FileSystem.get(URI.create("sftp://user:password@localhost";), conf);
Review comment:
will do, thank you!
##########
File path:
hadoop-common-project/hadoop-common/src/test/resources/contract/sftp.xml
##########
@@ -0,0 +1,79 @@
+<!--
+ ~ 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.
+ -->
+
+<configuration>
+ <!--
+ FTP -these options are for testing against a remote unix filesystem.
Review comment:
yep, thanks a lot.
##########
File path:
hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/fs/contract/sftp/SFTPContract.java
##########
@@ -0,0 +1,108 @@
+/*
+ * 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.hadoop.fs.contract.sftp;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.fs.FileSystem;
+import org.apache.hadoop.fs.FileSystemTestHelper;
+import org.apache.hadoop.fs.Path;
+import org.apache.hadoop.fs.contract.AbstractFSContract;
+import org.apache.hadoop.fs.sftp.SFTPFileSystem;
+import org.apache.sshd.common.NamedFactory;
+import org.apache.sshd.server.SshServer;
+import org.apache.sshd.server.auth.UserAuth;
+import org.apache.sshd.server.auth.password.UserAuthPasswordFactory;
+import org.apache.sshd.server.keyprovider.SimpleGeneratorHostKeyProvider;
+import org.apache.sshd.server.subsystem.sftp.SftpSubsystemFactory;
+
+public class SFTPContract extends AbstractFSContract {
+
+ private String testDataDir = new FileSystemTestHelper().getTestRootDir();
+ private Configuration conf;
+ public static final String CONTRACT_XML = "contract/sftp.xml";
+ private SshServer sshd;
+
+ public SFTPContract(Configuration conf) {
+ super(conf);
+ addConfResource(CONTRACT_XML);
+ this.conf = conf;
+ }
+
+ @Override
+ public void init() throws IOException {
+ sshd = SshServer.setUpDefaultServer();
+ // ask OS to assign a port
+ sshd.setPort(0);
+ sshd.setKeyPairProvider(new SimpleGeneratorHostKeyProvider());
+
+ List<NamedFactory<UserAuth>> userAuthFactories = new ArrayList<>();
+ userAuthFactories.add(new UserAuthPasswordFactory());
+
+ sshd.setUserAuthFactories(userAuthFactories);
+ sshd.setPasswordAuthenticator((username, password, session) ->
+ username.equals("user") && password.equals("password")
+ );
+
+ sshd.setSubsystemFactories(
+ Collections.singletonList(new SftpSubsystemFactory()));
+
+ sshd.start();
+ int port = sshd.getPort();
+
+ conf.setClass("fs.sftp.impl", SFTPFileSystem.class, FileSystem.class);
+ conf.setInt("fs.sftp.host.port", port);
+ conf.setBoolean("fs.sftp.impl.disable.cache", true);
+ }
+
+ @Override
+ public void teardown() throws IOException {
+ if (sshd != null) {
+ sshd.stop();
+ }
+ }
+
+ @Override
+ public FileSystem getTestFileSystem() throws IOException {
+ return FileSystem.get(URI.create("sftp://user:password@localhost";), conf);
+ }
+
+ @Override
+ public String getScheme() {
+ return "sftp";
+ }
+
+ @Override
+ public Path getTestPath() {
Review comment:
it's not too late, would you like me to try to declare it as throwing
IOE?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: common-issues-h...@hadoop.apache.org
