From a007ffea406c944b8d6f5fe3da651196bb02195b Mon Sep 17 00:00:00 2001
From: bono007 <chris.bono@gmail.com>
Date: Fri, 24 Jul 2020 08:50:36 -0500
Subject: [PATCH] Adds a probe implementation for ConsulDiscoveryClient

See https://github.com/spring-cloud/spring-cloud-commons/issues/785

Fixes gh-657
---
 .../discovery/ConsulDiscoveryClient.java      |  5 ++
 .../ConsulDiscoveryClientProbeTests.java      | 64 +++++++++++++++++++
 .../discovery/ConsulDiscoveryClientTests.java |  5 ++
 3 files changed, 74 insertions(+)
 create mode 100644 spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientProbeTests.java

diff --git a/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClient.java b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClient.java
index c0b1fa9e..9c73d0ff 100644
--- a/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClient.java
+++ b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClient.java
@@ -126,6 +126,11 @@ public class ConsulDiscoveryClient implements DiscoveryClient {
 				this.client.getCatalogServices(request).getValue().keySet());
 	}
 
+	@Override
+	public void probe() {
+		this.client.getStatusLeader();
+	}
+
 	@Override
 	public int getOrder() {
 		return this.properties.getOrder();
diff --git a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientProbeTests.java b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientProbeTests.java
new file mode 100644
index 00000000..86dc051f
--- /dev/null
+++ b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientProbeTests.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2013-2019 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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.cloud.consul.discovery;
+
+import com.ecwid.consul.v1.ConsulClient;
+import com.ecwid.consul.v1.OperationException;
+import com.ecwid.consul.v1.Response;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+/**
+ * Unit tests for {@link ConsulDiscoveryClient} probe API.
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class ConsulDiscoveryClientProbeTests {
+
+	@Mock
+	private ConsulClient consulClient;
+
+	@Mock
+	private ConsulDiscoveryProperties consulDiscoveryProperties;
+
+	@InjectMocks
+	private ConsulDiscoveryClient discoveryClient;
+
+	@Test
+	public void probeSucceeds() {
+		when(consulClient.getStatusLeader()).thenReturn(
+				new Response<>("5150", 5150L, false, System.currentTimeMillis()));
+		discoveryClient.probe();
+		verify(consulClient).getStatusLeader();
+	}
+
+	@Test
+	public void probeFails() {
+		when(consulClient.getStatusLeader())
+				.thenThrow(new OperationException(5150, "5150", "No leader"));
+		assertThatThrownBy(() -> discoveryClient.probe())
+				.isInstanceOf(OperationException.class).hasMessageContaining("No leader");
+		verify(consulClient).getStatusLeader();
+	}
+
+}
diff --git a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientTests.java b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientTests.java
index dce02203..503f3a05 100644
--- a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientTests.java
+++ b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientTests.java
@@ -85,6 +85,11 @@ public class ConsulDiscoveryClientTests {
 		assertIpAddress(instance);
 	}
 
+	@Test
+	public void probeWorks() {
+		discoveryClient.probe();
+	}
+
 	private void assertIpAddress(ServiceInstance instance) {
 		assertThat(Character.isDigit(instance.getHost().charAt(0)))
 				.as("host isn't an ip address").isTrue();