Custom Integrations

If Flakiness.io doesn’t have a first-party integration for your testing framework, you can still integrate with our platform using several approaches.

Integration Options

File an Issue

File an issue on our feedback repository to request official support for your testing framework.

Request New Integration →

JUnit XML

Many testing frameworks can output JUnit XML format, which Flakiness.io supports natively.

JUnit Integration →

Custom Reporter

Build your own reporter using the Flakiness Report specification and upload via CLI.

Learn More ↓

Custom Reporter

If your testing framework doesn’t support JUnit XML output, you can create a custom reporter that generates Flakiness Reports.

Getting Started

Generate Report JSON

Review the Flakiness Report specification to understand the required JSON structure. Create a reporter plugin for your testing framework that outputs a report.json file following the specification.

report.json looks like this:

{
  "category": "bash",
  "commitId": "a1b2c3d4e5f6789012345678901234567890abcd",
  "environments": [{ "name": "ubuntu" }],
  "tests": [
    {
      "title": "My shell test",
      "location": {
        "file": "tests/shell.sh",
        "line": 3,
        "column": 1
      },
      "attempts": [
        {
          "environmentIdx": 0,
          "expectedStatus": "passed",
          "status": "passed",
          "startTimestamp": 1703001600000,
          "duration": 1500,
          "attachments": [{
            "name": "screenshot.png",
            "contentType": "image/png",
            "id": "5d41402abc4b2a76b9719d911017c592"
          }]
        }
      ]
    }
  ],
  "startTimestamp": 1703001600000,
  "duration": 2000
}

Include Attachments (Optional)

Place any test artifacts (screenshots, logs, videos) in the same directory as report.json:
```
 flakiness-report/
 ├── report.json
 └── attachments/
     └── 5d41402abc4b2a76b9719d911017c592
```
Upload to Flakiness.io

Use the Flakiness CLI to upload your generated report:
Terminal window
```
flakiness upload ./flakiness-report
```

Example Implementations

Looking for inspiration? Check out our existing integrations:

Pytest Plugin