Add Service Routes Tests

This commit adds integration tests for listing routes for both system and user provided
services.

It also constrains the range of ports available to the integration tests to match the
default range of ports available for tcp routes.

[resolves #812]

Author: twoseat

integration-test/src/test/java/org/cloudfoundry/RandomNameFactory.java

@@ -25,9 +25,9 @@
 
 final class RandomNameFactory implements NameFactory {
 
-    private static final int PORT_MAXIMUM = 65_535;
+    private static final int PORT_MAXIMUM = 61_099;
 
-    private static final int PORT_MINIMUM = 1_024;
+    private static final int PORT_MINIMUM = 61_001;
 
     private final Random random;
 

integration-test/src/test/java/org/cloudfoundry/client/v2/ServiceInstancesTest.java

@@ -46,10 +46,17 @@
 import org.cloudfoundry.client.v2.serviceplans.ServicePlanResource;
 import org.cloudfoundry.client.v2.services.ListServicesRequest;
 import org.cloudfoundry.client.v2.services.ServiceResource;
+import org.cloudfoundry.client.v2.shareddomains.CreateSharedDomainRequest;
+import org.cloudfoundry.client.v2.shareddomains.CreateSharedDomainResponse;
+import org.cloudfoundry.routing.RoutingClient;
+import org.cloudfoundry.routing.v1.routergroups.ListRouterGroupsRequest;
+import org.cloudfoundry.routing.v1.routergroups.ListRouterGroupsResponse;
+import org.cloudfoundry.routing.v1.routergroups.RouterGroup;
 import org.cloudfoundry.util.JobUtils;
 import org.cloudfoundry.util.LastOperationUtils;
 import org.cloudfoundry.util.PaginationUtils;
 import org.cloudfoundry.util.ResourceUtils;
+import org.junit.Ignore;
 import org.junit.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import reactor.core.publisher.Flux;
@@ -65,12 +72,17 @@
 
 public final class ServiceInstancesTest extends AbstractIntegrationTest {
 
+    private static final String DEFAULT_ROUTER_GROUP = "default-tcp";
+
     @Autowired
     private CloudFoundryClient cloudFoundryClient;
 
     @Autowired
     private Mono<String> organizationId;
 
+    @Autowired
+    private RoutingClient routingClient;
+
     @Autowired
     private Mono<String> serviceBrokerId;
 
@@ -90,7 +102,7 @@ public void bindRoute() {
                 Mono.just(spaceId)
             )))
             .then(function((domainId, serviceInstanceId, spaceId) -> Mono.when(
-                createRouteId(this.cloudFoundryClient, domainId, hostName, spaceId),
+                createRouteId(this.cloudFoundryClient, domainId, hostName, null, spaceId),
                 Mono.just(serviceInstanceId))
             ))
             .then(function((routeId, serviceInstanceId) -> this.cloudFoundryClient.serviceInstances()
@@ -469,6 +481,216 @@ public void listFilterBySpaceId() {
             .verify(Duration.ofMinutes(5));
     }
 
+    @Test
+    public void listRoutes() {
+        String domainName = this.nameFactory.getDomainName();
+        String hostName = this.nameFactory.getHostName();
+        String serviceInstanceName = this.nameFactory.getServiceInstanceName();
+
+        Mono.when(this.organizationId, this.spaceId)
+            .then(function((organizationId, spaceId) -> Mono.when(
+                createPrivateDomainId(this.cloudFoundryClient, domainName, organizationId),
+                createServiceInstanceId(this.cloudFoundryClient, this.serviceBrokerId, serviceInstanceName, spaceId),
+                Mono.just(spaceId)
+            )))
+            .then(function((domainId, serviceInstanceId, spaceId) -> Mono.when(
+                createRouteId(this.cloudFoundryClient, domainId, hostName, null, spaceId),
+                Mono.just(serviceInstanceId))
+            ))
+            .then(function((routeId, serviceInstanceId) -> requestBindServiceInstanceRoute(this.cloudFoundryClient, routeId, serviceInstanceId)
+                .then(Mono.just(serviceInstanceId))))
+            .flatMapMany(serviceInstanceId -> Mono.when(
+                Mono.just(serviceInstanceId),
+                PaginationUtils.requestClientV2Resources(page -> this.cloudFoundryClient.serviceInstances()
+                    .listRoutes(ListServiceInstanceRoutesRequest.builder()
+                        .page(page)
+                        .serviceInstanceId(serviceInstanceId)
+                        .build()))
+                    .map(resource -> ResourceUtils.getEntity(resource).getServiceInstanceId())
+                    .single()))
+            .as(StepVerifier::create)
+            .consumeNextWith(tupleEquality())
+            .expectComplete()
+            .verify(Duration.ofMinutes(5));
+    }
+
+    @Test
+    public void listRoutesFilterByDomainId() {
+        String domainName = this.nameFactory.getDomainName();
+        String hostName = this.nameFactory.getHostName();
+        String serviceInstanceName = this.nameFactory.getServiceInstanceName();
+
+        Mono.when(this.organizationId, this.spaceId)
+            .then(function((organizationId, spaceId) -> Mono.when(
+                createPrivateDomainId(this.cloudFoundryClient, domainName, organizationId),
+                createServiceInstanceId(this.cloudFoundryClient, this.serviceBrokerId, serviceInstanceName, spaceId),
+                Mono.just(spaceId)
+            )))
+            .then(function((domainId, serviceInstanceId, spaceId) -> Mono.when(
+                Mono.just(domainId),
+                createRouteId(this.cloudFoundryClient, domainId, hostName, null, spaceId),
+                Mono.just(serviceInstanceId))
+            ))
+            .then(function((domainId, routeId, serviceInstanceId) -> requestBindServiceInstanceRoute(this.cloudFoundryClient, routeId, serviceInstanceId)
+                .then(Mono.just(Tuples.of(domainId, serviceInstanceId)))))
+            .flatMapMany(function((domainId, serviceInstanceId) -> Mono.when(
+                Mono.just(serviceInstanceId),
+                PaginationUtils.requestClientV2Resources(page -> this.cloudFoundryClient.serviceInstances()
+                    .listRoutes(ListServiceInstanceRoutesRequest.builder()
+                        .domainId(domainId)
+                        .page(page)
+                        .serviceInstanceId(serviceInstanceId)
+                        .build()))
+                    .map(resource -> ResourceUtils.getEntity(resource).getServiceInstanceId())
+                    .single())))
+            .as(StepVerifier::create)
+            .consumeNextWith(tupleEquality())
+            .expectComplete()
+            .verify(Duration.ofMinutes(5));
+    }
+
+    @Test
+    public void listRoutesFilterByHost() {
+        String domainName = this.nameFactory.getDomainName();
+        String hostName = this.nameFactory.getHostName();
+        String serviceInstanceName = this.nameFactory.getServiceInstanceName();
+
+        Mono.when(this.organizationId, this.spaceId)
+            .then(function((organizationId, spaceId) -> Mono.when(
+                createPrivateDomainId(this.cloudFoundryClient, domainName, organizationId),
+                createServiceInstanceId(this.cloudFoundryClient, this.serviceBrokerId, serviceInstanceName, spaceId),
+                Mono.just(spaceId)
+            )))
+            .then(function((domainId, serviceInstanceId, spaceId) -> Mono.when(
+                createRouteId(this.cloudFoundryClient, domainId, hostName, null, spaceId),
+                Mono.just(serviceInstanceId))
+            ))
+            .then(function((routeId, serviceInstanceId) -> requestBindServiceInstanceRoute(this.cloudFoundryClient, routeId, serviceInstanceId)
+                .then(Mono.just(serviceInstanceId))))
+            .flatMapMany(serviceInstanceId -> Mono.when(
+                Mono.just(serviceInstanceId),
+                PaginationUtils.requestClientV2Resources(page -> this.cloudFoundryClient.serviceInstances()
+                    .listRoutes(ListServiceInstanceRoutesRequest.builder()
+                        .host(hostName)
+                        .page(page)
+                        .serviceInstanceId(serviceInstanceId)
+                        .build()))
+                    .map(resource -> ResourceUtils.getEntity(resource).getServiceInstanceId())
+                    .single()))
+            .as(StepVerifier::create)
+            .consumeNextWith(tupleEquality())
+            .expectComplete()
+            .verify(Duration.ofMinutes(5));
+    }
+
+    //TODO: Await https://github.com/cloudfoundry/cloud_controller_ng/issues/900
+    @Ignore("Await https://github.com/cloudfoundry/cloud_controller_ng/issues/900")
+    @Test
+    public void listRoutesFilterByOrganizationId() {
+        String domainName = this.nameFactory.getDomainName();
+        String hostName = this.nameFactory.getHostName();
+        String serviceInstanceName = this.nameFactory.getServiceInstanceName();
+
+        Mono.when(this.organizationId, this.spaceId)
+            .then(function((organizationId, spaceId) -> Mono.when(
+                createPrivateDomainId(this.cloudFoundryClient, domainName, organizationId),
+                Mono.just(organizationId),
+                createServiceInstanceId(this.cloudFoundryClient, this.serviceBrokerId, serviceInstanceName, spaceId),
+                Mono.just(spaceId)
+            )))
+            .then(function((domainId, organizationId, serviceInstanceId, spaceId) -> Mono.when(
+                createRouteId(this.cloudFoundryClient, domainId, hostName, null, spaceId),
+                Mono.just(organizationId),
+                Mono.just(serviceInstanceId))
+            ))
+            .then(function((routeId, organizationId, serviceInstanceId) -> requestBindServiceInstanceRoute(this.cloudFoundryClient, routeId, serviceInstanceId)
+                .then(Mono.just(Tuples.of(organizationId, serviceInstanceId)))))
+            .flatMapMany(function((organizationId, serviceInstanceId) -> Mono.when(
+                Mono.just(serviceInstanceId),
+                PaginationUtils.requestClientV2Resources(page -> this.cloudFoundryClient.serviceInstances()
+                    .listRoutes(ListServiceInstanceRoutesRequest.builder()
+                        .organizationId(organizationId)
+                        .page(page)
+                        .serviceInstanceId(serviceInstanceId)
+                        .build()))
+                    .map(resource -> ResourceUtils.getEntity(resource).getServiceInstanceId())
+                    .single())))
+            .as(StepVerifier::create)
+            .consumeNextWith(tupleEquality())
+            .expectComplete()
+            .verify(Duration.ofMinutes(5));
+    }
+
+    @Test
+    public void listRoutesFilterByPath() {
+        String domainName = this.nameFactory.getDomainName();
+        String serviceInstanceName = this.nameFactory.getServiceInstanceName();
+        String path = this.nameFactory.getPath();
+
+        Mono.when(this.organizationId, this.spaceId)
+            .then(function((organizationId, spaceId) -> Mono.when(
+                createPrivateDomainId(this.cloudFoundryClient, domainName, organizationId),
+                createServiceInstanceId(this.cloudFoundryClient, this.serviceBrokerId, serviceInstanceName, spaceId),
+                Mono.just(spaceId)
+            )))
+            .then(function((domainId, serviceInstanceId, spaceId) -> Mono.when(
+                createRouteId(this.cloudFoundryClient, domainId, null, path, spaceId),
+                Mono.just(serviceInstanceId))
+            ))
+            .then(function((routeId, serviceInstanceId) -> requestBindServiceInstanceRoute(this.cloudFoundryClient, routeId, serviceInstanceId)
+                .then(Mono.just(serviceInstanceId))))
+            .flatMapMany(serviceInstanceId -> Mono.when(
+                Mono.just(serviceInstanceId),
+                PaginationUtils.requestClientV2Resources(page -> this.cloudFoundryClient.serviceInstances()
+                    .listRoutes(ListServiceInstanceRoutesRequest.builder()
+                        .page(page)
+                        .path(path)
+                        .serviceInstanceId(serviceInstanceId)
+                        .build()))
+                    .map(resource -> ResourceUtils.getEntity(resource).getServiceInstanceId())
+                    .single()))
+            .as(StepVerifier::create)
+            .consumeNextWith(tupleEquality())
+            .expectComplete()
+            .verify(Duration.ofMinutes(5));
+    }
+
+    @Test
+    public void listRoutesFilterByPort() {
+        String domainName = this.nameFactory.getDomainName();
+        String hostName = this.nameFactory.getHostName();
+        Integer port = this.nameFactory.getPort();
+        String serviceInstanceName = this.nameFactory.getServiceInstanceName();
+
+        Mono.when(this.organizationId, this.spaceId)
+            .then(function((organizationId, spaceId) -> Mono.when(
+                getRouterGroupId(this.routingClient, DEFAULT_ROUTER_GROUP)
+                    .then(routerGroupId -> createTcpDomainId(this.cloudFoundryClient, domainName, routerGroupId)),
+                createServiceInstanceId(this.cloudFoundryClient, this.serviceBrokerId, serviceInstanceName, spaceId),
+                Mono.just(spaceId)
+            )))
+            .then(function((domainId, serviceInstanceId, spaceId) -> Mono.when(
+                createRouteId(this.cloudFoundryClient, domainId, port, spaceId),
+                Mono.just(serviceInstanceId))
+            ))
+            .then(function((routeId, serviceInstanceId) -> requestBindServiceInstanceRoute(this.cloudFoundryClient, routeId, serviceInstanceId)
+                .then(Mono.just(serviceInstanceId))))
+            .flatMapMany(serviceInstanceId -> Mono.when(
+                Mono.just(serviceInstanceId),
+                PaginationUtils.requestClientV2Resources(page -> this.cloudFoundryClient.serviceInstances()
+                    .listRoutes(ListServiceInstanceRoutesRequest.builder()
+                        .page(page)
+                        .port(port.toString())
+                        .serviceInstanceId(serviceInstanceId)
+                        .build()))
+                    .map(resource -> ResourceUtils.getEntity(resource).getServiceInstanceId())
+                    .single()))
+            .as(StepVerifier::create)
+            .consumeNextWith(tupleEquality())
+            .expectComplete()
+            .verify(Duration.ofMinutes(5));
+    }
+
     @Test
     public void listServiceBindings() {
         String applicationName = this.nameFactory.getApplicationName();
@@ -539,7 +761,7 @@ public void unbindRoute() {
                 Mono.just(spaceId)
             )))
             .then(function((domainId, serviceInstanceId, spaceId) -> Mono.when(
-                createRouteId(this.cloudFoundryClient, domainId, hostName, spaceId),
+                createRouteId(this.cloudFoundryClient, domainId, hostName, null, spaceId),
                 Mono.just(serviceInstanceId))
             ))
             .then(function((routeId, serviceInstanceId) -> requestBindServiceInstanceRoute(this.cloudFoundryClient, routeId, serviceInstanceId)
@@ -598,7 +820,7 @@ public void updateEmptyCollections() {
     private static Mono<BindServiceInstanceRouteResponse> createAndBindRoute(CloudFoundryClient cloudFoundryClient, String domainName, String organizationId, String spaceId, String
         serviceInstanceId) {
         return createPrivateDomainId(cloudFoundryClient, domainName, organizationId)
-            .then(domainId -> createRouteId(cloudFoundryClient, domainId, spaceId))
+            .then(domainId -> createRouteId(cloudFoundryClient, domainId, null, null, spaceId))
             .then(routeId -> requestBindServiceInstanceRoute(cloudFoundryClient, routeId, serviceInstanceId));
     }
 
@@ -612,13 +834,13 @@ private static Mono<String> createPrivateDomainId(CloudFoundryClient cloudFoundr
             .map(ResourceUtils::getId);
     }
 
-    private static Mono<String> createRouteId(CloudFoundryClient cloudFoundryClient, String domainId, String hostName, String spaceId) {
-        return requestCreateRoute(cloudFoundryClient, domainId, hostName, spaceId)
+    private static Mono<String> createRouteId(CloudFoundryClient cloudFoundryClient, String domainId, String hostName, String path, String spaceId) {
+        return requestCreateRoute(cloudFoundryClient, domainId, hostName, path, spaceId)
             .map(ResourceUtils::getId);
     }
 
-    private static Mono<String> createRouteId(CloudFoundryClient cloudFoundryClient, String domainId, String spaceId) {
-        return requestCreateRoute(cloudFoundryClient, domainId, spaceId)
+    private static Mono<String> createRouteId(CloudFoundryClient cloudFoundryClient, String domainId, Integer port, String spaceId) {
+        return requestCreateRoute(cloudFoundryClient, domainId, port, spaceId)
             .map(ResourceUtils::getId);
     }
 
@@ -639,6 +861,11 @@ private static Mono<String> createServiceKeyId(CloudFoundryClient cloudFoundryCl
             .map(ResourceUtils::getId);
     }
 
+    private static Mono<String> createTcpDomainId(CloudFoundryClient cloudFoundryClient, String name, String routerGroupId) {
+        return requestCreateTcpDomain(cloudFoundryClient, name, routerGroupId)
+            .map(ResourceUtils::getId);
+    }
+
     private static Mono<String> getPlanId(CloudFoundryClient cloudFoundryClient, String serviceBrokerId) {
         return requestListServices(cloudFoundryClient, serviceBrokerId)
             .single()
@@ -648,6 +875,14 @@ private static Mono<String> getPlanId(CloudFoundryClient cloudFoundryClient, Str
             .map(ResourceUtils::getId);
     }
 
+    private static Mono<String> getRouterGroupId(RoutingClient routingClient, String routerGroupName) {
+        return requestListRouterGroups(routingClient)
+            .flatMapIterable(ListRouterGroupsResponse::getRouterGroups)
+            .filter(group -> routerGroupName.equals(group.getName()))
+            .single()
+            .map(RouterGroup::getRouterGroupId);
+    }
+
     private static Mono<BindServiceInstanceRouteResponse> requestBindServiceInstanceRoute(CloudFoundryClient cloudFoundryClient, String routeId, String serviceInstanceId) {
         return cloudFoundryClient.serviceInstances()
             .bindRoute(BindServiceInstanceRouteRequest.builder()
@@ -672,19 +907,21 @@ private static Mono<CreatePrivateDomainResponse> requestCreatePrivateDomain(Clou
                 .build());
     }
 
-    private static Mono<CreateRouteResponse> requestCreateRoute(CloudFoundryClient cloudFoundryClient, String domainId, String hostName, String spaceId) {
+    private static Mono<CreateRouteResponse> requestCreateRoute(CloudFoundryClient cloudFoundryClient, String domainId, Integer port, String spaceId) {
         return cloudFoundryClient.routes()
             .create(CreateRouteRequest.builder()
                 .domainId(domainId)
-                .host(hostName)
+                .port(port)
                 .spaceId(spaceId)
                 .build());
     }
 
-    private static Mono<CreateRouteResponse> requestCreateRoute(CloudFoundryClient cloudFoundryClient, String domainId, String spaceId) {
+    private static Mono<CreateRouteResponse> requestCreateRoute(CloudFoundryClient cloudFoundryClient, String domainId, String hostName, String path, String spaceId) {
         return cloudFoundryClient.routes()
             .create(CreateRouteRequest.builder()
                 .domainId(domainId)
+                .host(hostName)
+                .path(path)
                 .spaceId(spaceId)
                 .build());
     }
@@ -715,6 +952,20 @@ private static Mono<CreateServiceKeyResponse> requestCreateServiceKey(CloudFound
                 .build());
     }
 
+    private static Mono<CreateSharedDomainResponse> requestCreateTcpDomain(CloudFoundryClient cloudFoundryClient, String name, String routerGroupId) {
+        return cloudFoundryClient.sharedDomains()
+            .create(CreateSharedDomainRequest.builder()
+                .name(name)
+                .routerGroupId(routerGroupId)
+                .build());
+    }
+
+    private static Mono<ListRouterGroupsResponse> requestListRouterGroups(RoutingClient routingClient) {
+        return routingClient.routerGroups()
+            .list(ListRouterGroupsRequest.builder()
+                .build());
+    }
+
     private static Flux<RouteResource> requestListRoutes(CloudFoundryClient cloudFoundryClient, String serviceInstanceId) {
         return PaginationUtils
             .requestClientV2Resources(page -> cloudFoundryClient.serviceInstances()