Support include query parameter for list roles

Author: Fabian-K

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/roles/_ListRolesRequest.java

@@ -58,4 +58,10 @@ abstract class _ListRolesRequest extends PaginatedRequest {
     @FilterParameter("user_guids")
     abstract List<String> getUserIds();
 
+    /**
+     * The include parameter
+     */
+    @FilterParameter("include")
+    abstract List<String> getInclude();
+
 }

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/roles/_ListRolesResponse.java

@@ -16,7 +16,9 @@
 
 package org.cloudfoundry.client.v3.roles;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import org.cloudfoundry.Nullable;
 import org.cloudfoundry.client.v3.PaginatedResponse;
 import org.immutables.value.Value;
 
@@ -27,4 +29,8 @@
 @Value.Immutable
 abstract class _ListRolesResponse extends PaginatedResponse<RoleResource> {
 
+    @JsonProperty("included")
+    @Nullable
+    public abstract RoleIncluded getIncluded();
+
 }

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/roles/_RoleIncluded.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2013-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.cloudfoundry.client.v3.roles;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import org.cloudfoundry.Nullable;
+import org.cloudfoundry.client.v3.organizations.OrganizationResource;
+import org.cloudfoundry.client.v3.spaces.SpaceResource;
+import org.cloudfoundry.client.v3.users.UserResource;
+import org.immutables.value.Value;
+
+import java.util.List;
+
+
+@JsonDeserialize
+@Value.Immutable
+public abstract class _RoleIncluded {
+    @JsonProperty("users")
+    @Nullable
+    public abstract List<UserResource> getUsers();
+
+    @JsonProperty("spaces")
+    @Nullable
+    public abstract List<SpaceResource> getSpaces();
+
+    @JsonProperty("organizations")
+    @Nullable
+    public abstract List<OrganizationResource> getOrganizations();
+}

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/users/User.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2013-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.cloudfoundry.client.v3.users;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import org.cloudfoundry.client.v3.Metadata;
+import org.cloudfoundry.client.v3.Resource;
+
+/**
+ * Base class for responses that are users
+ */
+public abstract class User extends Resource {
+
+    /**
+     * The metadata
+     */
+    @JsonProperty("metadata")
+    public abstract Metadata getMetadata();
+
+    /**
+     * The username
+     */
+    @JsonProperty("username")
+    public abstract String getUsername();
+
+    /**
+     * The presentation name
+     */
+    @JsonProperty("presentation_name")
+    public abstract String getPresentationName();
+
+    /**
+     * The origin
+     */
+    @JsonProperty("origin")
+    public abstract String getOrigin();
+}

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/users/_UserResource.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2013-2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.cloudfoundry.client.v3.users;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import org.immutables.value.Value;
+
+/**
+ * The Resource response payload for the List Users operation
+ */
+@JsonDeserialize
+@Value.Immutable
+abstract class _UserResource extends User {
+
+}

integration-test/src/test/java/org/cloudfoundry/client/v3/RolesTest.java

@@ -32,6 +32,7 @@
 import org.cloudfoundry.client.v3.roles.ListRolesRequest;
 import org.cloudfoundry.client.v3.roles.RoleRelationships;
 import org.cloudfoundry.client.v3.roles.RoleResource;
+import org.cloudfoundry.client.v3.users.UserResource;
 import org.cloudfoundry.util.JobUtils;
 import org.cloudfoundry.util.PaginationUtils;
 import org.junit.jupiter.api.Test;
@@ -202,6 +203,34 @@ public void listFilterByOrganizationId() {
                 .verify(Duration.ofMinutes(5));
     }
 
+    @Test
+    public void listIncludeUser() {
+        String organizationName = this.nameFactory.getOrganizationName();
+        String userId = this.nameFactory.getUserId();
+
+        createOrganizationId(this.cloudFoundryClient, organizationName)
+                .flatMap(
+                        organizationId ->
+                                requestCreateOrganizationRelationship(
+                                                this.cloudFoundryClient, organizationId, userId)
+                                        .map(CreateRoleResponse::getId))
+                .flatMapMany(
+                        roleId ->
+                                this.cloudFoundryClient
+                                        .rolesV3()
+                                        .list(
+                                                ListRolesRequest.builder()
+                                                        .roleId(roleId)
+                                                        .include("user")
+                                                        .build())
+                                        .flatMapIterable(i -> i.getIncluded().getUsers())
+                                        .map(UserResource::getId))
+                .as(StepVerifier::create)
+                .expectNext(userId)
+                .expectComplete()
+                .verify(Duration.ofMinutes(5));
+    }
+
     private static Mono<String> createOrganizationId(
             CloudFoundryClient cloudFoundryClient, String organizationName) {
         return requestCreateOrganization(cloudFoundryClient, organizationName)