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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
|
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
use std::cell::RefCell;
use std::collections::HashMap;
use std::io::Read;
use std::io::Write;
use std::path::Path;
use std::path::PathBuf;
use std::process::Command;
use std::process::Stdio;
use std::rc::Rc;
use backtrace::Backtrace;
use os_pipe::pipe;
use pretty_assertions::assert_eq;
use crate::copy_dir_recursive;
use crate::deno_exe_path;
use crate::http_server;
use crate::new_deno_dir;
use crate::strip_ansi_codes;
use crate::testdata_path;
use crate::wildcard_match;
use crate::HttpServerGuard;
use crate::TempDir;
#[derive(Default)]
pub struct TestContextBuilder {
use_http_server: bool,
use_temp_cwd: bool,
/// Copies the files at the specified directory in the "testdata" directory
/// to the temp folder and runs the test from there. This is useful when
/// the test creates files in the testdata directory (ex. a node_modules folder)
copy_temp_dir: Option<String>,
cwd: Option<String>,
envs: HashMap<String, String>,
}
impl TestContextBuilder {
pub fn new() -> Self {
Self::default()
}
pub fn use_http_server(&mut self) -> &mut Self {
self.use_http_server = true;
self
}
pub fn use_temp_cwd(&mut self) -> &mut Self {
self.use_temp_cwd = true;
self
}
/// Copies the files at the specified directory in the "testdata" directory
/// to the temp folder and runs the test from there. This is useful when
/// the test creates files in the testdata directory (ex. a node_modules folder)
pub fn use_copy_temp_dir(&mut self, dir: impl AsRef<str>) {
self.copy_temp_dir = Some(dir.as_ref().to_string());
}
pub fn set_cwd(&mut self, cwd: impl AsRef<str>) -> &mut Self {
self.cwd = Some(cwd.as_ref().to_string());
self
}
pub fn env(
&mut self,
key: impl AsRef<str>,
value: impl AsRef<str>,
) -> &mut Self {
self
.envs
.insert(key.as_ref().to_string(), value.as_ref().to_string());
self
}
pub fn build(&self) -> TestContext {
let deno_dir = new_deno_dir(); // keep this alive for the test
let testdata_dir = if let Some(temp_copy_dir) = &self.copy_temp_dir {
let test_data_path = testdata_path().join(temp_copy_dir);
let temp_copy_dir = deno_dir.path().join(temp_copy_dir);
std::fs::create_dir_all(&temp_copy_dir).unwrap();
copy_dir_recursive(&test_data_path, &temp_copy_dir).unwrap();
deno_dir.path().to_owned()
} else {
testdata_path()
};
let deno_exe = deno_exe_path();
println!("deno_exe path {}", deno_exe.display());
let http_server_guard = if self.use_http_server {
Some(Rc::new(http_server()))
} else {
None
};
TestContext {
cwd: self.cwd.clone(),
envs: self.envs.clone(),
use_temp_cwd: self.use_temp_cwd,
_http_server_guard: http_server_guard,
deno_dir,
testdata_dir,
}
}
}
#[derive(Clone)]
pub struct TestContext {
envs: HashMap<String, String>,
use_temp_cwd: bool,
cwd: Option<String>,
_http_server_guard: Option<Rc<HttpServerGuard>>,
deno_dir: TempDir,
testdata_dir: PathBuf,
}
impl Default for TestContext {
fn default() -> Self {
TestContextBuilder::default().build()
}
}
impl TestContext {
pub fn with_http_server() -> Self {
TestContextBuilder::default().use_http_server().build()
}
pub fn testdata_path(&self) -> &PathBuf {
&self.testdata_dir
}
pub fn deno_dir(&self) -> &TempDir {
&self.deno_dir
}
pub fn new_command(&self) -> TestCommandBuilder {
TestCommandBuilder {
command_name: Default::default(),
args: Default::default(),
args_vec: Default::default(),
stdin: Default::default(),
envs: Default::default(),
env_clear: Default::default(),
cwd: Default::default(),
context: self.clone(),
}
}
}
pub struct TestCommandBuilder {
command_name: Option<String>,
args: String,
args_vec: Vec<String>,
stdin: Option<String>,
envs: HashMap<String, String>,
env_clear: bool,
cwd: Option<String>,
context: TestContext,
}
impl TestCommandBuilder {
pub fn command_name(&mut self, name: impl AsRef<str>) -> &mut Self {
self.command_name = Some(name.as_ref().to_string());
self
}
pub fn args(&mut self, text: impl AsRef<str>) -> &mut Self {
self.args = text.as_ref().to_string();
self
}
pub fn args_vec(&mut self, args: Vec<String>) -> &mut Self {
self.args_vec = args;
self
}
pub fn stdin(&mut self, text: impl AsRef<str>) -> &mut Self {
self.stdin = Some(text.as_ref().to_string());
self
}
pub fn env(
&mut self,
key: impl AsRef<str>,
value: impl AsRef<str>,
) -> &mut Self {
self
.envs
.insert(key.as_ref().to_string(), value.as_ref().to_string());
self
}
pub fn env_clear(&mut self) -> &mut Self {
self.env_clear = true;
self
}
pub fn cwd(&mut self, cwd: impl AsRef<str>) -> &mut Self {
self.cwd = Some(cwd.as_ref().to_string());
self
}
pub fn run(&self) -> TestCommandOutput {
let cwd = self.cwd.as_ref().or(self.context.cwd.as_ref());
let cwd = if self.context.use_temp_cwd {
assert!(cwd.is_none());
self.context.deno_dir.path().to_owned()
} else if let Some(cwd_) = cwd {
self.context.testdata_dir.join(cwd_)
} else {
self.context.testdata_dir.clone()
};
let args = if self.args_vec.is_empty() {
std::borrow::Cow::Owned(
self
.args
.split_whitespace()
.map(|s| s.to_string())
.collect::<Vec<_>>(),
)
} else {
assert!(
self.args.is_empty(),
"Do not provide args when providing args_vec."
);
std::borrow::Cow::Borrowed(&self.args_vec)
}
.iter()
.map(|arg| {
arg.replace("$TESTDATA", &self.context.testdata_dir.to_string_lossy())
})
.collect::<Vec<_>>();
let (mut reader, writer) = pipe().unwrap();
let command_name = self
.command_name
.as_ref()
.cloned()
.unwrap_or("deno".to_string());
let mut command = if command_name == "deno" {
Command::new(deno_exe_path())
} else {
Command::new(&command_name)
};
command.env("DENO_DIR", self.context.deno_dir.path());
println!("command {} {}", command_name, args.join(" "));
println!("command cwd {:?}", &cwd);
command.args(args.iter());
if self.env_clear {
command.env_clear();
}
command.envs({
let mut envs = self.context.envs.clone();
for (key, value) in &self.envs {
envs.insert(key.to_string(), value.to_string());
}
envs
});
command.current_dir(cwd);
command.stdin(Stdio::piped());
let writer_clone = writer.try_clone().unwrap();
command.stderr(writer_clone);
command.stdout(writer);
let mut process = command.spawn().unwrap();
if let Some(input) = &self.stdin {
let mut p_stdin = process.stdin.take().unwrap();
write!(p_stdin, "{input}").unwrap();
}
// This parent process is still holding its copies of the write ends,
// and we have to close them before we read, otherwise the read end
// will never report EOF. The Command object owns the writers now,
// and dropping it closes them.
drop(command);
let mut actual = String::new();
reader.read_to_string(&mut actual).unwrap();
let status = process.wait().expect("failed to finish process");
let exit_code = status.code();
#[cfg(unix)]
let signal = {
use std::os::unix::process::ExitStatusExt;
status.signal()
};
#[cfg(not(unix))]
let signal = None;
actual = strip_ansi_codes(&actual).to_string();
// deno test's output capturing flushes with a zero-width space in order to
// synchronize the output pipes. Occassionally this zero width space
// might end up in the output so strip it from the output comparison here.
if args.first().map(|s| s.as_str()) == Some("test") {
actual = actual.replace('\u{200B}', "");
}
TestCommandOutput {
exit_code,
signal,
text: actual,
testdata_dir: self.context.testdata_dir.clone(),
asserted_exit_code: RefCell::new(false),
asserted_text: RefCell::new(false),
_test_context: self.context.clone(),
}
}
}
pub struct TestCommandOutput {
text: String,
exit_code: Option<i32>,
signal: Option<i32>,
testdata_dir: PathBuf,
asserted_text: RefCell<bool>,
asserted_exit_code: RefCell<bool>,
// keep alive for the duration of the output reference
_test_context: TestContext,
}
impl Drop for TestCommandOutput {
fn drop(&mut self) {
if std::thread::panicking() {
return;
}
// force the caller to assert these
if !*self.asserted_exit_code.borrow() && self.exit_code != Some(0) {
panic!(
"The non-zero exit code of the command was not asserted: {:?} at {}.",
self.exit_code,
failed_position(),
)
}
if !*self.asserted_text.borrow() && !self.text.is_empty() {
println!("OUTPUT\n{}\nOUTPUT", self.text);
panic!(
concat!(
"The non-empty text of the command was not asserted. ",
"Call `output.skip_output_check()` to skip if necessary at {}.",
),
failed_position()
);
}
}
}
impl TestCommandOutput {
pub fn testdata_dir(&self) -> &PathBuf {
&self.testdata_dir
}
pub fn skip_output_check(&self) {
*self.asserted_text.borrow_mut() = true;
}
pub fn skip_exit_code_check(&self) {
*self.asserted_exit_code.borrow_mut() = true;
}
pub fn exit_code(&self) -> Option<i32> {
self.skip_exit_code_check();
self.exit_code
}
pub fn signal(&self) -> Option<i32> {
self.signal
}
pub fn text(&self) -> &str {
self.skip_output_check();
&self.text
}
pub fn assert_exit_code(&self, expected_exit_code: i32) -> &Self {
let actual_exit_code = self.exit_code();
if let Some(exit_code) = &actual_exit_code {
if *exit_code != expected_exit_code {
println!("OUTPUT\n{}\nOUTPUT", self.text());
panic!(
"bad exit code, expected: {:?}, actual: {:?} at {}",
expected_exit_code,
exit_code,
failed_position(),
);
}
} else {
println!("OUTPUT\n{}\nOUTPUT", self.text());
if let Some(signal) = self.signal() {
panic!(
"process terminated by signal, expected exit code: {:?}, actual signal: {:?} at {}",
actual_exit_code,
signal,
failed_position(),
);
} else {
panic!(
"process terminated without status code on non unix platform, expected exit code: {:?} at {}",
actual_exit_code,
failed_position(),
);
}
}
self
}
pub fn assert_matches_text(&self, expected_text: impl AsRef<str>) -> &Self {
let expected_text = expected_text.as_ref();
let actual = self.text();
if !expected_text.contains("[WILDCARD]") {
assert_eq!(actual, expected_text, "at {}", failed_position());
} else if !wildcard_match(expected_text, actual) {
println!("OUTPUT START\n{actual}\nOUTPUT END");
println!("EXPECTED START\n{expected_text}\nEXPECTED END");
panic!("pattern match failed at {}", failed_position());
}
self
}
pub fn assert_matches_file(&self, file_path: impl AsRef<Path>) -> &Self {
let output_path = self.testdata_dir().join(file_path);
println!("output path {}", output_path.display());
let expected_text =
std::fs::read_to_string(&output_path).unwrap_or_else(|err| {
panic!("failed loading {}\n\n{err:#}", output_path.display())
});
self.assert_matches_text(expected_text)
}
}
fn failed_position() -> String {
let backtrace = Backtrace::new();
for frame in backtrace.frames() {
for symbol in frame.symbols() {
if let Some(filename) = symbol.filename() {
if !filename.to_string_lossy().ends_with("builders.rs") {
let line_num = symbol.lineno().unwrap_or(0);
let line_col = symbol.colno().unwrap_or(0);
return format!("{}:{}:{}", filename.display(), line_num, line_col);
}
}
}
}
"<unknown>".to_string()
}
|