ci: add scheduled public API e2e tests (CM-968)#4398
Draft
skwowet wants to merge 6 commits into
Draft
Conversation
![github-advanced-security[bot]](https://cdn.github.com/in/57789?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
Adds scheduled Public API end-to-end regression testing against the isolated api-e2e deployment.
Changes:
- Adds the scheduled deployment and test workflow.
- Adds HTTP-based fixture seeding and resource suites.
- Registers and documents the new e2e architecture.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
.github/scripts/public-api-e2e-tests.sh |
Implements the Public API test suite. |
.github/workflows/api-e2e-tests.yml |
Deploys and tests api-e2e nightly. |
scripts/builders/backend.env |
Maps api-e2e to the backend image. |
docs/adr/0011-api-e2e-test-architecture.md |
Documents runtime and isolation decisions. |
docs/adr/0012-api-e2e-test-suite-design.md |
Documents suite organization. |
docs/adr/README.md |
Indexes the new ADRs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Yeganathan S <63534555+skwowet@users.noreply.github.com>
Signed-off-by: Yeganathan S <63534555+skwowet@users.noreply.github.com>
Signed-off-by: Yeganathan S <63534555+skwowet@users.noreply.github.com>
Signed-off-by: Yeganathan S <63534555+skwowet@users.noreply.github.com>
skwowet
force-pushed
the
ci/CM-968-api-e2e-tests
branch
from
July 26, 2026 13:54
94a8eb5 to
71617ab
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Comments suppressed due to low confidence (1)
.github/scripts/public-api-e2e-tests.sh:113
- The Auth0 request is also unbounded, so a stalled token endpoint can consume the entire 90-minute job timeout before any test runs. Give this curl call a short connect and total timeout as well.
response="$(curl -sS -X POST "${AUTH0_STAGING_ISSUER}/oauth/token" \
Signed-off-by: Yeganathan S <63534555+skwowet@users.noreply.github.com>
Signed-off-by: Yeganathan S <63534555+skwowet@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
.github/workflows/api-e2e-tests.yml:78
- A job-level timeout cancels the whole
e2e-testsjob, so this later step is never reached when the 90-minute limit is hit. That leaves a hung build/deploy/test without the Slack alert promised by the ADR. Move notification into a separate job thatneeds: e2e-testsand runs whenalways() && needs.e2e-tests.result != 'success', so failures and timeouts are both reported.
if: failure()
Comment on lines
+17
to
+19
| Implement API e2e tests as HTTP bash script(s) with this structure. Current entrypoint: [`.github/scripts/public-api-e2e-tests.sh`](../../.github/scripts/public-api-e2e-tests.sh). New suites should reuse this pattern (same script or additional scripts), not invent a parallel style. | ||
|
|
||
| The suite is **thin**: assert the HTTP contract and critical flows so regressions show up early. Leave exhaustive edge-case matrices to unit or focused contract tests. |
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
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.
Summary
Adds a scheduled Public API e2e suite against the dedicated
api-e2estack (crowd_api_e2e), so we can catch contract regressions onmainwithout hand-running against shared staging.Changes
.github/scripts/public-api-e2e-tests.sh(HTTP seed + resource suites).github/workflows/api-e2e-tests.yml(deployapi-e2efrommain, then run the suite)api-e2einscripts/builders/backend.env