10 releases

Uses new Rust 2021

0.3.2 Nov 23, 2022
0.3.1 Nov 23, 2022
0.3.0 Jul 28, 2022
0.2.0 Jun 21, 2022
0.1.3 Jan 29, 2022

#131 in Encoding

Download history 11282/week @ 2022-08-18 9725/week @ 2022-08-25 8265/week @ 2022-09-01 8604/week @ 2022-09-08 8041/week @ 2022-09-15 9462/week @ 2022-09-22 7997/week @ 2022-09-29 8307/week @ 2022-10-06 7163/week @ 2022-10-13 8501/week @ 2022-10-20 8875/week @ 2022-10-27 7987/week @ 2022-11-03 7407/week @ 2022-11-10 7180/week @ 2022-11-17 7601/week @ 2022-11-24 13524/week @ 2022-12-01

37,077 downloads per month
Used in 6 crates (2 directly)

Apache-2.0 OR MIT

44KB
795 lines

quick-junit

quick-junit on crates.io Documentation (latest release) Documentation (main) Changelog License License

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.

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 TestCases.

The status (success, failure, error, or skipped) of a TestCase is represented by TestCaseStatus.

Features

  • ✅ Serializing JUnit/XUnit to the Jenkins format.
  • ✅ Including test reruns using TestRerun
  • ✅ Including flaky tests
  • ✅ Including standard output and error
  • ✅ 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

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#"<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="my-test-run" tests="2" failures="1" errors="0">
    <testsuite name="my-test-suite" tests="2" disabled="0" errors="0" failures="1">
        <testcase name="success-case">
        </testcase>
        <testcase name="failure-case">
            <failure/>
        </testcase>
    </testsuite>
</testsuites>
"#;

assert_eq!(report.to_string().unwrap(), EXPECTED_XML);

For a more comprehensive example, including reruns and flaky tests, see fixture_tests.rs.

Minimum supported Rust version (MSRV)

The minimum supported Rust version is Rust 1.62.

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: Older, more mature project. Doesn't appear to support flaky tests or arbitrary properties as of version 0.7.0.

Contributing

See the CONTRIBUTING file for how to help out.

License

This project is available under the terms of either the Apache 2.0 license or the MIT license.

Dependencies

~2.4–3MB
~58K SLoC