https://github.com/ctrf-io/ctrf-cli
https://github.com/ctrf-io/ctrf-cli
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ctrf-io/ctrf-cli
- Owner: ctrf-io
- License: mit
- Created: 2024-06-09T18:47:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-11T19:47:46.000Z (over 1 year ago)
- Last Synced: 2025-01-11T20:31:09.738Z (over 1 year ago)
- Language: TypeScript
- Size: 19.5 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# CTRF CLI
Various CTRF utilities available from the command line
💚
CTRF tooling is open source and free to use
You can support the project with a follow and a star
Maintained by Matthew Thomas
Contributions are very welcome!
Explore more integrations
## Command Line Utilities
| Name |Details |
| ------------ | ----------------------------------------------------------------------------------- |
| `merge` | Merge multiple CTRF reports into a single report. |
| `flaky` | Output flaky test name and retries. |
## Merge
This might be useful if you need a single report, but your chosen reporter generates multiple reports through design, parallelisation or otherwise.
To merge CTRF reports in a specified directory, use the following command:
```sh
npx ctrf-cli merge
```
Replace `directory` with the path to the directory containing the CTRF reports you want to merge.
### Options
-o, --output `filename`: Output file name for the merged report. Default is ctrf-report.json.
```sh
npx ctrf-cli merge --output my-merged-report.json
```
-d, --output-dir `directory`: Output directory for the merged report. Default is the same directory as the input reports.
```sh
npx ctrf-cli merge --output-dir /path/to/output
```
-k, --keep-reports: Keep existing reports after merging. By default, the original reports will be deleted after merging.
```sh
npx ctrf-cli merge --keep-reports
```
## Flaky
The flaky command is useful for identifying tests marked as flaky in your CTRF report. Flaky tests are tests that pass or fail inconsistently and may require special attention or retries to determine their reliability.
Usage
To output flaky tests, use the following command:
```sh
npx ctrf-cli flaky
```
Replace with the path to the CTRF report file you want to analyze.
### Output
The command will output the names of the flaky tests and the number of retries each test has undergone. For example:
```zsh
Processing report: reports/sample-report.json
Found 1 flaky test(s) in reports/sample-report.json:
- Test Name: Test 1, Retries: 2
```
## What is CTRF?
CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.
**Consistency Across Tools:** Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.
**Language and Framework Agnostic:** It provides a universal reporting schema that works seamlessly with any programming language and testing framework.
**Facilitates Better Analysis:** With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.
## Support Us
If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.