Skip to content

Create/Update route options #1339

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
theghost5800 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Create/Update route options #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
87064a8
Create/Update route options
theghost5800 Mar 12, 2026
901e4ed
Fix tests formatting
theghost5800 Mar 19, 2026
c4298c9
Switch RouteOptions to use specific fields for every parameter
theghost5800 May 21, 2026
319024f
Add integration tests for route options
theghost5800 May 21, 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
7 changes: 7 additions & 0 deletions cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/routes/_CreateRouteRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ abstract class _CreateRouteRequest {
@JsonProperty("metadata")
abstract Metadata getMetadata();

/**
* Route options
*/
@Nullable
@JsonProperty("options")
abstract RouteOptions getOptions();

/**
* The path
*/
Expand Down
19 changes: 18 additions & 1 deletion cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/routes/_RouteOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package org.cloudfoundry.client.v3.routes;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.cloudfoundry.Nullable;
Expand All @@ -13,10 +14,26 @@
abstract class _RouteOptions {

/**
* The loadbalancing
* The loadbalancing algorithm
*/
@JsonInclude
@JsonProperty("loadbalancing")
@Nullable
public abstract String getLoadbalancing();

/**
* The hash header
*/
@JsonInclude
@JsonProperty("hash_header")
@Nullable
public abstract String getHashHeader();

/**
* The hash balance
*/
@JsonInclude
@JsonProperty("hash_balance")
@Nullable
public abstract String getHashBalance();
}
7 changes: 7 additions & 0 deletions cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/routes/_UpdateRouteRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ abstract class _UpdateRouteRequest {
@Nullable
abstract Metadata getMetadata();

/**
* Route options
*/
@JsonProperty("options")
@Nullable
abstract RouteOptions getOptions();

/**
* The route id
*/
Expand Down
35 changes: 35 additions & 0 deletions ...oundry-client/src/test/java/org/cloudfoundry/client/v3/routes/CreateRouteRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.cloudfoundry.client.v3.routes;

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

import org.cloudfoundry.client.v3.Relationship;
Expand Down Expand Up @@ -94,4 +95,38 @@ void valid() {
.build())
.build());
}

@Test
void validWithRouteOptions() {
CreateRouteRequest request =
CreateRouteRequest.builder()
.relationships(
RouteRelationships.builder()
.domain(
ToOneRelationship.builder()
.data(
Relationship.builder()
.id("test-domain-id")
.build())
.build())
.space(
ToOneRelationship.builder()
.data(
Relationship.builder()
.id("test-space-id")
.build())
.build())
.build())
.options(
RouteOptions.builder()
.loadbalancing("hash")
.hashHeader("X-Hash")
.hashBalance("90")
.build())
.build();

assertEquals("hash", request.getOptions().getLoadbalancing());
assertEquals("X-Hash", request.getOptions().getHashHeader());
assertEquals("90", request.getOptions().getHashBalance());
}
}
20 changes: 20 additions & 0 deletions ...oundry-client/src/test/java/org/cloudfoundry/client/v3/routes/UpdateRouteRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.cloudfoundry.client.v3.routes;

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

import org.cloudfoundry.client.v3.Metadata;
Expand All @@ -39,4 +40,23 @@ void valid() {
.routeId("test-route-id")
.build();
}

@Test
void validWithRouteOptions() {
UpdateRouteRequest request =
UpdateRouteRequest.builder()
.metadata(Metadata.builder().label("test-key", "test-value").build())
.options(
RouteOptions.builder()
.loadbalancing("hash")
.hashHeader("X-Hash")
.hashBalance("90")
.build())
.routeId("test-route-id")
.build();

assertEquals("hash", request.getOptions().getLoadbalancing());
assertEquals("X-Hash", request.getOptions().getHashHeader());
assertEquals("90", request.getOptions().getHashBalance());
}
}
2 changes: 2 additions & 0 deletions integration-test/src/test/java/org/cloudfoundry/CloudFoundryVersion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ public enum CloudFoundryVersion {

PCF_2_13(Version.forIntegers(2, 186, 0)),

PCF_2_14(Version.forIntegers(2, 248, 0)),

PCF_4_v2(Version.forIntegers(2, 209, 0)),

PCF_4_v3(Version.forIntegers(3, 138, 0)),
Expand Down
117 changes: 117 additions & 0 deletions integration-test/src/test/java/org/cloudfoundry/client/v3/RoutesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
import org.cloudfoundry.client.v3.routes.RemoveRouteDestinationsRequest;
import org.cloudfoundry.client.v3.routes.ReplaceRouteDestinationsRequest;
import org.cloudfoundry.client.v3.routes.ReplaceRouteDestinationsResponse;
import org.cloudfoundry.client.v3.routes.RouteOptions;
import org.cloudfoundry.client.v3.routes.RouteRelationships;
import org.cloudfoundry.client.v3.routes.RouteResource;
import org.cloudfoundry.client.v3.routes.UpdateRouteRequest;
Expand Down Expand Up @@ -128,6 +129,72 @@ public void create() {
.verify(Duration.ofMinutes(5));
}

@IfCloudFoundryVersion(greaterThanOrEqualTo = CloudFoundryVersion.PCF_2_14)
@Test
public void createWithOptions() {
String domainName = this.nameFactory.getDomainName();

this.organizationId
.flatMap(
organizationId ->
Mono.zip(
createDomainId(
this.cloudFoundryClient,
domainName,
organizationId),
this.spaceId))
.flatMap(
function(
(domainId, spaceId) ->
this.cloudFoundryClient
.routesV3()
.create(
CreateRouteRequest.builder()
.metadata(
Metadata.builder()
.label(
"test-createWithOptions-key",
"test-createWithOptions-value")
.build())
.options(
RouteOptions.builder()
.loadbalancing(
"round-robin")
.build())
.relationships(
RouteRelationships.builder()
.domain(
ToOneRelationship
.builder()
.data(
Relationship
.builder()
.id(
domainId)
.build())
.build())
.space(
ToOneRelationship
.builder()
.data(
Relationship
.builder()
.id(
spaceId)
.build())
.build())
.build())
.build())
.thenReturn(domainId)))
.flatMapMany(domainId -> requestListRoutes(this.cloudFoundryClient, domainId))
.map(RouteResource::getOptions)
.map(RouteOptions::getLoadbalancing)
.as(StepVerifier::create)
.expectNext("round-robin")
.expectComplete()
.verify(Duration.ofMinutes(5));
}

@IfCloudFoundryVersion(greaterThanOrEqualTo = CloudFoundryVersion.PCF_2_9)
@Test
public void get() {
Expand Down Expand Up @@ -966,6 +1033,56 @@ public void update() {
.verify(Duration.ofMinutes(5));
}

@IfCloudFoundryVersion(greaterThanOrEqualTo = CloudFoundryVersion.PCF_2_14)
@Test
public void updateOptions() {
String domainName = this.nameFactory.getDomainName();

this.organizationId
.flatMap(
organizationId ->
Mono.zip(
createDomainId(
this.cloudFoundryClient,
domainName,
organizationId),
this.spaceId))
.flatMap(
function(
(domainId, spaceId) ->
Mono.zip(
Mono.just(domainId),
createRouteId(
this.cloudFoundryClient,
domainId,
"updateOptions",
spaceId))))
.delayUntil(
function(
(domainId, routeId) ->
this.cloudFoundryClient
.routesV3()
.update(
UpdateRouteRequest.builder()
.routeId(routeId)
.options(
RouteOptions.builder()
.loadbalancing(
"least-connection")
.build())
.build())))
.flatMapMany(
function(
(domainId, ignore) ->
requestListRoutes(this.cloudFoundryClient, domainId)))
.map(RouteResource::getOptions)
.map(RouteOptions::getLoadbalancing)
.as(StepVerifier::create)
.expectNext("least-connection")
.expectComplete()
.verify(Duration.ofMinutes(5));
}

private static Mono<String> createApplicationId(
CloudFoundryClient cloudFoundryClient, String applicationName, String spaceId) {
return requestCreateApplication(cloudFoundryClient, applicationName, spaceId)
Expand Down
Loading