GH-3026: Fix chmod support for DSL

joaquinjsb · artembilan · commit 7aea76c6c452 · 2019-10-29T15:20:08.000-04:00
Fixes #3026 **Cherry-pick to `5.1.x`** * Populate proper `FileTransferringMessageHandler` impl from DSL spec implementations. This way we are able to use a provided `chmod` from Java DSL * Added `FileTransferringMessageHandlerSpec` ctor TODO * Update SftpTests * Code cleanup; `@Ignore` `SftpTests.testSftpOutboundFlowWithChmod()` since it doesn't work properly on Windows
diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileTransferringMessageHandlerSpec.java b/spring-integration-file/src/main/java/org/springframework/integration/file/dsl/FileTransferringMessageHandlerSpec.java
@@ -41,6 +41,7 @@
  * @param <S> the target {@link FileTransferringMessageHandlerSpec} implementation type.
  *
  * @author Artem Bilan
+ * @author Joaquin Santana
  *
  * @since 5.0
  */
@@ -52,6 +53,10 @@ public abstract class FileTransferringMessageHandlerSpec<F, S extends FileTransf
 
 	private DefaultFileNameGenerator defaultFileNameGenerator;
 
+	// TODO: should be refactored using generics in next release (breaking change), see PR-3080.
+	protected FileTransferringMessageHandlerSpec() {
+	}
+
 	protected FileTransferringMessageHandlerSpec(SessionFactory<F> sessionFactory) {
 		this.target = new FileTransferringMessageHandler<>(sessionFactory);
 	}
@@ -62,6 +67,7 @@ protected FileTransferringMessageHandlerSpec(RemoteFileTemplate<F> remoteFileTem
 
 	protected FileTransferringMessageHandlerSpec(RemoteFileTemplate<F> remoteFileTemplate,
 			FileExistsMode fileExistsMode) {
+
 		this.target = new FileTransferringMessageHandler<>(remoteFileTemplate, fileExistsMode);
 	}
 
diff --git a/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/dsl/FtpMessageHandlerSpec.java b/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/dsl/FtpMessageHandlerSpec.java
@@ -22,25 +22,28 @@
 import org.springframework.integration.file.remote.RemoteFileTemplate;
 import org.springframework.integration.file.remote.session.SessionFactory;
 import org.springframework.integration.file.support.FileExistsMode;
+import org.springframework.integration.ftp.outbound.FtpMessageHandler;
 
 /**
  * A {@link FileTransferringMessageHandlerSpec} for FTP.
  *
  * @author Artem Bilan
+ * @author Joaquin Santana
+ *
  * @since 5.0
  */
 public class FtpMessageHandlerSpec extends FileTransferringMessageHandlerSpec<FTPFile, FtpMessageHandlerSpec> {
 
 	FtpMessageHandlerSpec(SessionFactory<FTPFile> sessionFactory) {
-		super(sessionFactory);
+		this.target = new FtpMessageHandler(sessionFactory);
 	}
 
 	FtpMessageHandlerSpec(RemoteFileTemplate<FTPFile> remoteFileTemplate) {
-		super(remoteFileTemplate);
+		this.target = new FtpMessageHandler(remoteFileTemplate.getSessionFactory());
 	}
 
 	FtpMessageHandlerSpec(RemoteFileTemplate<FTPFile> remoteFileTemplate, FileExistsMode fileExistsMode) {
-		super(remoteFileTemplate, fileExistsMode);
+		this.target = new FtpMessageHandler(remoteFileTemplate, fileExistsMode);
 	}
 
 }
diff --git a/spring-integration-ftp/src/test/java/org/springframework/integration/ftp/dsl/FtpTests.java b/spring-integration-ftp/src/test/java/org/springframework/integration/ftp/dsl/FtpTests.java
@@ -66,6 +66,7 @@
 /**
  * @author Artem Bilan
  * @author Gary Russell
+ * @author Joaquin Santana
  *
  * @since 5.0
  */
@@ -192,6 +193,30 @@ public void testFtpOutboundFlow() {
 		registration.destroy();
 	}
 
+	@Test
+	public void testFtpOutboundFlowWithChmod() {
+		IntegrationFlow flow = f -> f
+				.handle(Ftp.outboundAdapter(sessionFactory(), FileExistsMode.FAIL)
+						.useTemporaryFileName(false)
+						.fileNameExpression("headers['" + FileHeaders.FILENAME + "']")
+						.chmod(0644)
+						.remoteDirectory("ftpTarget"));
+		IntegrationFlowRegistration registration = this.flowContext.registration(flow).register();
+		String fileName = "foo.file";
+		Message<ByteArrayInputStream> message = MessageBuilder
+				.withPayload(new ByteArrayInputStream("foo".getBytes(StandardCharsets.UTF_8)))
+				.setHeader(FileHeaders.FILENAME, fileName)
+				.build();
+		registration.getInputChannel().send(message);
+		RemoteFileTemplate<FTPFile> template = new RemoteFileTemplate<>(sessionFactory());
+		FTPFile[] files = template.execute(session ->
+				session.list(getTargetRemoteDirectory().getName() + "/" + fileName));
+		assertThat(files.length).isEqualTo(1);
+		assertThat(files[0].getSize()).isEqualTo(3);
+
+		registration.destroy();
+	}
+
 	@Test
 	@SuppressWarnings("unchecked")
 	public void testFtpMgetFlow() {
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/SftpMessageHandlerSpec.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/SftpMessageHandlerSpec.java
@@ -20,26 +20,30 @@
 import org.springframework.integration.file.remote.RemoteFileTemplate;
 import org.springframework.integration.file.remote.session.SessionFactory;
 import org.springframework.integration.file.support.FileExistsMode;
+import org.springframework.integration.sftp.outbound.SftpMessageHandler;
+import org.springframework.integration.sftp.session.SftpRemoteFileTemplate;
 
 import com.jcraft.jsch.ChannelSftp;
 
 /**
  * @author Artem Bilan
+ * @author Joaquin Santana
+ *
  * @since 5.0
  */
 public class SftpMessageHandlerSpec
 		extends FileTransferringMessageHandlerSpec<ChannelSftp.LsEntry, SftpMessageHandlerSpec> {
 
 	SftpMessageHandlerSpec(SessionFactory<ChannelSftp.LsEntry> sessionFactory) {
-		super(sessionFactory);
+		this.target = new SftpMessageHandler(sessionFactory);
 	}
 
 	SftpMessageHandlerSpec(RemoteFileTemplate<ChannelSftp.LsEntry> remoteFileTemplate) {
-		super(remoteFileTemplate);
+		this.target = new SftpMessageHandler(remoteFileTemplate.getSessionFactory());
 	}
 
 	SftpMessageHandlerSpec(RemoteFileTemplate<ChannelSftp.LsEntry> remoteFileTemplate, FileExistsMode fileExistsMode) {
-		super(remoteFileTemplate, fileExistsMode);
+		this.target = new SftpMessageHandler(new SftpRemoteFileTemplate(remoteFileTemplate.getSessionFactory()), fileExistsMode);
 	}
 
 }
diff --git a/spring-integration-sftp/src/test/java/org/springframework/integration/sftp/dsl/SftpTests.java b/spring-integration-sftp/src/test/java/org/springframework/integration/sftp/dsl/SftpTests.java
@@ -23,6 +23,7 @@
 import java.util.List;
 import java.util.regex.Matcher;
 
+import org.junit.Ignore;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
@@ -54,6 +55,7 @@
 /**
  * @author Artem Bilan
  * @author Gary Russell
+ * @author Joaquin Santana
  *
  * @since 5.0
  *
@@ -146,6 +148,34 @@ public void testSftpOutboundFlow() {
 		registration.destroy();
 	}
 
+
+	@Test
+	@Ignore("Doesn't work as expected on Windows")
+	public void testSftpOutboundFlowWithChmod() {
+		IntegrationFlow flow = f -> f.handle(Sftp.outboundAdapter(sessionFactory(), FileExistsMode.FAIL)
+				.useTemporaryFileName(false)
+				.fileNameExpression("headers['" + FileHeaders.FILENAME + "']")
+				.chmod(0644)
+				.remoteDirectory("sftpTarget"));
+		IntegrationFlowRegistration registration = this.flowContext.registration(flow).register();
+		String fileName = "foo.file";
+		registration.getInputChannel().send(MessageBuilder.withPayload("foo")
+				.setHeader(FileHeaders.FILENAME, fileName)
+				.build());
+
+		RemoteFileTemplate<ChannelSftp.LsEntry> template = new RemoteFileTemplate<>(sessionFactory());
+		ChannelSftp.LsEntry[] files = template.execute(session ->
+				session.list(getTargetRemoteDirectory().getName() + "/" + fileName));
+		assertThat(files.length).isEqualTo(1);
+		assertThat(files[0].getAttrs().getSize()).isEqualTo(3);
+		String[] permissions = files[0].getAttrs().getPermissionsString().substring(1).replaceAll("--", "-").split("-");
+		assertThat(permissions[0]).isEqualTo("rw");
+		assertThat(permissions[1]).isEqualTo("r");
+		assertThat(permissions[2]).isEqualTo("r");
+
+		registration.destroy();
+	}
+
 	@Test
 	@SuppressWarnings("unchecked")
 	public void testSftpMgetFlow() {
diff --git a/spring-integration-sftp/src/test/java/org/springframework/integration/sftp/inbound/SftpInboundRemoteFileSystemSynchronizerTests.java b/spring-integration-sftp/src/test/java/org/springframework/integration/sftp/inbound/SftpInboundRemoteFileSystemSynchronizerTests.java
@@ -59,6 +59,7 @@
  * @author Gunnar Hillert
  * @author Gary Russell
  * @author Artem Bilan
+ * @author Joaquin Santana
  *
  * @since 2.0
  */
@@ -169,7 +170,8 @@ private void init() {
 
 				Calendar calendar = Calendar.getInstance();
 				calendar.add(Calendar.DATE, 1);
-				when(lsEntry.getAttrs().getMTime()).thenReturn(new Long(calendar.getTimeInMillis() / 1000).intValue());
+				when(lsEntry.getAttrs().getMTime())
+						.thenReturn(Long.valueOf(calendar.getTimeInMillis() / 1000).intValue());
 				when(lsEntry.getFilename()).thenReturn(fileName);
 				when(lsEntry.getLongname()).thenReturn(fileName);
 				sftpEntries.add(lsEntry);

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@`
`41`	`41`	`* @param <S> the target {@link FileTransferringMessageHandlerSpec} implementation type.`
`42`	`42`	`*`
`43`	`43`	`* @author Artem Bilan`
	`44`	`+ * @author Joaquin Santana`
`44`	`45`	`*`
`45`	`46`	`* @since 5.0`
`46`	`47`	`*/`
`@@ -52,6 +53,10 @@ public abstract class FileTransferringMessageHandlerSpec<F, S extends FileTransf`
`52`	`53`
`53`	`54`	`private DefaultFileNameGenerator defaultFileNameGenerator;`
`54`	`55`
	`56`	`+ // TODO: should be refactored using generics in next release (breaking change), see PR-3080.`
	`57`	`+ protected FileTransferringMessageHandlerSpec() {`
	`58`	`+ }`
	`59`	`+`
`55`	`60`	`protected FileTransferringMessageHandlerSpec(SessionFactory<F> sessionFactory) {`
`56`	`61`	`this.target = new FileTransferringMessageHandler<>(sessionFactory);`
`57`	`62`	`}`
`@@ -62,6 +67,7 @@ protected FileTransferringMessageHandlerSpec(RemoteFileTemplate<F> remoteFileTem`
`62`	`67`
`63`	`68`	`protected FileTransferringMessageHandlerSpec(RemoteFileTemplate<F> remoteFileTemplate,`
`64`	`69`	`FileExistsMode fileExistsMode) {`
	`70`	`+`
`65`	`71`	`this.target = new FileTransferringMessageHandler<>(remoteFileTemplate, fileExistsMode);`
`66`	`72`	`}`
`67`	`73`
Original file line number	Diff line number	Diff line change
`@@ -22,25 +22,28 @@`
`22`	`22`	`import org.springframework.integration.file.remote.RemoteFileTemplate;`
`23`	`23`	`import org.springframework.integration.file.remote.session.SessionFactory;`
`24`	`24`	`import org.springframework.integration.file.support.FileExistsMode;`
	`25`	`+import org.springframework.integration.ftp.outbound.FtpMessageHandler;`
`25`	`26`
`26`	`27`	`/**`
`27`	`28`	`* A {@link FileTransferringMessageHandlerSpec} for FTP.`
`28`	`29`	`*`
`29`	`30`	`* @author Artem Bilan`
	`31`	`+ * @author Joaquin Santana`
	`32`	`+ *`
`30`	`33`	`* @since 5.0`
`31`	`34`	`*/`
`32`	`35`	`public class FtpMessageHandlerSpec extends FileTransferringMessageHandlerSpec<FTPFile, FtpMessageHandlerSpec> {`
`33`	`36`
`34`	`37`	`FtpMessageHandlerSpec(SessionFactory<FTPFile> sessionFactory) {`
`35`		`- super(sessionFactory);`
	`38`	`+ this.target = new FtpMessageHandler(sessionFactory);`
`36`	`39`	`}`
`37`	`40`
`38`	`41`	`FtpMessageHandlerSpec(RemoteFileTemplate<FTPFile> remoteFileTemplate) {`
`39`		`- super(remoteFileTemplate);`
	`42`	`+ this.target = new FtpMessageHandler(remoteFileTemplate.getSessionFactory());`
`40`	`43`	`}`
`41`	`44`
`42`	`45`	`FtpMessageHandlerSpec(RemoteFileTemplate<FTPFile> remoteFileTemplate, FileExistsMode fileExistsMode) {`
`43`		`- super(remoteFileTemplate, fileExistsMode);`
	`46`	`+ this.target = new FtpMessageHandler(remoteFileTemplate, fileExistsMode);`
`44`	`47`	`}`
`45`	`48`
`46`	`49`	`}`