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
214
use std::{
env, fmt,
fs::{create_dir_all, File},
io::Read,
ops::Deref,
path::Path,
};
use tracing::{debug, error};
use crate::paths;
#[must_use]
pub struct TestOutput<R> {
pub errors: StdErr,
pub result: R,
}
pub type StdErr = NormalizedOutput;
#[derive(Debug, Clone, Hash)]
pub struct Diff {
pub actual: NormalizedOutput,
pub expected: NormalizedOutput,
}
#[derive(Clone, Ord, PartialOrd, PartialEq, Eq, Default, Hash)]
pub struct NormalizedOutput(String);
impl fmt::Display for NormalizedOutput {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
fmt::Display::fmt(&self.0, f)
}
}
impl fmt::Debug for NormalizedOutput {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
fmt::Display::fmt(&self.0, f)
}
}
fn normalize_input(input: String, skip_last_newline: bool) -> String {
let manifest_dirs = vec![
adjust_canonicalization(paths::manifest_dir()),
paths::manifest_dir().to_string_lossy().to_string(),
adjust_canonicalization(paths::manifest_dir()).replace('\\', "\\\\"),
paths::manifest_dir()
.to_string_lossy()
.replace('\\', "\\\\"),
];
let input = input.replace("\r\n", "\n");
let mut buf = String::new();
for line in input.lines() {
if manifest_dirs.iter().any(|dir| line.contains(&**dir)) {
let mut s = line.to_string();
for dir in &manifest_dirs {
s = s.replace(&**dir, "$DIR");
}
s = s.replace("\\\\", "\\").replace('\\', "/");
let s = if cfg!(target_os = "windows") {
s.replace("//?/$DIR", "$DIR").replace("/?/$DIR", "$DIR")
} else {
s
};
buf.push_str(&s)
} else {
buf.push_str(line);
}
buf.push('\n');
}
if skip_last_newline && !matches!(input.chars().last(), Some('\n')) {
buf.truncate(buf.len() - 1);
}
buf
}
impl NormalizedOutput {
pub fn new_raw(s: String) -> Self {
if s.is_empty() {
return NormalizedOutput(s);
}
NormalizedOutput(normalize_input(s, true))
}
pub fn compare_to_file<P>(self, path: P) -> Result<(), Diff>
where
P: AsRef<Path>,
{
let path = path.as_ref();
let path = path.canonicalize().unwrap_or_else(|err| {
debug!(
"compare_to_file: failed to canonicalize outfile path `{}`: {:?}",
path.display(),
err
);
path.to_path_buf()
});
let expected: NormalizedOutput = NormalizedOutput(
File::open(&path)
.map(|mut file| {
let mut buf = String::new();
file.read_to_string(&mut buf).unwrap();
buf
})
.unwrap_or_else(|_| {
String::new()
})
.replace("\r\n", "\n"),
);
if expected == self {
return Ok(());
}
debug!("Comparing output to {}", path.display());
create_dir_all(path.parent().unwrap()).expect("failed to run `mkdir -p`");
if std::env::var("UPDATE").unwrap_or_default() == "1" {
crate::write_to_file(&path, &self.0);
error!(
"Assertion failed: \nActual file printed to {}",
path.display()
);
}
if self.0.lines().count() <= 5 {
assert_eq!(expected, self, "Actual:\n{}", self);
}
let diff = Diff {
expected,
actual: self,
};
if env::var("DIFF").unwrap_or_default() == "0" {
assert_eq!(diff.expected, diff.actual, "Actual:\n{}", diff.actual);
} else {
pretty_assertions::assert_eq!(diff.expected, diff.actual, "Actual:\n{}", diff.actual);
}
Err(diff)
}
}
impl From<String> for NormalizedOutput {
fn from(s: String) -> Self {
if s.is_empty() {
return NormalizedOutput(s);
}
NormalizedOutput(normalize_input(s, false))
}
}
impl Deref for NormalizedOutput {
type Target = str;
fn deref(&self) -> &str {
&self.0
}
}
pub type StdOut = NormalizedOutput;
impl<R> TestOutput<Option<R>> {
pub fn expect_err(self, _path: &Path) {}
}
#[cfg(not(target_os = "windows"))]
fn adjust_canonicalization<P: AsRef<Path>>(p: P) -> String {
p.as_ref().display().to_string()
}
#[cfg(target_os = "windows")]
fn adjust_canonicalization<P: AsRef<Path>>(p: P) -> String {
const VERBATIM_PREFIX: &str = r#"\\?\"#;
let p = p.as_ref().display().to_string();
if let Some(stripped) = p.strip_prefix(VERBATIM_PREFIX) {
stripped.to_string()
} else {
p
}
}