refactoring(ping-service)

TODO-Roadmap.md
This commit is contained in:
stefan
2025-08-14 12:30:31 +02:00
parent 9811eb6130
commit d937e82d2b
11 changed files with 1242 additions and 73 deletions
@@ -0,0 +1,272 @@
package at.mocode.temp.pingservice
import io.github.resilience4j.circuitbreaker.CircuitBreaker
import io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import org.slf4j.LoggerFactory
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.test.web.client.TestRestTemplate
import org.springframework.boot.test.web.server.LocalServerPort
import org.springframework.http.HttpStatus
import org.springframework.test.context.ActiveProfiles
/**
* Integration tests for PingController
* Tests REST endpoints with circuit breaker functionality using TestRestTemplate
*/
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@ActiveProfiles("test")
class PingControllerIntegrationTest {
@LocalServerPort
private var port: Int = 0
@Autowired
private lateinit var restTemplate: TestRestTemplate
@Autowired
private lateinit var circuitBreakerRegistry: CircuitBreakerRegistry
private val logger = LoggerFactory.getLogger(PingControllerIntegrationTest::class.java)
private lateinit var circuitBreaker: CircuitBreaker
@BeforeEach
fun setUp() {
circuitBreaker = circuitBreakerRegistry.circuitBreaker(PingServiceCircuitBreaker.PING_CIRCUIT_BREAKER)
// Reset circuit breaker state before each test
circuitBreaker.reset()
}
private fun getUrl(endpoint: String) = "http://localhost:$port$endpoint"
@Test
fun `should return basic ping response from standard endpoint`() {
// When
val response = restTemplate.getForEntity(getUrl("/ping"), Map::class.java)
// Then
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
assertThat(response.body!!["status"]).isEqualTo("pong")
logger.info("Standard ping endpoint response: {}", response.body)
}
@Test
fun `should return enhanced ping response when circuit breaker is closed`() {
// Given
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
// When
val response = restTemplate.getForEntity(getUrl("/ping/enhanced"), Map::class.java)
// Then
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
val body = response.body!!
assertThat(body["status"]).isEqualTo("pong")
assertThat(body["service"]).isEqualTo("ping-service")
assertThat(body["circuitBreaker"]).isEqualTo("CLOSED")
assertThat(body["timestamp"]).isNotNull()
logger.info("Enhanced ping response: {}", body)
}
@Test
fun `should return enhanced ping response without simulation`() {
// When
val response = restTemplate.getForEntity(getUrl("/ping/enhanced?simulate=false"), Map::class.java)
// Then
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
val body = response.body!!
assertThat(body["status"]).isEqualTo("pong")
assertThat(body["service"]).isEqualTo("ping-service")
assertThat(body["circuitBreaker"]).isEqualTo("CLOSED")
logger.info("Enhanced ping without simulation: {}", body)
}
@Test
fun `should handle failure simulation in enhanced ping endpoint`() {
// Multiple calls to potentially trigger failures due to random simulation
repeat(3) { i ->
val response = restTemplate.getForEntity(getUrl("/ping/enhanced?simulate=true"), Map::class.java)
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
val body = response.body!!
logger.info("Attempt {}: Response status = {}, Circuit breaker state = {}",
i + 1, body["status"], circuitBreaker.state)
// Response should be either success or fallback
assertThat(body["status"]).isIn("pong", "fallback")
}
}
@Test
fun `should return health check response when circuit breaker is closed`() {
// Given
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
// When
val response = restTemplate.getForEntity(getUrl("/ping/health"), Map::class.java)
// Then
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
val body = response.body!!
assertThat(body["status"]).isEqualTo("UP")
assertThat(body["circuitBreaker"]).isEqualTo("CLOSED")
assertThat(body["timestamp"]).isNotNull()
logger.info("Health check response: {}", body)
}
@Test
fun `should return fallback health check when circuit breaker is open`() {
// Given - manually open circuit breaker
circuitBreaker.transitionToOpenState()
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.OPEN)
// When
val response = restTemplate.getForEntity(getUrl("/ping/health"), Map::class.java)
// Then
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
val body = response.body!!
assertThat(body["status"]).isEqualTo("DOWN")
assertThat(body["circuitBreaker"]).isEqualTo("OPEN")
assertThat(body["message"]).isEqualTo("Health check temporarily unavailable")
logger.info("Fallback health check response: {}", body)
}
@Test
fun `should return response from test-failure endpoint`() {
// When
val response = restTemplate.getForEntity(getUrl("/ping/test-failure"), Map::class.java)
// Then
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
val body = response.body!!
// Due to 60% failure simulation, we expect either success or fallback
assertThat(body["status"]).isIn("pong", "fallback")
if (body["status"] == "fallback") {
assertThat(body["service"]).isEqualTo("ping-service-fallback")
assertThat(body["circuitBreaker"]).isEqualTo("OPEN")
assertThat(body["message"]).isEqualTo("Service temporarily unavailable")
assertThat(body["error"]).isNotNull()
} else {
assertThat(body["service"]).isEqualTo("ping-service")
assertThat(body["circuitBreaker"]).isEqualTo("CLOSED")
}
logger.info("Test failure endpoint response: {}", body)
}
@Test
fun `should handle multiple rapid requests correctly`() {
// Execute multiple rapid requests
val results = mutableListOf<Map<String, Any>>()
repeat(5) { i ->
val response = restTemplate.getForEntity(getUrl("/ping/enhanced"), Map::class.java)
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
@Suppress("UNCHECKED_CAST")
val body = response.body as Map<String, Any>
results.add(body)
logger.info("Rapid request {}: status = {}", i + 1, body["status"])
}
// All should be successful since we're not simulating failures
results.forEach { response ->
assertThat(response["status"]).isEqualTo("pong")
assertThat(response["service"]).isEqualTo("ping-service")
}
}
@Test
fun `should maintain circuit breaker state across requests`() {
// Given - manually open circuit breaker
circuitBreaker.transitionToOpenState()
// When - make multiple requests
repeat(3) { i ->
val response = restTemplate.getForEntity(getUrl("/ping/enhanced"), Map::class.java)
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull
val body = response.body!!
// All should return fallback responses while circuit breaker is open
assertThat(body["status"]).isEqualTo("fallback")
assertThat(body["circuitBreaker"]).isEqualTo("OPEN")
logger.info("Request {} with OPEN circuit breaker: {}", i + 1, body["status"])
}
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.OPEN)
}
@Test
fun `should test all endpoints return valid responses`() {
val endpoints = listOf(
"/ping",
"/ping/enhanced",
"/ping/health",
"/ping/test-failure"
)
endpoints.forEach { endpoint ->
val response = restTemplate.getForEntity(getUrl(endpoint), Map::class.java)
assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
assertThat(response.body).isNotNull()
assertThat(response.body!!).isNotEmpty()
logger.info("Endpoint {} returned valid response: {}", endpoint, response.body)
}
}
@Test
fun `should track circuit breaker metrics after calls`() {
// Given
val initialMetrics = circuitBreaker.metrics
logger.info("Initial metrics - Calls: {}, Failures: {}",
initialMetrics.numberOfBufferedCalls, initialMetrics.numberOfFailedCalls)
// When - execute some calls
repeat(3) {
restTemplate.getForEntity(getUrl("/ping/enhanced"), Map::class.java)
}
// Then
val newMetrics = circuitBreaker.metrics
assertThat(newMetrics.numberOfBufferedCalls).isGreaterThanOrEqualTo(3)
logger.info("Updated metrics - Calls: {}, Failure rate: {}%, Successful: {}, Failed: {}",
newMetrics.numberOfBufferedCalls,
newMetrics.failureRate,
newMetrics.numberOfSuccessfulCalls,
newMetrics.numberOfFailedCalls)
}
}
@@ -3,6 +3,7 @@ package at.mocode.temp.pingservice
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.boot.test.mock.mockito.MockBean
import org.springframework.test.web.servlet.MockMvc
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
import org.springframework.test.web.servlet.result.MockMvcResultMatchers.*
@@ -13,6 +14,9 @@ class PingControllerTest {
@Autowired
private lateinit var mockMvc: MockMvc
@MockBean
private lateinit var pingServiceCircuitBreaker: PingServiceCircuitBreaker
@Test
fun `ping endpoint should return pong status`() {
mockMvc.perform(get("/ping"))
@@ -0,0 +1,232 @@
package at.mocode.temp.pingservice
import io.github.resilience4j.circuitbreaker.CircuitBreaker
import io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import org.slf4j.LoggerFactory
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import kotlin.math.ceil
/**
* Comprehensive test suite for PingServiceCircuitBreaker
* Tests circuit breaker behavior, fallback methods, and state transitions
*/
@SpringBootTest
class PingServiceCircuitBreakerTest {
@Autowired
private lateinit var pingServiceCircuitBreaker: PingServiceCircuitBreaker
@Autowired
private lateinit var circuitBreakerRegistry: CircuitBreakerRegistry
private val logger = LoggerFactory.getLogger(PingServiceCircuitBreakerTest::class.java)
private lateinit var circuitBreaker: CircuitBreaker
@BeforeEach
fun setUp() {
circuitBreaker = circuitBreakerRegistry.circuitBreaker(PingServiceCircuitBreaker.PING_CIRCUIT_BREAKER)
// Reset circuit breaker state before each test
circuitBreaker.reset()
}
@Test
fun `should return successful ping response when circuit breaker is closed`() {
// Given
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
// When
val result = pingServiceCircuitBreaker.ping(simulateFailure = false)
// Then
assertThat(result["status"]).isEqualTo("pong")
assertThat(result["service"]).isEqualTo("ping-service")
assertThat(result["circuitBreaker"]).isEqualTo("CLOSED")
assertThat(result).containsKeys("timestamp")
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
}
@Test
fun `should handle single failure without opening circuit breaker`() {
// Given
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
// When - single failure should not open circuit breaker (needs 4 failures minimum)
// Try multiple times since failure simulation is probabilistic (60% chance)
var result: Map<String, Any>
var attempts = 0
do {
result = pingServiceCircuitBreaker.ping(simulateFailure = true)
attempts++
} while (result["status"] == "pong" && attempts < 10)
// Then - should get fallback response eventually, but circuit breaker might still be closed after just one failure
assertThat(result["status"]).isEqualTo("fallback")
assertThat(result["service"]).isEqualTo("ping-service-fallback")
assertThat(result["circuitBreaker"]).isEqualTo("OPEN")
assertThat(result).containsKeys("timestamp", "message", "error")
logger.info("Circuit breaker state after single failure (after {} attempts): {}", attempts, circuitBreaker.state)
}
@Test
fun `should open circuit breaker after multiple failures`() {
// Given
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
// When - trigger multiple failures to reach minimum-number-of-calls (4) and failure threshold (60%)
// Keep calling until we get enough failures to trigger the circuit breaker
var failureCount = 0
var totalCalls = 0
val maxAttempts = 20 // Prevent infinite loop
while (circuitBreaker.state == CircuitBreaker.State.CLOSED && totalCalls < maxAttempts) {
val result = pingServiceCircuitBreaker.ping(simulateFailure = true)
totalCalls++
if (result["status"] == "fallback") {
failureCount++
}
logger.info("Attempt {}: Circuit breaker state = {}, Response status = {}, Failures so far = {}",
totalCalls, circuitBreaker.state, result["status"], failureCount)
}
// Then - circuit breaker should be open after sufficient failures
logger.info("Final circuit breaker state: {} after {} total calls with {} failures",
circuitBreaker.state, totalCalls, failureCount)
// The circuit breaker should eventually open due to failure rate threshold
// Note: Due to the minimum calls requirement (4) and failure rate threshold (60%),
// it might take several attempts depending on random simulation
if (totalCalls >= 4 && failureCount >= ceil(totalCalls * 0.6)) {
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.OPEN)
}
}
@Test
fun `should return fallback response when circuit breaker is manually opened`() {
// Given
circuitBreaker.transitionToOpenState()
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.OPEN)
// When
val result = pingServiceCircuitBreaker.ping(simulateFailure = false)
// Then
assertThat(result["status"]).isEqualTo("fallback")
assertThat(result["service"]).isEqualTo("ping-service-fallback")
assertThat(result["circuitBreaker"]).isEqualTo("OPEN")
assertThat(result["message"]).isEqualTo("Service temporarily unavailable")
}
@Test
fun `should return successful health check when circuit breaker is closed`() {
// Given
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
// When - retry if we get random failure (10% chance in health check method)
var result: Map<String, Any>
var attempts = 0
do {
result = pingServiceCircuitBreaker.healthCheck()
attempts++
} while (result["status"] == "DOWN" && attempts < 15) // 15 attempts should be enough to get a success
// Then
assertThat(result["status"]).isEqualTo("UP")
assertThat(result["circuitBreaker"]).isEqualTo("CLOSED")
assertThat(result).containsKeys("timestamp")
logger.info("Health check succeeded after {} attempts", attempts)
}
@Test
fun `should return fallback health check when circuit breaker is open`() {
// Given
circuitBreaker.transitionToOpenState()
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.OPEN)
// When
val result = pingServiceCircuitBreaker.healthCheck()
// Then
assertThat(result["status"]).isEqualTo("DOWN")
assertThat(result["circuitBreaker"]).isEqualTo("OPEN")
assertThat(result["message"]).isEqualTo("Health check temporarily unavailable")
}
@Test
fun `should test circuit breaker state transitions`() {
// Given
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
// When - manually transition to open state
circuitBreaker.transitionToOpenState()
// Then
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.OPEN)
// When - manually transition to half-open state
circuitBreaker.transitionToHalfOpenState()
// Then
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.HALF_OPEN)
// When - successful call should close circuit breaker
val result = pingServiceCircuitBreaker.ping(simulateFailure = false)
// Then
assertThat(result["status"]).isEqualTo("pong")
logger.info("Circuit breaker state after successful call in HALF_OPEN: {}", circuitBreaker.state)
}
@Test
fun `should track circuit breaker metrics`() {
// Given
val metrics = circuitBreaker.metrics
// When
val initialFailureRate = metrics.failureRate
val initialNumberOfCalls = metrics.numberOfBufferedCalls
// Execute some successful calls
repeat(3) {
pingServiceCircuitBreaker.ping(simulateFailure = false)
}
// Then
val newMetrics = circuitBreaker.metrics
assertThat(newMetrics.numberOfBufferedCalls).isGreaterThan(initialNumberOfCalls)
logger.info("Circuit breaker metrics - Calls: {}, Failure rate: {}%, Successful calls: {}, Failed calls: {}",
newMetrics.numberOfBufferedCalls,
newMetrics.failureRate,
newMetrics.numberOfSuccessfulCalls,
newMetrics.numberOfFailedCalls)
}
@Test
fun `should handle concurrent calls correctly`() {
// Given
assertThat(circuitBreaker.state).isEqualTo(CircuitBreaker.State.CLOSED)
// When - execute concurrent calls
val futures = (1..10).map { index ->
Thread {
val result = pingServiceCircuitBreaker.ping(simulateFailure = false)
logger.info("Concurrent call {}: status = {}", index, result["status"])
}
}
futures.forEach { it.start() }
futures.forEach { it.join() }
// Then
val metrics = circuitBreaker.metrics
assertThat(metrics.numberOfBufferedCalls).isEqualTo(10)
assertThat(metrics.numberOfSuccessfulCalls).isEqualTo(10)
assertThat(metrics.numberOfFailedCalls).isEqualTo(0)
}
}
@@ -0,0 +1,53 @@
spring:
application:
name: ping-service-test
cloud:
consul:
enabled: false
discovery:
enabled: false
register: false
server:
port: 0
management:
endpoints:
web:
exposure:
include: health,info,circuitbreakers
endpoint:
health:
show-details: always
# Resilience4j Circuit Breaker Configuration for tests
resilience4j:
circuitbreaker:
configs:
default:
failure-rate-threshold: 50
minimum-number-of-calls: 5
wait-duration-in-open-state: 10s
permitted-number-of-calls-in-half-open-state: 3
sliding-window-size: 10
sliding-window-type: COUNT_BASED
record-exceptions:
- java.lang.Exception
ignore-exceptions:
- java.lang.IllegalArgumentException
instances:
pingCircuitBreaker:
base-config: default
failure-rate-threshold: 60
minimum-number-of-calls: 4
wait-duration-in-open-state: 5s
metrics:
enabled: true
legacy:
enabled: true
logging:
level:
org.springframework.cloud.consul: ERROR
com.ecwid.consul: ERROR