trellis-testing 0.1.1

Companion testing support for Trellis graph invariants.
Documentation 
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

use trellis_core::{GraphResult, InputNode, Transaction};

pub(crate) type StageOperation<C, O> =
    dyn for<'tx> Fn(&mut Transaction<'tx, C, O>) -> GraphResult<()> + 'static;

/// Deterministic transaction script that can be replayed against a fresh graph.
pub struct TransactionScript<C = (), O = ()> {
    pub(crate) steps: Vec<TransactionScriptStep<C, O>>,
}

impl<C, O> TransactionScript<C, O> {
    /// Creates an empty transaction script.
    pub fn new() -> Self {
        Self { steps: Vec::new() }
    }

    /// Starts a named script step.
    pub fn step(&mut self, name: impl Into<String>) -> TransactionScriptStepBuilder<'_, C, O> {
        TransactionScriptStepBuilder {
            script: self,
            name: name.into(),
            operations: Vec::new(),
        }
    }

    /// Returns script steps in replay order.
    pub fn steps(&self) -> &[TransactionScriptStep<C, O>] {
        &self.steps
    }
}

impl<C, O> Default for TransactionScript<C, O> {
    fn default() -> Self {
        Self::new()
    }
}

/// Builder for one transaction script step.
pub struct TransactionScriptStepBuilder<'script, C, O> {
    script: &'script mut TransactionScript<C, O>,
    name: String,
    operations: Vec<Box<StageOperation<C, O>>>,
}

impl<C, O> TransactionScriptStepBuilder<'_, C, O>
where
    O: Clone + PartialEq,
{
    /// Stages a typed canonical input write for this step.
    pub fn input<T>(mut self, input: InputNode<T>, value: T) -> Self
    where
        T: Clone + PartialEq + Send + Sync + 'static,
    {
        self.operations
            .push(Box::new(move |tx| tx.set_input(input, value.clone())));
        self
    }

    /// Stages a custom operation against the transaction.
    pub fn operation(
        mut self,
        operation: impl for<'tx> Fn(&mut Transaction<'tx, C, O>) -> GraphResult<()> + 'static,
    ) -> Self {
        self.operations.push(Box::new(operation));
        self
    }

    /// Adds this step to the script.
    pub fn commit(self) {
        self.script.steps.push(TransactionScriptStep {
            name: self.name,
            operations: self.operations,
        });
    }
}

/// One named transaction in a replayable script.
pub struct TransactionScriptStep<C = (), O = ()> {
    pub(crate) name: String,
    pub(crate) operations: Vec<Box<StageOperation<C, O>>>,
}

impl<C, O> TransactionScriptStep<C, O> {
    /// Returns the step name.
    pub fn name(&self) -> &str {
        &self.name
    }
}