proptest/test_runner/failure_persistence/
map.rs

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
//-
// Copyright 2017, 2018 The proptest developers
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use crate::std_facade::{fmt, BTreeMap, BTreeSet, Box, Vec};
use core::any::Any;

use crate::test_runner::failure_persistence::FailurePersistence;
use crate::test_runner::failure_persistence::PersistedSeed;

/// Failure persistence option that loads and saves seeds in memory
/// on the heap. This may be useful when accumulating test failures
/// across multiple `TestRunner` instances for external reporting
/// or batched persistence.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct MapFailurePersistence {
    /// Backing map, keyed by source_file.
    pub map: BTreeMap<&'static str, BTreeSet<PersistedSeed>>,
}

impl FailurePersistence for MapFailurePersistence {
    fn load_persisted_failures2(
        &self,
        source_file: Option<&'static str>,
    ) -> Vec<PersistedSeed> {
        source_file
            .and_then(|source| self.map.get(source))
            .map(|seeds| seeds.iter().cloned().collect::<Vec<_>>())
            .unwrap_or_default()
    }

    fn save_persisted_failure2(
        &mut self,
        source_file: Option<&'static str>,
        seed: PersistedSeed,
        _shrunken_value: &dyn fmt::Debug,
    ) {
        let s = match source_file {
            Some(sf) => sf,
            None => return,
        };
        let set = self.map.entry(s).or_insert_with(BTreeSet::new);
        set.insert(seed);
    }

    fn box_clone(&self) -> Box<dyn FailurePersistence> {
        Box::new(self.clone())
    }

    fn eq(&self, other: &dyn FailurePersistence) -> bool {
        other
            .as_any()
            .downcast_ref::<Self>()
            .map_or(false, |x| x == self)
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_runner::failure_persistence::tests::*;

    #[test]
    fn initial_map_is_empty() {
        assert!(MapFailurePersistence::default()
            .load_persisted_failures2(HI_PATH)
            .is_empty())
    }

    #[test]
    fn seeds_recoverable() {
        let mut p = MapFailurePersistence::default();
        p.save_persisted_failure2(HI_PATH, INC_SEED, &"");
        let restored = p.load_persisted_failures2(HI_PATH);
        assert_eq!(1, restored.len());
        assert_eq!(INC_SEED, *restored.first().unwrap());

        assert!(p.load_persisted_failures2(None).is_empty());
        assert!(p.load_persisted_failures2(UNREL_PATH).is_empty());
    }

    #[test]
    fn seeds_deduplicated() {
        let mut p = MapFailurePersistence::default();
        p.save_persisted_failure2(HI_PATH, INC_SEED, &"");
        p.save_persisted_failure2(HI_PATH, INC_SEED, &"");
        let restored = p.load_persisted_failures2(HI_PATH);
        assert_eq!(1, restored.len());
    }
}