Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/josecelano/cargo-pretty-test
A Rust command that prettifies the ugly `cargo test` output into a beautiful one.
https://github.com/josecelano/cargo-pretty-test
hacktoberfest rust-lang testing
Last synced: about 2 months ago
JSON representation
A Rust command that prettifies the ugly `cargo test` output into a beautiful one.
- Host: GitHub
- URL: https://github.com/josecelano/cargo-pretty-test
- Owner: josecelano
- Created: 2023-09-21T15:45:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-11T02:32:42.000Z (10 months ago)
- Last Synced: 2024-07-05T02:16:49.799Z (3 months ago)
- Topics: hacktoberfest, rust-lang, testing
- Language: Rust
- Homepage: https://users.rust-lang.org/t/cargo-test-output-with-indentation/100149
- Size: 115 KB
- Stars: 133
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cargo Pretty Test ✨
[](https://github.com/josecelano/pretty-test/actions/workflows/testing.yaml)
[](https://crates.io/crates/cargo-pretty-test)
[](https://docs.rs/cargo-pretty-test)
A Rust command-line tool that prettifies the ugly `cargo test` output into a beautiful output.
This crate can be also used as a library that [fully parses][parsing] the output from `cargo test`.
[parsing]: https://docs.rs/cargo-pretty-test/*/cargo_pretty_test/parsing/index.html
```console
$ cargo pretty-test --workspace --no-fail-fast
Error details from `cargo test` if any ... (Omitted here)
Generated by cargo-pretty-test
├── (OK) cargo_pretty_test ... (4 tests in 0.16s: ✅ 4)
│ ├── (OK) tests/golden_master_test.rs ... (1 tests in 0.00s: ✅ 1)
│ │ └─ ✅ golden_master_test
│ ├── (OK) tests/mocking_project.rs ... (2 tests in 0.16s: ✅ 2)
│ │ ├─ ✅ snapshot_testing_for_parsed_output
│ │ └─ ✅ snapshot_testing_for_pretty_output
│ └── (OK) tests/parsing.rs ... (1 tests in 0.00s: ✅ 1)
│ └─ ✅ parse_stderr_stdout
├── (FAIL) integration ... (10 tests in 0.00s: ✅ 6; ❌ 2; 🔕 2)
│ ├── (FAIL) src/lib.rs ... (8 tests in 0.00s: ✅ 4; ❌ 2; 🔕 2)
│ │ ├── submod
│ │ │ ├─ 🔕 ignore
│ │ │ ├─ 🔕 ignore_without_reason
│ │ │ ├─ ✅ normal_test
│ │ │ └── panic
│ │ │ ├─ ❌ panicked
│ │ │ ├─ ✅ should_panic - should panic
│ │ │ ├─ ❌ should_panic_but_didnt - should panic
│ │ │ └─ ✅ should_panic_without_reanson - should panic
│ │ └─ ✅ works
│ ├── (OK) src/main.rs ... (1 tests in 0.00s: ✅ 1)
│ │ └─ ✅ from_main_rs
│ └── (OK) tests/parsing.rs ... (1 tests in 0.00s: ✅ 1)
│ └─ ✅ from_integration
└── (OK) Doc Tests ... (2 tests in 0.41s: ✅ 2)
├── (OK) cargo-pretty-test ... (1 tests in 0.20s: ✅ 1)
│ └─ ✅ src/doc.rs - doc (line 3)
└── (OK) integration ... (1 tests in 0.21s: ✅ 1)
└─ ✅ tests/integration/src/lib.rs - doc (line 41)
Status: FAIL; total 16 tests in 0.57s: 12 passed; 2 failed; 2 ignored; 0 measured; 0 filtered out
```
[More screenshots.](https://github.com/josecelano/cargo-pretty-test/wiki/cargo%E2%80%90pretty%E2%80%90test-screenshots)
## Usage
Install:
```console
cargo install cargo-pretty-test
```
Run in your project:
```console
cargo pretty-test
```
Note: all the arguments passed to `cargo pretty-test` are forwarded to `cargo test`.
---
Run in CI as a summary: [demo](https://github.com/josecelano/cargo-pretty-test/actions/runs/6334295212)
```console
- id: pretty-test
name: Run cargo pretty-test
run: |
cargo install cargo-pretty-test
cargo pretty-test --color=always
echo '```text' >> $GITHUB_STEP_SUMMARY
echo "$(cargo pretty-test --color=never)" >> $GITHUB_STEP_SUMMARY 2>&1
echo '```' >> $GITHUB_STEP_SUMMARY
```
Note: `--color=always` produces texts in color when running CI, and `--color=never`
strips ANSI escapes before written to summary.
## Credits
- First commit author [@ZJPzjp](https://github.com/zjp-CN).
- Idea described on [https://users.rust-lang.org](https://users.rust-lang.org/t/cargo-test-output-with-indentation/100149) by [@josecelano](https://github.com/josecelano).
### Links
-
-