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

//! Goldenfile tests generate one or more output files as they run. If any files
//! differ from their checked-in "golden" version, the test fails. This ensures
//! that behavioral changes are intentional, explicit, and version controlled.
//!
//! # Example
//!
//! ```rust
//! use goldenfile::Mint;
//! use std::io::Write;
//!
//! let mut mint = Mint::new("tests/goldenfiles");
//! let mut file1 = mint.new_goldenfile("file1.txt").unwrap();
//! let mut file2 = mint.new_goldenfile("file2.txt").unwrap();
//!
//! writeln!(file1, "Hello world!").unwrap();
//! writeln!(file2, "Foo bar!").unwrap();
//! ```
//!
//! When the `Mint` goes out of scope, it compares the contents of each file
//! to its checked-in golden version and fails the test if they differ. To
//! update the checked-in versions, run:
//! ```sh
//! UPDATE_GOLDENFILES=1 cargo test
//! ```

#![deny(missing_docs)]

#[macro_use(defer_on_unwind)]
extern crate scopeguard;

pub mod differs;
pub mod mint;

pub use mint::*;