fix(#4164): client reg with spring boot configured to use snake case (#4208)

Co-authored-by: Stephan Köninger <stephan.koeninger@codecentric.de>
Co-authored-by: Timo <mailantimo@gmx.de>

Author: 3 people

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

@@ -18,7 +18,9 @@
 
 import java.net.InetAddress;
 import java.net.UnknownHostException;
+import java.util.Arrays;
 import java.util.concurrent.CountDownLatch;
+import java.util.stream.Stream;
 
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder;
@@ -27,9 +29,12 @@
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.SpringApplication;
 import org.springframework.boot.SpringBootConfiguration;
+import org.springframework.boot.WebApplicationType;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.event.EventListener;
 
 import de.codecentric.boot.admin.client.registration.ApplicationRegistrator;
@@ -45,11 +50,21 @@
 
 public abstract class AbstractClientApplicationTest {
 
-	public WireMockServer wireMock = new WireMockServer(options().dynamicPort().notifier(new ConsoleNotifier(true)));
+	private final WireMockServer wireMock = new WireMockServer(
+			options().dynamicPort().notifier(new ConsoleNotifier(true)));
+
+	private SpringApplication application;
+
+	private ConfigurableApplicationContext instance;
 
 	private static final CountDownLatch cdl = new CountDownLatch(1);
 
-	public void setUp() throws Exception {
+	protected void setUp(WebApplicationType type) throws Exception {
+		setUpWiremock();
+		setUpApplication(type);
+	}
+
+	private void setUpWiremock() {
 		wireMock.start();
 		ResponseDefinitionBuilder response = created().withHeader("Content-Type", "application/json")
 			.withHeader("Connection", "close")
@@ -58,13 +73,33 @@ public void setUp() throws Exception {
 		wireMock.stubFor(post(urlEqualTo("/instances")).willReturn(response));
 	}
 
+	private void setUpApplication(WebApplicationType type) {
+		application = new SpringApplication(TestClientApplication.class);
+		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("/"));
+
+		String[] args = Stream.concat(defaultArgs, Arrays.stream(additionalArgs)).toArray(String[]::new);
+
+		this.instance = application.run(args);
+	}
+
 	@AfterEach
 	void tearDown() {
 		wireMock.stop();
+		if (instance != null) {
+			instance.close();
+		}
 	}
 
 	@Test
 	public void test_context() throws InterruptedException, UnknownHostException {
+		setUpApplicationContext();
+
 		cdl.await();
 		Thread.sleep(2500);
 		String hostName = InetAddress.getLocalHost().getCanonicalHostName();
@@ -81,9 +116,33 @@ public void test_context() throws InterruptedException, UnknownHostException {
 		wireMock.verify(request);
 	}
 
-	protected abstract int getServerPort();
+	@Test
+	public void test_context_with_snake_case() throws InterruptedException, UnknownHostException {
+		setUpApplicationContext("--spring.jackson.property-naming-strategy=SNAKE_CASE");
 
-	protected abstract int getManagementPort();
+		cdl.await();
+		Thread.sleep(2500);
+		String hostName = InetAddress.getLocalHost().getCanonicalHostName();
+		String serviceHost = "http://" + hostName + ":" + getServerPort();
+		String managementHost = "http://" + hostName + ":" + getManagementPort();
+		RequestPatternBuilder request = postRequestedFor(urlEqualTo("/instances"));
+		request.withHeader("Content-Type", equalTo("application/json"))
+			.withRequestBody(matchingJsonPath("$.name", equalTo("Test-Client")))
+			.withRequestBody(matchingJsonPath("$.health_url", equalTo(managementHost + "/mgmt/health")))
+			.withRequestBody(matchingJsonPath("$.management_url", equalTo(managementHost + "/mgmt")))
+			.withRequestBody(matchingJsonPath("$.service_url", equalTo(serviceHost + "/")))
+			.withRequestBody(matchingJsonPath("$.metadata.startup", matching(".+")));
+
+		wireMock.verify(request);
+	}
+
+	private int getServerPort() {
+		return instance.getEnvironment().getProperty("local.server.port", Integer.class, 0);
+	}
+
+	private int getManagementPort() {
+		return instance.getEnvironment().getProperty("local.management.port", Integer.class, 0);
+	}
 
 	@SpringBootConfiguration
 	@EnableAutoConfiguration

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

@@ -16,42 +16,14 @@
 
 package de.codecentric.boot.admin.client;
 
-import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.springframework.boot.SpringApplication;
 import org.springframework.boot.WebApplicationType;
-import org.springframework.context.ConfigurableApplicationContext;
 
 public class ClientReactiveApplicationTest extends AbstractClientApplicationTest {
 
-	private ConfigurableApplicationContext instance;
-
 	@BeforeEach
-	@Override
 	public void setUp() throws Exception {
-		super.setUp();
-
-		SpringApplication application = new SpringApplication(TestClientApplication.class);
-		application.setWebApplicationType(WebApplicationType.REACTIVE);
-		instance = application.run("--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("/"));
-	}
-
-	@AfterEach
-	public void shutdown() {
-		instance.close();
-	}
-
-	@Override
-	protected int getServerPort() {
-		return instance.getEnvironment().getProperty("local.server.port", Integer.class, 0);
-	}
-
-	@Override
-	protected int getManagementPort() {
-		return instance.getEnvironment().getProperty("local.management.port", Integer.class, 0);
-
+		super.setUp(WebApplicationType.REACTIVE);
 	}
 
 }

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

@@ -16,42 +16,14 @@
 
 package de.codecentric.boot.admin.client;
 
-import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.springframework.boot.SpringApplication;
 import org.springframework.boot.WebApplicationType;
-import org.springframework.context.ConfigurableApplicationContext;
 
 public class ClientServletApplicationTest extends AbstractClientApplicationTest {
 
-	private ConfigurableApplicationContext instance;
-
 	@BeforeEach
-	@Override
 	public void setUp() throws Exception {
-		super.setUp();
-
-		SpringApplication application = new SpringApplication(TestClientApplication.class);
-		application.setWebApplicationType(WebApplicationType.SERVLET);
-		instance = application.run("--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("/"));
-	}
-
-	@AfterEach
-	public void shutdown() {
-		instance.close();
-	}
-
-	@Override
-	protected int getServerPort() {
-		return instance.getEnvironment().getProperty("local.server.port", Integer.class, 0);
-	}
-
-	@Override
-	protected int getManagementPort() {
-		return instance.getEnvironment().getProperty("local.management.port", Integer.class, 0);
-
+		super.setUp(WebApplicationType.SERVLET);
 	}
 
 }

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/utils/jackson/RegistrationDeserializer.java

@@ -40,23 +40,16 @@ public Registration deserialize(JsonParser p, DeserializationContext ctxt) throw
 		JsonNode node = p.readValueAsTree();
 		Registration.Builder builder = Registration.builder();
 
-		if (node.hasNonNull("name")) {
-			builder.name(node.get("name").asText());
-		}
+		builder.name(firstNonNullAsText(node, "name"));
+
 		if (node.hasNonNull("url")) {
-			String url = node.get("url").asText();
+			String url = firstNonNullAsText(node, "url");
 			builder.healthUrl(url.replaceFirst("/+$", "") + "/health").managementUrl(url);
 		}
 		else {
-			if (node.hasNonNull("healthUrl")) {
-				builder.healthUrl(node.get("healthUrl").asText());
-			}
-			if (node.hasNonNull("managementUrl")) {
-				builder.managementUrl(node.get("managementUrl").asText());
-			}
-			if (node.hasNonNull("serviceUrl")) {
-				builder.serviceUrl(node.get("serviceUrl").asText());
-			}
+			builder.healthUrl(firstNonNullAsText(node, "healthUrl", "health_url"));
+			builder.managementUrl(firstNonNullAsText(node, "managementUrl", "management_url"));
+			builder.serviceUrl(firstNonNullAsText(node, "serviceUrl", "service_url"));
 		}
 
 		if (node.has("metadata")) {
@@ -67,11 +60,18 @@ public Registration deserialize(JsonParser p, DeserializationContext ctxt) throw
 			}
 		}
 
-		if (node.hasNonNull("source")) {
-			builder.source(node.get("source").asText());
-		}
+		builder.source(firstNonNullAsText(node, "source"));
 
 		return builder.build();
 	}
 
+	private String firstNonNullAsText(JsonNode node, String... fieldNames) {
+		for (String fieldName : fieldNames) {
+			if (node.hasNonNull(fieldName)) {
+				return node.get(fieldName).asText();
+			}
+		}
+		return null;
+	}
+
 }

spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/server/utils/jackson/RegistrationDeserializerTest.java

@@ -123,4 +123,21 @@ public void test_sanitize_metadata() throws JsonProcessingException {
 		assertThat(json).contains("humptydumpty");
 	}
 
+	@Test
+	void test_snake_case() throws Exception {
+		String json = new JSONObject().put("name", "test")
+			.put("management_url", "http://test")
+			.put("health_url", "http://health")
+			.put("service_url", "http://service")
+			.put("metadata", new JSONObject().put("labels", "foo,bar"))
+			.toString();
+		Registration value = objectMapper.readValue(json, Registration.class);
+		assertThat(value.getName()).isEqualTo("test");
+		assertThat(value.getManagementUrl()).isEqualTo("http://test");
+		assertThat(value.getHealthUrl()).isEqualTo("http://health");
+		assertThat(value.getServiceUrl()).isEqualTo("http://service");
+		assertThat(value.getMetadata()).isEqualTo(singletonMap("labels", "foo,bar"));
+
+	}
+
 }