Use Awaitility in our own tests

Closes gh-18227

Author: wilkinsona

spring-boot-project/spring-boot-actuator/pom.xml

@@ -345,6 +345,11 @@
 			<artifactId>jersey-media-json-jackson</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>com.jayway.jsonpath</groupId>
 			<artifactId>json-path</artifactId>

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/management/HeapDumpWebEndpointWebIntegrationTests.java

@@ -18,8 +18,10 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.time.Duration;
 import java.util.concurrent.TimeUnit;
 
+import org.awaitility.Awaitility;
 import org.junit.jupiter.api.BeforeEach;
 
 import org.springframework.boot.actuate.endpoint.web.test.WebEndpointTest;
@@ -31,7 +33,7 @@
 import org.springframework.test.web.reactive.server.WebTestClient;
 import org.springframework.util.FileCopyUtils;
 
-import static org.assertj.core.api.Assertions.assertThat;
+import static org.hamcrest.Matchers.is;
 
 /**
  * Integration tests for {@link HeapDumpWebEndpoint} exposed by Jersey, Spring MVC, and
@@ -64,11 +66,7 @@ void getRequestShouldReturnHeapDumpInResponseBody(WebTestClient client) throws E
 	}
 
 	private void assertHeapDumpFileIsDeleted() throws InterruptedException {
-		long end = System.currentTimeMillis() + 5000;
-		while (System.currentTimeMillis() < end && this.endpoint.file.exists()) {
-			Thread.sleep(100);
-		}
-		assertThat(this.endpoint.file.exists()).isFalse();
+		Awaitility.waitAtMost(Duration.ofSeconds(5)).until(this.endpoint.file::exists, is(false));
 	}
 
 	@Configuration(proxyBeanMethods = false)

spring-boot-project/spring-boot-autoconfigure/pom.xml

@@ -897,6 +897,11 @@
 			<artifactId>tomcat-embed-jasper</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.hsqldb</groupId>
 			<artifactId>hsqldb</artifactId>

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/orm/jpa/HibernateJpaAutoConfigurationTests.java

@@ -19,6 +19,7 @@
 import java.io.IOException;
 import java.net.URL;
 import java.net.URLClassLoader;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -27,6 +28,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
+import java.util.stream.Collectors;
 
 import javax.persistence.EntityManager;
 import javax.persistence.EntityManagerFactory;
@@ -37,6 +39,7 @@
 import javax.transaction.UserTransaction;
 
 import com.zaxxer.hikari.HikariDataSource;
+import org.awaitility.Awaitility;
 import org.hibernate.boot.model.naming.ImplicitNamingStrategy;
 import org.hibernate.boot.model.naming.PhysicalNamingStrategy;
 import org.hibernate.cfg.AvailableSettings;
@@ -77,6 +80,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.entry;
+import static org.hamcrest.Matchers.hasSize;
 import static org.mockito.Mockito.mock;
 
 /**
@@ -387,12 +391,8 @@ void withAsyncBootstrappingAnApplicationListenerThatUsesJpaDoesNotTriggerABeanCu
 					assertThat(context).hasNotFailed();
 					EventCapturingApplicationListener listener = context
 							.getBean(EventCapturingApplicationListener.class);
-					long end = System.currentTimeMillis() + 30000;
-					while ((System.currentTimeMillis() < end) && !dataSourceSchemaCreatedEventReceived(listener)) {
-						Thread.sleep(100);
-					}
-					assertThat(listener.events.stream().filter(DataSourceSchemaCreatedEvent.class::isInstance))
-							.hasSize(1);
+					Awaitility.waitAtMost(Duration.ofSeconds(30))
+							.until(() -> dataSourceSchemaCreatedEventsReceivedBy(listener), hasSize(1));
 				});
 	}
 
@@ -408,13 +408,9 @@ void whenLocalContanerEntityManagerFactoryBeanHasNoJpaVendorAdapterAutoConfigura
 				});
 	}
 
-	private boolean dataSourceSchemaCreatedEventReceived(EventCapturingApplicationListener listener) {
-		for (ApplicationEvent event : listener.events) {
-			if (event instanceof DataSourceSchemaCreatedEvent) {
-				return true;
-			}
-		}
-		return false;
+	private List<ApplicationEvent> dataSourceSchemaCreatedEventsReceivedBy(EventCapturingApplicationListener listener) {
+		return listener.events.stream().filter(DataSourceSchemaCreatedEvent.class::isInstance)
+				.collect(Collectors.toList());
 	}
 
 	@Configuration(proxyBeanMethods = false)

spring-boot-project/spring-boot-devtools/pom.xml

@@ -130,6 +130,11 @@
 			<artifactId>HikariCP</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework</groupId>
 			<artifactId>spring-webmvc</artifactId>

spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/livereload/LiveReloadServerTests.java

@@ -20,12 +20,14 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.URI;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
 import org.apache.tomcat.websocket.WsWebSocketContainer;
+import org.awaitility.Awaitility;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Disabled;
@@ -43,6 +45,9 @@
 import org.springframework.web.socket.handler.TextWebSocketHandler;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.hamcrest.Matchers.empty;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.not;
 
 /**
  * Tests for {@link LiveReloadServer}.
@@ -107,10 +112,7 @@ void clientClose() throws Exception {
 	}
 
 	private void awaitClosedException() throws InterruptedException {
-		long startTime = System.currentTimeMillis();
-		while (this.server.getClosedExceptions().isEmpty() && System.currentTimeMillis() - startTime < 10000) {
-			Thread.sleep(100);
-		}
+		Awaitility.waitAtMost(Duration.ofSeconds(10)).until(this.server::getClosedExceptions, is(not(empty())));
 	}
 
 	@Test

spring-boot-project/spring-boot-tools/spring-boot-loader/pom.xml

@@ -21,14 +21,19 @@
 			<optional>true</optional>
 		</dependency>
 		<!-- Test -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-test-support</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>ch.qos.logback</groupId>
 			<artifactId>logback-classic</artifactId>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
-			<groupId>org.springframework</groupId>
-			<artifactId>spring-webmvc</artifactId>
+			<groupId>org.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
@@ -39,8 +44,8 @@
 			<scope>test</scope>
 		</dependency>
 		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-test-support</artifactId>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-webmvc</artifactId>
 			<scope>test</scope>
 		</dependency>
 	</dependencies>

spring-boot-project/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/PropertiesLauncherTests.java

@@ -21,13 +21,15 @@
 import java.io.IOException;
 import java.net.URL;
 import java.net.URLClassLoader;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.jar.Attributes;
 import java.util.jar.Manifest;
 
 import org.assertj.core.api.Condition;
+import org.awaitility.Awaitility;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -44,6 +46,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
+import static org.hamcrest.Matchers.containsString;
 
 /**
  * Tests for {@link PropertiesLauncher}.
@@ -339,14 +342,7 @@ void encodedFileUrlLoaderPathIsHandledCorrectly() throws Exception {
 	}
 
 	private void waitFor(String value) throws Exception {
-		int count = 0;
-		boolean timeout = false;
-		while (!timeout && count < 100) {
-			count++;
-			Thread.sleep(50L);
-			timeout = this.output.toString().contains(value);
-		}
-		assertThat(timeout).as("Timed out waiting for (" + value + ")").isTrue();
+		Awaitility.waitAtMost(Duration.ofSeconds(5)).until(this.output::toString, containsString(value));
 	}
 
 	private Condition<Archive> endingWith(String value) {

spring-boot-project/spring-boot/pom.xml

@@ -421,6 +421,11 @@
 			<artifactId>httpasyncclient</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.awaitility</groupId>
+			<artifactId>awaitility</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.firebirdsql.jdbc</groupId>
 			<artifactId>jaybird-jdk18</artifactId>

spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/embedded/undertow/UndertowReactiveWebServerFactoryTests.java

@@ -23,6 +23,7 @@
 import java.util.Arrays;
 
 import io.undertow.Undertow;
+import org.awaitility.Awaitility;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 import org.mockito.InOrder;
@@ -36,6 +37,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
+import static org.hamcrest.Matchers.is;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.inOrder;
 import static org.mockito.Mockito.mock;
@@ -124,11 +126,8 @@ private void testAccessLog(String prefix, String suffix, String expectedFile)
 		assertThat(accessLogDirectory.listFiles()).contains(accessLog);
 	}
 
-	private void awaitFile(File file) throws InterruptedException {
-		long end = System.currentTimeMillis() + 10000;
-		while (!file.exists() && System.currentTimeMillis() < end) {
-			Thread.sleep(100);
-		}
+	private void awaitFile(File file) {
+		Awaitility.waitAtMost(Duration.ofSeconds(10)).until(file::exists, is(true));
 	}
 
 }