Add integration tests for mock endpoint feature#14209
Open
YasasRangika wants to merge 5 commits into
Open
Conversation
YasasRangika
requested review from
AnuGayan,
Arshardh,
chamilaadhi and
tharindu1st
as code owners
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds an integration test and supporting OpenAPI/resources that import a mock petstore OAS as a prototype API, generate and replace mock mediation scripts, deploy the API, create/subscribe an app with JWT keys, invoke gateway mock endpoints across scenarios, and assert responses and API metadata. ChangesMock Endpoint Integration Tests
sequenceDiagram
participant Test as MockEndpointIntegrationTestCase
participant Publisher as restAPIPublisher
participant Store as restAPIStore
participant Gateway as Gateway
Test->>Publisher: importOASDefinition(temp OAS + additionalProperties)
Publisher->>Gateway: generate mock scripts / deploy revision
Test->>Publisher: updateSwagger (apply modified x-mediation-script)
Test->>Store: create application, subscribe, generate JWT keys
Test->>Gateway: invoke /pet endpoints with Bearer token
🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java`:
- Around line 187-189: The code calls
getClass().getClassLoader().getResourceAsStream(...) and passes the result
straight into IOUtils.toString(...), which will throw an opaque NPE if the
resource is missing; update both occurrences (the creation of modifiedScript and
the similar block around lines 243-246) to first assign the InputStream to a
local variable (e.g., is =
getClass().getClassLoader().getResourceAsStream(RESOURCE_PATH + "...")), check
if is == null and throw or fail with a clear message that the classpath resource
was not found (including the resource name), then pass the non-null stream to
IOUtils.toString(...). Ensure the streams are closed appropriately
(try-with-resources) and reference the getResourceAsStream and IOUtils.toString
usages for locating the fixes.
In
`@all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/get_pet_modified_mediation_script.js`:
- Line 38: Replace the typo in the mock response payload by changing the value
for the JSON key "name" that currently reads "German Sheperd" to the correct
spelling "German Shepherd" so the mock endpoint returns the correct breed name.
- Around line 44-57: The responses object is returning JSON strings for 400 and
404 and a mismatched shape for 501; update responses[400]["application/json"]
and responses[404]["application/json"] to be objects that match the OpenAPI
error schema/example (not the empty string), and change
responses[501]["application/json"] to use the same error object shape and fields
as specified in the OAS example. Locate the assignments to responses[400],
responses[404], and responses[501] in get_pet_modified_mediation_script.js and
replace the string payloads and the current 501 object with objects that mirror
the OpenAPI contract’s error model.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 5c75bbab-8b30-42ba-bb75-25eb1054da72
📒 Files selected for processing (5)
all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.javaall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/additionalProperties.jsonall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/get_pet_modified_mediation_script.jsall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/petstore_oas.jsonall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/testng.xml
YasasRangika
force-pushed
the
mock-ep-tests
branch
from
bd64c6f to
5c661ab
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java`:
- Around line 170-172: Before deserializing the API response, verify that the
HTTP call succeeded: check the HttpResponse returned by
restAPIPublisher.getAPI(apiId) for a successful status (or non-error) and assert
it (e.g., status code or isSuccess) before calling new Gson().fromJson(...).
Update the test around restAPIPublisher.getAPI, HttpResponse apiResponse and
APIDTO apiDto to assert the response is OK and include a helpful message if it
is not, then only deserialize into APIDTO when the response check passes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 331a9118-552c-4f34-bd12-9399a3aebcce
📒 Files selected for processing (5)
all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.javaall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/additionalProperties.jsonall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/get_pet_modified_mediation_script.jsall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/petstore_oas.jsonall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/testng.xml
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java (1)
237-241: 💤 Low valueConsider checking application creation response code for consistency.
For consistency with the pattern at line 194 (where response code is checked before using the data), consider validating the HTTP response code before treating
applicationResponse.getData()as a valid application ID. While subsequent operations would fail if creation didn't succeed, an explicit check provides clearer diagnostics.💡 Suggested improvement
HttpResponse applicationResponse = restAPIStore.createApplication( APPLICATION_NAME + userMode, "Mock Endpoint Test Application", APIMIntegrationConstants.APPLICATION_TIER.UNLIMITED, ApplicationDTO.TokenTypeEnum.JWT); + Assert.assertEquals(applicationResponse.getResponseCode(), Response.Status.OK.getStatusCode(), + "Application creation failed. Response: " + applicationResponse.getData()); Assert.assertNotNull(applicationResponse.getData(), "Application creation failed"); applicationId = applicationResponse.getData();🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java` around lines 237 - 241, Check the HTTP response code from restAPIStore.createApplication before using applicationResponse.getData(): assert that applicationResponse.getResponseCode() equals the expected success code (e.g., 201/CREATED) and only then assign applicationId = applicationResponse.getData(); update the assertion to mirror the pattern used earlier (line ~194) so failures give clear diagnostics about creation vs. missing data.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In
`@all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java`:
- Around line 237-241: Check the HTTP response code from
restAPIStore.createApplication before using applicationResponse.getData():
assert that applicationResponse.getResponseCode() equals the expected success
code (e.g., 201/CREATED) and only then assign applicationId =
applicationResponse.getData(); update the assertion to mirror the pattern used
earlier (line ~194) so failures give clear diagnostics about creation vs.
missing data.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 4c21ec7c-6bd3-4f5f-b725-c28bbdb4b1aa
📒 Files selected for processing (1)
all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java (1)
169-183: ⚡ Quick winPrefer structural JSON assertions over
contains(...)checks.These assertions are brittle to serialization formatting and can still miss payload-shape regressions. Parsing the response body and asserting fields directly would make this test much more stable.
Suggested refactor
- Assert.assertTrue(petZeroResponse.getData().contains("\"id\":10") - || petZeroResponse.getData().contains("\"id\": 10"), - "petId=0 should return default mock payload with id 10. Response: " + petZeroResponse.getData()); - Assert.assertTrue(petZeroResponse.getData().contains("Dogs"), - "petId=0 should return default mock payload with Dogs category. Response: " + petZeroResponse.getData()); + JSONObject petZeroBody = new JSONObject(petZeroResponse.getData()); + Assert.assertEquals(petZeroBody.getInt("id"), 10, + "petId=0 should return default mock payload. Response: " + petZeroResponse.getData()); + Assert.assertEquals(petZeroBody.getJSONObject("category").getString("name"), "Dogs", + "petId=0 should return Dogs category. Response: " + petZeroResponse.getData()); ... - Assert.assertTrue(petOneResponse.getData().contains("German Shepherd"), - "petId=1 should return manually modified mock payload. Response: " + petOneResponse.getData()); - Assert.assertTrue(petOneResponse.getData().contains("\"id\":1") - || petOneResponse.getData().contains("\"id\": 1"), - "petId=1 should return mock payload with id 1. Response: " + petOneResponse.getData()); + JSONObject petOneBody = new JSONObject(petOneResponse.getData()); + Assert.assertEquals(petOneBody.getString("name"), "German Shepherd", + "petId=1 should return manually modified mock payload. Response: " + petOneResponse.getData()); + Assert.assertEquals(petOneBody.getInt("id"), 1, + "petId=1 should return mock payload with id 1. Response: " + petOneResponse.getData());🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java` around lines 169 - 183, Replace brittle contains(...) string checks in MockEndpointIntegrationTestCase by parsing the response JSON from petZeroResponse.getData() and petOneResponse.getData() (responses obtained via HTTPSClientUtils.doGet) and asserting structure/values: assert the numeric "id" equals 10 for petZeroResponse and 1 for petOneResponse, assert the category name equals "Dogs" for petZeroResponse, and assert the relevant name/title field contains "German Shepherd" (or the appropriate JSON field) for petOneResponse; use a JSON parser (e.g., ObjectMapper.readTree or new JSONObject) to extract fields rather than substring matching so assertions target fields like root.get("id").asInt() and root.path("category").path("name").asText().
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java`:
- Around line 141-146: The test currently only asserts
applicationResponse.getData() is not null before using it; instead assert the
createApplication call succeeded by checking applicationResponse's HTTP status
is a 2xx (e.g., assertTrue(applicationResponse.getStatusCode() >= 200 &&
applicationResponse.getStatusCode() < 300)) and include the response body in the
assertion message for debugging, then only assign applicationId =
applicationResponse.getData() and call restAPIStore.subscribeToAPI(...) after
that success check; reference createApplication, applicationResponse,
applicationId, and restAPIStore.subscribeToAPI in the change.
---
Nitpick comments:
In
`@all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.java`:
- Around line 169-183: Replace brittle contains(...) string checks in
MockEndpointIntegrationTestCase by parsing the response JSON from
petZeroResponse.getData() and petOneResponse.getData() (responses obtained via
HTTPSClientUtils.doGet) and asserting structure/values: assert the numeric "id"
equals 10 for petZeroResponse and 1 for petOneResponse, assert the category name
equals "Dogs" for petZeroResponse, and assert the relevant name/title field
contains "German Shepherd" (or the appropriate JSON field) for petOneResponse;
use a JSON parser (e.g., ObjectMapper.readTree or new JSONObject) to extract
fields rather than substring matching so assertions target fields like
root.get("id").asInt() and root.path("category").path("name").asText().
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: a15f9c18-8981-4fd9-841d-c67455e0785e
📒 Files selected for processing (2)
all-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/prototype/MockEndpointIntegrationTestCase.javaall-in-one-apim/modules/integration/tests-integration/tests-backend/src/test/resources/oas/v3/mock-endpoint/get_pet_modified_mediation_script.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a comprehensive integration test suite for the mock endpoint (inline mediation script) feature in the API Gateway, following the official Mock Implementation guide. It adds a new test class, supporting OpenAPI and mediation script resources, and updates the test suite configuration to ensure these tests are executed. The main focus is to validate the generation, modification, and invocation of inline mock scripts for APIs, including advanced scenarios such as custom response branching and HTTP status handling.
The most important changes are:
New Integration Test Implementation:
MockEndpointIntegrationTestCasethat covers end-to-end scenarios for inline mock endpoint implementation, including script generation, manual modification, and runtime invocation with various parameters. The tests verify correct payloads for differentpetIdvalues and response codes, and ensure the API's implementation type is set to INLINE.Test Resource Additions:
petstore_oas.json, an OpenAPI 3.0 definition for the mock pet store API, used as the base for import and testing.additionalProperties.json, specifying API import properties such as context, version, policies, and endpoint configuration for the mock API.get_pet_modified_mediation_script.js, containing a sample mediation script that demonstrates both generated and manually added logic for response branching and custom HTTP status handling.Test Suite Configuration:
testng.xmlto include the newMockEndpointIntegrationTestCasein the integration test suite, ensuring these tests are executed as part of the automated pipeline.