Skip to content

docs: document structured E2E test report artifacts #673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jlost wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document structured E2E test report artifacts #673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/developer-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,21 @@ When running tests with Gateway API, you should provide the `--networking-layer`

Tests may not clean up. To re-run, first do `kubectl delete namespace kserve-ci-e2e-test`, recreate the namespace, and run again.

### CI Analysis

Every E2E job uploads a zip named `test-results-<suite>-<install-method>` (e.g. `test-results-predictor-kustomize`) containing two structured report files:

- **`junit_e2e.xml`** -- JUnit XML (built-in pytest). Standard format consumed by most CI observability tools.
- **`e2e_results.json`** -- JSON via [pytest-json-report](https://pypi.org/project/pytest-json-report/). Richer data including per-test timings, setup/call/teardown phases, and full tracebacks.

Both files are written even when tests fail, enabling partial failure analysis.

To produce these locally, set `ARTIFACT_DIR` before running the E2E script:

```bash
ARTIFACT_DIR=./results ./test/scripts/gh-actions/run-e2e-tests.sh predictor
```

### Iterating

As you make changes to the code-base, there are special cases to be aware of:
Expand Down