Convert (S)FTP Tests to JUnit5

* Fix SftpTestServer for latest RemoteFileTestSupport changes.

Author: garyrussell

spring-integration-file/src/test/java/org/springframework/integration/file/remote/RemoteFileTestSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 the original author or authors.
+ * Copyright 2016-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,15 +19,14 @@
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
+import java.nio.file.Path;
 import java.util.Arrays;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.junit.Before;
-import org.junit.ClassRule;
-import org.junit.Rule;
-import org.junit.rules.TemporaryFolder;
-import org.junit.rules.TestName;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestInfo;
+import org.junit.jupiter.api.io.TempDir;
 
 /**
  * Abstract base class for tests requiring remote file servers, e.g. (S)FTP.
@@ -42,14 +41,12 @@ public abstract class RemoteFileTestSupport {
 
 	protected static int port;
 
-	@ClassRule
-	public static final TemporaryFolder remoteTemporaryFolder = new TemporaryFolder();
+	@TempDir
+	public static Path temporaryFolder;
 
-	@ClassRule
-	public static final TemporaryFolder localTemporaryFolder = new TemporaryFolder();
+	protected static File remoteTemporaryFolder;
 
-	@Rule
-	public final TestName testName = new TestName();
+	protected static File localTemporaryFolder;
 
 	protected volatile File sourceRemoteDirectory;
 
@@ -89,42 +86,53 @@ public String getTargetLocalDirectoryName() {
 	 * <pre class="code">
 	 *  $ tree remoteSource/
 	 *  remoteSource/
-	 *  ??? remoteSource1.txt - contains 'source1'
-	 *  ??? remoteSource2.txt - contains 'source2'
-	 *  ??? subRemoteSource
-	 *      ??? subRemoteSource1.txt - contains 'subSource1'
+	 *  |-- remoteSource1.txt - contains 'source1'
+	 *  |-- remoteSource2.txt - contains 'source2'
+	 *  |-- subRemoteSource
+	 *      |-- subRemoteSource1.txt - contains 'subSource1'
 	 *  remoteTarget/
 	 *  $ tree localSource/
 	 *  localSource/
-	 *  ??? localSource1.txt - contains 'local1'
-	 *  ??? localSource2.txt - contains 'local2'
-	 *  ??? subLocalSource
-	 *      ??? subLocalSource1.txt - contains 'subLocal1'
+	 *  |-- localSource1.txt - contains 'local1'
+	 *  |-- localSource2.txt - contains 'local2'
+	 *  |-- subLocalSource
+	 *      |-- subLocalSource1.txt - contains 'subLocal1'
 	 *  localTarget/
 	 * </pre>
 	 *
-	 * The intent is tests retrieve from remoteSource and verify arrival in localTarget or send from localSource and verify
-	 * arrival in remoteTarget.
+	 * The intent is tests retrieve from remoteSource and verify arrival in localTarget or
+	 * send from localSource and verify arrival in remoteTarget.
 	 * <p>
-	 * Subclasses can change 'remote' in these names by overriding {@link #prefix()} or override this method completely to
-	 * create a different structure.
+	 * Subclasses can change 'remote' in these names by overriding {@link #prefix()} or
+	 * override this method completely to create a different structure.
 	 * <p>
-	 * While a single server exists for all tests, the directory structure is rebuilt for each test.
+	 * While a single server exists for all tests, the directory structure is rebuilt for
+	 * each test.
 	 * @throws IOException IO Exception.
 	 */
-	@Before
-	public void setupFolders() throws IOException {
+	@BeforeEach
+	public void setupFolders(TestInfo info) throws IOException {
 		String prefix = prefix();
-		recursiveDelete(new File(remoteTemporaryFolder.getRoot(), prefix + "Source"));
-		this.sourceRemoteDirectory = remoteTemporaryFolder.newFolder(prefix + "Source");
-		recursiveDelete(new File(remoteTemporaryFolder.getRoot(), prefix + "Target"));
-		this.targetRemoteDirectory = remoteTemporaryFolder.newFolder(prefix + "Target");
-		recursiveDelete(new File(localTemporaryFolder.getRoot(), "localSource"));
-		this.sourceLocalDirectory = localTemporaryFolder.newFolder("localSource");
-		recursiveDelete(new File(localTemporaryFolder.getRoot(), "localTarget"));
-		this.targetLocalDirectory = localTemporaryFolder.newFolder("localTarget");
-
-		File file = new File(this.sourceRemoteDirectory, " " + prefix + "Source1.txt");
+		getRemoteTempFolder();
+		getLocalTempFolder();
+		File file = new File(remoteTemporaryFolder, prefix + "Source");
+		recursiveDelete(file, info);
+		this.sourceRemoteDirectory = new File(file.getAbsolutePath());
+		this.sourceRemoteDirectory.mkdirs();
+		file = new File(remoteTemporaryFolder, prefix + "Target");
+		recursiveDelete(file, info);
+		this.targetRemoteDirectory = new File(file.getAbsolutePath());
+		this.targetRemoteDirectory.mkdirs();
+		file = new File(localTemporaryFolder, "localSource");
+		recursiveDelete(file, info);
+		this.sourceLocalDirectory = new File(file.getAbsolutePath());
+		this.sourceLocalDirectory.mkdirs();
+		file = new File(localTemporaryFolder, "localTarget");
+		recursiveDelete(file, info);
+		this.targetLocalDirectory = new File(file.getAbsolutePath());
+		this.targetLocalDirectory.mkdirs();
+
+		file = new File(this.sourceRemoteDirectory, " " + prefix + "Source1.txt");
 		file.createNewFile();
 		FileOutputStream fos = new FileOutputStream(file);
 		fos.write("source1".getBytes());
@@ -161,31 +169,47 @@ public void setupFolders() throws IOException {
 		fos.close();
 	}
 
+	protected static File getRemoteTempFolder() {
+		if (remoteTemporaryFolder == null) {
+			remoteTemporaryFolder = new File(temporaryFolder.toFile().getAbsolutePath() + File.separator + "source");
+			remoteTemporaryFolder.mkdirs();
+		}
+		return remoteTemporaryFolder;
+	}
+
+	protected static File getLocalTempFolder() {
+		if (localTemporaryFolder == null) {
+			localTemporaryFolder = new File(temporaryFolder.toFile().getAbsolutePath() + File.separator + "local");
+			localTemporaryFolder.mkdirs();
+		}
+		return localTemporaryFolder;
+	}
+
 	private String camelCase(String prefix) {
 		char[] chars = prefix.toCharArray();
 		chars[0] &= 0xdf;
 		return new String(chars);
 	}
 
-	public void recursiveDelete(File file) {
+	public void recursiveDelete(File file, TestInfo info) {
 		if (file != null && file.exists()) {
 			File[] files = file.listFiles();
 			if (files != null) {
 				for (File fyle : files) {
-					logger.info("Deleting: " + fyle + " in " + testName.getMethodName());
+					logger.info("Deleting: " + fyle + " in " + info.getDisplayName());
 					if (fyle.isDirectory()) {
-						recursiveDelete(fyle);
+						recursiveDelete(fyle, info);
 					}
 					else {
 						if (!fyle.delete()) {
-							logger.error("Couldn't delete: " + fyle + " in " + testName.getMethodName());
+							logger.error("Couldn't delete: " + fyle + " in " + info.getDisplayName());
 						}
 					}
 				}
 			}
-			logger.info("Deleting: " + file + " in " + testName.getMethodName());
+			logger.info("Deleting: " + file + " in " + info.getDisplayName());
 			if (!file.delete()) {
-				logger.error("Couldn't delete: " + file + " in " + testName.getMethodName());
+				logger.error("Couldn't delete: " + file + " in " + info.getDisplayName());
 				if (file.isDirectory()) {
 					logger.error("Contents: " + Arrays.toString(file.listFiles()));
 				}

spring-integration-ftp/src/test/java/org/springframework/integration/ftp/FtpMessageHistoryTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.context.support.ClassPathXmlApplicationContext;
 import org.springframework.integration.endpoint.SourcePollingChannelAdapter;
@@ -30,6 +30,7 @@
  *
  */
 public class FtpMessageHistoryTests {
+
 	@Test
 	public void testMessageHistory() throws Exception {
 		ClassPathXmlApplicationContext ac = new ClassPathXmlApplicationContext("ftp-message-history-context.xml",
@@ -39,4 +40,5 @@ public void testMessageHistory() throws Exception {
 		assertThat(adapter.getComponentType()).isEqualTo("ftp:inbound-channel-adapter");
 		ac.close();
 	}
+
 }

spring-integration-ftp/src/test/java/org/springframework/integration/ftp/FtpParserInboundTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,9 +22,9 @@
 import java.io.File;
 import java.io.FileNotFoundException;
 
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.BeanCreationException;
@@ -38,7 +38,8 @@
  *
  */
 public class FtpParserInboundTests {
-	@Before
+
+	@BeforeEach
 	public void prepare() {
 		new File("target/foo").delete();
 	}
@@ -67,7 +68,7 @@ public void testLocalFilesAutoCreationFalse() throws Exception {
 		}
 	}
 
-	@After
+	@AfterEach
 	public void cleanUp() throws Exception {
 		new File("target/foo").delete();
 	}

spring-integration-ftp/src/test/java/org/springframework/integration/ftp/FtpTestSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 the original author or authors.
+ * Copyright 2015-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,8 +35,8 @@
 import org.apache.ftpserver.usermanager.impl.ConcurrentLoginPermission;
 import org.apache.ftpserver.usermanager.impl.TransferRatePermission;
 import org.apache.ftpserver.usermanager.impl.WritePermission;
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
 
 import org.springframework.integration.file.remote.RemoteFileTestSupport;
 import org.springframework.integration.file.remote.session.CachingSessionFactory;
@@ -58,10 +58,10 @@ public class FtpTestSupport extends RemoteFileTestSupport {
 
 	private static volatile FtpServer server;
 
-	@BeforeClass
+	@BeforeAll
 	public static void createServer() throws Exception {
 		FtpServerFactory serverFactory = new FtpServerFactory();
-		serverFactory.setUserManager(new TestUserManager(remoteTemporaryFolder.getRoot().getAbsolutePath()));
+		serverFactory.setUserManager(new TestUserManager(getRemoteTempFolder().getAbsolutePath()));
 
 		ListenerFactory factory = new ListenerFactory();
 		factory.setPort(0);
@@ -78,7 +78,7 @@ public static void createServer() throws Exception {
 	}
 
 
-	@AfterClass
+	@AfterAll
 	public static void stopServer() throws Exception {
 		server.stop();
 	}

spring-integration-ftp/src/test/java/org/springframework/integration/ftp/config/FtpInboundChannelAdapterParserTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,8 +28,7 @@
 import java.util.concurrent.PriorityBlockingQueue;
 import java.util.concurrent.atomic.AtomicReference;
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.FactoryBean;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -52,8 +51,7 @@
 import org.springframework.integration.test.util.TestUtils;
 import org.springframework.messaging.MessageChannel;
 import org.springframework.test.annotation.DirtiesContext;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 import org.springframework.util.ReflectionUtils;
 
 /**
@@ -64,8 +62,7 @@
  * @author Artem Bilan
  * @author Venil Noronha
  */
-@ContextConfiguration
-@RunWith(SpringJUnit4ClassRunner.class)
+@SpringJUnitConfig
 @DirtiesContext
 public class FtpInboundChannelAdapterParserTests {
 

spring-integration-ftp/src/test/java/org/springframework/integration/ftp/config/FtpInboundOutboundSanitySample.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,8 +20,8 @@
 
 import java.io.File;
 
-import org.junit.Ignore;
-import org.junit.Test;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.context.support.ClassPathXmlApplicationContext;
 import org.springframework.messaging.MessageChannel;
@@ -36,7 +36,7 @@ public class FtpInboundOutboundSanitySample {
 
 
 	@Test
-	@Ignore
+	@Disabled
 	public void testFtpInboundChannelAdapter() throws Exception {
 		File fileA = new File("local-test-dir/a.test");
 		if (fileA.exists()) {
@@ -66,7 +66,7 @@ public void testFtpInboundChannelAdapter() throws Exception {
 	}
 
 	@Test
-	@Ignore
+	@Disabled
 	public void testFtpOutboundChannelAdapter() throws Exception {
 		ClassPathXmlApplicationContext ac =
 			new ClassPathXmlApplicationContext("FtpOutboundChannelAdapterSample-context.xml", this.getClass());

spring-integration-ftp/src/test/java/org/springframework/integration/ftp/config/FtpOutboundGatewayParserTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,8 +22,7 @@
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicReference;
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.expression.Expression;
@@ -45,8 +44,7 @@
 import org.springframework.messaging.Message;
 import org.springframework.messaging.support.GenericMessage;
 import org.springframework.test.annotation.DirtiesContext;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 import org.springframework.util.ReflectionUtils;
 
 /**
@@ -57,8 +55,7 @@
  * @since 2.1
  *
  */
-@ContextConfiguration
-@RunWith(SpringJUnit4ClassRunner.class)
+@SpringJUnitConfig
 @DirtiesContext
 public class FtpOutboundGatewayParserTests {