Make sure that starting a JMS connection does not block infinitely

Starting a JMS connection may block infinitely if the factory is not correctly setup.
For example if ActiveMQ with failover transport is used then the default connection
retries infinitely, which leads to ActiveMQ trying to establish a connection and
never succedding in case none of the configured brokers is up.

Fixes spring-projectsgh-10809

Author: filiphr

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/jms/JmsHealthIndicator.java

@@ -16,8 +16,14 @@
 
 package org.springframework.boot.actuate.jms;
 
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
 import javax.jms.Connection;
 import javax.jms.ConnectionFactory;
+import javax.jms.JMSException;
 
 import org.springframework.boot.actuate.health.AbstractHealthIndicator;
 import org.springframework.boot.actuate.health.Health;
@@ -27,6 +33,7 @@
  * {@link HealthIndicator} for a JMS {@link ConnectionFactory}.
  *
  * @author Stephane Nicoll
+ * @author Filip Hrisfov
  * @since 2.0.0
  */
 public class JmsHealthIndicator extends AbstractHealthIndicator {
@@ -40,9 +47,31 @@ public JmsHealthIndicator(ConnectionFactory connectionFactory) {
 	@Override
 	protected void doHealthCheck(Health.Builder builder) throws Exception {
 		try (Connection connection = this.connectionFactory.createConnection()) {
-			connection.start();
-			builder.up().withDetail("provider",
-					connection.getMetaData().getJMSProviderName());
+			CompletableFuture<Exception> future = CompletableFuture.supplyAsync(() -> {
+				try {
+					connection.start();
+					return null;
+				}
+				catch (JMSException e) {
+					return e;
+				}
+			});
+			try {
+				Exception exception = future.get(100, TimeUnit.MILLISECONDS);
+				if (exception != null) {
+					throw exception;
+				}
+				builder.up().withDetail("provider",
+						connection.getMetaData().getJMSProviderName());
+			}
+			catch (TimeoutException ex) {
+				builder.unknown().withDetail("provider",
+						connection.getMetaData().getJMSProviderName())
+						.withDetail("cause", "Could not connect for 100 milliseconds");
+			}
+			catch (ExecutionException ex) {
+				throw ex;
+			}
 		}
 	}
 

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/jms/JmsHealthIndicatorTests.java

@@ -16,6 +16,9 @@
 
 package org.springframework.boot.actuate.jms;
 
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
 import javax.jms.Connection;
 import javax.jms.ConnectionFactory;
 import javax.jms.ConnectionMetaData;
@@ -27,7 +30,9 @@
 import org.springframework.boot.actuate.health.Status;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.entry;
 import static org.mockito.BDDMockito.given;
+import static org.mockito.BDDMockito.willAnswer;
 import static org.mockito.BDDMockito.willThrow;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
@@ -37,6 +42,7 @@
  * Tests for {@link JmsHealthIndicator}.
  *
  * @author Stephane Nicoll
+ * @author Filip Hrisafov
  */
 public class JmsHealthIndicatorTests {
 
@@ -97,4 +103,25 @@ public void jmsBrokerUsesFailover() throws JMSException {
 		assertThat(health.getDetails().get("provider")).isNull();
 	}
 
+	@Test public void jmsBrokerUsesInfiniteFailover() throws JMSException {
+		CountDownLatch latch = new CountDownLatch(1);
+		ConnectionFactory connectionFactory = mock(ConnectionFactory.class);
+		ConnectionMetaData connectionMetaData = mock(ConnectionMetaData.class);
+		given(connectionMetaData.getJMSProviderName()).willReturn("JMS test provider");
+		Connection connection = mock(Connection.class);
+		given(connection.getMetaData()).willReturn(connectionMetaData);
+		willAnswer(invocationOnMock -> latch.await(1, TimeUnit.SECONDS)).given(connection)
+				.start();
+		given(connectionFactory.createConnection()).willReturn(connection);
+		JmsHealthIndicator indicator = new JmsHealthIndicator(connectionFactory);
+		Health health = indicator.health();
+		assertThat(health.getStatus()).isEqualTo(Status.UNKNOWN);
+		assertThat(health.getDetails()).as("Health Details")
+				.containsExactly(entry("provider", "JMS test provider"),
+						entry("cause", "Could not connect for 100 milliseconds"));
+		verify(connection, times(1)).close();
+		verify(connection, times(1)).start();
+		latch.countDown();
+	}
+
 }