health-check/src/test/java/CustomHealthIndicatorTest.java - master - githubmirror/java-design-patterns

health-check/src/test/java/CustomHealthIndicatorTest.java
158 строк6 KB
Ilkka Seppälä
deps: Refactor dependencies (#3224)
29 мар 2025, 20:34
29 мар 2025, 20:340ca162a
/*
 * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
 *
 * The MIT License
 * Copyright © 2014-2022 Ilkka Seppälä
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.ArgumentMatchers.anyLong;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.iluwatar.health.check.AsynchronousHealthChecker;
import com.iluwatar.health.check.CustomHealthIndicator;
import com.iluwatar.health.check.HealthCheckRepository;
import java.util.concurrent.CompletableFuture;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.Status;
import org.springframework.cache.Cache;
import org.springframework.cache.CacheManager;
import org.springframework.cache.concurrent.ConcurrentMapCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/** Tests class< for {@link CustomHealthIndicator}. * */
class CustomHealthIndicatorTest {

  /** Mocked AsynchronousHealthChecker instance. */
  @Mock private AsynchronousHealthChecker healthChecker;

  /** Mocked CacheManager instance. */
  @Mock private CacheManager cacheManager;

  /** Mocked HealthCheckRepository instance. */
  @Mock private HealthCheckRepository healthCheckRepository;

  /** Mocked Cache instance. */
  @Mock private Cache cache;

  /** `CustomHealthIndicator` instance to be tested. */
  private CustomHealthIndicator customHealthIndicator;

  /** Sets up the test environment. */
  @BeforeEach
  void setUp() {
    MockitoAnnotations.openMocks(this);
    when(cacheManager.getCache("health-check")).thenReturn(cache);
    customHealthIndicator =
        new CustomHealthIndicator(healthChecker, cacheManager, healthCheckRepository);
  }

  /**
   * Test case for the `health()` method when the database is up.
   *
   * <p>Asserts that when the `health()` method is called and the database is up, it returns a
   * Health object with Status.UP.
   */
  @Test
  void whenDatabaseIsUp_thenHealthIsUp() {
    CompletableFuture<Health> future =
        CompletableFuture.completedFuture(Health.up().withDetail("database", "reachable").build());
    when(healthChecker.performCheck(any(), anyLong())).thenReturn(future);
    when(healthCheckRepository.checkHealth()).thenReturn(1);

    Health health = customHealthIndicator.health();

    assertEquals(Status.UP, health.getStatus());
  }

  /**
   * Test case for the `health()` method when the database is down.
   *
   * <p>Asserts that when the `health()` method is called and the database is down, it returns a
   * Health object with Status.DOWN.
   */
  @Test
  void whenDatabaseIsDown_thenHealthIsDown() {
    CompletableFuture<Health> future =
        CompletableFuture.completedFuture(
            Health.down().withDetail("database", "unreachable").build());
    when(healthChecker.performCheck(any(), anyLong())).thenReturn(future);
    when(healthCheckRepository.checkHealth()).thenReturn(null);

    Health health = customHealthIndicator.health();

    assertEquals(Status.DOWN, health.getStatus());
  }

  /**
   * Test case for the `health()` method when the health check times out.
   *
   * <p>Asserts that when the `health()` method is called and the health check times out, it returns
   * a Health object with Status.DOWN.
   */
  @Test
  void whenHealthCheckTimesOut_thenHealthIsDown() {
    CompletableFuture<Health> future = new CompletableFuture<>();
    when(healthChecker.performCheck(any(), anyLong())).thenReturn(future);

    Health health = customHealthIndicator.health();

    assertEquals(Status.DOWN, health.getStatus());
  }

  /**
   * Test case for the `evictHealthCache()` method.
   *
   * <p>Asserts that when the `evictHealthCache()` method is called, the health cache is cleared.
   */
  @Test
  void whenEvictHealthCache_thenCacheIsCleared() {
    doNothing().when(cache).clear();

    customHealthIndicator.evictHealthCache();

    verify(cache, times(1)).clear();
    verify(cacheManager, times(1)).getCache("health-check");
  }

  /** Configuration static class for the health check cache. */
  @Configuration
  static class CacheConfig {
    /**
     * Creates a concurrent map cache manager named "health-check".
     *
     * @return a new ConcurrentMapCacheManager instance
     */
    @Bean
    public CacheManager cacheManager() {
      return new ConcurrentMapCacheManager("health-check");
    }
  }
}