Skip to content

[LMCROSSITXSADEPLOY-3316] Introduce health-check-interval module parameter #1853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
IvanBorislavovDimitrov wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[LMCROSSITXSADEPLOY-3316] Introduce health-check-interval module parameter #1853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33914ee
Add health-check-interval module parameter
IvanBorislavovDimitrov Jun 1, 2026
bb90b41
Add tests for health-check-interval parameter
IvanBorislavovDimitrov Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...in/java/org/cloudfoundry/multiapps/controller/client/facade/adapters/RawCloudProcess.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ public CloudProcess derive() {
Integer healthCheckTimeout = null;
String healthCheckHttpEndpoint = null;
Integer healthCheckInvocationTimeout = null;
Integer healthCheckInterval = null;
if (healthCheck.getData() != null) {
Data healthCheckData = healthCheck.getData();
healthCheckTimeout = healthCheckData.getTimeout();
healthCheckInvocationTimeout = healthCheckData.getInvocationTimeout();
healthCheckHttpEndpoint = healthCheckData.getEndpoint();
healthCheckInterval = healthCheckData.getInterval();
}
Integer readinessHealthCheckInvocationTimeout = null;
String readinessHealthCheckHttpEndpoint = null;
Expand All @@ -49,6 +51,7 @@ public CloudProcess derive() {
.healthCheckHttpEndpoint(healthCheckHttpEndpoint)
.healthCheckTimeout(healthCheckTimeout)
.healthCheckInvocationTimeout(healthCheckInvocationTimeout)
.healthCheckInterval(healthCheckInterval)
.readinessHealthCheckType(readinessHealthCheckType.getType()
.getValue())
.readinessHealthCheckHttpEndpoint(readinessHealthCheckHttpEndpoint)
Expand Down
3 changes: 3 additions & 0 deletions ...rc/main/java/org/cloudfoundry/multiapps/controller/client/facade/domain/CloudProcess.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ public abstract class CloudProcess extends CloudEntity implements Derivable<Clou
@Nullable
public abstract Integer getHealthCheckTimeout();

@Nullable
public abstract Integer getHealthCheckInterval();

@Nullable
public abstract Integer getReadinessHealthCheckInterval();

Expand Down
6 changes: 6 additions & 0 deletions ...ent/src/main/java/org/cloudfoundry/multiapps/controller/client/facade/domain/Staging.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ public interface Staging {
@Nullable
String getHealthCheckHttpEndpoint();

/**
* @return health check interval in seconds (liveness)
*/
@Nullable
Integer getHealthCheckInterval();

/**
* @return readiness health check interval
*/
Expand Down
1 change: 1 addition & 0 deletions ...g/cloudfoundry/multiapps/controller/client/facade/rest/CloudControllerRestClientImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,7 @@ private HealthCheck buildHealthCheck(Staging staging) {
.endpoint(staging.getHealthCheckHttpEndpoint())
.timeout(staging.getHealthCheckTimeout())
.invocationTimeout(staging.getInvocationTimeout())
.interval(staging.getHealthCheckInterval())
.build())
.build();
}
Expand Down
15 changes: 12 additions & 3 deletions ...rc/main/java/org/cloudfoundry/multiapps/controller/client/lib/domain/HealthCheckInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ public class HealthCheckInfo {
private final String type;
private final Integer timeout;
private final Integer invocationTimeout;
private final Integer interval;
private final String httpEndpoint;

private HealthCheckInfo(String type, Integer timeout, Integer invocationTimeout, String httpEndpoint) {
private HealthCheckInfo(String type, Integer timeout, Integer invocationTimeout, Integer interval, String httpEndpoint) {
this.type = type;
this.timeout = timeout;
this.invocationTimeout = invocationTimeout;
this.interval = interval;
this.httpEndpoint = httpEndpoint;
}

Expand All @@ -26,16 +28,18 @@ public static HealthCheckInfo fromStaging(Staging staging) {
}
var timeout = staging.getHealthCheckTimeout();
var invocationTimeout = staging.getInvocationTimeout();
var interval = staging.getHealthCheckInterval();
var httpEndpoint = staging.getHealthCheckHttpEndpoint();
return new HealthCheckInfo(type, timeout, invocationTimeout, httpEndpoint);
return new HealthCheckInfo(type, timeout, invocationTimeout, interval, httpEndpoint);
}

public static HealthCheckInfo fromProcess(CloudProcess process) {
var type = process.getHealthCheckType();
var timeout = process.getHealthCheckTimeout();
var invocationTimeout = process.getHealthCheckInvocationTimeout();
var interval = process.getHealthCheckInterval();
var httpEndpoint = process.getHealthCheckHttpEndpoint();
return new HealthCheckInfo(type.toString(), timeout, invocationTimeout, httpEndpoint);
return new HealthCheckInfo(type.toString(), timeout, invocationTimeout, interval, httpEndpoint);
}

public String getType() {
Expand All @@ -50,6 +54,10 @@ public Integer getInvocationTimeout() {
return invocationTimeout;
}

public Integer getInterval() {
return interval;
}

public String getHttpEndpoint() {
return httpEndpoint;
}
Expand All @@ -66,6 +74,7 @@ public boolean equals(Object obj) {
return Objects.equals(getType(), other.getType())
&& Objects.equals(getTimeout(), other.getTimeout())
&& Objects.equals(getInvocationTimeout(), other.getInvocationTimeout())
&& Objects.equals(getInterval(), other.getInterval())
&& Objects.equals(getHttpEndpoint(), other.getHttpEndpoint());
}
}
146 changes: 146 additions & 0 deletions ...ava/org/cloudfoundry/multiapps/controller/client/facade/adapters/RawCloudProcessTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
package org.cloudfoundry.multiapps.controller.client.facade.adapters;

import org.cloudfoundry.client.v3.Metadata;
import org.cloudfoundry.client.v3.processes.Data;
import org.cloudfoundry.client.v3.processes.HealthCheck;
import org.cloudfoundry.client.v3.processes.HealthCheckType;
import org.cloudfoundry.client.v3.processes.ProcessRelationships;
import org.cloudfoundry.client.v3.processes.ProcessResource;
import org.cloudfoundry.client.v3.processes.ReadinessHealthCheck;
import org.cloudfoundry.client.v3.processes.ReadinessHealthCheckType;
import org.cloudfoundry.multiapps.controller.client.facade.domain.CloudProcess;
import org.cloudfoundry.multiapps.controller.client.facade.domain.ImmutableCloudProcess;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;

class RawCloudProcessTest {

private static final String COMMAND = "bundle exec rackup";
private static final Integer DISK_IN_MB = 1024;
private static final Integer INSTANCES = 2;
private static final Integer MEMORY_IN_MB = 512;
private static final String HTTP_ENDPOINT = "/health";
private static final Integer TIMEOUT = 30;
private static final Integer INVOCATION_TIMEOUT = 5;
private static final Integer INTERVAL = 10;
private static final String READINESS_HTTP_ENDPOINT = "/ready";
private static final Integer READINESS_INVOCATION_TIMEOUT = 4;
private static final Integer READINESS_INTERVAL = 8;

@Test
void testDeriveWithFullHealthCheckDataIncludingInterval() {
RawCloudProcess raw = ImmutableRawCloudProcess.of(buildProcessResource(HealthCheckType.HTTP, buildHealthCheckData(),
ReadinessHealthCheckType.HTTP,
buildReadinessHealthCheckData()));

CloudProcess derived = raw.derive();

assertEquals(buildExpected(org.cloudfoundry.multiapps.controller.client.facade.domain.HealthCheckType.HTTP, INTERVAL,
ReadinessHealthCheckType.HTTP.getValue()),
derived);
}

@Test
void testDeriveWithMissingHealthCheckDataLeavesIntervalNull() {
// healthCheck.getData() returns null -> all four health-check Integer/String fields stay null
RawCloudProcess raw = ImmutableRawCloudProcess.of(buildProcessResource(HealthCheckType.PORT, null,
ReadinessHealthCheckType.PORT, null));

CloudProcess derived = raw.derive();

assertEquals(org.cloudfoundry.multiapps.controller.client.facade.domain.HealthCheckType.PORT, derived.getHealthCheckType());
assertNull(derived.getHealthCheckTimeout());
assertNull(derived.getHealthCheckInvocationTimeout());
assertNull(derived.getHealthCheckHttpEndpoint());
assertNull(derived.getHealthCheckInterval());
assertNull(derived.getReadinessHealthCheckInvocationTimeout());
assertNull(derived.getReadinessHealthCheckHttpEndpoint());
assertNull(derived.getReadinessHealthCheckInterval());
}

@Test
void testDeriveWithHealthCheckDataPresentButIntervalNull() {
Data dataWithoutInterval = Data.builder()
.endpoint(HTTP_ENDPOINT)
.timeout(TIMEOUT)
.invocationTimeout(INVOCATION_TIMEOUT)
.build();
RawCloudProcess raw = ImmutableRawCloudProcess.of(buildProcessResource(HealthCheckType.HTTP, dataWithoutInterval,
ReadinessHealthCheckType.PORT, null));

CloudProcess derived = raw.derive();

assertEquals(TIMEOUT, derived.getHealthCheckTimeout());
assertEquals(INVOCATION_TIMEOUT, derived.getHealthCheckInvocationTimeout());
assertEquals(HTTP_ENDPOINT, derived.getHealthCheckHttpEndpoint());
assertNull(derived.getHealthCheckInterval());
}

private static ProcessResource buildProcessResource(HealthCheckType healthCheckType, Data healthCheckData,
ReadinessHealthCheckType readinessHealthCheckType, Data readinessHealthCheckData) {
HealthCheck.Builder healthCheckBuilder = HealthCheck.builder()
.type(healthCheckType);
if (healthCheckData != null) {
healthCheckBuilder.data(healthCheckData);
}
ReadinessHealthCheck.Builder readinessBuilder = ReadinessHealthCheck.builder()
.type(readinessHealthCheckType);
if (readinessHealthCheckData != null) {
readinessBuilder.data(readinessHealthCheckData);
}
return ProcessResource.builder()
.id(RawCloudEntityTest.GUID_STRING)
.createdAt(RawCloudEntityTest.CREATED_AT_STRING)
.updatedAt(RawCloudEntityTest.UPDATED_AT_STRING)
.command(COMMAND)
.diskInMb(DISK_IN_MB)
.instances(INSTANCES)
.memoryInMb(MEMORY_IN_MB)
.type("web")
.metadata(Metadata.builder()
.build())
.relationships(ProcessRelationships.builder()
.build())
.healthCheck(healthCheckBuilder.build())
.readinessHealthCheck(readinessBuilder.build())
.build();
}

private static Data buildHealthCheckData() {
return Data.builder()
.endpoint(HTTP_ENDPOINT)
.timeout(TIMEOUT)
.invocationTimeout(INVOCATION_TIMEOUT)
.interval(INTERVAL)
.build();
}

private static Data buildReadinessHealthCheckData() {
return Data.builder()
.endpoint(READINESS_HTTP_ENDPOINT)
.invocationTimeout(READINESS_INVOCATION_TIMEOUT)
.interval(READINESS_INTERVAL)
.build();
}

private static CloudProcess buildExpected(org.cloudfoundry.multiapps.controller.client.facade.domain.HealthCheckType type,
Integer interval, String readinessHealthCheckType) {
return ImmutableCloudProcess.builder()
.command(COMMAND)
.instances(INSTANCES)
.memoryInMb(MEMORY_IN_MB)
.diskInMb(DISK_IN_MB)
.healthCheckType(type)
.healthCheckHttpEndpoint(HTTP_ENDPOINT)
.healthCheckTimeout(TIMEOUT)
.healthCheckInvocationTimeout(INVOCATION_TIMEOUT)
.healthCheckInterval(interval)
.readinessHealthCheckType(readinessHealthCheckType)
.readinessHealthCheckHttpEndpoint(READINESS_HTTP_ENDPOINT)
.readinessHealthCheckInvocationTimeout(READINESS_INVOCATION_TIMEOUT)
.readinessHealthCheckInterval(READINESS_INTERVAL)
.build();
}
}
Loading
Loading