Skip to content

docs: add JUnit XML Reports page #804

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
PrathamSikka24 wants to merge 2 commits into
base: main
Choose a base branch
from
+107 −3
Open

docs: add JUnit XML Reports page #804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3721df
docs: add JUnit XML Reports page
Mar 22, 2026
c2f2ded
docs: address Copilot review comments on junit-xml-reports page
Mar 23, 2026
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
92 changes: 92 additions & 0 deletions versioned_docs/version-4.0.0/keploy-cloud/junit-xml-reports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
id: junit-xml-reports
title: JUnit XML Reports
description: Export Keploy test results as JUnit XML for CI dashboards and trend tracking
sidebar_label: JUnit XML Reports
keywords:
- junit
- junit xml
- test reports
- ci testing
- ci/cd
- github actions
- jenkins
- gitlab
- test results
tags:
- junit
- ci
- reports
---

import ProductTier from '@site/src/components/ProductTier';

<ProductTier tiers="Open Source, Enterprise" offerings="Self-Hosted, Dedicated" />

Keploy supports exporting test results as standard JUnit XML. Use `--format junit` flag on the `keploy report` command — it is a user-defined config and does not need any external plugin.


## Usage

```bash
keploy test -c "<CMD_TO_RUN_APP>" --delay 10
keploy report --format junit > test-results.xml
```

To scope the report to specific test-sets:

```bash
keploy report --format junit --test-sets "test-set-1"
```

The default format remains `text` — existing workflows are unaffected.

## Output Structure

| Keploy Concept | JUnit XML Element |
|---|---|
| Test-set | `<testsuite>` |
| Test case | `<testcase>` |
| Failed test | `<failure>` with diff summary |
| Obsolete test | `<skipped>` |

### Sample Output


```xml
<?xml version="1.0" encoding="UTF-8"?>
<testsuites tests="5" failures="1" time="2.300">
<testsuite name="test-set-1" tests="3" failures="1" skipped="0" time="1.500">
<testcase name="tc-1" classname="test-set-1" time="0.500"></testcase>
<testcase name="tc-2" classname="test-set-1" time="0.400"></testcase>
<testcase name="tc-3" classname="test-set-1" time="0.600">
<failure message="test assertion failed [HIGH-RISK]" type="AssertionError">status: expected 200, got 500
body mismatch (JSON)</failure>
</testcase>
</testsuite>
<testsuite name="test-set-2" tests="2" failures="0" skipped="1" time="0.800">
<testcase name="tc-4" classname="test-set-2" time="0.300"></testcase>
<testcase name="tc-5" classname="test-set-2" time="0.500">
<skipped message="obsolete test case"></skipped>
</testcase>
</testsuite>
</testsuites>
```

## CI Configuration

### Config Example using GitHub Actions

```yaml
- name: Run Keploy Tests
id: keploy-test
run: keploy test -c "<CMD_TO_RUN_APP>" --delay 10
continue-on-error: true

- name: Generate JUnit Report
if: always()
run: keploy report --format junit > test-results.xml
```
Comment on lines +81 to +89
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In GitHub Actions, if keploy test fails (which is when the JUnit report is most valuable), subsequent steps won’t run by default—so the report may never be generated/published. Adjust the example to ensure the report generation and publishing steps run even when tests fail (e.g., by using an always-run condition and/or capturing the test exit code).

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor Author

@PrathamSikka24 PrathamSikka24 Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There were several examples of CI providers, so it makes more sense to keep one example because the configuration process is similar across all CI providers.


Results appear in the workflow summary under the **Tests** tab.

17 changes: 14 additions & 3 deletions versioned_docs/version-4.0.0/running-keploy/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Here are some examples of how to use some common flags:
| `gen` (Deprecated) | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` |
| `normalize` | `-p, --path`, `--test-run`, `--tests` |
| `rerecord` | `--test-sets`, `-t` |
| `report` | `--test-sets, -t`, `-p, --path`, `--report-path, -r`, `--body` |
| `report` | `--test-sets, -t`, `-p, --path`, `--report-path, -r`, `--body` `--format` | |
| `sanitize` | `--test-sets, -t`, `-p, --path` |
| `config` | `--generate`,`-p, --path` |

Expand Down Expand Up @@ -406,9 +406,20 @@ keploy report --summary
```bash
keploy report --test-case "test-1"
```
- `--format string` - Output format for the report. Accepted values: `text` (default), `junit`. When set to `junit`, outputs standard JUnit XML to stdout.
```bash
keploy report --format junit > test-results.xml
```

To scope the JUnit report to specific test-sets:
```bash
keploy report --format junit --test-sets "test-set-1"
```

See [JUnit XML Reports](/docs/keploy-cloud/junit-xml-reports) for CI integration examples.

### Notes

> **Notes**
>
> - By default, `report` shows only **failed** tests with a compact, human-readable diff (status, headers—including trailers/content-length where applicable—and body changes).
> - Use `--full` to see the complete expected vs actual bodies (with JSON colorization).
> - `--summary` prints just the totals and a per–test-set table, optionally restricted with `-t/--test-sets`.
Expand Down
1 change: 1 addition & 0 deletions versioned_sidebars/version-4.0.0-sidebars.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"running-keploy/keploy-templatize",
"running-keploy/risk-profile-analysis",
"keploy-cloud/time-freezing",
"keploy-cloud/junit-xml-reports",
"keploy-cloud/mock-registry",
"keploy-cloud/keploy-console",
"keploy-cloud/auto-test-generation",
Expand Down
Loading