test: try to fix endless hanging test

- the CountDownLatch.await should have a timeout too

Author: Andreas Höhmann

spring-boot-admin-client/src/test/java/de/codecentric/boot/admin/client/AbstractClientApplicationTest.java

@@ -17,16 +17,18 @@
 package de.codecentric.boot.admin.client;
 
 import java.net.InetAddress;
-import java.net.UnknownHostException;
 import java.time.Duration;
 import java.util.Arrays;
 import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
 import java.util.stream.Stream;
 
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder;
 import com.github.tomakehurst.wiremock.common.ConsoleNotifier;
 import com.github.tomakehurst.wiremock.matching.RequestPatternBuilder;
+import lombok.extern.slf4j.Slf4j;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -35,6 +37,7 @@
 import org.springframework.boot.WebApplicationType;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.boot.jackson.autoconfigure.JacksonProperties;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.event.EventListener;
 
@@ -50,6 +53,7 @@
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;
 import static org.awaitility.Awaitility.await;
 
+@Slf4j
 public abstract class AbstractClientApplicationTest {
 
 	private final WireMockServer wireMock = new WireMockServer(
@@ -67,39 +71,43 @@ protected void setUp(WebApplicationType type) {
 	}
 
 	private void setUpWiremock() {
-		wireMock.start();
+		this.wireMock.start();
 		ResponseDefinitionBuilder response = created().withHeader("Content-Type", "application/json")
 			.withHeader("Connection", "close")
-			.withHeader("Location", wireMock.url("/instances/abcdef"))
+			.withHeader("Location", this.wireMock.url("/instances/abcdef"))
 			.withBody("{ \"id\" : \"abcdef\" }");
-		wireMock.stubFor(post(urlEqualTo("/instances")).willReturn(response));
+		this.wireMock.stubFor(post(urlEqualTo("/instances")).willReturn(response));
 	}
 
 	private void setUpApplication(WebApplicationType type) {
-		application = new SpringApplication(TestClientApplication.class);
-		application.setWebApplicationType(type);
+		this.application = new SpringApplication(TestClientApplication.class);
+		this.application.setWebApplicationType(type);
 	}
 
 	private void setUpApplicationContext(String... additionalArgs) {
 		Stream<String> defaultArgs = Stream.of("--spring.application.name=Test-Client", "--server.port=0",
 				"--management.endpoints.web.base-path=/mgmt", "--endpoints.health.enabled=true",
-				"--spring.boot.admin.client.url=" + wireMock.url("/"));
+				"--spring.boot.admin.client.url=" + this.wireMock.url("/"));
 
 		String[] args = Stream.concat(defaultArgs, Arrays.stream(additionalArgs)).toArray(String[]::new);
 
-		this.instance = application.run(args);
+		this.instance = this.application.run(args);
 	}
 
 	@AfterEach
 	void tearDown() {
-		wireMock.stop();
-		if (instance != null) {
-			instance.close();
+		this.wireMock.stop();
+		if (this.instance != null) {
+			this.instance.close();
 		}
 	}
 
+	/**
+	 * @see JacksonProperties
+	 * @see PropertyNamingStrategies#LOWER_CAMEL_CASE
+	 */
 	@Test
-	public void test_context() throws InterruptedException, UnknownHostException {
+	public void test_context() throws Exception {
 		setUpApplicationContext();
 
 		String hostName = InetAddress.getLocalHost().getCanonicalHostName();
@@ -113,12 +121,17 @@ public void test_context() throws InterruptedException, UnknownHostException {
 			.withRequestBody(matchingJsonPath("$.serviceUrl", equalTo(serviceHost + "/")))
 			.withRequestBody(matchingJsonPath("$.metadata.startup", matching(".+")));
 
-		cdl.await();
-		await().atMost(Duration.ofMillis(2500)).untilAsserted(() -> wireMock.verify(request));
+		log.info("Waiting for registration at mocked sba-server for '{}' ...", this.instance);
+		cdl.await(5_000, TimeUnit.MILLISECONDS);
+		await().atMost(Duration.ofMillis(2500)).untilAsserted(() -> this.wireMock.verify(request));
 	}
 
+	/**
+	 * @see JacksonProperties
+	 * @see PropertyNamingStrategies#SNAKE_CASE
+	 */
 	@Test
-	public void test_context_with_snake_case() throws InterruptedException, UnknownHostException {
+	public void test_context_with_snake_case() throws Exception {
 		setUpApplicationContext("--spring.jackson.property-naming-strategy=SNAKE_CASE");
 
 		String hostName = InetAddress.getLocalHost().getCanonicalHostName();
@@ -132,16 +145,17 @@ public void test_context_with_snake_case() throws InterruptedException, UnknownH
 			.withRequestBody(matchingJsonPath("$.service_url", equalTo(serviceHost + "/")))
 			.withRequestBody(matchingJsonPath("$.metadata.startup", matching(".+")));
 
-		cdl.await();
-		await().atMost(Duration.ofMillis(2500)).untilAsserted(() -> wireMock.verify(request));
+		log.info("Waiting for registration at mocked sba-server for '{}' ...", this.instance);
+		cdl.await(5_000, TimeUnit.MILLISECONDS);
+		await().atMost(Duration.ofMillis(2500)).untilAsserted(() -> this.wireMock.verify(request));
 	}
 
 	private int getServerPort() {
-		return instance.getEnvironment().getProperty("local.server.port", Integer.class, 0);
+		return this.instance.getEnvironment().getProperty("local.server.port", Integer.class, 0);
 	}
 
 	private int getManagementPort() {
-		return instance.getEnvironment().getProperty("local.management.port", Integer.class, 0);
+		return this.instance.getEnvironment().getProperty("local.management.port", Integer.class, 0);
 	}
 
 	@SpringBootConfiguration
@@ -154,7 +168,9 @@ public static class TestClientApplication {
 		@EventListener
 		public void ping(ApplicationReadyEvent ev) {
 			new Thread(() -> {
-				await().atMost(Duration.ofMillis(500)).until(() -> registrator.getRegisteredId() != null);
+				log.info("Waiting for registration at mocked sba-server for '{}' ...", this);
+				await().atMost(Duration.ofMillis(3_500)).until(() -> this.registrator.getRegisteredId() != null);
+				log.info("Found registration id '{}' for '{}'", this.registrator.getRegisteredId(), this);
 				cdl.countDown();
 			}).start();
 		}