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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
use std::borrow::Cow;
use std::collections::BTreeMap;
use std::env;
use std::fmt;
use std::io;
use std::panic::{self, AssertUnwindSafe};
use std::path::{Path, PathBuf};
use std::sync::Arc;
use std::sync::atomic::AtomicUsize;
use std::sync::atomic::Ordering::SeqCst;
use rand::{self, Rand, SeedableRng, XorShiftRng};
use strategy::*;
mod failure_persistence;
mod config;
mod reason;
mod errors;
pub use self::failure_persistence::*;
pub use self::config::*;
pub use self::reason::*;
pub use self::errors::*;
type RejectionDetail = BTreeMap<Reason, u32>;
#[derive(Clone)]
pub struct TestRunner {
config: Config,
successes: u32,
local_rejects: u32,
global_rejects: u32,
rng: XorShiftRng,
flat_map_regens: Arc<AtomicUsize>,
local_reject_detail: RejectionDetail,
global_reject_detail: RejectionDetail,
source_file: Option<Cow<'static, Path>>,
}
impl fmt::Debug for TestRunner {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("TestRunner")
.field("config", &self.config)
.field("successes", &self.successes)
.field("local_rejects", &self.local_rejects)
.field("global_rejects", &self.global_rejects)
.field("rng", &"<XorShiftRng>")
.field("flat_map_regens", &self.flat_map_regens)
.field("local_reject_detail", &self.local_reject_detail)
.field("global_reject_detail", &self.global_reject_detail)
.field("source_file", &self.source_file)
.finish()
}
}
impl fmt::Display for TestRunner {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "\tsuccesses: {}\n\
\tlocal rejects: {}\n",
self.successes, self.local_rejects)?;
for (whence, count) in &self.local_reject_detail {
writeln!(f, "\t\t{} times at {}", count, whence)?;
}
writeln!(f, "\tglobal rejects: {}", self.global_rejects)?;
for (whence, count) in &self.global_reject_detail {
writeln!(f, "\t\t{} times at {}", count, whence)?;
}
Ok(())
}
}
impl Default for TestRunner {
fn default() -> Self {
Self::new(Config::default())
}
}
fn panic_guard<V, F>(case: &V, test: &F) -> TestCaseResult
where
F: Fn(&V) -> TestCaseResult
{
match panic::catch_unwind(AssertUnwindSafe(|| test(case))) {
Ok(r) => r,
Err(what) => Err(TestCaseError::Fail(
what.downcast::<&'static str>().map(|s| (*s).into())
.or_else(|what| what.downcast::<String>().map(|b| (*b).into()))
.or_else(|what| what.downcast::<Box<str>>().map(|b| (*b).into()))
.unwrap_or_else(|_| "<unknown panic value>".into()))),
}
}
impl TestRunner {
pub fn new(config: Config) -> Self {
TestRunner {
config: config,
successes: 0,
local_rejects: 0,
global_rejects: 0,
rng: rand::weak_rng(),
flat_map_regens: Arc::new(AtomicUsize::new(0)),
local_reject_detail: BTreeMap::new(),
global_reject_detail: BTreeMap::new(),
source_file: None,
}
}
pub(crate) fn partial_clone(&mut self) -> Self {
let rng = self.new_rng();
TestRunner {
config: self.config.clone(),
successes: 0,
local_rejects: 0,
global_rejects: 0,
rng: rng,
flat_map_regens: Arc::clone(&self.flat_map_regens),
local_reject_detail: BTreeMap::new(),
global_reject_detail: BTreeMap::new(),
source_file: self.source_file.clone(),
}
}
pub fn rng(&mut self) -> &mut XorShiftRng {
&mut self.rng
}
fn new_rng_seed(&mut self) -> [u32;4] {
let mut seed = <[u32;4] as Rand>::rand(&mut self.rng);
for word in &mut seed {
*word ^= 0xdead_beef;
}
seed
}
pub fn new_rng(&mut self) -> XorShiftRng {
XorShiftRng::from_seed(self.new_rng_seed())
}
pub fn config(&self) -> &Config {
&self.config
}
pub fn set_source_file(&mut self, source: &'static Path) {
self.set_source_file_with_cwd(env::current_dir, source)
}
pub(crate) fn set_source_file_with_cwd<F>(
&mut self, getcwd: F,
source: &'static Path)
where F : FnOnce () -> io::Result<PathBuf> {
self.source_file = if source.is_absolute() {
Some(Cow::Borrowed(source))
} else {
match getcwd() {
Ok(mut cwd) => {
loop {
let joined = cwd.join(source);
if joined.is_file() {
break Some(Cow::Owned(joined));
}
if !cwd.pop() {
eprintln!(
"proptest: Failed to find absolute path of \
source file '{:?}'. Ensure the test is \
being run from somewhere within the crate \
directory hierarchy.", source);
break None;
}
}
},
Err(e) => {
eprintln!("proptest: Failed to determine current \
directory, so the relative source path \
'{:?}' cannot be resolved: {}",
source, e);
None
}
}
}
}
pub(crate) fn source_file(&self) -> Option<&Path> {
self.source_file.as_ref().map(|cow| &**cow)
}
pub fn run<S : Strategy,
F : Fn (&ValueFor<S>) -> TestCaseResult>
(&mut self, strategy: &S, test: F)
-> Result<(), TestError<ValueFor<S>>>
{
let persist_path = self.config.failure_persistence.resolve(
self.source_file());
let old_rng = self.rng.clone();
for persisted_seed in load_persisted_failures(persist_path.as_ref()) {
self.rng = XorShiftRng::from_seed(persisted_seed);
self.gen_and_run_case(strategy, &test)?;
}
self.rng = old_rng;
while self.successes < self.config.cases {
let seed = self.new_rng_seed();
self.rng = XorShiftRng::from_seed(seed);
let result = self.gen_and_run_case(strategy, &test);
if let Err(TestError::Fail(_, ref value)) = result {
save_persisted_failure(persist_path.as_ref(), seed, value);
}
result?;
}
Ok(())
}
fn gen_and_run_case<S : Strategy, F : Fn (&ValueFor<S>) -> TestCaseResult>
(&mut self, strategy: &S, f: &F)
-> Result<(), TestError<ValueFor<S>>>
{
let case = match strategy.new_value(self) {
Ok(v) => v,
Err(msg) => return Err(TestError::Abort(msg)),
};
if self.run_one(case, f)? {
self.successes += 1;
}
Ok(())
}
pub fn run_one<V : ValueTree, F : Fn (&V::Value) -> TestCaseResult>
(&mut self, case: V, test: F) -> Result<bool, TestError<V::Value>>
{
let curr = case.current();
match panic_guard(&curr, &test) {
Ok(_) => Ok(true),
Err(TestCaseError::Fail(why)) => {
let (why, curr) = self.shrink(case, test).unwrap_or((why, curr));
Err(TestError::Fail(why, curr))
},
Err(TestCaseError::Reject(whence)) => {
self.reject_global(whence)?;
Ok(false)
},
}
}
fn shrink<V: ValueTree, F : Fn (&V::Value) -> TestCaseResult>
(&mut self, mut case: V, test: F) -> Option<(Reason, V::Value)>
{
let mut last_failure = None;
if case.simplify() {
loop {
let curr = case.current();
match panic_guard(&curr, &test) {
Ok(_) | Err(TestCaseError::Reject(..)) => {
if !case.complicate() {
break;
}
},
Err(TestCaseError::Fail(why)) => {
last_failure = Some((why, curr));
if !case.simplify() {
break;
}
},
}
}
}
last_failure
}
pub fn reject_local<R>(&mut self, whence: R) -> Result<(), Reason>
where
R: Into<Reason>
{
if self.local_rejects >= self.config.max_local_rejects {
Err("Too many local rejects".into())
} else {
self.local_rejects += 1;
Self::insert_or_increment(&mut self.local_reject_detail,
whence.into());
Ok(())
}
}
fn reject_global<T>(&mut self, whence: Reason) -> Result<(),TestError<T>> {
if self.global_rejects >= self.config.max_global_rejects {
Err(TestError::Abort("Too many global rejects".into()))
} else {
self.global_rejects += 1;
Self::insert_or_increment(&mut self.global_reject_detail, whence);
Ok(())
}
}
fn insert_or_increment(into: &mut RejectionDetail, whence: Reason) {
use std::collections::btree_map::Entry::*;
match into.entry(whence) {
Occupied(oe) => { *oe.into_mut() += 1; },
Vacant(ve) => { ve.insert(1); },
}
}
pub fn flat_map_regen(&self) -> bool {
self.flat_map_regens.fetch_add(1, SeqCst) <
self.config.max_flat_map_regens as usize
}
}
#[cfg(test)]
mod test {
use std::cell::Cell;
use std::fs;
use super::*;
use strategy::Strategy;
#[test]
fn gives_up_after_too_many_rejections() {
let config = Config::default();
let mut runner = TestRunner::new(config.clone());
let runs = Cell::new(0);
let result = runner.run(&(0u32..), |_| {
runs.set(runs.get() + 1);
Err(TestCaseError::reject("reject"))
});
match result {
Err(TestError::Abort(_)) => (),
e => panic!("Unexpected result: {:?}", e),
}
assert_eq!(config.max_global_rejects + 1, runs.get());
}
#[test]
fn test_pass() {
let mut runner = TestRunner::default();
let result = runner.run(&(1u32..), |&v| { assert!(v > 0); Ok(()) });
assert_eq!(Ok(()), result);
}
#[test]
fn test_fail_via_result() {
let mut runner = TestRunner::new(Config {
failure_persistence: FailurePersistence::Off,
.. Config::default()
});
let result = runner.run(
&(0u32..10u32), |&v| {
if v < 5 {
Ok(())
} else {
Err(TestCaseError::fail("not less than 5"))
}
});
assert_eq!(Err(TestError::Fail("not less than 5".into(), 5)), result);
}
#[test]
fn test_fail_via_panic() {
let mut runner = TestRunner::new(Config {
failure_persistence: FailurePersistence::Off,
.. Config::default()
});
let result = runner.run(&(0u32..10u32), |&v| {
assert!(v < 5, "not less than 5");
Ok(())
});
assert_eq!(Err(TestError::Fail("not less than 5".into(), 5)), result);
}
#[derive(Clone, Copy, PartialEq)]
struct PoorlyBehavedDebug(i32);
impl fmt::Debug for PoorlyBehavedDebug {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "\r\n{:?}\r\n", self.0)
}
}
#[test]
fn failing_cases_persisted_and_reloaded() {
const FILE: &'static str = "persistence-test.txt";
let _ = fs::remove_file(FILE);
let max = 10_000_000i32;
let input = (0i32..max).prop_map(PoorlyBehavedDebug);
let config = Config {
failure_persistence: FailurePersistence::Direct(FILE),
.. Config::default()
};
let first_sub_failure = {
TestRunner::new(config.clone()).run(&input, |v| {
if v.0 < max/2 {
Ok(())
} else {
Err(TestCaseError::Fail("too big".into()))
}
}).expect_err("didn't fail?")
};
let first_super_failure = {
TestRunner::new(config.clone()).run(&input, |v| {
if v.0 >= max/2 {
Ok(())
} else {
Err(TestCaseError::Fail("too small".into()))
}
}).expect_err("didn't fail?")
};
let second_sub_failure = {
TestRunner::new(config.clone()).run(&input, |v| {
if v.0 < max/2 {
Ok(())
} else {
Err(TestCaseError::Fail("too big".into()))
}
}).expect_err("didn't fail?")
};
let second_super_failure = {
TestRunner::new(config.clone()).run(&input, |v| {
if v.0 >= max/2 {
Ok(())
} else {
Err(TestCaseError::Fail("too small".into()))
}
}).expect_err("didn't fail?")
};
assert_eq!(first_sub_failure, second_sub_failure);
assert_eq!(first_super_failure, second_super_failure);
}
#[test]
fn relative_source_files_absolutified() {
const TEST_RUNNER_PATH: &[&str] = &["src", "test_runner", "mod.rs"];
lazy_static! {
static ref TEST_RUNNER_RELATIVE: PathBuf =
TEST_RUNNER_PATH.iter().collect();
}
const CARGO_DIR: &str = env!("CARGO_MANIFEST_DIR");
let expected = ::std::iter::once(CARGO_DIR)
.chain(TEST_RUNNER_PATH.iter().map(|s| *s))
.collect::<PathBuf>();
let mut runner = TestRunner::default();
runner.set_source_file_with_cwd(
|| Ok(Path::new(CARGO_DIR).to_owned()),
&TEST_RUNNER_RELATIVE);
assert_eq!(&*expected, runner.source_file().unwrap());
runner.set_source_file_with_cwd(
|| Ok(Path::new(CARGO_DIR).join("target")),
&TEST_RUNNER_RELATIVE);
assert_eq!(&*expected, runner.source_file().unwrap());
}
#[test]
fn new_rng_makes_separate_rng() {
let mut runner = TestRunner::default();
let mut rng2 = runner.new_rng();
let rng1 = runner.rng();
let from_1 = <[u32;4] as Rand>::rand(rng1);
let from_2 = <[u32;4] as Rand>::rand(&mut rng2);
assert_ne!(from_1, from_2);
}
}