Added ChangeDirectoryAsync to SftpClient (#1504)

* Add ChangeDirectoryAsync

* Added async tests for ChangeDirectoryAsync

Author: snargledorf

src/Renci.SshNet/ISftpClient.cs

@@ -358,6 +358,20 @@ public interface ISftpClient : IBaseClient
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
         void ChangeDirectory(string path);
 
+        /// <summary>
+        /// Asynchronously requests to change the current working directory to the specified path.
+        /// </summary>
+        /// <param name="path">The new working directory.</param>
+        /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        /// <returns>A <see cref="Task"/> that tracks the asynchronous change working directory request.</returns>
+        /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
+        /// <exception cref="SshConnectionException">Client is not connected.</exception>
+        /// <exception cref="SftpPermissionDeniedException">Permission to change directory denied by remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
+        /// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
+        /// <exception cref="SshException">A SSH error where <see cref="Exception.Message"/> is the message from the remote host.</exception>
+        /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
+        Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken = default);
+
         /// <summary>
         /// Changes permissions of file(s) to specified mode.
         /// </summary>

src/Renci.SshNet/Sftp/ISftpSession.cs

@@ -34,6 +34,14 @@ internal interface ISftpSession : ISubsystemSession
         /// <param name="path">The new working directory.</param>
         void ChangeDirectory(string path);
 
+        /// <summary>
+        /// Asynchronously requests to change the current working directory to the specified path.
+        /// </summary>
+        /// <param name="path">The new working directory.</param>
+        /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        /// <returns>A <see cref="Task"/> that tracks the asynchronous change working directory request.</returns>
+        Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken = default);
+
         /// <summary>
         /// Resolves a given path into an absolute path on the server.
         /// </summary>

src/Renci.SshNet/Sftp/SftpSession.cs

@@ -82,6 +82,24 @@ public void ChangeDirectory(string path)
             WorkingDirectory = fullPath;
         }
 
+        /// <summary>
+        /// Asynchronously requests to change the current working directory to the specified path.
+        /// </summary>
+        /// <param name="path">The new working directory.</param>
+        /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        /// <returns>A <see cref="Task"/> that tracks the asynchronous change working directory request.</returns>
+        public async Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken = default)
+        {
+            cancellationToken.ThrowIfCancellationRequested();
+
+            var fullPath = await GetCanonicalPathAsync(path, cancellationToken).ConfigureAwait(false);
+            var handle = await RequestOpenDirAsync(fullPath, cancellationToken).ConfigureAwait(false);
+
+            await RequestCloseAsync(handle, cancellationToken).ConfigureAwait(false);
+
+            WorkingDirectory = fullPath;
+        }
+
         internal void SendMessage(SftpMessage sftpMessage)
         {
             var data = sftpMessage.GetBytes();

src/Renci.SshNet/SftpClient.cs

@@ -305,6 +305,33 @@ public void ChangeDirectory(string path)
             _sftpSession.ChangeDirectory(path);
         }
 
+        /// <summary>
+        /// Asynchronously requests to change the current working directory to the specified path.
+        /// </summary>
+        /// <param name="path">The new working directory.</param>
+        /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        /// <returns>A <see cref="Task"/> that tracks the asynchronous change working directory request.</returns>
+        /// <exception cref="ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
+        /// <exception cref="SshConnectionException">Client is not connected.</exception>
+        /// <exception cref="SftpPermissionDeniedException">Permission to change directory denied by remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
+        /// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
+        /// <exception cref="SshException">A SSH error where <see cref="Exception.Message"/> is the message from the remote host.</exception>
+        /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
+        public Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken = default)
+        {
+            CheckDisposed();
+            ThrowHelper.ThrowIfNull(path);
+
+            if (_sftpSession is null)
+            {
+                throw new SshConnectionException("Client not connected.");
+            }
+
+            cancellationToken.ThrowIfCancellationRequested();
+
+            return _sftpSession.ChangeDirectoryAsync(path, cancellationToken);
+        }
+
         /// <summary>
         /// Changes permissions of file(s) to specified mode.
         /// </summary>

test/Renci.SshNet.IntegrationTests/OldIntegrationTests/SftpClientTest.ChangeDirectory.cs

@@ -19,6 +19,18 @@ public void Test_Sftp_ChangeDirectory_Root_Dont_Exists()
             }
         }
 
+        [TestMethod]
+        [TestCategory("Sftp")]
+        [ExpectedException(typeof(SftpPathNotFoundException))]
+        public async Task Test_Sftp_ChangeDirectory_Root_Dont_ExistsAsync()
+        {
+            using (var sftp = new SftpClient(SshServerHostName, SshServerPort, User.UserName, User.Password))
+            {
+                await sftp.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+                await sftp.ChangeDirectoryAsync("/asdasd", CancellationToken.None).ConfigureAwait(false);
+            }
+        }
+
         [TestMethod]
         [TestCategory("Sftp")]
         [ExpectedException(typeof(SftpPathNotFoundException))]
@@ -31,6 +43,18 @@ public void Test_Sftp_ChangeDirectory_Root_With_Slash_Dont_Exists()
             }
         }
 
+        [TestMethod]
+        [TestCategory("Sftp")]
+        [ExpectedException(typeof(SftpPathNotFoundException))]
+        public async Task Test_Sftp_ChangeDirectory_Root_With_Slash_Dont_ExistsAsync()
+        {
+            using (var sftp = new SftpClient(SshServerHostName, SshServerPort, User.UserName, User.Password))
+            {
+                await sftp.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+                await sftp.ChangeDirectoryAsync("/asdasd/", CancellationToken.None).ConfigureAwait(false);
+            }
+        }
+
         [TestMethod]
         [TestCategory("Sftp")]
         [ExpectedException(typeof(SftpPathNotFoundException))]
@@ -43,6 +67,18 @@ public void Test_Sftp_ChangeDirectory_Subfolder_Dont_Exists()
             }
         }
 
+        [TestMethod]
+        [TestCategory("Sftp")]
+        [ExpectedException(typeof(SftpPathNotFoundException))]
+        public async Task Test_Sftp_ChangeDirectory_Subfolder_Dont_ExistsAsync()
+        {
+            using (var sftp = new SftpClient(SshServerHostName, SshServerPort, User.UserName, User.Password))
+            {
+                await sftp.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+                await sftp.ChangeDirectoryAsync("/asdasd/sssddds", CancellationToken.None).ConfigureAwait(false);
+            }
+        }
+
         [TestMethod]
         [TestCategory("Sftp")]
         [ExpectedException(typeof(SftpPathNotFoundException))]
@@ -55,6 +91,18 @@ public void Test_Sftp_ChangeDirectory_Subfolder_With_Slash_Dont_Exists()
             }
         }
 
+        [TestMethod]
+        [TestCategory("Sftp")]
+        [ExpectedException(typeof(SftpPathNotFoundException))]
+        public async Task Test_Sftp_ChangeDirectory_Subfolder_With_Slash_Dont_ExistsAsync()
+        {
+            using (var sftp = new SftpClient(SshServerHostName, SshServerPort, User.UserName, User.Password))
+            {
+                await sftp.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+                await sftp.ChangeDirectoryAsync("/asdasd/sssddds/", CancellationToken.None).ConfigureAwait(false);
+            }
+        }
+
         [TestMethod]
         [TestCategory("Sftp")]
         public void Test_Sftp_ChangeDirectory_Which_Exists()
@@ -67,6 +115,18 @@ public void Test_Sftp_ChangeDirectory_Which_Exists()
             }
         }
 
+        [TestMethod]
+        [TestCategory("Sftp")]
+        public async Task Test_Sftp_ChangeDirectory_Which_ExistsAsync()
+        {
+            using (var sftp = new SftpClient(SshServerHostName, SshServerPort, User.UserName, User.Password))
+            {
+                await sftp.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+                await sftp.ChangeDirectoryAsync("/usr", CancellationToken.None).ConfigureAwait(false);
+                Assert.AreEqual("/usr", sftp.WorkingDirectory);
+            }
+        }
+
         [TestMethod]
         [TestCategory("Sftp")]
         public void Test_Sftp_ChangeDirectory_Which_Exists_With_Slash()
@@ -78,5 +138,17 @@ public void Test_Sftp_ChangeDirectory_Which_Exists_With_Slash()
                 Assert.AreEqual("/usr", sftp.WorkingDirectory);
             }
         }
+
+        [TestMethod]
+        [TestCategory("Sftp")]
+        public async Task Test_Sftp_ChangeDirectory_Which_Exists_With_SlashAsync()
+        {
+            using (var sftp = new SftpClient(SshServerHostName, SshServerPort, User.UserName, User.Password))
+            {
+                await sftp.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+                await sftp.ChangeDirectoryAsync("/usr/", CancellationToken.None).ConfigureAwait(false);
+                Assert.AreEqual("/usr", sftp.WorkingDirectory);
+            }
+        }
     }
 }

test/Renci.SshNet.IntegrationTests/OldIntegrationTests/SftpClientTest.ListDirectory.cs

@@ -229,6 +229,75 @@ public void Test_Sftp_Change_Directory()
             RemoveAllFiles();
         }
 
+        [TestMethod]
+        [TestCategory("Sftp")]
+        public async Task Test_Sftp_Change_DirectoryAsync()
+        {
+            using (var sftp = new SftpClient(SshServerHostName, SshServerPort, User.UserName, User.Password))
+            {
+                await sftp.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet");
+
+                sftp.CreateDirectory("test1");
+
+                await sftp.ChangeDirectoryAsync("test1", CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet/test1");
+
+                sftp.CreateDirectory("test1_1");
+                sftp.CreateDirectory("test1_2");
+                sftp.CreateDirectory("test1_3");
+
+                var files = sftp.ListDirectory(".");
+
+                Assert.IsTrue(files.First().FullName.StartsWith(string.Format("{0}", sftp.WorkingDirectory)));
+
+                await sftp.ChangeDirectoryAsync("test1_1", CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet/test1/test1_1");
+
+                await sftp.ChangeDirectoryAsync("../test1_2", CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet/test1/test1_2");
+
+                await sftp.ChangeDirectoryAsync("..", CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet/test1");
+
+                await sftp.ChangeDirectoryAsync("..", CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet");
+
+                files = sftp.ListDirectory("test1/test1_1");
+
+                Assert.IsTrue(files.First().FullName.StartsWith(string.Format("{0}/test1/test1_1", sftp.WorkingDirectory)));
+
+                await sftp.ChangeDirectoryAsync("test1/test1_1", CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet/test1/test1_1");
+
+                await sftp.ChangeDirectoryAsync("/home/sshnet/test1/test1_1", CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet/test1/test1_1");
+
+                await sftp.ChangeDirectoryAsync("/home/sshnet/test1/test1_1/../test1_2", CancellationToken.None).ConfigureAwait(false);
+
+                Assert.AreEqual(sftp.WorkingDirectory, "/home/sshnet/test1/test1_2");
+
+                await sftp.ChangeDirectoryAsync("../../", CancellationToken.None).ConfigureAwait(false);
+
+                sftp.DeleteDirectory("test1/test1_1");
+                sftp.DeleteDirectory("test1/test1_2");
+                sftp.DeleteDirectory("test1/test1_3");
+                sftp.DeleteDirectory("test1");
+
+                sftp.Disconnect();
+            }
+
+            RemoveAllFiles();
+        }
+
         [TestMethod]
         [TestCategory("Sftp")]
         [Description("Test passing null to ChangeDirectory.")]
@@ -245,6 +314,22 @@ public void Test_Sftp_ChangeDirectory_Null()
             }
         }
 
+        [TestMethod]
+        [TestCategory("Sftp")]
+        [Description("Test passing null to ChangeDirectory.")]
+        [ExpectedException(typeof(ArgumentNullException))]
+        public async Task Test_Sftp_ChangeDirectory_NullAsync()
+        {
+            using (var sftp = new SftpClient(SshServerHostName, SshServerPort, User.UserName, User.Password))
+            {
+                await sftp.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+
+                await sftp.ChangeDirectoryAsync(null, CancellationToken.None).ConfigureAwait(false);
+
+                sftp.Disconnect();
+            }
+        }
+
         [TestMethod]
         [TestCategory("Sftp")]
         [Description("Test calling EndListDirectory method more then once.")]