Add integration tests for mock endpoint feature

all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java

@@ -0,0 +1,309 @@
+/*
+ * Copyright (c) 2026, WSO2 LLC. (http://www.wso2.com) All Rights Reserved.
+ *
+ * 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.am.integration.tests.prototype;
+
+import com.google.gson.Gson;
+import org.apache.commons.io.IOUtils;
+import org.json.JSONObject;
+import org.testng.Assert;
+import org.testng.annotations.AfterClass;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Factory;
+import org.testng.annotations.Test;
+import org.wso2.am.integration.clients.publisher.api.v1.dto.APIDTO;
+import org.wso2.am.integration.clients.store.api.v1.dto.ApplicationDTO;
+import org.wso2.am.integration.clients.store.api.v1.dto.ApplicationKeyDTO;
+import org.wso2.am.integration.clients.store.api.v1.dto.ApplicationKeyGenerateRequestDTO;
+import org.wso2.am.integration.test.Constants;
+import org.wso2.am.integration.test.utils.APIManagerIntegrationTestException;
+import org.wso2.am.integration.test.utils.base.APIMIntegrationBaseTest;
+import org.wso2.am.integration.test.utils.base.APIMIntegrationConstants;
+import org.wso2.am.integration.test.utils.http.HTTPSClientUtils;
+import org.wso2.carbon.automation.engine.context.TestUserMode;
+import org.wso2.carbon.automation.test.utils.http.client.HttpResponse;
+import org.wso2.carbon.utils.multitenancy.MultitenantConstants;
+
+import javax.ws.rs.core.Response;
+
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Integration tests for mock implementation (inline JS mediation scripts) on the API Gateway,
+ * aligned with the official Mock Implementation guide: generate scripts from OpenAPI, apply the
+ * modified inline script (including {@code uri.var.petId} branching), and invoke via the gateway.
+ */
+public class MockEndpointIntegrationTestCase extends APIMIntegrationBaseTest {
+
+    private static final String API_VERSION = "1.0.0";
+    private static final String API_CONTEXT = "mockpetstore";
+    private static final String APPLICATION_NAME = "MockEndpointIntegrationTestCaseApp";
+    private static final String RESOURCE_PATH = "oas" + File.separator + "v3" + File.separator + "mock-endpoint"
+            + File.separator;
+    private static final String GET_PET_PATH = "/pet/{petId}";
+
+    private String apiId;
+    private String apiName;
+    private String applicationId;
+    private String accessToken;
+
+    /**
+     * @param userMode tenant user mode for multitenant test execution
+     */
+    @Factory(dataProvider = "userModeDataProvider")
+    public MockEndpointIntegrationTestCase(TestUserMode userMode) {
+        this.userMode = userMode;
+    }
+
+    /** Provides super-tenant and tenant user modes for parameterized test runs. */
+    @DataProvider
+    public static Object[][] userModeDataProvider() {
+        return new Object[][]{
+                new Object[]{TestUserMode.SUPER_TENANT_ADMIN},
+                new Object[]{TestUserMode.TENANT_USER}
+        };
+    }
+
+    /** Initializes publisher, store, and gateway clients for the configured user mode. */
+    @BeforeClass(alwaysRun = true)
+    public void setEnvironment() throws APIManagerIntegrationTestException {
+        super.init(userMode);
+    }
+
+    /**
+     * Imports the mock API, generates inline mock scripts, applies the doc-style mediation script,
+     * and asserts the updated swagger contains expected mock artifacts.
+     */
+    @Test(groups = {"wso2.am"}, description = "Generate mock scripts and apply doc-style modified inline script")
+    public void testGenerateAndApplyModifiedMockScript() throws Exception {
+        apiId = importMockPetStoreApi();
+        restAPIPublisher.changeAPILifeCycleStatus(apiId, Constants.DEPLOY_AS_PROTOTYPE);
+
+        HttpResponse mockGenResponse = restAPIPublisher.generateMockScript(apiId);
+        Assert.assertEquals(mockGenResponse.getResponseCode(), 200, "Mock script generation failed");
+
+        String generatedSwagger = restAPIPublisher.getSwaggerByID(apiId);
+        Assert.assertTrue(generatedSwagger.contains("x-mediation-script"),
+                "Generated swagger does not contain x-mediation-script");
+        Assert.assertTrue(generatedSwagger.contains("query.param.responseCode"),
+                "Auto-generated mock script does not include responseCode handling from OAS parser");
+        Assert.assertTrue(generatedSwagger.contains("mc.setPayloadJSON"),
+                "Auto-generated mock script does not set JSON payload");
+
+        applyModifiedMediationScriptFromDoc();
+
+        String updatedSwagger = restAPIPublisher.getSwaggerByID(apiId);
+        Assert.assertTrue(updatedSwagger.contains("MANUALLY ADDED CODE"),
+                "Modified mediation script was not saved to swagger");
+        Assert.assertTrue(updatedSwagger.contains("uri.var.petId"),
+                "Modified mediation script does not contain petId path parameter handling");
+        Assert.assertTrue(updatedSwagger.contains("German Shepherd"),
+                "Modified mediation script does not contain petId=1 branch payload");
+    }
+
+    /**
+     * Invokes GET /pet/0 and verifies the default generated mock payload (id=10, Dogs category).
+     */
+    @Test(groups = {"wso2.am"}, description = "petId=0 returns default generated mock payload (id=10, Dogs category)",
+            dependsOnMethods = "testGenerateAndApplyModifiedMockScript")
+    public void testInvokeMockEndpointForPetIdZero() throws Exception {
+        prepareForGatewayInvocation();
+
+        Map<String, String> requestHeaders = buildAuthHeaders();
+        HttpResponse response = HTTPSClientUtils.doGet(
+                getAPIInvocationURLHttps(API_CONTEXT, API_VERSION) + "/pet/0", requestHeaders);
+
+        Assert.assertEquals(response.getResponseCode(), 200,
+                "Mock endpoint invocation failed for petId=0. Response: " + response.getData());
+        Assert.assertTrue(response.getData().contains("\"id\":10") || response.getData().contains("\"id\": 10"),
+                "petId=0 should return default mock payload with id 10. Response: " + response.getData());
+        Assert.assertTrue(response.getData().contains("Dogs"),
+                "petId=0 should return default mock payload with Dogs category. Response: " + response.getData());
+    }
+
+    /**
+     * Invokes GET /pet/1 and verifies the manually modified mock payload (German Shepherd tag).
+     */
+    @Test(groups = {"wso2.am"}, description = "petId=1 returns manually modified mock payload (German Shepherd tag)",
+            dependsOnMethods = "testGenerateAndApplyModifiedMockScript")
+    public void testInvokeMockEndpointForPetIdOne() throws Exception {
+        prepareForGatewayInvocation();
+
+        Map<String, String> requestHeaders = buildAuthHeaders();
+        HttpResponse response = HTTPSClientUtils.doGet(
+                getAPIInvocationURLHttps(API_CONTEXT, API_VERSION) + "/pet/1", requestHeaders);
+
+        Assert.assertEquals(response.getResponseCode(), 200,
+                "Mock endpoint invocation failed for petId=1. Response: " + response.getData());
+        Assert.assertTrue(response.getData().contains("German Shepherd"),
+                "petId=1 should return manually modified mock payload. Response: " + response.getData());
+        Assert.assertTrue(response.getData().contains("\"id\":1") || response.getData().contains("\"id\": 1"),
+                "petId=1 should return mock payload with id 1. Response: " + response.getData());
+    }
+
+    /**
+     * Invokes GET /pet/0?responseCode=501 and verifies HTTP 501 with a Not Implemented body.
+     */
+    @Test(groups = {"wso2.am"}, description = "responseCode=501 query param returns Not Implemented per mock script",
+            dependsOnMethods = "testGenerateAndApplyModifiedMockScript")
+    public void testInvokeMockEndpointWithResponseCodeQueryParam() throws Exception {
+        prepareForGatewayInvocation();
+
+        Map<String, String> requestHeaders = buildAuthHeaders();
+        HttpResponse response = HTTPSClientUtils.doGet(
+                getAPIInvocationURLHttps(API_CONTEXT, API_VERSION) + "/pet/0?responseCode=501",
+                requestHeaders);
+
+        Assert.assertEquals(response.getResponseCode(), 501,
+                "Expected HTTP 501 for responseCode=501. Response: " + response.getData());
+        Assert.assertTrue(response.getData().contains("Not Implemented"),
+                "Mock 501 response body mismatch. Response: " + response.getData());
+    }
+
+    /**
+     * Verifies the imported API retains INLINE endpoint implementation type after mock setup.
+     */
+    @Test(groups = {"wso2.am"}, description = "Verify INLINE mock implementation type is retained on API",
+            dependsOnMethods = "testGenerateAndApplyModifiedMockScript")
+    public void testMockEndpointImplementationType() throws Exception {
+        HttpResponse apiResponse = restAPIPublisher.getAPI(apiId);
+        Assert.assertEquals(apiResponse.getResponseCode(), Response.Status.OK.getStatusCode(),
+                "Failed to retrieve API details. Response: " + apiResponse.getData());
+        APIDTO apiDto = new Gson().fromJson(apiResponse.getData(), APIDTO.class);
+
+        Assert.assertEquals(apiDto.getEndpointImplementationType(), APIDTO.EndpointImplementationTypeEnum.INLINE,
+                "API endpointImplementationType is not INLINE for mock implementation");
+    }
+
+    /** Deletes the test application and removes APIs created during the test run. */
+    @AfterClass(alwaysRun = true)
+    public void destroy() throws Exception {
+        if (applicationId != null) {
+            restAPIStore.deleteApplication(applicationId);
+        }
+        super.cleanUp();
+    }
+
+    /**
+     * Replaces the GET /pet/{petId} x-mediation-script with the modified script from the official guide
+     * (generated responses map + manual petId branch + responseCode selection).
+     */
+    private void applyModifiedMediationScriptFromDoc() throws Exception {
+        String modifiedScript = readResource(RESOURCE_PATH + "get_pet_modified_mediation_script.js");
+
+        JSONObject swagger = new JSONObject(restAPIPublisher.getSwaggerByID(apiId));
+        swagger.getJSONObject("paths").getJSONObject(GET_PET_PATH).getJSONObject("get")
+                .put("x-mediation-script", modifiedScript);
+        restAPIPublisher.updateSwagger(apiId, swagger.toString());
+    }
+
+    /**
+     * Mirrors {@link PrototypedAPITestcase#testOAS3InlinePrototypeWithMock}: deploy revision, subscribe,
+     * generate keys, wait for gateway sync, then invoke.
+     */
+    private void prepareForGatewayInvocation() throws Exception {
+        if (accessToken != null) {
+            return;
+        }
+
+        createAPIRevisionAndDeployUsingRest(apiId, restAPIPublisher);
+        waitForAPIDeploymentSync(user.getUserName(), apiName, API_VERSION,
+                APIMIntegrationConstants.IS_API_EXISTS);
+
+        HttpResponse applicationResponse = restAPIStore.createApplication(
+                APPLICATION_NAME + userMode, "Mock Endpoint Test Application",
+                APIMIntegrationConstants.APPLICATION_TIER.UNLIMITED, ApplicationDTO.TokenTypeEnum.JWT);
+        Assert.assertNotNull(applicationResponse.getData(), "Application creation failed");
+        applicationId = applicationResponse.getData();
+        restAPIStore.subscribeToAPI(apiId, applicationId, APIMIntegrationConstants.APPLICATION_TIER.UNLIMITED);
+
+        ArrayList<String> grantTypes = new ArrayList<>();
+        grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.PASSWORD);
+        grantTypes.add(APIMIntegrationConstants.GRANT_TYPE.CLIENT_CREDENTIAL);
+
+        ApplicationKeyDTO applicationKeyDTO = restAPIStore.generateKeys(applicationId, "36000", "",
+                ApplicationKeyGenerateRequestDTO.KeyTypeEnum.PRODUCTION, null, grantTypes);
+        Assert.assertNotNull(applicationKeyDTO.getToken(), "Application key token is null");
+        accessToken = applicationKeyDTO.getToken().getAccessToken();
+        Assert.assertNotNull(accessToken, "Access token is null after key generation");
+        waitForAPIDeployment();
+    }
+
+    /** Builds request headers with the generated bearer token for gateway invocation. */
+    private Map<String, String> buildAuthHeaders() {
+        Map<String, String> requestHeaders = new HashMap<>();
+        requestHeaders.put("Authorization", "Bearer " + accessToken);
+        requestHeaders.put("accept", "application/json");
+        return requestHeaders;
+    }
+
+    /** Imports the mock pet store OAS and returns the created API id. */
+    private String importMockPetStoreApi() throws Exception {
+        apiName = "MockPetStore" + userMode;
+        String context = "/" + API_CONTEXT;
+        if (!MultitenantConstants.SUPER_TENANT_DOMAIN_NAME.equals(user.getUserDomain())) {
+            context = "/t/" + user.getUserDomain() + context;
+        }
+
+        String oasDefinition = readResource(RESOURCE_PATH + "petstore_oas.json");
+        String additionalProperties = readResource(RESOURCE_PATH + "additionalProperties.json");
+
+        JSONObject additionalPropertiesObj = new JSONObject(additionalProperties);
+        additionalPropertiesObj.put("name", apiName);
+        additionalPropertiesObj.put("provider", user.getUserName());
+        additionalPropertiesObj.put("context", context);
+
+        File file = getTempFileWithContent(oasDefinition);
+        APIDTO apiDto = restAPIPublisher.importOASDefinition(file, additionalPropertiesObj.toString());
+        return apiDto.getId();
+    }
+
+    /** Writes content to a temporary file for OAS import. */
+    private File getTempFileWithContent(String content) throws Exception {
+        File temp = File.createTempFile("swagger", ".json");
+        temp.deleteOnExit();
+        try (BufferedWriter out = new BufferedWriter(new FileWriter(temp))) {
+            out.write(content);
+        }
+        return temp;
+    }
+
+    /**
+     * Reads a classpath test resource as UTF-8 text.
+     *
+     * @param resourcePath classpath-relative resource path
+     * @return resource contents
+     * @throws NullPointerException if the resource is not found on the classpath
+     */
+    private String readResource(String resourcePath) throws Exception {
+        try (InputStream inputStream = Objects.requireNonNull(
+                getClass().getClassLoader().getResourceAsStream(resourcePath),
+                "Missing test resource: " + resourcePath)) {
+            return IOUtils.toString(inputStream, StandardCharsets.UTF_8);
+        }
+    }
+}

all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/additionalProperties.json

@@ -0,0 +1,31 @@
+{
+  "name": "MockPetStore",
+  "context": "/mockpetstore",
+  "version": "1.0.0",
+  "provider": "admin",
+  "type": "HTTP",
+  "transport": [
+    "http",
+    "https"
+  ],
+  "policies": [
+    "Unlimited"
+  ],
+  "apiThrottlingPolicy": "Unlimited",
+  "securityScheme": [
+    "oauth2",
+    "oauth_basic_auth_mandatory"
+  ],
+  "visibility": "PUBLIC",
+  "subscriptionAvailability": "ALL_TENANTS",
+  "endpointImplementationType": "INLINE",
+  "endpointConfig": {
+    "endpoint_type": "http",
+    "production_endpoints": {
+      "url": "https://localhost:9443/publisher-new/apis/create/openapi"
+    },
+    "sandbox_endpoints": {
+      "url": "https://localhost:9443/publisher-new/apis/create/openapi"
+    }
+  }
+}