Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextest-rs/quick-junit
A serializer for JUnit reports, used by cargo-nextest
https://github.com/nextest-rs/quick-junit
junit nextest rust testing xml xunit
Last synced: about 1 month ago
JSON representation
A serializer for JUnit reports, used by cargo-nextest
- Host: GitHub
- URL: https://github.com/nextest-rs/quick-junit
- Owner: nextest-rs
- License: apache-2.0
- Created: 2024-04-07T20:49:27.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-19T00:32:46.000Z (8 months ago)
- Last Synced: 2024-04-19T19:03:07.653Z (8 months ago)
- Topics: junit, nextest, rust, testing, xml, xunit
- Language: Rust
- Homepage: https://docs.rs/quick-junit
- Size: 137 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# quick-junit
[](https://crates.io/crates/quick-junit)
[](https://docs.rs/quick-junit/)
[](https://quick-junit.nexte.st/)
[](CHANGELOG.md)
[](LICENSE-APACHE)
[](LICENSE-MIT)
`quick-junit` is a JUnit/XUnit XML data model and serializer for Rust. This crate allows users
to create a JUnit report as an XML file. JUnit XML files are widely supported by test tooling.
This crate is built to serve the needs of [cargo-nextest](https://nexte.st).
## Overview
The root element of a JUnit report is a `Report`. A `Report` consists of one or more
`TestSuite` instances. A `TestSuite` instance consists of one or more `TestCase`s.
The status (success, failure, error, or skipped) of a `TestCase` is represented by
`TestCaseStatus`.
## Features
- ✅ Serializing JUnit/XUnit to the [Jenkins format](https://llg.cubic.org/docs/junit/).
- ✅ Including test reruns using `TestRerun`
- ✅ Including flaky tests
- ✅ Including standard output and error
- ✅ Filtering out [invalid XML
characters](https://en.wikipedia.org/wiki/Valid_characters_in_XML) (eg ANSI escape codes)
from the output
- ✅ Automatically keeping track of success, failure and error counts
- ✅ Arbitrary properties and extra attributes
This crate does not currently support deserializing JUnit XML. (PRs are welcome!)
## Examples
```rust
use quick_junit::*;
let mut report = Report::new("my-test-run");
let mut test_suite = TestSuite::new("my-test-suite");
let success_case = TestCase::new("success-case", TestCaseStatus::success());
let failure_case = TestCase::new("failure-case", TestCaseStatus::non_success(NonSuccessKind::Failure));
test_suite.add_test_cases([success_case, failure_case]);
report.add_test_suite(test_suite);
const EXPECTED_XML: &str = r#"
"#;
assert_eq!(report.to_string().unwrap(), EXPECTED_XML);
```
For a more comprehensive example, including reruns and flaky tests, see
[`fixture_tests.rs`](https://github.com/nextest-rs/quick-junit/blob/main/tests/fixture_tests.rs).
## Minimum supported Rust version (MSRV)
The minimum supported Rust version is **Rust 1.70.** At any time, Rust versions from at least
the last 6 months will be supported.
While this crate is a pre-release (0.x.x) it may have its MSRV bumped in a patch release. Once a
crate has reached 1.x, any MSRV bump will be accompanied with a new minor version.
## Alternatives
- [**junit-report**](https://crates.io/crates/junit-report): Older, more mature project. Doesn't
appear to support flaky tests or arbitrary properties as of version 0.8.3.
## Contributing
See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
## License
This project is available under the terms of either the [Apache 2.0 license](LICENSE-APACHE) or
the [MIT license](LICENSE-MIT).