Add end-to-end test case for API Platform + Gateway + Devportal integration#2471
Add end-to-end test case for API Platform + Gateway + Devportal integration#2471DinithHerath wants to merge 5 commits into
Conversation
DinithHerath
requested review from
AnuGayan,
Arshardh,
CrowleyRajapakse,
HeshanSudarshana,
HiranyaKavishani,
Krishanx92,
PasanT9,
RakhithaRR,
Tharsanan1,
VirajSalaka,
ashera96,
chamilaadhi,
dushaniw,
hisanhunais,
malinthaprasan,
pubudu538,
renuka-fernando,
senthuran16,
tgtshanika,
tharikaGitHub and
tharindu1st
as code owners
|
Warning Review limit reached
Next review available in: 17 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughAdds a new Postgres-based developer-portal E2E test stack: a GitHub Actions workflow, a ChangesDeveloper Portal E2E Suite
Estimated code review effort: 4 (Complex) | ~60 minutes Sequence Diagram(s)sequenceDiagram
participant TestSuite as E2E Suite
participant Portal as developer-portal
participant PlatformAPI as platform-api
participant Gateway
TestSuite->>Portal: bootstrap (health check, org link, webhook subscribe)
Portal->>PlatformAPI: register webhook subscriber (HMAC secret, RSA public key)
TestSuite->>Portal: create application, subscription, API key
Portal->>PlatformAPI: webhook event (subscription.created, apikey.created)
PlatformAPI->>Gateway: propagate credential/subscription state
TestSuite->>Gateway: invoke with API-Key/Subscription-Key
Gateway-->>TestSuite: 200 (valid) or 401/403 (invalid/revoked/expired)
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
.github/workflows/platform-api-devportal-e2e.yml (1)
30-71: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick winNo job-level
timeout-minutes.The
go teststep is bounded at 25m, but the preceding checkout/setup/four image-build steps have no bound and could hang (e.g. registry/network stalls) well past that, consuming the default multi-hour GitHub Actions job timeout.🤖 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 @.github/workflows/platform-api-devportal-e2e.yml around lines 30 - 71, Add a job-level timeout for the devportal-e2e workflow job so the entire `devportal-e2e` sequence cannot run indefinitely. Keep the existing `go test` timeout, but update the job definition around the `devportal-e2e` job to include a `timeout-minutes` value that covers the full checkout/setup/build/test flow and prevents hangs in steps like `actions/checkout`, `actions/setup-go`, `docker/setup-buildx-action`, or the various `make build` commands.
🤖 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 @.github/workflows/platform-api-devportal-e2e.yml:
- Around line 9-20: The workflow trigger for the devportal e2e job is too broad
and causes it to run on every pull request to main, which conflicts with the
intended “off the critical path” behavior. Update the workflow’s pull_request
trigger in the platform-api-devportal-e2e workflow to include path scoping so it
only runs when the e2e/devportal stack or related workflow inputs change, while
keeping workflow_dispatch for on-demand runs. Use the workflow’s existing
trigger block as the place to narrow the PR trigger and preserve the current job
definition.
In `@tests/integration-e2e/docker-compose.yaml`:
- Around line 200-222: Update the stale header comment in the devportal service
block to match the actual wiring used by the devportal environment. The comment
near the devportal definition currently claims it uses a self-contained SQLite
store with no database wiring, but the `devportal` service is configured with
`DP_DB_DIALECT`, `DP_DB_HOST`, `DP_DB_PORT`, and the other DB env vars to use
the shared `postgres` service. Keep the inline explanation aligned with the
existing `devportal` service definition and its environment variables so readers
understand it is intentionally backed by Postgres, not SQLite.
In `@tests/integration-e2e/README.md`:
- Around line 148-154: The README text in the auth section mixes literal
wildcard scopes with Markdown bold formatting, triggering the MD037 ambiguity
warning. Update the sentence in the integration-e2e README so the scope values
in the Auth description are consistently wrapped as code, and keep the wording
around AUTH_FILE_BASED_USERS and bearer auth unchanged. Use the surrounding auth
paragraph to locate the affected text.
---
Nitpick comments:
In @.github/workflows/platform-api-devportal-e2e.yml:
- Around line 30-71: Add a job-level timeout for the devportal-e2e workflow job
so the entire `devportal-e2e` sequence cannot run indefinitely. Keep the
existing `go test` timeout, but update the job definition around the
`devportal-e2e` job to include a `timeout-minutes` value that covers the full
checkout/setup/build/test flow and prevents hangs in steps like
`actions/checkout`, `actions/setup-go`, `docker/setup-buildx-action`, or the
various `make build` commands.
🪄 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: 0f69e18b-0c71-42d8-a273-c987d2ab1e17
📒 Files selected for processing (14)
.github/workflows/platform-api-devportal-e2e.yml.github/workflows/platform-api-gateway-e2e.ymltests/integration-e2e/.gitignoretests/integration-e2e/README.mdtests/integration-e2e/docker-compose.yamltests/integration-e2e/features/devportal-webhook.featuretests/integration-e2e/features/secured-api-invocation.featuretests/integration-e2e/init-db.sqltests/integration-e2e/platform-api-config.tomltests/integration-e2e/steps_devportal_lifecycle_test.gotests/integration-e2e/steps_devportal_test.gotests/integration-e2e/steps_secured_test.gotests/integration-e2e/steps_test.gotests/integration-e2e/suite_test.go
1 participant
This pull request introduces a full three-plane end-to-end (E2E) integration test for the platform, covering Platform API, Gateway, and Developer Portal. It adds a new GitHub Actions workflow, expands the E2E test suite and documentation, updates Docker Compose to support the developer portal, and ensures credentials and webhooks are properly exercised and tested. The changes also clarify environment variables and credential handling for complex scenarios, especially those involving the developer portal.
Major changes include:
E2E Testing Infrastructure
.github/workflows/platform-api-devportal-e2e.ymlto run developer portal E2E tests, integrating Platform API, Gateway, and Developer Portal, including credential lifecycle scenarios and webhook propagation..github/workflows/platform-api-gateway-e2e.ymlto exclude developer portal scenarios from the combined E2E job, ensuring only the new workflow runs those tests.Docker Compose and Environment
tests/integration-e2e/docker-compose.yamlto add adevportalservice, configure its environment, mount its schema, and set up webhook integration with Platform API, including correct encryption keys and admin user injection. [1] [2] [3] [4].webhook-key.it.pemto.gitignoreto ignore the world-readable copy of the devportal webhook private key generated during tests.Documentation
tests/integration-e2e/README.mdto document the developer portal E2E scenarios, how to build and run them, new environment variables, and details on the credential lifecycle and webhook trust model. [1] [2] [3] [4]Security and Configuration
DATABASE_SUBSCRIPTION_TOKEN_ENCRYPTION_KEY,DP_ADVANCED_ENCRYPTIONKEY) are the correct length and properly documented for secure credential handling and webhook encryption.These changes collectively enable robust, real-world E2E testing of the entire API platform, including developer portal integration, and provide clear documentation and configuration for contributors.