expectorate 1.2.0

Library for comparing output to file contents with simple updating
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

// Copyright 2025 Oxide Computer Company

use std::{fmt::Display, path::PathBuf};

use predicates::{reflection::PredicateReflection, Predicate};

/// Creates a new predicate that ensures equality with the given file.
///
/// To accept changes to the file, run with `EXPECTORATE=overwrite`.
#[cfg_attr(docsrs, doc(cfg(feature = "predicates")))]
pub fn eq_file(path: impl Into<PathBuf>) -> FilePredicate {
    let path = path.into();
    FilePredicate { path, panic: false }
}

/// Creates a new predicate that ensures equality with the given file and
/// panics if there's a mismatch.
///
/// To accept changes to the file, run with `EXPECTORATE=overwrite`.
#[cfg_attr(docsrs, doc(cfg(feature = "predicates")))]
pub fn eq_file_or_panic(path: impl Into<PathBuf>) -> FilePredicate {
    let path = path.into();
    FilePredicate { path, panic: true }
}

pub struct FilePredicate {
    path: PathBuf,
    panic: bool,
}

impl Display for FilePredicate {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} {}", self.path.display(), self.panic)
    }
}

impl Predicate<str> for FilePredicate {
    fn eval(&self, actual: &str) -> bool {
        match crate::assert_contents_impl(
            &self.path,
            actual,
            crate::OverwriteMode::from_env(),
        ) {
            Err(e) if self.panic => {
                panic!("assertion failed: {e}")
            }
            Err(e) => {
                println!("{e}");
                false
            }
            Ok(_) => true,
        }
    }

    fn find_case<'a>(
        &'a self,
        expected: bool,
        variable: &str,
    ) -> Option<predicates::reflection::Case<'a>> {
        let actual = self.eval(variable);
        if expected == actual {
            Some(predicates::reflection::Case::new(None, actual))
        } else {
            None
        }
    }
}

impl PredicateReflection for FilePredicate {}

#[cfg(test)]
mod test {
    use predicates::Predicate;

    use crate::eq_file;

    #[test]
    fn predicates_good() {
        let actual = include_str!("../tests/data_a.txt");
        assert!(eq_file("tests/data_a.txt").eval(actual));
    }

    #[test]
    #[should_panic]
    fn predicates_bad() {
        let actual = include_str!("../tests/data_a.txt");
        assert!(eq_file("tests/data_b.txt").eval(actual));
    }

    #[test]
    #[should_panic]
    fn predicates_one_line_change() {
        let actual = include_str!("../tests/data_a.txt");
        assert!(eq_file("tests/data_a2.txt").eval(actual));
    }
}