feat: Add 'outputFiles' property with a map of file name / URI

Fixes #108
kestra-io · May 20, 2024 · 8adaf52 · 8adaf52
1 parent 42ddfc7
commit 8adaf52
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/src/main/java/io/kestra/plugin/fs/vfs/Downloads.java b/src/main/java/io/kestra/plugin/fs/vfs/Downloads.java
@@ -13,6 +13,8 @@
 
 import jakarta.validation.constraints.NotNull;
 import java.net.URI;
+import java.util.AbstractMap;
+import java.util.Map;
 import java.util.stream.Collectors;
 
 import static io.kestra.core.utils.Rethrow.throwFunction;
@@ -105,6 +107,10 @@ public Output run(RunContext runContext) throws Exception {
                 }))
                 .collect(Collectors.toList());
 
+            Map<String, URI> outputFiles = list.stream()
+                .map(file -> new AbstractMap.SimpleEntry<>(file.getName(), file.getPath()))
+                .collect(Collectors.toMap(entry -> entry.getKey(), entry -> entry.getValue()));
+
             if (this.action != null) {
                 VfsService.performAction(
                     runContext,
@@ -119,6 +125,7 @@ public Output run(RunContext runContext) throws Exception {
             return Downloads.Output
                 .builder()
                 .files(list)
+                .outputFiles(outputFiles)
                 .build();
         }
     }
@@ -138,5 +145,10 @@ public static class Output implements io.kestra.core.models.tasks.Output {
         )
         @PluginProperty(additionalProperties = io.kestra.plugin.fs.vfs.models.File.class)
         private final java.util.List<io.kestra.plugin.fs.vfs.models.File> files;
+
+        @Schema(
+            title = "The downloaded files as a map of from/to URIs."
+        )
+        private final Map<String, URI> outputFiles;
     }
 }
diff --git a/src/test/java/io/kestra/plugin/fs/ftp/DownloadsTest.java b/src/test/java/io/kestra/plugin/fs/ftp/DownloadsTest.java
@@ -48,6 +48,7 @@ void run_DeleteAfterDownloads() throws Exception {
 
         assertThat(run.getFiles().size(), is(2));
         assertThat(run.getFiles().get(0).getPath().getPath(), endsWith(".txt"));
+        assertThat(run.getOutputFiles().size(), is(2));
 
         assertThat(ftpUtils.list(toUploadDir).getFiles().isEmpty(), is(true));
     }
@@ -75,6 +76,7 @@ void run_NoneAfterDownloads() throws Exception {
 
         assertThat(run.getFiles().size(), is(2));
         assertThat(run.getFiles().get(0).getPath().getPath(), endsWith(".txt"));
+        assertThat(run.getOutputFiles().size(), is(2));
 
         assertThat(ftpUtils.list(toUploadDir).getFiles().size(), is(2));
     }

diff --git a/src/test/java/io/kestra/plugin/fs/sftp/DownloadsTest.java b/src/test/java/io/kestra/plugin/fs/sftp/DownloadsTest.java
@@ -48,6 +48,7 @@ void run_DeleteAfterDownloads() throws Exception {
 
         assertThat(run.getFiles().size(), is(2));
         assertThat(run.getFiles().get(0).getPath().getPath(), endsWith(".txt"));
+        assertThat(run.getOutputFiles().size(), is(2));
 
         assertThat(sftpUtils.list(toUploadDir).getFiles().isEmpty(), is(true));
     }
@@ -75,6 +76,7 @@ void run_NoneAfterDownloads() throws Exception {
 
         assertThat(run.getFiles().size(), is(2));
         assertThat(run.getFiles().get(0).getPath().getPath(), endsWith(".txt"));
+        assertThat(run.getOutputFiles().size(), is(2));
 
         assertThat(sftpUtils.list(toUploadDir).getFiles().size(), is(2));
     }

diff --git a/src/test/java/io/kestra/plugin/fs/smb/DownloadsTest.java b/src/test/java/io/kestra/plugin/fs/smb/DownloadsTest.java
@@ -42,6 +42,7 @@ void run_DeleteAfterDownloads() throws Exception {
 
         assertThat(run.getFiles().size(), is(2));
         assertThat(run.getFiles().get(0).getPath().getPath(), endsWith(".txt"));
+        assertThat(run.getOutputFiles().size(), is(2));
 
         assertThat(smbUtils.list(toUploadDir).getFiles().isEmpty(), is(true));
     }
@@ -70,6 +71,7 @@ void run_MoveAfterDownloads() throws Exception {
 
         assertThat(run.getFiles().size(), is(2));
         assertThat(run.getFiles().get(0).getPath().getPath(), endsWith(".txt"));
+        assertThat(run.getOutputFiles().size(), is(2));
 
         run = task.run(TestsUtils.mockRunContext(runContextFactory, task, ImmutableMap.of()));
         assertThat(run.getFiles().isEmpty(), is(true));
@@ -80,6 +82,7 @@ void run_MoveAfterDownloads() throws Exception {
         run = task.run(TestsUtils.mockRunContext(runContextFactory, task, ImmutableMap.of()));
         assertThat(run.getFiles().size(), is(2));
         assertThat(run.getFiles().get(0).getPath().getPath(), endsWith(".txt"));
+        assertThat(run.getOutputFiles().size(), is(2));
 
         assertThat(smbUtils.list(toUploadDir).getFiles().isEmpty(), is(true));
         assertThat(smbUtils.list(archiveShareDirectory).getFiles().size(), is(2));
@@ -107,6 +110,7 @@ void run_NoneAfterDownloads() throws Exception {
 
         assertThat(run.getFiles().size(), is(2));
         assertThat(run.getFiles().get(0).getPath().getPath(), endsWith(".txt"));
+        assertThat(run.getOutputFiles().size(), is(2));
 
         assertThat(smbUtils.list(toUploadDir).getFiles().size(), is(2));
     }