https://github.com/quark-zju/cargo-fixeq
Fix `assert_eq!` test errors automatically.
https://github.com/quark-zju/cargo-fixeq
cargo rust
Last synced: about 1 month ago
JSON representation
Fix `assert_eq!` test errors automatically.
- Host: GitHub
- URL: https://github.com/quark-zju/cargo-fixeq
- Owner: quark-zju
- License: mit
- Created: 2020-01-12T02:16:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-20T05:39:09.000Z (over 1 year ago)
- Last Synced: 2025-04-04T02:41:26.851Z (about 2 months ago)
- Topics: cargo, rust
- Language: Rust
- Homepage:
- Size: 38.1 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `cargo-fixeq`
Fix `assert_eq!` test errors by editing the source code to match the test output.
Inspired by [Mercurial's `run-tests.py -i`](https://www.mercurial-scm.org/repo/hg/rev/02e9355c3420).
## Installation
```bash
cargo install cargo-fixeq
```
## Example
Write tests using `assert_eq!` as usual. Put the code to evaluate on the left, leave a dummy value on the right:
```rust
fn f(n: usize) -> usize {
if n <= 2 { 1 } else { f(n - 1) + f(n - 2) }
}
#[test]
fn test_f() {
assert_eq!(f(10), 0);
assert_eq!(f(20), 0);
}
```
Run `cargo fixeq` from the project root:
```bash
cargo fixeq
```
The dummy values are fixed automatically:
```diff
fn test_f() {
- assert_eq!(f(10), 0);
- assert_eq!(f(20), 0);
+ assert_eq!(f(10), 55);
+ assert_eq!(f(20), 6765);
}
```
In general, `cargo-fixeq` can be helpful for writing initial tests and updating tests. See [here](https://github.com/facebookexperimental/eden/blob/213b3f086c349e84871add20ac8b5641397c62bf/eden/scm/lib/renderdag/src/box_drawing.rs#L321-L340) for a more complicated real world example.
## Command-line Parameters
All parameters are passed to `cargo test`. `cargo-fixeq` does not define its own parameters.
## Versions
- `cargo-fixeq 0.5` works for Rust >= 1.73, which [changed `assert_eq!` output format](https://github.com/rust-lang/rust/commit/950e3d9989c6ebbf7b43961e4268bd3e403a84bb).
- `cargo-fixeq 0.4` works for Rust < 1.73.
## Similar Projects
- [expect-test](https://github.com/rust-analyzer/expect-test): Lightweight snapshot testing.