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
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
extern crate expectation_shared;
extern crate serde_json;

#[cfg(feature = "text")]
extern crate diff;

#[cfg(feature = "image")]
extern crate image;

pub mod extensions;
mod ipc;
mod provider;
#[cfg(test)]
mod test;

pub use provider::Provider;

use expectation_shared::filesystem::*;
use expectation_shared::{Result as EResult, ResultKind};
use std::collections::HashSet;
use std::path::{Path, PathBuf};

pub use provider::Writer;

fn should_continue(name: &str) -> bool {
    match std::env::var("CARGO_EXPECT_FILTER") {
        Ok(v) => name.contains(&v),
        Err(_) => true,
    }
}

fn file_filter(file: &Path) -> bool {
    match std::env::var("CARGO_EXPECT_FILES") {
        Ok(v) => v
            .split(",")
            .any(|ending| file.to_str().map(|f| f.ends_with(ending)).unwrap_or(false)),
        Err(_) => true,
    }
}

pub fn expect<F: FnOnce(Provider)>(name: &str, f: F) {
    if !name.starts_with("expectation_test_") {
        panic!("expectation test {} is an invalid test name.  It must start with \"expectation_test_\"", name);
    }

    let name = name.trim_left_matches("expectation_test_");
    if !should_continue(name) {
        return;
    }

    let top_fs = RealFileSystem {
        root: Path::new("./").canonicalize().unwrap(),
    }.subsystem(Path::new("expectation-tests"));
    let act_fs = top_fs
        .subsystem(Path::new("actual"))
        .subsystem(Path::new(name));
    let provider = Provider::new(top_fs.duplicate(), act_fs.duplicate());
    f(provider.clone());

    let mut succeeded = true;
    let results = validate(name, top_fs, provider, file_filter);

    ipc::send(name, &results);

    for result in results {
        match result.kind {
            ResultKind::Ok => {}
            ResultKind::ActualNotFound(double) => {
                println!("\"Actual\" file not found");
                println!("  expected          {}", double.expected.to_string_lossy());
                println!("  actual (missing)  {}", double.actual.to_string_lossy());
                succeeded = false;
            }
            ResultKind::ExpectedNotFound(double) => {
                println!("\"Expected\" file not found");
                println!(
                    "  expected (missing)  {}",
                    double.expected.to_string_lossy()
                );
                println!("  actual              {}", double.actual.to_string_lossy());
                succeeded = false;
            }
            ResultKind::Difference(tripple) => {
                println!("Files differ");
                println!("  expected  {}", tripple.expected.to_string_lossy());
                println!("  actual    {}", tripple.actual.to_string_lossy());
                match tripple.diffs.len() {
                    0 => {}
                    1 => println!("  diff      {}", tripple.diffs[0].to_string_lossy()),
                    _ => {
                        println!("  diffs");
                        for diff in tripple.diffs {
                            println!("    {}", diff.to_string_lossy());
                        }
                    }
                }
                succeeded = false;
            }
            _ => {}
        }
    }
    if !succeeded {
        panic!("Expectation test found some errors.");
    }
}

fn validate<Fi: Fn(&Path) -> bool>(
    name: &str,
    fs: Box<FileSystem>,
    provider: Provider,
    filter: Fi,
) -> Vec<EResult> {
    let mut visited = HashSet::new();
    let mut out = Vec::new();

    let expected_fs = fs
        .subsystem(Path::new("expected"))
        .subsystem(Path::new(name));
    let actual_fs = fs.subsystem(Path::new("actual")).subsystem(Path::new(name));
    let diff_fs = fs.subsystem(Path::new("diff")).subsystem(Path::new(name));

    #[allow(unused_variables)]
    let fs = ();

    for (file, eq, diff) in provider.take_files() {
        if !filter(&file) || visited.contains(&file) {
            continue;
        }
        visited.insert(file.clone());

        if !actual_fs.exists(&file) {
            out.push(EResult::actual_not_found(
                name,
                &file,
                actual_fs.full_path_for(&file),
                expected_fs.full_path_for(&file),
            ));
            continue;
        }

        if !expected_fs.exists(&file) {
            out.push(EResult::expected_not_found(
                name,
                &file,
                actual_fs.full_path_for(&file),
                expected_fs.full_path_for(&file),
            ));
            continue;
        }

        let mut is_eq = false;
        let res = actual_fs.read(&file, &mut |actual_read| {
            expected_fs.read(&file, &mut |expected_read| {
                is_eq = eq(actual_read, expected_read)?;
                Ok(())
            })
        });

        let is_eq = match res {
            Ok(_) => is_eq,
            Err(e) => {
                out.push(EResult::io_error(name, &file, e));
                continue;
            }
        };

        if !is_eq {
            let mut write_requester = provider::WriteRequester {
                fs: diff_fs.duplicate(),
                files: vec![],
            };

            let diff_result = actual_fs.read(&file, &mut |actual_read| {
                expected_fs.read(&file, &mut |expected_read| {
                    diff(actual_read, expected_read, &file, &mut write_requester)
                })
            });

            out.push(EResult::difference(
                name,
                &file,
                actual_fs.full_path_for(&file),
                expected_fs.full_path_for(&file),
                write_requester.files,
            ));

            if let Err(e) = diff_result {
                out.push(EResult::io_error(name, &file, e));
            }
            continue;
        }

        out.push(EResult::ok(name, &file));
    }

    for file in expected_fs.files() {
        if !filter(&file) || visited.contains(&file) {
            continue;
        }

        if !actual_fs.exists(&file) {
            out.push(EResult::actual_not_found(
                name,
                &file,
                actual_fs.full_path_for(&file),
                expected_fs.full_path_for(&file),
            ));
            continue;
        }
    }

    out
}