Add Integration Tests for User Sharing API

modules/integration/tests-integration/tests-backend/pom.xml

@@ -986,6 +986,12 @@
             <artifactId>swagger-request-validator-restassured</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <version>4.2.0</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-jul</artifactId>

modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/identity/integration/test/rest/api/server/user/sharing/management/v1/constant/UserSharingConstants.java

@@ -0,0 +1,189 @@
+/*
+ * Copyright (c) 2025, WSO2 LLC. (http://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you 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.wso2.identity.integration.test.rest.api.server.user.sharing.management.v1.constant;
+
+/**
+ * Constants for organization user sharing.
+ */
+public class UserSharingConstants {
+
+    public static final String API_DEFINITION_NAME = "organization-user-share.yaml";
+    public static final String AUTHORIZED_APIS_JSON = "user-sharing-apis.json";
+    public static final String API_VERSION = "v1";
+    public static final String API_PACKAGE_NAME =
+            "org.wso2.carbon.identity.api.server.organization.user.sharing.management.v1";
+
+    public static final String API_SERVER_V1_BASE_PATH = "/api/server/v1";
+    public static final String ORGANIZATION_API_PATH = "/o";
+    public static final String USER_SHARING_API_BASE_PATH = "/users";
+    public static final String SHARE_PATH = "/share";
+    public static final String SHARE_WITH_ALL_PATH = "/share-with-all";
+    public static final String UNSHARE_PATH = "/unshare";
+    public static final String UNSHARE_WITH_ALL_PATH = "/unshare-with-all";
+    public static final String SHARED_ORGANIZATIONS_PATH = "/shared-organizations";
+    public static final String SHARED_ROLES_PATH = "/shared-roles";
+
+    public static final String PATH_SEPARATOR = "/";
+    public static final String QUERY_PARAM_SEPARATOR = "?";
+    public static final String QUERY_PARAM_VALUE_SEPARATOR = "=";
+    public static final String UNDERSCORE = "_";
+
+    public static final String HEADER_AUTHORIZATION = "Authorization";
+    public static final String HEADER_AUTHORIZATION_VALUE_BEARER = "Bearer ";
+    public static final String HEADER_CONTENT_TYPE = "Content-Type";
+
+    public static final String SHARED_TYPE_SHARED = "SHARED";
+    public static final String SHARED_TYPE_OWNER = "OWNER";
+    public static final String SHARED_TYPE_INVITED = "INVITED";
+
+    public static final String PATH_PARAM_USER_ID = "userId";
+    public static final String QUERY_PARAM_ORG_ID = "orgId";
+    public static final String QUERY_PARAM_LIMIT = "limit";
+    public static final String QUERY_PARAM_AFTER = "after";
+    public static final String QUERY_PARAM_BEFORE = "before";
+    public static final String QUERY_PARAM_FILTER = "filter";
+    public static final String QUERY_PARAM_RECURSIVE = "recursive";
+
+    public static final String ERROR_CODE_BAD_REQUEST = "UE-10000";
+    public static final String ERROR_CODE_INVALID_PAGINATION_CURSOR = "ORG-60026";
+    public static final String ERROR_CODE_SERVER_ERROR = "SE-50000";
+
+    public static final String ROOT_ORG_NAME = "Super";
+    public static final String L1_ORG_1_NAME = "L1 - Organization 1";
+    public static final String L1_ORG_2_NAME = "L1 - Organization 2";
+    public static final String L1_ORG_3_NAME = "L1 - Organization 3";
+    public static final String L2_ORG_1_NAME = "L2 - Organization 1";
+    public static final String L2_ORG_2_NAME = "L2 - Organization 2";
+    public static final String L2_ORG_3_NAME = "L2 - Organization 3";
+    public static final String L3_ORG_1_NAME = "L3 - Organization 1";
+
+    public static final String ROOT_ORG_ID = "10084a8d-113f-4211-a0d5-efe36b082211";
+
+    public static final String APP_1_NAME = "App 1";
+    public static final String APP_2_NAME = "App 2";
+
+    public static final String APPLICATION_AUDIENCE = "application";
+    public static final String ORGANIZATION_AUDIENCE = "organization";
+
+    public static final String APP_ROLE_1 = "app-role-1";
+    public static final String APP_ROLE_2 = "app-role-2";
+    public static final String APP_ROLE_3 = "app-role-3";
+    public static final String ORG_ROLE_1 = "org-role-1";
+    public static final String ORG_ROLE_2 = "org-role-2";
+    public static final String ORG_ROLE_3 = "org-role-3";
+
+    public static final String USER_DOMAIN_PRIMARY = "PRIMARY";
+
+    public static final String ROOT_ORG_USER_1_USERNAME = "rootUser1";
+    public static final String ROOT_ORG_USER_2_USERNAME = "rootUser2";
+    public static final String ROOT_ORG_USER_3_USERNAME = "rootUser3";
+    public static final String L1_ORG_1_USER_1_USERNAME = "l1Org1User1";
+    public static final String L1_ORG_1_USER_2_USERNAME = "l1Org1User2";
+    public static final String L1_ORG_1_USER_3_USERNAME = "l1Org1User3";
+    public static final String ROOT_ORG_USER_DUPLICATED_USERNAME = "rootUserDuplicated";
+
+    public static final String MAP_KEY_SELECTIVE_ORG_ID = "orgId";
+    public static final String MAP_KEY_SELECTIVE_ORG_NAME = "orgName";
+    public static final String MAP_KEY_SELECTIVE_POLICY = "selectivePolicy";
+    public static final String MAP_KEY_SELECTIVE_ROLES = "selectiveRoles";
+
+    public static final String MAP_KEY_GENERAL_POLICY = "generalPolicy";
+    public static final String MAP_KEY_GENERAL_ROLES = "generalRoles";
+
+    public static final String MAP_KEY_EXPECTED_ORG_COUNT = "expectedOrgCount";
+    public static final String MAP_KEY_EXPECTED_ORG_IDS = "expectedOrgIds";
+    public static final String MAP_KEY_EXPECTED_ORG_NAMES = "expectedOrgNames";
+    public static final String MAP_KEY_EXPECTED_ROLES_PER_EXPECTED_ORG = "expectedRolesPerExpectedOrg";
+
+    public static final String MAP_ORG_DETAILS_KEY_ORG_NAME = "orgName";
+    public static final String MAP_ORG_DETAILS_KEY_ORG_ID = "orgId";
+    public static final String MAP_ORG_DETAILS_KEY_PARENT_ORG_ID = "parentOrgId";
+    public static final String MAP_ORG_DETAILS_KEY_ORG_SWITCH_TOKEN = "orgSwitchToken";
+    public static final String MAP_ORG_DETAILS_KEY_ORG_LEVEL = "orgLevel";
+
+    public static final String MAP_APP_DETAILS_KEY_APP_NAME = "appName";
+    public static final String MAP_APP_DETAILS_KEY_APP_ID = "appId";
+    public static final String MAP_APP_DETAILS_KEY_APP_AUDIENCE = "appAudience";
+    public static final String MAP_APP_DETAILS_KEY_CLIENT_ID = "clientId";
+    public static final String MAP_APP_DETAILS_KEY_CLIENT_SECRET = "clientSecret";
+    public static final String MAP_APP_DETAILS_KEY_ROLE_NAMES = "roleNames";
+    public static final String MAP_APP_DETAILS_KEY_ROLE_IDS_BY_NAME = "roleIdsByName";
+    public static final String MAP_APP_DETAILS_KEY_APP_DETAILS_OF_SUB_ORGS = "appDetailsOfSubOrgs";
+    public static final String MAP_APP_DETAILS_KEY_APP_SUB_ORG_NAME = "subOrgName";
+
+    public static final String MAP_USER_DETAILS_KEY_DOMAIN_QUALIFIED_USER_NAME = "domainQualifiedUserName";
+    public static final String MAP_USER_DETAILS_KEY_USER_NAME = "userName";
+    public static final String MAP_USER_DETAILS_KEY_USER_ID = "userId";
+    public static final String MAP_USER_DETAILS_KEY_USER_DOMAIN = "userDomain";
+    public static final String MAP_USER_DETAILS_KEY_USER_ORG_NAME = "userOrgName";
+    public static final String MAP_USER_DETAILS_KEY_USER_ORG_ID = "userOrgId";
+    public static final String MAP_USER_DETAILS_KEY_USER_ORG_LEVEL = "userOrgLevel";
+    public static final String MAP_USER_DETAILS_KEY_IS_ROOT_ORG_USER = "isRootOrgUser";
+
+    public static final String MAP_USER_DOMAIN_QUALIFIED_USER_NAME_USER_NAME = "userName";
+    public static final String MAP_USER_DOMAIN_QUALIFIED_USER_NAME_USER_DOMAIN = "userDomain";
+
+    public static final String SCOPE_INTERNAL_USER_SHARE = "internal_user_share";
+    public static final String SCOPE_INTERNAL_USER_UNSHARE = "internal_user_unshare";
+    public static final String SCOPE_INTERNAL_USER_SHARED_ACCESS_VIEW = "internal_user_shared_access_view";
+    public static final String SCOPE_INTERNAL_ORG_USER_SHARE = "internal_org_user_share";
+    public static final String SCOPE_INTERNAL_ORG_USER_UNSHARE = "internal_org_user_unshare";
+    public static final String SCOPE_INTERNAL_ORG_USER_SHARED_ACCESS_VIEW = "internal_org_user_shared_access_view";
+
+    public static final String GRANT_AUTHORIZATION_CODE = "authorization_code";
+    public static final String GRANT_IMPLICIT = "implicit";
+    public static final String GRANT_PASSWORD = "password";
+    public static final String GRANT_CLIENT_CREDENTIALS = "client_credentials";
+    public static final String GRANT_REFRESH_TOKEN = "refresh_token";
+    public static final String GRANT_ORGANIZATION_SWITCH = "organization_switch";
+
+    public static final String CLAIM_EMAIL_URI = "http://wso2.org/claims/emailaddress";
+    public static final String CLAIM_COUNTRY_URI = "http://wso2.org/claims/country";
+    public static final String CLAIM_ROLES_URI = "http://wso2.org/claims/roles";
+    public static final String CLAIM_GROUPS_URI = "http://wso2.org/claims/groups";
+
+    public static final String ATTRIBUTE_USER_PASSWORD = "Admin123";
+    public static final String ATTRIBUTE_USER_EMAIL_DOMAIN = "@gmail.com";
+    public static final String ATTRIBUTE_USER_SCHEMA_SCIM2_USER = "urn:ietf:params:scim:schemas:core:2.0:User";
+
+    public static final String RESPONSE_STATUS = "status";
+    public static final String RESPONSE_DETAILS = "details";
+    public static final String RESPONSE_STATUS_VALUE = "Processing";
+    public static final String RESPONSE_DETAIL_VALUE_SHARING = "User sharing process triggered successfully.";
+    public static final String RESPONSE_DETAIL_VALUE_UNSHARING = "User unsharing process triggered successfully.";
+
+    public static final String RESPONSE_LINKS_SIZE = "links.size()";
+    public static final String RESPONSE_LINKS_EMPTY = "links[0].isEmpty()";
+    public static final String RESPONSE_LINKS_SHARED_ORGS = "sharedOrganizations";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_SIZE = "sharedOrganizations.size()";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_ID = "sharedOrganizations.orgId";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_NAME = "sharedOrganizations.orgName";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_SHARED_USER_ID = "sharedOrganizations.sharedUserId";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_SHARED_TYPE = "sharedOrganizations.sharedType";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_ROLES_REF = "sharedOrganizations.rolesRef";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_ROLES = "roles";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_ROLES_SIZE = "roles.size()";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_ROLES_NAME = "roles.displayName";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_ROLES_AUDIENCE_NAME = "roles.audience.display";
+    public static final String RESPONSE_LINKS_SHARED_ORGS_ROLES_AUDIENCE_TYPE = "roles.audience.type";
+
+    public static final String ERROR_SETUP_SWAGGER_DEFINITION = "Unable to read the swagger definition %s from %s";
+    public static final String SHARED_USER_ID_JSON_PATH =
+            "sharedOrganizations.find { it.orgName == '%s' }.sharedUserId";
+}

modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/identity/integration/test/restclients/UserSharingRestClient.java

@@ -24,10 +24,12 @@
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.message.BasicHeader;
 import org.testng.Assert;
-import org.wso2.carbon.automation.engine.context.TestUserMode;
 import org.wso2.carbon.automation.engine.context.beans.Tenant;
 import org.wso2.identity.integration.common.utils.ISIntegrationTest;
+import org.wso2.identity.integration.test.rest.api.server.user.sharing.management.v1.model.UserShareRequestBody;
 import org.wso2.identity.integration.test.rest.api.server.user.sharing.management.v1.model.UserShareWithAllRequestBody;
+import org.wso2.identity.integration.test.rest.api.server.user.sharing.management.v1.model.UserUnshareRequestBody;
+import org.wso2.identity.integration.test.rest.api.server.user.sharing.management.v1.model.UserUnshareWithAllRequestBody;
 
 import java.io.IOException;
 
@@ -39,13 +41,25 @@
 public class UserSharingRestClient extends RestBaseClient {
 
     private static final String API_SERVER_BASE_PATH = "/api/server/v1";
-    public static final String USER_SHARE_WITH_ALL_ENDPOINT_URI = "/users/share-with-all";
+    static final String USER_SHARING_API_BASE_PATH = "/users";
+    static final String SHARE_PATH = "/share";
+    static final String SHARE_WITH_ALL_PATH = "/share-with-all";
+    static final String UNSHARE_PATH = "/unshare";
+    static final String UNSHARE_WITH_ALL_PATH = "/unshare-with-all";
+    static final String SHARED_ORGANIZATIONS_PATH = "/shared-organizations";
+    static final String SHARED_ROLES_PATH = "/shared-roles";
+
     public static final String PATH_SEPARATOR = "/";
+
     private final String serverUrl;
     private final String tenantDomain;
     private final String username;
     private final String password;
-    private final String userShareWithAllBasePath;
+
+    private final String selectiveUserShareEndpoint;
+    private final String generalUserShareEndpoint;
+    private final String selectiveUserUnshareEndpoint;
+    private final String generalUserUnshareEndpoint;
 
     public UserSharingRestClient(String serverUrl, Tenant tenantInfo) {
 
@@ -54,24 +68,77 @@ public UserSharingRestClient(String serverUrl, Tenant tenantInfo) {
         this.username = tenantInfo.getContextUser().getUserName();
         this.password = tenantInfo.getContextUser().getPassword();
 
-        userShareWithAllBasePath = serverUrl +
-                ISIntegrationTest.getTenantedRelativePath(API_SERVER_BASE_PATH + USER_SHARE_WITH_ALL_ENDPOINT_URI,
-                        tenantDomain);
+        selectiveUserShareEndpoint = serverUrl + ISIntegrationTest.getTenantedRelativePath(
+                API_SERVER_BASE_PATH + USER_SHARING_API_BASE_PATH + SHARE_PATH, tenantDomain);
+        generalUserShareEndpoint = serverUrl + ISIntegrationTest.getTenantedRelativePath(
+                API_SERVER_BASE_PATH + USER_SHARING_API_BASE_PATH + SHARE_WITH_ALL_PATH, tenantDomain);
+        selectiveUserUnshareEndpoint = serverUrl + ISIntegrationTest.getTenantedRelativePath(
+                API_SERVER_BASE_PATH + USER_SHARING_API_BASE_PATH + UNSHARE_PATH, tenantDomain);
+        generalUserUnshareEndpoint = serverUrl + ISIntegrationTest.getTenantedRelativePath(
+                API_SERVER_BASE_PATH + USER_SHARING_API_BASE_PATH + UNSHARE_WITH_ALL_PATH, tenantDomain);
+    }
+
+    /**
+     * Share users selectively.
+     *
+     * @param userShareRequestBody Selective User Share request body.
+     * @throws Exception If an error occurs while sharing users selectively.
+     */
+    public void shareUsers(UserShareRequestBody userShareRequestBody) throws Exception {
+
+        String jsonRequest = toJSONString(userShareRequestBody);
+        try (CloseableHttpResponse response = getResponseOfHttpPost(selectiveUserShareEndpoint, jsonRequest,
+                getHeaders())) {
+            Assert.assertEquals(response.getStatusLine().getStatusCode(), HttpServletResponse.SC_ACCEPTED,
+                    "Selective User Sharing request accepted.");
+        }
     }
 
     /**
      * Share users with all.
      *
-     * @param userShareWithAllRequestBody User share with all request body.
+     * @param userShareWithAllRequestBody General User Share request body.
      * @throws Exception If an error occurs while sharing users with all.
      */
     public void shareUsersWithAll(UserShareWithAllRequestBody userShareWithAllRequestBody) throws Exception {
 
         String jsonRequest = toJSONString(userShareWithAllRequestBody);
-        try (CloseableHttpResponse response = getResponseOfHttpPost(userShareWithAllBasePath, jsonRequest,
+        try (CloseableHttpResponse response = getResponseOfHttpPost(generalUserShareEndpoint, jsonRequest,
+                getHeaders())) {
+            Assert.assertEquals(response.getStatusLine().getStatusCode(), HttpServletResponse.SC_ACCEPTED,
+                    "General User Sharing request accepted.");
+        }
+    }
+
+    /**
+     * Unshare users selectively.
+     *
+     * @param userUnshareRequestBody Selective User Unshare request body.
+     * @throws Exception If an error occurs while unsharing users selectively.
+     */
+    public void unshareUsers(UserUnshareRequestBody userUnshareRequestBody) throws Exception {
+
+        String jsonRequest = toJSONString(userUnshareRequestBody);
+        try (CloseableHttpResponse response = getResponseOfHttpPost(selectiveUserUnshareEndpoint, jsonRequest,
+                getHeaders())) {
+            Assert.assertEquals(response.getStatusLine().getStatusCode(), HttpServletResponse.SC_ACCEPTED,
+                    "Selective User Unsharing request accepted.");
+        }
+    }
+
+    /**
+     * Unshare users with all.
+     *
+     * @param userUnshareWithAllRequestBody General User Unshare request body.
+     * @throws Exception If an error occurs while unsharing users with all.
+     */
+    public void unshareUsersWithAll(UserUnshareWithAllRequestBody userUnshareWithAllRequestBody) throws Exception {
+
+        String jsonRequest = toJSONString(userUnshareWithAllRequestBody);
+        try (CloseableHttpResponse response = getResponseOfHttpPost(generalUserUnshareEndpoint, jsonRequest,
                 getHeaders())) {
             Assert.assertEquals(response.getStatusLine().getStatusCode(), HttpServletResponse.SC_ACCEPTED,
-                    "User sharing request accepted.");
+                    "General User Unsharing request accepted.");
         }
     }