Merge pull request #142 from FrendsPlatform/issue-39

Frends.SFTP.UploadFiles - Added new result attribute

Frends.SFTP.UploadFiles/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.6.0] - 2023-05-16
+### Added
+- Added new result attribute TransferredDestinationFilePaths list consisting of the file paths of destination files.
+
 ## [2.5.5] - 2023-05-05
 ### Fixed
 - Fixed Permission denied error when using mounted CIFS share by canonizing the destination path. 

Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles.Tests/MacroTests.cs

@@ -1,6 +1,7 @@
 using NUnit.Framework;
 using System.IO;
 using System;
+using System.Linq;
 using System.Threading;
 using Frends.SFTP.UploadFiles.Definitions;
 
@@ -24,7 +25,9 @@ public void UploadFiles_TestUsingMacros()
             var result = SFTP.UploadFiles(_source, destination, _connection, _options, _info, new CancellationToken());
             Assert.IsTrue(result.Success);
             var date = DateTime.Now;
-            Assert.IsTrue(Helpers.CheckFileExistsInDestination("/upload/Upload/SFTPUploadTestFile1" + date.ToString(@"yyyy-MM-dd") + ".txt"));
+            var file = "/upload/Upload/SFTPUploadTestFile1" + date.ToString(@"yyyy-MM-dd") + ".txt";
+            Assert.AreEqual(file, result.TransferredDestinationFilePaths.ToList().FirstOrDefault());
+            Assert.IsTrue(Helpers.CheckFileExistsInDestination(file));
         }
 
         [Test]

Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles.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.UploadFiles.Definitions;
@@ -18,6 +19,7 @@ public void UploadFiles_TestSimpleTransfer()
             var result = SFTP.UploadFiles(_source, _destination, _connection, _options, _info, new CancellationToken());
             Assert.IsTrue(result.Success);
             Assert.AreEqual(1, result.SuccessfulTransferCount);
+            Assert.AreEqual(Path.Combine(_destination.Directory, _source.FileName).Replace("\\", "/"), result.TransferredDestinationFilePaths.ToList().FirstOrDefault());
         }
 
         [Test]

Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/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; }
 }
 

Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/FileTransporter.cs

@@ -469,6 +469,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>()
         };
     }
@@ -496,6 +497,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(r => r.TransferredDestinationFilePath ?? "--unknown--").ToList(),
             OperationsLog = new Dictionary<string, string>()
         };
     }

Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/Result.cs

@@ -84,6 +84,19 @@ public class Result
     /// </example>
     public IEnumerable<string> TransferredFilePaths { get; private set; }
 
+    /// <summary>
+    /// List of destaintion file paths of the transferred files.
+    /// </summary>
+    /// <example>
+    /// <code>
+    /// [
+    ///     "upload/Upload/test.txt",
+    ///     "upload/Upload/test2.txt"
+    /// ]
+    /// </code>
+    /// </example>
+    public IEnumerable<string> TransferredDestinationFilePaths { get; private set; }
+
     /// <summary>
     /// Operations logs for the transfer.
     /// </summary>
@@ -107,6 +120,7 @@ internal Result(FileTransferResult result)
         TransferredFileNames = result.TransferredFileNames;
         TransferErrors = result.TransferErrors;
         TransferredFilePaths = result.TransferredFilePaths;
+        TransferredDestinationFilePaths = result.TransferredDestinationFilePaths;
         OperationsLog = result.OperationsLog;
     }
 }

Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/SingleFileTransfer.cs

@@ -93,6 +93,7 @@ internal SingleFileTransferResult TransferSingleFile()
             if (!string.IsNullOrEmpty(destinationFileRestoreMessage))
                 HandleTransferError(ex, destinationFileRestoreMessage);
         }
+        _result.TransferredDestinationFilePath = DestinationFileWithMacrosExpanded;
         return _result;
     }
 

Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Definitions/SingleFileTransferResult.cs

@@ -15,6 +15,8 @@ internal class SingleFileTransferResult
 
     internal string TransferredFilePath { get; set; }
 
+    internal string TransferredDestinationFilePath { get; set; }
+
     internal SingleFileTransferResult()
     {
         ErrorMessages = new List<string>();

Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles/Frends.SFTP.UploadFiles.csproj

@@ -8,7 +8,7 @@
 	  <AssemblyName>Frends.SFTP.UploadFiles</AssemblyName>
 	  <RootNamespace>Frends.SFTP.UploadFiles</RootNamespace>
 
-	  <Version>2.5.5</Version>
+	  <Version>2.6.0</Version>
 	  <Authors>Frends</Authors>
 	  <Copyright>Frends</Copyright>
 	  <Company>Frends</Company>