Merge pull request #2679 from lashinijay/master-revamp-dcr-endpoint

[Spring Cleanup] Refactor dcr endpoint to remove Spring dependency
wso2-extensions · Jan 21, 2025 · 8bdfb65 · 8bdfb65
2 parents 7782ea7 + e3c1723
commit 8bdfb65
Show file tree

Hide file tree

Showing 12 changed files with 780 additions and 155 deletions.
diff --git a/components/org.wso2.carbon.identity.api.server.dcr/pom.xml b/components/org.wso2.carbon.identity.api.server.dcr/pom.xml
@@ -48,11 +48,6 @@
             <artifactId>jackson-databind</artifactId>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-web</artifactId>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
@@ -151,6 +146,10 @@
             <artifactId>jaxp-ri</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.wso2.carbon.identity.framework</groupId>
+            <artifactId>org.wso2.carbon.identity.testutil</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

diff --git a/...ava/org/wso2/carbon/identity/oauth2/dcr/endpoint/factories/RegisterApiServiceFactory.java b/...ava/org/wso2/carbon/identity/oauth2/dcr/endpoint/factories/RegisterApiServiceFactory.java
@@ -5,10 +5,10 @@
 
 public class RegisterApiServiceFactory {
 
-   private final static RegisterApiService service = new RegisterApiServiceImpl();
+   private static final RegisterApiService SERVICE = new RegisterApiServiceImpl();
 
    public static RegisterApiService getRegisterApi()
    {
-      return service;
+      return SERVICE;
    }
 }
diff --git a/...n/java/org/wso2/carbon/identity/oauth2/dcr/endpoint/factory/OAuth2DCRMServiceFactory.java b/...n/java/org/wso2/carbon/identity/oauth2/dcr/endpoint/factory/OAuth2DCRMServiceFactory.java
diff --git a/...server.dcr/src/main/java/org/wso2/carbon/identity/oauth2/dcr/endpoint/util/DCRMUtils.java b/...server.dcr/src/main/java/org/wso2/carbon/identity/oauth2/dcr/endpoint/util/DCRMUtils.java
@@ -1,7 +1,7 @@
 /*
- * Copyright (c) 2017, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ * Copyright (c) 2017-2025, WSO2 LLC. (http://www.wso2.com).
  *
- * WSO2 Inc. licenses this file to you under the Apache License,
+ * 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
@@ -20,6 +20,7 @@
 
 import org.apache.commons.logging.Log;
 import org.slf4j.MDC;
+import org.wso2.carbon.context.PrivilegedCarbonContext;
 import org.wso2.carbon.identity.oauth.dcr.DCRMConstants;
 import org.wso2.carbon.identity.oauth.dcr.bean.Application;
 import org.wso2.carbon.identity.oauth.dcr.bean.ApplicationRegistrationRequest;
@@ -44,16 +45,15 @@ public class DCRMUtils {
     private static final String NOT_FOUND_STATUS = "NOT_FOUND_";
     private static final String FORBIDDEN_STATUS = "FORBIDDEN_";
 
-    private static DCRMService oAuth2DCRMService;
+    private static class OAuth2DCRMServiceHolder {
 
-    public static void setOAuth2DCRMService(DCRMService oAuth2DCRMService) {
-
-        DCRMUtils.oAuth2DCRMService = oAuth2DCRMService;
+        private static final DCRMService SERVICE = (DCRMService) PrivilegedCarbonContext
+                .getThreadLocalCarbonContext().getOSGiService(DCRMService.class, null);
     }
 
     public static DCRMService getOAuth2DCRMService() {
 
-        return oAuth2DCRMService;
+        return OAuth2DCRMServiceHolder.SERVICE;
     }
 
     public static ApplicationRegistrationRequest getApplicationRegistrationRequest(
@@ -307,5 +307,4 @@ private static DCRMEndpointException buildDCRMEndpointException(Response.Status
             return new DCRMEndpointException(status, errorDTO);
         }
     }
-
 }
diff --git a/...o2.carbon.identity.api.server.dcr/src/main/resources/META-INF/cxf/oauth2-dcr-v1-1-cxf.xml b/...o2.carbon.identity.api.server.dcr/src/main/resources/META-INF/cxf/oauth2-dcr-v1-1-cxf.xml
diff --git a/...rg/wso2/carbon/identity/oauth2/dcr/endpoint/impl/RegisterApiServiceImplExceptionTest.java b/...rg/wso2/carbon/identity/oauth2/dcr/endpoint/impl/RegisterApiServiceImplExceptionTest.java
@@ -33,14 +33,14 @@
 import org.wso2.carbon.context.internal.OSGiDataHolder;
 import org.wso2.carbon.identity.application.common.IdentityApplicationManagementException;
 import org.wso2.carbon.identity.application.mgt.ApplicationManagementService;
+import org.wso2.carbon.identity.common.testng.WithCarbonHome;
 import org.wso2.carbon.identity.oauth.dcr.exception.DCRMException;
 import org.wso2.carbon.identity.oauth.dcr.internal.DCRDataHolder;
 import org.wso2.carbon.identity.oauth.dcr.service.DCRMService;
 import org.wso2.carbon.identity.oauth2.dcr.endpoint.TestUtil;
 import org.wso2.carbon.identity.oauth2.dcr.endpoint.dto.RegistrationRequestDTO;
 import org.wso2.carbon.identity.oauth2.dcr.endpoint.dto.UpdateRequestDTO;
 import org.wso2.carbon.identity.oauth2.dcr.endpoint.exceptions.DCRMEndpointException;
-import org.wso2.carbon.identity.oauth2.dcr.endpoint.util.DCRMUtils;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -49,11 +49,13 @@
 
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.lenient;
+import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockConstruction;
 import static org.mockito.Mockito.mockStatic;
 import static org.mockito.Mockito.when;
 import static org.testng.Assert.assertEquals;
 
+@WithCarbonHome
 @Listeners(MockitoTestNGListener.class)
 public class RegisterApiServiceImplExceptionTest {
 
@@ -70,13 +72,22 @@ public class RegisterApiServiceImplExceptionTest {
     ApplicationManagementService applicationManagementService;
 
     @Mock
-    DCRMService mockedDCRMService;
+    PrivilegedCarbonContext privilegedCarbonContext;
 
     MockedConstruction<ServiceTracker> mockedConstruction;
+    private MockedStatic<PrivilegedCarbonContext> mockedPrivilegedCarbonContext;
 
     @BeforeMethod
     public void setUp() throws Exception {
 
+        if (mockedPrivilegedCarbonContext != null) {
+            mockedPrivilegedCarbonContext.close();
+        }
+        mockedPrivilegedCarbonContext = mockStatic(PrivilegedCarbonContext.class);
+        when(PrivilegedCarbonContext.getThreadLocalCarbonContext()).thenReturn(privilegedCarbonContext);
+        lenient().when(PrivilegedCarbonContext.getThreadLocalCarbonContext()
+                .getOSGiService(DCRMService.class, null)).thenReturn(mock(DCRMService.class));
+
         // Initializing variables.
         registerApiService = new RegisterApiServiceImpl();
 
@@ -104,7 +115,6 @@ public void tearDown() {
     public void testDeleteApplicationClientException() throws Exception {
 
         try {
-            DCRMUtils.setOAuth2DCRMService(mockedDCRMService);
             registerApiService.deleteApplication("");
         } catch (DCRMEndpointException e) {
             assertEquals(e.getResponse().getStatus(), Response.Status.BAD_REQUEST.getStatusCode());
@@ -126,7 +136,6 @@ public void testDeleteApplicationThrowableException() throws DCRMException {
     public void testGetApplicationClientException() throws Exception {
 
         try {
-            DCRMUtils.setOAuth2DCRMService(mockedDCRMService);
             registerApiService.getApplication("");
         } catch (DCRMEndpointException e) {
             assertEquals(e.getResponse().getStatus(), Response.Status.BAD_REQUEST.getStatusCode());
@@ -155,7 +164,6 @@ public void testRegisterApplicationClientException() throws DCRMException {
             registrationRequestDTO.setClientName("Test App");
             registrationRequestDTO.setGrantTypes(granttypes);
             registrationRequestDTO.setRedirectUris(redirectUris);
-            DCRMUtils.setOAuth2DCRMService(mockedDCRMService);
             dcrDataHolder.when(DCRDataHolder::getInstance).thenReturn(dataHolder);
             lenient().when(dataHolder.getApplicationManagementService()).thenReturn(applicationManagementService);
 
@@ -180,7 +188,6 @@ public void testRegisterApplicationServerException() throws DCRMException, Ident
             registrationRequestDTO.setGrantTypes(granttypes);
             registrationRequestDTO.setRedirectUris(redirectUris);
 
-            DCRMUtils.setOAuth2DCRMService(mockedDCRMService);
             dcrDataHolder.when(DCRDataHolder::getInstance).thenReturn(dataHolder);
             lenient().when(dataHolder.getApplicationManagementService()).thenReturn(applicationManagementService);
             lenient().when(applicationManagementService.getServiceProvider(any(String.class), any(String.class))).
@@ -218,7 +225,6 @@ public void testUpdateApplicationClientException() throws DCRMException {
             updateRequestDTO.setClientName("Test App");
             updateRequestDTO.setGrantTypes(granttypes);
             updateRequestDTO.setRedirectUris(redirectUris);
-            DCRMUtils.setOAuth2DCRMService(mockedDCRMService);
             dcrDataHolder.when(DCRDataHolder::getInstance).thenReturn(dataHolder);
             lenient().when(dataHolder.getApplicationManagementService()).thenReturn(applicationManagementService);
 

diff --git a/...st/java/org/wso2/carbon/identity/oauth2/dcr/endpoint/impl/RegisterApiServiceImplTest.java b/...st/java/org/wso2/carbon/identity/oauth2/dcr/endpoint/impl/RegisterApiServiceImplTest.java
@@ -20,6 +20,7 @@
 
 import org.mockito.Mock;
 import org.mockito.MockedConstruction;
+import org.mockito.MockedStatic;
 import org.mockito.testng.MockitoTestNGListener;
 import org.osgi.framework.BundleContext;
 import org.osgi.util.tracker.ServiceTracker;
@@ -30,6 +31,7 @@
 import org.testng.annotations.Test;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
 import org.wso2.carbon.context.internal.OSGiDataHolder;
+import org.wso2.carbon.identity.common.testng.WithCarbonHome;
 import org.wso2.carbon.identity.oauth.dcr.bean.Application;
 import org.wso2.carbon.identity.oauth.dcr.bean.ApplicationRegistrationRequest;
 import org.wso2.carbon.identity.oauth.dcr.bean.ApplicationUpdateRequest;
@@ -40,7 +42,6 @@
 import org.wso2.carbon.identity.oauth2.dcr.endpoint.dto.RegistrationRequestDTO;
 import org.wso2.carbon.identity.oauth2.dcr.endpoint.dto.UpdateRequestDTO;
 import org.wso2.carbon.identity.oauth2.dcr.endpoint.exceptions.DCRMEndpointException;
-import org.wso2.carbon.identity.oauth2.dcr.endpoint.util.DCRMUtils;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -49,11 +50,13 @@
 
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
-import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.lenient;
+import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockConstruction;
+import static org.mockito.Mockito.mockStatic;
 import static org.mockito.Mockito.when;
 
+@WithCarbonHome
 @Listeners(MockitoTestNGListener.class)
 public class RegisterApiServiceImplTest {
 
@@ -69,10 +72,20 @@ public class RegisterApiServiceImplTest {
     @Mock
     private DCRMService dcrmService;
 
+    @Mock
+    PrivilegedCarbonContext privilegedCarbonContext;
+
     MockedConstruction<ServiceTracker> mockedConstruction;
+    private MockedStatic<PrivilegedCarbonContext> mockedPrivilegedCarbonContext;
 
     @BeforeMethod
     public void setUp() throws Exception {
+
+        mockedPrivilegedCarbonContext = mockStatic(PrivilegedCarbonContext.class);
+        lenient().when(PrivilegedCarbonContext.getThreadLocalCarbonContext()).thenReturn(privilegedCarbonContext);
+        lenient().when(PrivilegedCarbonContext.getThreadLocalCarbonContext()
+                .getOSGiService(DCRMService.class, null)).thenReturn(mock(DCRMService.class));
+
         //Initializing variables.
         registerApiService = new RegisterApiServiceImpl();
         validclientId = "N2QqQluzQuL5X6CtM3KZwqzLQhUa";
@@ -101,16 +114,15 @@ public void tearDown() {
 
         mockedConstruction.close();
         PrivilegedCarbonContext.endTenantFlow();
+        mockedPrivilegedCarbonContext.close();
     }
 
     @Test
     public void testDeleteApplication() throws Exception {
 
-        DCRMUtils.setOAuth2DCRMService(dcrmService);
-        doNothing().when(dcrmService).deleteApplication(validclientId);
+        lenient().doNothing().when(dcrmService).deleteApplication(validclientId);
         Assert.assertEquals(registerApiService.deleteApplication(validclientId).getStatus(),
                 Response.Status.NO_CONTENT.getStatusCode());
-
     }
 
     @Test
@@ -127,8 +139,7 @@ public void testDeleteApplicationServerException() throws Exception {
     @Test
     public void testGetApplication() throws Exception {
 
-        DCRMUtils.setOAuth2DCRMService(dcrmService);
-        when(dcrmService.getApplication(validclientId)).thenReturn(application);
+        lenient().when(dcrmService.getApplication(validclientId)).thenReturn(application);
         Assert.assertEquals(registerApiService.getApplication(validclientId).getStatus(),
                 Response.Status.OK.getStatusCode());
 
@@ -153,8 +164,7 @@ public void testRegisterApplication() throws Exception {
 
         RegistrationRequestDTO registrationRequestDTO = new RegistrationRequestDTO();
         registrationRequestDTO.setClientName("app1");
-        DCRMUtils.setOAuth2DCRMService(dcrmService);
-        when(dcrmService.registerApplication(any(ApplicationRegistrationRequest.class)))
+        lenient().when(dcrmService.registerApplication(any(ApplicationRegistrationRequest.class)))
                 .thenReturn(application);
         Assert.assertEquals(registerApiService.registerApplication(registrationRequestDTO)
                 .getStatus(), Response.Status.CREATED.getStatusCode());
@@ -179,8 +189,7 @@ public void testUpdateApplication() throws Exception {
         UpdateRequestDTO updateRequestDTO1 = new UpdateRequestDTO();
         updateRequestDTO1.setClientName("Client1");
         String clientID = "clientID1";
-        DCRMUtils.setOAuth2DCRMService(dcrmService);
-        when(dcrmService.updateApplication
+        lenient().when(dcrmService.updateApplication
                 (any(ApplicationUpdateRequest.class), anyString()))
                 .thenReturn(application);
         Assert.assertEquals(registerApiService.updateApplication(updateRequestDTO1, clientID)