goldenfile 1.11.0

Simple goldenfile testing library
Documentation 
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Functions for comparing files.

use std::fs;
use std::io;
use std::io::{BufReader, Read};
use std::path::Path;

use similar_asserts;

/// A function that displays a diff and panics if two files to not match.
pub type Differ = Box<dyn Fn(&Path, &Path) + Send + Sync>;

/// Compare unicode text files. Print a colored diff and panic on failure.
pub fn text_diff(old: &Path, new: &Path) {
    let old_str = String::from_utf8(check_io(fs::read(old), "reading file", old));
    let new_str = String::from_utf8(check_io(fs::read(new), "reading file", new));

    match (old_str, new_str) {
        (Ok(old_str), Ok(new_str)) => {
            similar_asserts::assert_eq!(&old_str, &new_str, "{}", old.display())
        }
        _ => binary_diff(old, new),
    }
}

/// Panic if binary files differ with some basic information about where they
/// differ.
pub fn binary_diff(old: &Path, new: &Path) {
    let old_len = file_len(old);
    let new_len = file_len(new);
    if old_len != new_len {
        panic!(
            "File sizes differ: Old file is {} bytes, new file is {} bytes",
            old_len, new_len
        );
    }

    let first_difference = file_byte_iter(old)
        .zip(file_byte_iter(new))
        .position(|(old_byte, new_byte)| old_byte != new_byte);

    if let Some(position) = first_difference {
        panic!("{}: Files differ at byte {}", old.display(), position + 1);
    }
}

fn open_file(path: &Path) -> fs::File {
    check_io(fs::File::open(path), "opening file", path)
}

fn file_byte_iter(path: &Path) -> impl Iterator<Item = u8> + '_ {
    BufReader::new(open_file(path))
        .bytes()
        .map(move |b| check_io(b, "reading file", path))
}

fn file_len(path: &Path) -> u64 {
    check_io(fs::metadata(path), "getting file length", path).len()
}

fn check_io<T>(x: Result<T, io::Error>, message: &str, path: &Path) -> T {
    x.unwrap_or_else(|err| panic!("Error {} {:?}: {:?}", message, path, err))
}