falsify 0.1.3

Property testing based on coroutines
Documentation
#![feature(coroutines)]

use std::rc::Rc;

#[derive(Debug, Clone)]
pub enum Expr {
    Term {
        #[allow(dead_code)]
        term: String,
    },
    Opt {
        child: Rc<Expr>,
    },
    Alt {
        children: Vec<Rc<Expr>>,
    },
}

fn main() {
    unimplemented!(); // dummy
}

#[cfg(test)]
mod tests {
    use falsify::{ArbGen, arb_vec_of_rc_refcell_of};
    use rand::distr::{Alphanumeric, SampleString};
    use rand::rngs::StdRng;
    use rand::seq::IndexedRandom;
    use std::cell::RefCell;
    use std::cmp::max;
    use std::ops::DerefMut;
    use std::ops::{Coroutine, CoroutineState};
    use std::pin::pin;
    use std::rc::Rc;

    use super::*;

    fn arb_term(rng: Rc<RefCell<StdRng>>) -> impl ArbGen<Rc<Expr>> {
        #[coroutine]
        move || {
            loop {
                let term: String = {
                    let mut r = rng.borrow_mut();
                    Alphanumeric.sample_string(&mut r, 16)
                };
                let expr = Expr::Term { term };
                yield Rc::new(expr);
            }
        }
    }

    fn arb_opt(child_coro: Rc<RefCell<dyn ArbGen<Rc<Expr>> + Unpin>>) -> impl ArbGen<Rc<Expr>> {
        #[coroutine]
        move || {
            loop {
                let child = {
                    let mut coro = child_coro.borrow_mut();
                    match pin!(coro.deref_mut()).resume(()) {
                        CoroutineState::Yielded(child_id) => child_id,
                        CoroutineState::Complete(()) => return (),
                    }
                };
                let expr = Expr::Opt { child: child };
                yield Rc::new(expr);
            }
        }
    }

    fn arb_alt(
        rng: Rc<RefCell<StdRng>>,
        child_coro: Rc<RefCell<dyn ArbGen<Rc<Expr>> + Unpin>>,
        max_width: usize,
    ) -> impl ArbGen<Rc<Expr>> {
        #[coroutine]
        move || {
            let mut arb_vec_coro = arb_vec_of_rc_refcell_of(child_coro, Rc::clone(&rng), max_width);
            loop {
                let children = match pin!(&mut arb_vec_coro).resume(()) {
                    CoroutineState::Yielded(subexpr) => subexpr,
                    CoroutineState::Complete(()) => return (),
                };

                let expr = Expr::Alt { children: children };
                yield Rc::new(expr);
            }
        }
    }

    fn do_arb_expr_depth_1(rng: Rc<RefCell<StdRng>>) -> Rc<RefCell<dyn ArbGen<Rc<Expr>> + Unpin>> {
        let coro = #[coroutine]
        move || {
            let mut term = arb_term(Rc::clone(&rng));
            loop {
                let expr_id = match pin!(&mut term).resume(()) {
                    CoroutineState::Yielded(child_id) => child_id,
                    CoroutineState::Complete(()) => return (),
                };
                yield expr_id;
            }
        };
        Rc::new(RefCell::new(coro))
    }

    fn do_arb_expr_depth_n(
        rng: Rc<RefCell<StdRng>>,
        max_width: usize,
        child_coro: Rc<RefCell<dyn ArbGen<Rc<Expr>> + Unpin>>,
    ) -> Rc<RefCell<dyn ArbGen<Rc<Expr>> + Unpin>> {
        let coro = #[coroutine]
        move || {
            let mut term = arb_term(Rc::clone(&rng));
            let mut opt = arb_opt(Rc::clone(&child_coro));
            let mut alt = arb_alt(Rc::clone(&rng), Rc::clone(&child_coro), max_width);

            let mut unexhausted_variants = vec![0, 1, 2];
            while unexhausted_variants.len() > 0 {
                let tree_node_variant = {
                    let mut r = rng.borrow_mut();
                    unexhausted_variants.choose(&mut r).unwrap()
                };
                let expr_id = match tree_node_variant {
                    0 => match pin!(&mut term).resume(()) {
                        CoroutineState::Yielded(expr_id) => expr_id,
                        CoroutineState::Complete(()) => {
                            unexhausted_variants.remove(*tree_node_variant);
                            continue;
                        }
                    },
                    1 => match pin!(&mut opt).resume(()) {
                        CoroutineState::Yielded(expr_id) => expr_id,
                        CoroutineState::Complete(()) => {
                            unexhausted_variants.remove(*tree_node_variant);
                            continue;
                        }
                    },
                    2 => match pin!(&mut alt).resume(()) {
                        CoroutineState::Yielded(expr_id) => expr_id,
                        CoroutineState::Complete(()) => {
                            unexhausted_variants.remove(*tree_node_variant);
                            continue;
                        }
                    },
                    _ => unreachable!(),
                };
                yield expr_id;
            }
        };
        Rc::new(RefCell::new(coro))
    }

    fn arb_expr(
        rng: Rc<RefCell<StdRng>>,
        max_width: usize,
        max_depth: usize,
    ) -> impl ArbGen<Rc<Expr>> + Unpin {
        #[coroutine]
        move || {
            let mut coro = do_arb_expr_depth_1(Rc::clone(&rng));
            for _ in 2..max_depth {
                coro = do_arb_expr_depth_n(Rc::clone(&rng), max_width, coro);
            }

            loop {
                let expr_id = {
                    let mut expr = coro.borrow_mut();
                    let expr_id = match pin!(expr.deref_mut()).resume(()) {
                        CoroutineState::Yielded(expr_id) => expr_id,
                        CoroutineState::Complete(()) => return (),
                    };
                    expr_id
                };
                yield expr_id;
            }
        }
    }

    fn get_max_tree_width(node: Rc<Expr>) -> usize {
        match node.as_ref() {
            Expr::Term { .. } => 0,
            Expr::Opt { child } => max(1, get_max_tree_width(Rc::clone(&child))),
            Expr::Alt { children } => max(
                1,
                children
                    .iter()
                    .map(|child| get_max_tree_width(Rc::clone(&child)))
                    .max()
                    .unwrap_or(0),
            ),
        }
    }

    fn get_max_tree_depth(node_id: Rc<Expr>) -> usize {
        match node_id.as_ref() {
            Expr::Term { .. } => 1,
            Expr::Opt { child } => 1 + get_max_tree_depth(Rc::clone(&child)),
            Expr::Alt { children } => {
                1 + children
                    .iter()
                    .map(|child| get_max_tree_depth(Rc::clone(&child)))
                    .max()
                    .unwrap_or(1)
            }
        }
    }

    #[test]
    fn test_tree_width_within_limits() {
        let rng = make_test_rng();
        const MAX_WIDTH: usize = 5;
        const MAX_DEPTH: usize = 10;
        let arb = arb_expr(rng, MAX_WIDTH, MAX_DEPTH);
        if let Some(counterexample) = falsify(|t| get_max_tree_width(t) <= MAX_WIDTH, arb) {
            assert!(false, "{:?}", counterexample);
        }
    }

    #[test]
    fn test_tree_depth_within_limits() {
        let rng = make_test_rng();
        const MAX_WIDTH: usize = 5;
        const MAX_DEPTH: usize = 10;
        let arb = arb_expr(rng, MAX_WIDTH, MAX_DEPTH);
        if let Some(counterexample) = falsify(|t| get_max_tree_depth(t) <= MAX_DEPTH, arb) {
            assert!(false, "{:?}", counterexample);
        }
    }
}