Enable API Resources APIs for organization level #6002

ShanChathusanda93 · 2024-10-09T06:30:52Z

Proposed changes in this pull request

$subject
Adding organization level API Resources API reference.
Adding organization level scopes to view the organization level API Resources.
Implementing the organization level API extraction by inheriting the API resources registered in the root organization level.
Related to Support for creating OAuth 2.0 clients inside B2B organizations for B2B API access product-is#21208

Follow up actions

Before updating the version in product IS, please merge Introduce the API Resources API for organization path product-is#21297

codecov · 2024-10-09T07:05:55Z

Codecov Report

Attention: Patch coverage is 27.77778% with 65 lines in your changes missing coverage. Please review.

Project coverage is 40.37%. Comparing base (565230f) to head (13aa92b).
Report is 151 commits behind head on master.

Files with missing lines	Patch %	Lines
...rce/mgt/dao/impl/APIResourceManagementDAOImpl.java	25.60%	59 Missing and 2 partials ⚠️
...nternal/APIResourceManagementServiceComponent.java	0.00%	4 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #6002      +/-   ##
============================================
- Coverage     40.43%   40.37%   -0.06%     
+ Complexity    14687    14324     -363     
============================================
  Files          1746     1746              
  Lines        123017   117515    -5502     
  Branches      21841    19087    -2754     
============================================
- Hits          49736    47444    -2292     
+ Misses        65716    62792    -2924     
+ Partials       7565     7279     -286

Flag	Coverage Δ
unit	`24.48% <27.77%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

...in/java/org/wso2/carbon/identity/api/resource/mgt/dao/impl/APIResourceManagementDAOImpl.java

...rg.wso2.carbon.identity.api.resource.mgt.server.feature/resources/system-api-resource.xml.j2

...ource.mgt/src/main/java/org/wso2/carbon/identity/api/resource/mgt/constant/SQLConstants.java

sahandilshan · 2024-10-21T06:54:52Z

...ource.mgt/src/main/java/org/wso2/carbon/identity/api/resource/mgt/constant/SQLConstants.java

+    public static final String GET_API_RESOURCE_BY_ID_FOR_ORGANIZATIONS = "SELECT" +
+            " AR.ID AS API_RESOURCE_ID," +
+            " AR.NAME AS API_RESOURCE_NAME," +
+            " AR.IDENTIFIER AS API_RESOURCE_IDENTIFIER," +
+            " AR.DESCRIPTION AS API_RESOURCE_DESCRIPTION," +
+            " AR.TENANT_ID AS API_RESOURCE_TENANT_ID," +
+            " AR.TYPE AS API_RESOURCE_TYPE," +
+            " AR.REQUIRES_AUTHORIZATION AS REQUIRES_AUTHORIZATION," +
+            " S.ID AS SCOPE_ID," +
+            " S.NAME AS SCOPE_QUALIFIED_NAME," +
+            " S.DISPLAY_NAME AS SCOPE_DISPLAY_NAME," +
+            " S.DESCRIPTION AS SCOPE_DESCRIPTION" +
+            " FROM API_RESOURCE AR LEFT JOIN SCOPE S ON AR.ID = S.API_ID WHERE AR.ID = ? AND (AR.TENANT_ID = ?" +
+            " OR AR.TENANT_ID IS NULL) AND AR.TYPE != 'TENANT' AND AR.TYPE != 'SYSTEM'";


Why do't we have DB-specific select queries. Does this query works on all of our supported DBs?

As of now this was tested against H2, MySQL and MSSQL. For those this is working as expected. Other DB type testings are in progress.

AnuradhaSK · 2024-10-22T02:34:21Z

...est/java/org/wso2/carbon/identity/api/resource/mgt/dao/APIResourceManagementDAOImplTest.java

+                {TENANT_ID, new ArrayList<>(), false, 2},
+                {INVALID_TENANT_ID, new ArrayList<>(), true, 0},


Here the combinations are less.

We need to execute the test for correct TENANT_ID and INVALID_TENANT_ID when isOrganization is false
TENANT_ID and INVALID_TENANT_ID when isOrganization is true

Do we need to test the INVALID_TENANT_ID when isOrganization is true?

Added a new combination

AnuradhaSK · 2024-10-22T02:46:22Z

...est/java/org/wso2/carbon/identity/api/resource/mgt/dao/APIResourceManagementDAOImplTest.java

+            String apiId = addAPIResourceToDB(name, getConnection(), tenantId, identityDatabaseUtil,
+                    organizationManagementUtil, isOrganization).getId();


we are not allowing to add API resources for sub orgs right?
As per this test, you are adding the API resources to the sub org tenant id

No we are not allowing to create the API resources in sub org level. Here the isOrganization property is sending to the addAPIResourceToDB is for the mock purposes.

Mocking is added since in the actual DAO method to add the API resource, it will retrieve the added API resource from the get method where we are checking whether the corresponding tenant is an organization or not.

AnuradhaSK · 2024-10-22T02:49:04Z

...a/org/wso2/carbon/identity/api/resource/mgt/dao/CacheBackedAPIResourceManagementDAOTest.java

@@ -529,6 +576,7 @@ private APIResource addAPIResourceToDB(String namePostFix, Connection connection
                    connection.commit();
                    return null;
                });
+        organizationManagementUtil.when(() -> OrganizationManagementUtil.isOrganization(anyInt())).thenReturn(false);


Why this mocking is required? can't find a usage of this in the DAO impl of addAPIResource method

When adding the API resource, inside the DAO method, it will extract the added API resource from the id[1]. Inside that method we added the organization checkl and this mocking is needed for that.

[1]

carbon-identity-framework/components/api-resource-mgt/org.wso2.carbon.identity.api.resource.mgt/src/main/java/org/wso2/carbon/identity/api/resource/mgt/dao/impl/APIResourceManagementDAOImpl.java

Line 168 in 0033577

return getAPIResourceById(generatedAPIId, tenantId);

AnuradhaSK · 2024-10-22T02:52:35Z

...est/java/org/wso2/carbon/identity/api/resource/mgt/dao/APIResourceManagementDAOImplTest.java

@@ -243,16 +351,32 @@ public void testIsScopeExistById(Integer tenantId, boolean expected) throws Exce
    public Object[][] deleteAPIResourceByIdData() {

        return new Object[][]{
-                {TENANT_ID, false}
+                {TENANT_ID, false, false},
+                {TENANT_ID, true, false}


Is this test correct? in sub org level to we store API resource?

No we dont. Here what the test is adding a resource and deleting that. The isOrganization property is for mocking purposes.

sonarcloud · 2024-10-25T06:19:11Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
2.9% Duplication on New Code

See analysis details on SonarCloud

ShanChathusanda93 force-pushed the org-path-api-res-branch branch 2 times, most recently from 8a510db to 39fa1e2 Compare October 9, 2024 06:39

ShanChathusanda93 force-pushed the org-path-api-res-branch branch from 39fa1e2 to 1dba26c Compare October 9, 2024 09:44

ShanChathusanda93 mentioned this pull request Oct 10, 2024

Enable role management in organization level wso2-extensions/identity-inbound-provisioning-scim2#575

Open

AnuradhaSK reviewed Oct 13, 2024

View reviewed changes

...in/java/org/wso2/carbon/identity/api/resource/mgt/dao/impl/APIResourceManagementDAOImpl.java Outdated Show resolved Hide resolved

AnuradhaSK reviewed Oct 13, 2024

View reviewed changes

...in/java/org/wso2/carbon/identity/api/resource/mgt/dao/impl/APIResourceManagementDAOImpl.java Outdated Show resolved Hide resolved

ShanChathusanda93 force-pushed the org-path-api-res-branch branch from 1dba26c to ce692d6 Compare October 15, 2024 11:13

SujanSanjula96 reviewed Oct 15, 2024

View reviewed changes

...rg.wso2.carbon.identity.api.resource.mgt.server.feature/resources/system-api-resource.xml.j2 Show resolved Hide resolved

SujanSanjula96 reviewed Oct 15, 2024

View reviewed changes

...ource.mgt/src/main/java/org/wso2/carbon/identity/api/resource/mgt/constant/SQLConstants.java Outdated Show resolved Hide resolved

ShanChathusanda93 force-pushed the org-path-api-res-branch branch 2 times, most recently from 1650b88 to 853e708 Compare October 21, 2024 05:39

sahandilshan reviewed Oct 21, 2024

View reviewed changes

ShanChathusanda93 force-pushed the org-path-api-res-branch branch from 853e708 to 3a19343 Compare October 21, 2024 08:31

AnuradhaSK reviewed Oct 22, 2024

View reviewed changes

ShanChathusanda93 force-pushed the org-path-api-res-branch branch 4 times, most recently from 7bbfc39 to 8c3c429 Compare October 24, 2024 09:53

Enable API Resources APIs for organization level

13aa92b

ShanChathusanda93 force-pushed the org-path-api-res-branch branch from 8c3c429 to 13aa92b Compare October 25, 2024 06:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable API Resources APIs for organization level #6002

Enable API Resources APIs for organization level #6002

ShanChathusanda93 commented Oct 9, 2024

codecov bot commented Oct 9, 2024 •

edited

Loading

sahandilshan Oct 21, 2024

ShanChathusanda93 Oct 21, 2024

AnuradhaSK Oct 22, 2024

ShanChathusanda93 Oct 23, 2024

ShanChathusanda93 Oct 24, 2024

AnuradhaSK Oct 22, 2024

ShanChathusanda93 Oct 24, 2024

AnuradhaSK Oct 22, 2024

ShanChathusanda93 Oct 24, 2024

AnuradhaSK Oct 22, 2024

ShanChathusanda93 Oct 24, 2024

sonarcloud bot commented Oct 25, 2024

		{TENANT_ID, new ArrayList<>(), false, 2},
		{INVALID_TENANT_ID, new ArrayList<>(), true, 0},

		String apiId = addAPIResourceToDB(name, getConnection(), tenantId, identityDatabaseUtil,
		organizationManagementUtil, isOrganization).getId();

Enable API Resources APIs for organization level #6002

Are you sure you want to change the base?

Enable API Resources APIs for organization level #6002

Conversation

ShanChathusanda93 commented Oct 9, 2024

Proposed changes in this pull request

Follow up actions

codecov bot commented Oct 9, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Oct 25, 2024

Quality Gate passed

codecov bot commented Oct 9, 2024 •

edited

Loading