Merge pull request #141 from FrendsPlatform/issue-40

Frends.SFTP.DownloadFiles - Added new result attribute for destination file paths
FrendsPlatform · May 17, 2023 · af495ec · af495ec
2 parents 4aa60cb + 5e432ff
commit af495ec
Show file tree

Hide file tree

Showing 9 changed files with 576 additions and 547 deletions.
diff --git a/Frends.SFTP.DownloadFiles/CHANGELOG.md b/Frends.SFTP.DownloadFiles/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.6.0] - 2023-05-16
+### Added
+- Added new result attribute TransferredDestinationFilePaths list consisting of the destination file paths.
+
 ## [2.5.4] - 2023-02-14
 ### Added
 - Re-enabled key exchange algorithms 'curve25519-sha256' and 'curve25519-sha256@libssh.org'.

diff --git a/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles.Tests/MacroTests.cs b/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles.Tests/MacroTests.cs
@@ -1,6 +1,7 @@
 using NUnit.Framework;
 using System.IO;
 using System;
+using System.Linq;
 using System.Threading;
 using Frends.SFTP.DownloadFiles.Definitions;
 
@@ -22,7 +23,9 @@ public void DownloadFiles_TestUsingMacros()
             var result = SFTP.DownloadFiles(_source, destination, _connection, _options, _info, new CancellationToken());
             Assert.IsTrue(result.Success);
             var date = DateTime.Now;
-            Assert.IsTrue(File.Exists(Path.Combine(_destWorkDir, "SFTPDownloadTestFile1" + date.ToString(@"yyyy-MM-dd") + ".txt")));
+            var file = Path.Combine(_destWorkDir, "SFTPDownloadTestFile1" + date.ToString(@"yyyy-MM-dd") + ".txt");
+            Assert.AreEqual(file, result.TransferredDestinationFilePaths.ToList().FirstOrDefault());
+            Assert.IsTrue(File.Exists(file));
         }
 
         [Test]

diff --git a/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles.Tests/TransferTests.cs b/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles.Tests/TransferTests.cs
@@ -1,6 +1,7 @@
 using NUnit.Framework;
 using System;
 using System.IO;
+using System.Linq;
 using System.Threading;
 using System.Collections.Generic;
 using Frends.SFTP.DownloadFiles.Definitions;
@@ -16,6 +17,7 @@ public void DownloadFiles_TestSimpleTransfer()
             var result = SFTP.DownloadFiles(_source, _destination, _connection, _options, _info, new CancellationToken());
             Assert.IsTrue(result.Success);
             Assert.AreEqual(1, result.SuccessfulTransferCount);
+            Assert.AreEqual(Path.Combine(_destination.Directory, _source.FileName), result.TransferredDestinationFilePaths.ToList().FirstOrDefault());
         }
 
         [Test]

diff --git a/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles/Definitions/FileTransferResult.cs b/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles/Definitions/FileTransferResult.cs
@@ -18,6 +18,8 @@ internal class FileTransferResult
 
     public IEnumerable<string> TransferredFilePaths { get; set; }
 
+    public IEnumerable<string> TransferredDestinationFilePaths { get; set; }
+
     public IDictionary<string, string> OperationsLog { get; set; }
 }
 
diff --git a/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles/Definitions/FileTransporter.cs b/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles/Definitions/FileTransporter.cs
@@ -461,6 +461,7 @@ private static FileTransferResult FormFailedFileTransferResult(string userResult
             TransferredFileNames = new List<string>(),
             TransferErrors = new Dictionary<string, IList<string>>(),
             TransferredFilePaths = new List<string>(),
+            TransferredDestinationFilePaths = new List<string>(),
             OperationsLog = new Dictionary<string, string>()
         };
     }
@@ -488,6 +489,7 @@ private FileTransferResult FormResultFromSingleTransferResults(List<SingleFileTr
             TransferredFileNames = transferredFileResults.Select(r => r.TransferredFile ?? "--unknown--").ToList(),
             TransferErrors = transferErrors,
             TransferredFilePaths = transferredFileResults.Select(r => r.TransferredFilePath ?? "--unknown--").ToList(),
+            TransferredDestinationFilePaths = transferredFileResults.Select(s => s.DestinationFilePath ?? "--unknown--").ToList(),
             OperationsLog = (singleResults.Any(x => !x.EnableOperationsLog)) ? null : new Dictionary<string, string>()
         };
     }

diff --git a/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles/Definitions/Result.cs b/Frends.SFTP.DownloadFiles/Frends.SFTP.DownloadFiles/Definitions/Result.cs
@@ -77,13 +77,24 @@ public class Result
     /// <example>
     /// <code>
     /// [
-    ///     "C:\\test\\test.txt",
-    ///     "C:\\test\\test2.txt"
+    ///     "/Upload/upload/test.txt",
+    ///     "/Upload/upload/test2.txt"
     /// ]
     /// </code>
     /// </example>
     public IEnumerable<string> TransferredFilePaths { get; private set; }
 
+    /// <summary>
+    /// List of destination file paths of the transferred files.
+    /// </summary>
+    /// <example>
+    /// [
+    ///     "C:\\test\\test.txt",
+    ///     "C:\\test\\test2.txt"
+    /// ]
+    /// </example>
+    public IEnumerable<string> TransferredDestinationFilePaths { get; private set; }
+
     /// <summary>
     /// Operations logs for the transfer.
     /// </summary>
@@ -107,6 +118,7 @@ internal Result(FileTransferResult result)
         TransferredFileNames = result.TransferredFileNames;
         TransferErrors = result.TransferErrors;
         TransferredFilePaths = result.TransferredFilePaths;
+        TransferredDestinationFilePaths = result.TransferredDestinationFilePaths;
         OperationsLog = result.OperationsLog;
     }
 }