summaryrefslogtreecommitdiffstats
path: root/vendor/snapbox/README.md
blob: 3e6c9b68dada398b9c6a490dc79a49db05c9a9a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# snapbox

> When you have to treat your tests like pets, instead of [cattle][trycmd]

[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
![License](https://img.shields.io/crates/l/snapbox.svg)
[![Crates Status](https://img.shields.io/crates/v/snapbox.svg)](https://crates.io/crates/snapbox)

`snapbox` is a snapshot-testing toolbox that is ready to use for verifying output from
- Function return values
- CLI stdout/stderr
- Filesystem changes

It is also flexible enough to build your own test harness like [trycmd].

See the [docs](http://docs.rs/snapbox) for more.

## License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.

[Crates.io]: https://crates.io/crates/snapbox
[Documentation]: https://docs.rs/snapbox
[trycmd]: https://crates.io/crates/trycmd