Merge branch 'wso2:master' into master

Author: Jalina2007

components/action-mgt/org.wso2.carbon.identity.action.execution/pom.xml

@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.wso2.carbon.identity.framework</groupId>
         <artifactId>action-mgt</artifactId>
-        <version>7.8.588-SNAPSHOT</version>
+        <version>7.8.591-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 

components/action-mgt/org.wso2.carbon.identity.action.execution/src/main/java/org/wso2/carbon/identity/action/execution/internal/service/impl/ActionExecutorServiceImpl.java

@@ -70,7 +70,9 @@
 import org.wso2.carbon.identity.rule.evaluation.api.model.RuleEvaluationResult;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.ExecutorService;
@@ -88,6 +90,7 @@ public class ActionExecutorServiceImpl implements ActionExecutorService {
     private static final int THREAD_POOL_SIZE = Runtime.getRuntime().availableProcessors() * 2;
     private static final ActionExecutorServiceImpl INSTANCE = new ActionExecutorServiceImpl();
     private static final ActionExecutionDiagnosticLogger DIAGNOSTIC_LOGGER = new ActionExecutionDiagnosticLogger();
+    private static final String API_VERSION_HEADER = "x-wso2-api-version";
     private final APIClient apiClient;
     private final ExecutorService executorService = ThreadLocalAwareExecutors.newFixedThreadPool(THREAD_POOL_SIZE);
 
@@ -339,9 +342,11 @@ private ActionInvocationResponse executeActionAsynchronously(Action action,
                                                                  String payload) throws ActionExecutionException {
 
         String apiEndpoint = action.getEndpoint().getUri();
+        Map<String, String> headers = new HashMap<>();
+        headers.put(API_VERSION_HEADER, action.getActionVersion());
         CompletableFuture<ActionInvocationResponse> actionExecutor = CompletableFuture.supplyAsync(
                 () -> apiClient.callAPI(ActionType.valueOf(action.getType().getActionType()),
-                        apiEndpoint, authenticationMethod, payload), executorService);
+                        apiEndpoint, authenticationMethod, headers, payload), executorService);
         try {
             return actionExecutor.get();
         } catch (InterruptedException | ExecutionException e) {

components/action-mgt/org.wso2.carbon.identity.action.execution/src/main/java/org/wso2/carbon/identity/action/execution/internal/util/APIClient.java

@@ -49,6 +49,7 @@
 import java.io.IOException;
 import java.net.SocketTimeoutException;
 import java.nio.charset.StandardCharsets;
+import java.util.Map;
 
 /**
  * This class is responsible for making API calls to the external services.
@@ -80,17 +81,27 @@ public APIClient() {
                 .build();
     }
 
+    /**
+     * Makes a POST API call to the given URL with the provided payload and headers.
+     *
+     * @param actionType  Action type.
+     * @param url         URL of the API endpoint.
+     * @param authMethod  Authentication method to be used.
+     * @param additionalHeaders     Headers to be included in the request.
+     * @param payload     Payload to be sent in the request body.
+     * @return ActionInvocationResponse containing the response or error details.
+     */
     public ActionInvocationResponse callAPI(ActionType actionType, String url, AuthMethods.AuthMethod authMethod,
-                                            String payload) {
+                                            Map<String, String> additionalHeaders, String payload) {
 
         HttpPost httpPost = new HttpPost(url);
-        setRequestEntity(httpPost, payload, authMethod, actionType);
+        setRequestEntity(httpPost, payload, authMethod, additionalHeaders);
 
         return executeRequest(actionType, httpPost);
     }
 
     private void setRequestEntity(HttpPost httpPost, String jsonRequest, AuthMethods.AuthMethod authMethod,
-                                  ActionType actionType) {
+                                  Map<String, String> additionalHeaders) {
 
         StringEntity entity = new StringEntity(jsonRequest, StandardCharsets.UTF_8);
         if (authMethod != null) {
@@ -99,8 +110,9 @@ private void setRequestEntity(HttpPost httpPost, String jsonRequest, AuthMethods
         httpPost.setEntity(entity);
         httpPost.setHeader("Accept", "application/json");
         httpPost.setHeader("Content-type", "application/json");
-        httpPost.setHeader(ActionAPIVersionResolver.API_VERSION_HEADER,
-                ActionAPIVersionResolver.resolveAPIVersion(actionType));
+        for (Map.Entry<String, String> header : additionalHeaders.entrySet()) {
+            httpPost.setHeader(header.getKey(), header.getValue());
+        }
     }
 
     private ActionInvocationResponse executeRequest(ActionType actionType, HttpPost request) {

components/action-mgt/org.wso2.carbon.identity.action.execution/src/main/java/org/wso2/carbon/identity/action/execution/internal/util/ActionAPIVersionResolver.java

@@ -397,13 +397,13 @@ public void testBuildActionExecutionRequestWithExcludedHeaders()
                 actionExecutionRequest);
 
         ActionInvocationResponse actionInvocationResponse = createSuccessActionInvocationResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         actionExecutorService.execute(actionType, FlowContext.create(), "tenantDomain");
 
         String payload = getJSONRequestPayload(actionExecutionRequest);
         // Verify that the HTTP client was called with the expected request
-        verify(apiClient).callAPI(any(), any(), any(), eq(payload));
+        verify(apiClient).callAPI(any(), any(), any(), any(), eq(payload));
     }
 
     @Test
@@ -428,13 +428,13 @@ public void testBuildActionExecutionRequest() throws Exception {
                 actionExecutionRequest);
 
         ActionInvocationResponse actionInvocationResponse = createSuccessActionInvocationResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         actionExecutorService.execute(actionType, FlowContext.create(), "tenantDomain");
 
         String payload = getJSONRequestPayload(actionExecutionRequest);
         // Verify that the HTTP client was called with the expected request
-        verify(apiClient).callAPI(any(), any(), any(), eq(payload));
+        verify(apiClient).callAPI(any(), any(), any(), any(), eq(payload));
     }
 
     @Test
@@ -467,7 +467,7 @@ public void testActionExecuteSuccessWhenNoRuleConfiguredInAction() throws Except
 
         ActionInvocationResponse actionInvocationResponse =
                 createSuccessActionInvocationResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         ActionExecutionStatus expectedStatus = new SuccessStatus.Builder().build();
         when(actionExecutionResponseProcessor.getSupportedActionType()).thenReturn(actionType);
@@ -517,7 +517,7 @@ public void testActionExecuteSuccessWhenRuleConfiguredInActionIsSatisfied() thro
                 actionExecutionRequest);
 
         ActionInvocationResponse actionInvocationResponse = createSuccessActionInvocationResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         ActionExecutionStatus expectedStatus = new SuccessStatus.Builder().build();
         when(actionExecutionResponseProcessor.getSupportedActionType()).thenReturn(actionType);
@@ -557,7 +557,7 @@ public void testActionExecuteFailureWithRetiredActionVersion() throws Exception
 
         ActionInvocationResponse actionInvocationResponse =
                 createSuccessActionInvocationResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         ActionExecutionStatus expectedStatus = new SuccessStatus.Builder().build();
         when(actionExecutionResponseProcessor.getSupportedActionType()).thenReturn(actionType);
@@ -588,7 +588,7 @@ public void testActionExecuteFailure() throws Exception {
                 mock(ActionExecutionRequest.class));
 
         ActionInvocationResponse actionInvocationResponse = createFailureActionInvocationResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         ActionExecutionStatus expectedStatus = new FailedStatus(new Failure("Error_reason",
                 "Error_description"));
@@ -627,7 +627,7 @@ public void testExecuteIncomplete() throws Exception {
                 mock(ActionExecutionRequest.class));
 
         ActionInvocationResponse actionInvocationResponse = createIncompleteActionInvocationResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         ActionExecutionStatus expectedStatus = new IncompleteStatus.Builder().build();
         when(actionExecutionResponseProcessor.getSupportedActionType()).thenReturn(actionType);
@@ -667,7 +667,7 @@ public void testActionExecuteFailureForUnexpectedAPIResponse() throws Exception
                 mock(ActionExecutionRequest.class));
 
         ActionInvocationResponse actionInvocationResponse = createActionInvocationResponseWithoutAPIResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         actionExecutorService.execute(actionType, FlowContext.create(), "tenantDomain");
     }
@@ -693,7 +693,7 @@ public void testExecuteError() throws Exception {
                 mock(ActionExecutionRequest.class));
 
         ActionInvocationResponse actionInvocationResponse = createErrorActionInvocationResponse();
-        when(apiClient.callAPI(any(), any(), any(), any())).thenReturn(actionInvocationResponse);
+        when(apiClient.callAPI(any(), any(), any(), any(), any())).thenReturn(actionInvocationResponse);
 
         ActionExecutionStatus expectedStatus = new ErrorStatus(new Error("Error_message",
                 "Error_description"));

components/action-mgt/org.wso2.carbon.identity.action.execution/src/test/java/org/wso2/carbon/identity/action/execution/impl/ActionExecutorServiceImplTest.java

@@ -34,6 +34,7 @@
 import org.mockito.MockedStatic;
 import org.mockito.MockitoAnnotations;
 import org.testng.annotations.AfterMethod;
+import org.testng.annotations.BeforeClass;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.DataProvider;
 import org.testng.annotations.Test;
@@ -58,6 +59,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.Map;
 
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
@@ -84,10 +86,17 @@ public class APIClientTest {
 
     private MockedStatic<ActionExecutorConfig> actionExecutorConfigStatic;
     private MockedStatic<LoggerUtils> loggerUtils;
+    private final Map<String, String> headers = new HashMap<>();
 
     @InjectMocks
     private APIClient apiClient;
 
+    @BeforeClass
+    public void init() {
+
+        headers.put("x-wso2-api-version", "v1");
+    }
+
     @BeforeMethod
     public void setUp() throws Exception {
 
@@ -122,7 +131,7 @@ public void testCallAPIUnacceptableContentTypeForSuccessResponse()
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
         assertNotNull(apiResponse);
         assertNull(apiResponse.getResponse());
         assertFalse(apiResponse.isRetry());
@@ -151,7 +160,7 @@ public void testCallAPIUnacceptablePayloadForSuccessResponse(String payload)
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
         assertNotNull(apiResponse);
         assertTrue(apiResponse.isError());
         assertFalse(apiResponse.isRetry());
@@ -178,7 +187,7 @@ public void testCallAPIAcceptablePayloadForSuccessResponse() throws Exception {
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
 
         assertNotNull(apiResponse);
         assertNotNull(apiResponse.getResponse());
@@ -218,7 +227,7 @@ public void testCallAPIAcceptablePayloadForIncompleteResponse() throws Exception
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
 
         assertNotNull(apiResponse);
         assertNotNull(apiResponse.getResponse());
@@ -258,7 +267,7 @@ public void testCallAPIUnexpectedIncompleteResponse(String incompleteResponse) t
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
 
         assertNotNull(apiResponse);
         assertTrue(apiResponse.isError());
@@ -289,7 +298,7 @@ public void testCallAPIAcceptablePayloadForFailureResponse() throws Exception {
                 .build();
         AuthMethods.AuthMethod bearAuth = new AuthMethods.BearerAuth(Collections.singletonList(authProperty));
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", bearAuth, "{}");
+                "http://example.com", bearAuth, headers, "{}");
 
         assertNotNull(apiResponse);
         assertNotNull(apiResponse.getResponse());
@@ -334,7 +343,7 @@ public void testCallAPIUnexpectedFailureResponse(Object statusCode, Object conte
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
         assertNotNull(apiResponse);
         assertTrue(apiResponse.isError());
         assertFalse(apiResponse.isRetry());
@@ -385,7 +394,7 @@ public void testCallAPIUnexpectedErrorResponse(Object statusCode, Object content
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
         assertNotNull(apiResponse);
         assertTrue(apiResponse.isError());
         if ((int) statusCode == 500 || (int) statusCode == 502) { // This is a retry
@@ -430,7 +439,7 @@ public void testCallAPIAcceptablePayloadForErrorResponse(Object statusCode, Obje
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
 
         assertNotNull(apiResponse);
         assertNotNull(apiResponse.getResponse());
@@ -466,7 +475,7 @@ public void testCallAPIRetryOnTimeoutAndReceiveSuccessResponse() throws Exceptio
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse response = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
 
         assertNotNull(response);
         assertTrue(response.isSuccess());
@@ -491,7 +500,7 @@ public void testReceiveSuccessResponseWithExtendedResponseData() throws Exceptio
         when(httpResponse.getEntity()).thenReturn(entity);
 
         ActionInvocationResponse response = apiClient.callAPI(ActionType.AUTHENTICATION,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
 
         assertNotNull(response);
         assertTrue(response.isSuccess());
@@ -504,7 +513,7 @@ public void testCallAPIRetryOnTimeoutAndReachMaxRetryAttempts() throws Exception
                 .thenThrow(new SocketTimeoutException("Read Timeout"));
 
         ActionInvocationResponse response = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
 
         assertNotNull(response);
         assertTrue(response.isError());
@@ -518,7 +527,7 @@ public void testUnexpectedExceptionFromHttpClient() throws Exception {
         when(httpClient.execute(any(HttpPost.class))).thenThrow(new ClientProtocolException("Unexpected exception"));
 
         ActionInvocationResponse apiResponse = apiClient.callAPI(ActionType.PRE_ISSUE_ACCESS_TOKEN,
-                "http://example.com", null, "{}");
+                "http://example.com", null, headers, "{}");
         assertNotNull(apiResponse);
         assertTrue(apiResponse.isError());
         assertEquals(apiResponse.getErrorLog(),

components/action-mgt/org.wso2.carbon.identity.action.execution/src/test/java/org/wso2/carbon/identity/action/execution/util/APIClientTest.java

@@ -22,7 +22,7 @@
     <parent>
         <groupId>org.wso2.carbon.identity.framework</groupId>
         <artifactId>action-mgt</artifactId>
-        <version>7.8.588-SNAPSHOT</version>
+        <version>7.8.591-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>