DiscoveryClientHealthIndicatorTests.java

/*
 * Copyright 2012-present 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.client.discovery.health;

import java.util.List;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.health.contributor.CompositeHealthContributor;
import org.springframework.boot.health.contributor.Health;
import org.springframework.boot.health.contributor.HealthContributor;
import org.springframework.boot.health.contributor.HealthIndicator;
import org.springframework.boot.health.contributor.Status;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.client.CommonsClientAutoConfiguration;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.cloud.client.discovery.event.InstanceRegisteredEvent;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import static org.assertj.core.api.BDDAssertions.then;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;

/**
 * @author Spencer Gibb
 */
// @checkstyle:off
@SpringBootTest(classes = { DiscoveryClientHealthIndicatorTests.Config.class, CommonsClientAutoConfiguration.class },
		properties = "spring.cloud.discovery.client.health-indicator.include-description:true")
// @checkstyle:on
public class DiscoveryClientHealthIndicatorTests {

	@Autowired
	private DiscoveryCompositeHealthContributor healthContributor;

	@Autowired
	private DiscoveryClientHealthIndicator clientHealthIndicator;

	@Test
	public void testHealthIndicatorDescriptionDisabled() {
		then(this.healthContributor).as("healthIndicator was null").isNotNull();
		assertHealth(getHealth("testDiscoveryHealthIndicator"), Status.UNKNOWN);
		assertHealth(getHealth("discoveryClient"), Status.UNKNOWN);

		this.clientHealthIndicator.onApplicationEvent(new InstanceRegisteredEvent<>(this, null));

		assertHealth(getHealth("testDiscoveryHealthIndicator"), Status.UNKNOWN);
		Status status = assertHealth(getHealth("discoveryClient"), Status.UP);
		then(status.getDescription()).as("status description was wrong").isEqualTo("TestDiscoveryClient");
	}

	private Health getHealth(String name) {
		HealthContributor delegate = ((CompositeHealthContributor) this.healthContributor).getContributor(name);
		return ((HealthIndicator) delegate).health();
	}

	private Status assertHealth(Health health, Status expected) {
		then(health).as("health was null").isNotNull();
		Status status = health.getStatus();
		then(status).as("status was null").isNotNull();
		then(status.getCode()).isEqualTo(expected.getCode()).as("status code was wrong");
		return status;
	}

	@Configuration(proxyBeanMethods = false)
	@EnableConfigurationProperties
	public static class Config {

		@Bean
		public DiscoveryClient discoveryClient() {
			DiscoveryClient mock = mock(DiscoveryClient.class);
			given(mock.description()).willReturn("TestDiscoveryClient");
			given(mock.getServices()).willReturn(List.of("TestService1"));
			return mock;
		}

		@Bean
		public DiscoveryHealthIndicator discoveryHealthIndicator() {
			return new DiscoveryHealthIndicator() {

				@Override
				public String getName() {
					return "testDiscoveryHealthIndicator";
				}

				@Override
				public Health health() {
					return new Health.Builder().unknown().build();
				}

			};
		}

	}

}