quick-junit-0.3.6/.cargo/config.toml 0000644 0000000 0000000 00000000126 10461020230 0015407 0 ustar 0000000 0000000 [alias]
xfmt = "fmt -- --config imports_granularity=Crate --config group_imports=One"
quick-junit-0.3.6/.cargo_vcs_info.json 0000644 00000000136 00000000001 0013305 0 ustar {
"git": {
"sha1": "d794af9629b4d5adc35c50cb7fb77143d2061429"
},
"path_in_vcs": ""
} quick-junit-0.3.6/.gitattributes 0000644 0000000 0000000 00000000057 10461020230 0014772 0 ustar 0000000 0000000 # Disable CRLF conversions on Windows.
* -text
quick-junit-0.3.6/.github/FUNDING.yml 0000644 0000000 0000000 00000000023 10461020230 0015245 0 ustar 0000000 0000000 github: sunshowers
quick-junit-0.3.6/.github/codecov.yml 0000644 0000000 0000000 00000000171 10461020230 0015601 0 ustar 0000000 0000000 coverage:
status:
project:
default:
informational: true
patch:
default:
target: 0%
quick-junit-0.3.6/.github/renovate.json 0000644 0000000 0000000 00000000100 10461020230 0016142 0 ustar 0000000 0000000 {
"extends": [
"github>nextest-rs/renovate"
]
}
quick-junit-0.3.6/.github/workflows/ci.yml 0000644 0000000 0000000 00000004304 10461020230 0016611 0 ustar 0000000 0000000 on:
push:
branches:
- main
pull_request:
branches:
- main
name: CI
env:
RUSTFLAGS: -D warnings
CARGO_TERM_COLOR: always
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
- name: Lint (clippy)
run: cargo clippy --all-features --all-targets
- name: Lint (rustfmt)
run: cargo xfmt --check
- name: Install cargo readme
uses: taiki-e/install-action@834a7b93e0c678fb40309ee0e36546336d5c6ea7 # v2
with:
tool: cargo-readme
- name: Run cargo readme
run: ./scripts/regenerate-readmes.sh
- name: Check for differences
run: git diff --exit-code
build-rustdoc:
name: Build documentation
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]
fail-fast: false
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
- name: Build rustdoc
run: cargo doc --all-features
build:
name: Build and test
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- ubuntu-latest
# macos-14 for M1 runners
- macos-14
- windows-latest
# 1.70 is the MSRV
rust-version: ["1.70", stable]
fail-fast: false
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust-version }}
- uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
with:
key: ${{ matrix.rust-version }}
- name: Install latest nextest release
uses: taiki-e/install-action@nextest
- name: Build quick-junit
run: cargo build
- name: Run tests
run: cargo nextest run
quick-junit-0.3.6/.github/workflows/coverage.yml 0000644 0000000 0000000 00000002541 10461020230 0020012 0 ustar 0000000 0000000 on:
push:
branches: [main, auto, canary]
pull_request:
branches:
- main
name: Test coverage
jobs:
coverage:
name: Collect test coverage
runs-on: ubuntu-latest
# nightly rust might break from time to time
continue-on-error: true
env:
RUSTFLAGS: -D warnings
CARGO_TERM_COLOR: always
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
# Nightly Rust is used for cargo llvm-cov --doc below.
- uses: dtolnay/rust-toolchain@nightly
with:
components: llvm-tools-preview
- uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
- name: Install latest nextest release
uses: taiki-e/install-action@nextest
- name: Install cargo-llvm-cov
uses: taiki-e/install-action@cargo-llvm-cov
- name: Collect coverage data
# Generate separate reports for nextest and doctests, and combine them.
run: |
cargo llvm-cov --no-report nextest
cargo llvm-cov --no-report --doc
cargo llvm-cov report --doctests --lcov --output-path lcov.info
- name: Upload coverage data to codecov
uses: codecov/codecov-action@c16abc29c95fcf9174b58eb7e1abf4c866893bc8 # v4
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
with:
files: lcov.info
quick-junit-0.3.6/.github/workflows/docs.yml 0000644 0000000 0000000 00000001705 10461020230 0017150 0 ustar 0000000 0000000 on:
push:
branches:
- main
name: Docs
jobs:
docs:
name: Build and deploy documentation
concurrency: ci-${{ github.ref }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
- name: Build rustdocs
run: ./scripts/build-docs.sh
- name: Organize
run: |
rm -rf target/gh-pages
mkdir target/gh-pages
mv target/doc/_redirects target/gh-pages
mv target/doc target/gh-pages/rustdoc
- name: Publish
uses: cloudflare/pages-action@1
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
projectName: quick-junit
directory: target/gh-pages
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
quick-junit-0.3.6/.github/workflows/release.yml 0000644 0000000 0000000 00000002133 10461020230 0017634 0 ustar 0000000 0000000 # adapted from https://github.com/taiki-e/cargo-hack/blob/main/.github/workflows/release.yml
name: Publish releases to GitHub
on:
push:
tags:
- "*"
jobs:
quick-junit-release:
if: github.repository_owner == 'nextest-rs' && startsWith(github.ref_name, 'quick-junit-')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
with:
persist-credentials: false
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
- name: Install cargo release
uses: taiki-e/install-action@834a7b93e0c678fb40309ee0e36546336d5c6ea7 # v2
with:
tool: cargo-release@0.25.0
- uses: taiki-e/create-gh-release-action@8df4de6534ceacdaed10a08f73418ca751f31793 # v1
with:
prefix: quick-junit
changelog: CHANGELOG.md
title: $prefix $version
branch: main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: ./scripts/cargo-release-publish.sh
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
quick-junit-0.3.6/.gitignore 0000644 0000000 0000000 00000000010 10461020230 0014054 0 ustar 0000000 0000000 /target
quick-junit-0.3.6/CHANGELOG.md 0000644 0000000 0000000 00000006315 10461020230 0013713 0 ustar 0000000 0000000 # Changelog
## Unreleased
## [0.3.6] - 2024-04-08
- Updated repository to [https://github.com/nextest-rs/quick-junit](https://github.com/nextest-rs/quick-junit).
## [0.3.5] - 2023-10-27
### Fixed
- Corrected the `rust-version` field in `Cargo.toml` to `1.70`.
### Changed
- The `chrono` dependency no longer imports the `clock` feature. This helps cut down on the dependency tree. Thanks [@littledivy](https://github.com/littledivy) for your first contribution!
## [0.3.4] - 2023-10-22
### Fixed
- `Output::new` now strips ANSI escapes as well. Thanks [@MaienM](https://github.com/MaienM) for your first contribution!
### Changed
- Internal dependency update: `quick-xml` updated to 0.31.0.
- MSRV updated to Rust 1.70.
## [0.3.3] - 2023-06-07
### Added
- `TestCase` now has an extra `properties` section and an `add_property` method, similar to `TestSuite`. Thanks [@skycoop](https://github.com/skycoop) for your first contribution!
### Changed
- Internal dependency update: quick-xml updated to 0.29.0.
- MSRV updated to Rust 1.66.
## [0.3.2] - 2022-11-23
### Changed
- Internal dependency update: quick-xml updated to 0.26.0.
- MSRV updated to Rust 1.62.
## [0.3.1] - 2022-11-23
(This version was not published due to a code issue.)
## [0.3.0] - 2022-07-27
### Added
- `Report` contains a new `uuid` field with a unique identifier for a particular run. This is an extension to the JUnit spec.
## [0.2.0] - 2022-06-21
### Changed
- quick-xml updated to 0.23.0.
- The error type is now defined by quick-junit, so that future breaking changes to quick-xml will not necessitate a breaking change to this crate.
- MSRV bumped to Rust 1.59.
## [0.1.5] - 2022-02-14
### Changed
- Lower MSRV to Rust 1.54.
## [0.1.4] - 2022-02-07
### Fixed
- In readme, fix link to cargo-nextest.
### Changed
- Update repository location.
## [0.1.3] - 2022-01-29
- In the readme, replace Markdown checkboxes with Unicode ✅ to make them render properly on
crates.io.
## [0.1.2] - 2022-01-29
- Expand readme.
- Add keywords and categories.
## [0.1.1] - 2022-01-28
- Fix repository field in Cargo.toml.
## [0.1.0] - 2022-01-28
- Initial version.
[0.3.6-rc.1]: https://github.com/nextest-rs/quick-junit/releases/tag/quick-junit-0.3.6-rc.1
[0.3.5]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.3.5
[0.3.4]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.3.4
[0.3.3]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.3.3
[0.3.2]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.3.2
[0.3.1]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.3.1
[0.3.0]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.3.0
[0.2.0]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.2.0
[0.1.5]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.1.5
[0.1.4]: https://github.com/nextest-rs/nextest/releases/tag/quick-junit-0.1.4
[0.1.3]: https://github.com/diem/diem-devtools/releases/tag/quick-junit-0.1.3
[0.1.2]: https://github.com/diem/diem-devtools/releases/tag/quick-junit-0.1.2
[0.1.1]: https://github.com/diem/diem-devtools/releases/tag/quick-junit-0.1.1
[0.1.0]: https://github.com/diem/diem-devtools/releases/tag/quick-junit-0.1.0
quick-junit-0.3.6/CONTRIBUTING.md 0000644 0000000 0000000 00000004261 10461020230 0014331 0 ustar 0000000 0000000 ## Pull Requests
If you have a new feature in mind, please discuss the feature in an issue to ensure that your
contributions will be accepted.
1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes with `cargo nextest run --all-features`.
5. Run `cargo xfmt` to automatically format your changes (CI will let you know if you missed this).
## Logically Separate Commits
As far as possible, please try and make commits
[atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention) and logically
separate. We understand that GitHub's pull request model doesn't work well with "stacked diffs", so
if your changes are complex, then a single PR with a series of commits is preferred.
## Bisectable History
It is important that the project history is bisectable, so that when regressions are identified we
can easily use `git bisect` to be able to pinpoint the exact commit which introduced the regression.
We'll land your commits with:
- "Rebase and merge" if your commits are atomic and each commit passes CI.
- "Squash and merge" if they are not.
## Maintainers Editing Commits
For efficiency reasons, maintainers may choose to edit your commits before landing them. The commits
will still be credited to you, and the edits will be limited to reasonable changes that are in the
spirit of the PR. (Think of the changes that the maintainers would have done anyway.)
To make this easier, please check the box that allows maintainers to edit your branch:
If maintainers need to make changes and that box is checked, then your PR can be marked as "merged"
in the web UI. Otherwise, it will be marked as "closed".
## License
By contributing to `quick-junit`, you agree that your contributions will be dual-licensed under the
terms of the [`LICENSE-MIT`](LICENSE-MIT) and [`LICENSE-APACHE`](LICENSE-APACHE) files in the root
directory of this source tree.
quick-junit-0.3.6/Cargo.toml 0000644 00000002457 00000000001 0011313 0 ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.
[package]
edition = "2021"
rust-version = "1.70"
name = "quick-junit"
version = "0.3.6"
description = "Data model and serializer for JUnit/XUnit XML"
documentation = "https://docs.rs/quick-junit"
readme = "README.md"
keywords = [
"junit",
"xunit",
"xml",
"serializer",
"flaky-tests",
]
categories = [
"encoding",
"development-tools",
]
license = "Apache-2.0 OR MIT"
repository = "https://github.com/nextest-rs/quick-junit"
[dependencies.chrono]
version = "0.4.35"
features = ["std"]
default-features = false
[dependencies.indexmap]
version = "2.2.5"
[dependencies.quick-xml]
version = "0.31.0"
[dependencies.strip-ansi-escapes]
version = "0.2.0"
[dependencies.thiserror]
version = "1.0.58"
[dependencies.uuid]
version = "1.7.0"
[dev-dependencies.goldenfile]
version = "1.6.0"
[dev-dependencies.owo-colors]
version = "4.0.0"
quick-junit-0.3.6/Cargo.toml.orig 0000644 0000000 0000000 00000001246 10461020230 0014767 0 ustar 0000000 0000000 [package]
name = "quick-junit"
description = "Data model and serializer for JUnit/XUnit XML"
version = "0.3.6"
readme = "README.md"
license = "Apache-2.0 OR MIT"
repository = "https://github.com/nextest-rs/quick-junit"
documentation = "https://docs.rs/quick-junit"
keywords = ["junit", "xunit", "xml", "serializer", "flaky-tests"]
categories = ["encoding", "development-tools"]
edition = "2021"
rust-version = "1.70"
[dependencies]
chrono = { version = "0.4.35", default-features = false, features = ["std"] }
indexmap = "2.2.5"
quick-xml = "0.31.0"
thiserror = "1.0.58"
uuid = "1.7.0"
strip-ansi-escapes = "0.2.0"
[dev-dependencies]
goldenfile = "1.6.0"
owo-colors = "4.0.0"
quick-junit-0.3.6/LICENSE-APACHE 0000644 0000000 0000000 00000025137 10461020230 0014031 0 ustar 0000000 0000000 Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
quick-junit-0.3.6/LICENSE-MIT 0000644 0000000 0000000 00000002047 10461020230 0013534 0 ustar 0000000 0000000 Copyright (c) The nextest Contributors
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
quick-junit-0.3.6/README.md 0000644 0000000 0000000 00000007152 10461020230 0013361 0 ustar 0000000 0000000 # 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/nextest/blob/main/quick-junit/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).
quick-junit-0.3.6/README.tpl 0000644 0000000 0000000 00000001722 10461020230 0013555 0 ustar 0000000 0000000 # {{crate}}
[](https://crates.io/crates/quick-junit)
[](https://docs.rs/quick-junit/)
[](https://quick-junit.nexte.st/)
[](CHANGELOG.md)
[](LICENSE-APACHE)
[](LICENSE-MIT)
{{readme}}
## 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).
quick-junit-0.3.6/release.toml 0000644 0000000 0000000 00000000474 10461020230 0014417 0 ustar 0000000 0000000 sign-tag = true
# Required for templates below to work
consolidate-commits = false
pre-release-commit-message = "[{{crate_name}}] version {{version}}"
tag-message = "[{{crate_name}}] version {{version}}"
tag-prefix = "{{crate_name}}-"
tag-name = "{{prefix}}{{version}}"
publish = false
dependent-version = "upgrade"
quick-junit-0.3.6/scripts/build-docs.sh 0000755 0000000 0000000 00000000763 10461020230 0016156 0 ustar 0000000 0000000 #!/usr/bin/env bash
# Build docs for all crates and direct dependencies. The gawk script turns e.g. "quick-junit v0.1.0"
# into "quick-junit@0.1.0".
cargo tree --depth 1 -e normal --prefix none \
| gawk '{ gsub(" v", "@", $0); printf("%s\n", $1); }' \
| xargs printf -- '-p %s\n' \
| xargs cargo doc --no-deps --lib
# Also drop a _redirects file in the root of the docs directory -- this will be picked up by the
# CI script.
echo "/ /rustdoc/quick_junit/ 301" > target/doc/_redirects
quick-junit-0.3.6/scripts/cargo-release-publish.sh 0000755 0000000 0000000 00000000736 10461020230 0020306 0 ustar 0000000 0000000 #!/bin/bash
# Use cargo-release to publish crates to crates.io.
set -xe -o pipefail
# cargo-release requires a release off a branch (maybe it shouldn't?)
# Check out this branch, creating it if it doesn't exist.
git checkout -B to-release
# --execute: actually does the release
# --no-confirm: don't ask for confirmation, since this is a non-interactive script
cargo release publish --publish --execute --no-confirm --workspace "$@"
git checkout -
git branch -D to-release
quick-junit-0.3.6/scripts/fix-readmes.awk 0000644 0000000 0000000 00000001057 10461020230 0016477 0 ustar 0000000 0000000 # Fix up readmes:
# * Replace ## with # in code blocks.
# * Remove [] without a following () from output.
BEGIN {
true = 1
false = 0
in_block = false
}
{
if (!in_block && $0 ~ /^```/) {
in_block = true
} else if (in_block && $0 ~ /^```$/) {
in_block = false
}
if (in_block) {
sub(/## /, "# ")
print $0
} else {
# Strip [] without a () that immediately follows them from
# the output.
subbed = gensub(/\[([^\[]+)]([^\(]|$)/, "\\1\\2", "g")
print subbed
}
}
quick-junit-0.3.6/scripts/regenerate-readmes.sh 0000755 0000000 0000000 00000000724 10461020230 0017665 0 ustar 0000000 0000000 #!/usr/bin/env bash
# Copyright (c) The cargo-guppy Contributors
# SPDX-License-Identifier: MIT OR Apache-2.0
# Regenerate readme files in this repository.
set -eo pipefail
cd "$(git rev-parse --show-toplevel)"
git ls-files | grep README.tpl$ | while read -r readme; do
dir=$(dirname "$readme")
cargo readme --project-root "$dir" > "$dir/README.md.tmp"
gawk -f "scripts/fix-readmes.awk" "$dir/README.md.tmp" > "$dir/README.md"
rm "$dir/README.md.tmp"
done
quick-junit-0.3.6/src/errors.rs 0000644 0000000 0000000 00000000677 10461020230 0014560 0 ustar 0000000 0000000 // Copyright (c) The nextest Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
use thiserror::Error;
/// An error that occurs while serializing a [`Report`](crate::Report).
///
/// Returned by [`Report::serialize`](crate::Report::serialize) and
/// [`Report::to_string`](crate::Report::to_string).
#[derive(Debug, Error)]
#[error("error serializing JUnit report")]
pub struct SerializeError {
#[from]
inner: quick_xml::Error,
}
quick-junit-0.3.6/src/lib.rs 0000644 0000000 0000000 00000006156 10461020230 0014010 0 ustar 0000000 0000000 // Copyright (c) The nextest Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
#![warn(missing_docs)]
//! `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/nextest/blob/main/quick-junit/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.
mod errors;
mod report;
mod serialize;
pub use errors::*;
pub use report::*;
quick-junit-0.3.6/src/report.rs 0000644 0000000 0000000 00000054201 10461020230 0014547 0 ustar 0000000 0000000 // Copyright (c) The nextest Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
use crate::{serialize::serialize_report, SerializeError};
use chrono::{DateTime, FixedOffset};
use indexmap::map::IndexMap;
use std::{io, iter, time::Duration};
use uuid::Uuid;
/// The root element of a JUnit report.
#[derive(Clone, Debug)]
pub struct Report {
/// The name of this report.
pub name: String,
/// A unique identifier associated with this report.
///
/// This is an extension to the spec that's used by nextest.
pub uuid: Option,
/// The time at which the first test in this report began execution.
///
/// This is not part of the JUnit spec, but may be useful for some tools.
pub timestamp: Option>,
/// The overall time taken by the test suite.
///
/// This is serialized as the number of seconds.
pub time: Option,
/// The total number of tests from all TestSuites.
pub tests: usize,
/// The total number of failures from all TestSuites.
pub failures: usize,
/// The total number of errors from all TestSuites.
pub errors: usize,
/// The test suites contained in this report.
pub test_suites: Vec,
}
impl Report {
/// Creates a new `Report` with the given name.
pub fn new(name: impl Into) -> Self {
Self {
name: name.into(),
uuid: None,
timestamp: None,
time: None,
tests: 0,
failures: 0,
errors: 0,
test_suites: vec![],
}
}
/// Sets a unique ID for this `Report`.
///
/// This is an extension that's used by nextest.
pub fn set_uuid(&mut self, uuid: Uuid) -> &mut Self {
self.uuid = Some(uuid);
self
}
/// Sets the start timestamp for the report.
pub fn set_timestamp(&mut self, timestamp: impl Into>) -> &mut Self {
self.timestamp = Some(timestamp.into());
self
}
/// Sets the time taken for overall execution.
pub fn set_time(&mut self, time: Duration) -> &mut Self {
self.time = Some(time);
self
}
/// Adds a new TestSuite and updates the `tests`, `failures` and `errors` counts.
///
/// When generating a new report, use of this method is recommended over adding to
/// `self.TestSuites` directly.
pub fn add_test_suite(&mut self, test_suite: TestSuite) -> &mut Self {
self.tests += test_suite.tests;
self.failures += test_suite.failures;
self.errors += test_suite.errors;
self.test_suites.push(test_suite);
self
}
/// Adds several [`TestSuite`]s and updates the `tests`, `failures` and `errors` counts.
///
/// When generating a new report, use of this method is recommended over adding to
/// `self.TestSuites` directly.
pub fn add_test_suites(
&mut self,
test_suites: impl IntoIterator- ,
) -> &mut Self {
for test_suite in test_suites {
self.add_test_suite(test_suite);
}
self
}
/// Serialize this report to the given writer.
pub fn serialize(&self, writer: impl io::Write) -> Result<(), SerializeError> {
serialize_report(self, writer)
}
/// Serialize this report to a string.
pub fn to_string(&self) -> Result {
let mut buf: Vec = vec![];
self.serialize(&mut buf)?;
String::from_utf8(buf).map_err(|utf8_err| quick_xml::Error::from(utf8_err).into())
}
}
/// Represents a single TestSuite.
///
/// A `TestSuite` groups together several `TestCase` instances.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct TestSuite {
/// The name of this TestSuite.
pub name: String,
/// The total number of tests in this TestSuite.
pub tests: usize,
/// The total number of disabled tests in this TestSuite.
pub disabled: usize,
/// The total number of tests in this suite that errored.
///
/// An "error" is usually some sort of *unexpected* issue in a test.
pub errors: usize,
/// The total number of tests in this suite that failed.
///
/// A "failure" is usually some sort of *expected* issue in a test.
pub failures: usize,
/// The time at which the TestSuite began execution.
pub timestamp: Option>,
/// The overall time taken by the TestSuite.
pub time: Option,
/// The test cases that form this TestSuite.
pub test_cases: Vec,
/// Custom properties set during test execution, e.g. environment variables.
pub properties: Vec,
/// Data written to standard output while the TestSuite was executed.
pub system_out: Option