fail-parallel 0.6.0

Fail points for rust. A fork that supports parallel test execution.
Documentation
// Copyright 2019 TiKV Project Authors. Licensed under Apache-2.0.

use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::*;
use std::time::*;
use std::*;

use fail_parallel::{fail_point, fail_point_send, FailPointRegistry};

#[cfg(feature = "failpoints")]
use fail_parallel::{fail_point_channel, FailPointTx};

#[cfg(feature = "failpoints")]
fn fail_point_send_result(fp_tx: &FailPointTx) -> Result<(), String> {
    fail_point_send!(fp_tx, "fail-point-send-return", |arg| {
        Err(arg.expect("configured failpoint should include a value"))
    });
    Ok(())
}

#[test]
#[cfg(feature = "failpoints")]
fn test_fail_point_send_propagates_failpoints() {
    let registry = Arc::new(FailPointRegistry::new());
    let (fp_tx, _) = fail_point_channel(registry.clone());
    fail_parallel::cfg(registry, "fail-point-send-return", "return(propagated)").unwrap();

    assert_eq!(
        fail_point_send_result(&fp_tx),
        Err("propagated".to_string())
    );
}

#[test]
#[cfg(feature = "failpoints")]
fn test_fail_point_send_sends_events() {
    let registry = Arc::new(FailPointRegistry::new());
    let (fp_tx, mut event_rx) = fail_point_channel(registry);

    fail_point_send!(fp_tx, "fail-point-send-event", |_| {});

    assert_eq!(
        event_rx.try_recv().unwrap(),
        "fail-point-send-event".to_string()
    );
    assert!(event_rx.try_recv().is_err());
}

#[test]
#[cfg(feature = "failpoints")]
fn test_fail_point_send_without_return_expression() {
    let registry = Arc::new(FailPointRegistry::new());
    let (fp_tx, mut event_rx) = fail_point_channel(registry.clone());
    let calls = Arc::new(AtomicUsize::new(0));
    let callback_calls = calls.clone();
    fail_parallel::cfg_callback(registry, "fail-point-send-no-return", move || {
        callback_calls.fetch_add(1, Ordering::SeqCst);
    })
    .unwrap();

    fail_point_send!(fp_tx, "fail-point-send-no-return");

    assert_eq!(calls.load(Ordering::SeqCst), 1);
    assert_eq!(
        event_rx.try_recv().unwrap(),
        "fail-point-send-no-return".to_string()
    );
}

#[test]
#[cfg(not(feature = "failpoints"))]
fn test_fail_point_send_without_return_expression_is_disabled() {
    let evaluated = std::cell::Cell::new(false);

    fail_point_send!(evaluated.set(true), evaluated.set(true));

    assert!(!evaluated.get());
}

#[test]
fn test_off() {
    let registry = Arc::new(FailPointRegistry::new());
    let f = || {
        fail_point!(registry.clone(), "off", |_| 2);
        0
    };
    assert_eq!(f(), 0);

    fail_parallel::cfg(registry.clone(), "off", "off").unwrap();
    assert_eq!(f(), 0);
}

#[test]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_return() {
    let registry = Arc::new(FailPointRegistry::new());
    let f = || {
        fail_point!(registry.clone(), "return", |s: Option<String>| s
            .map_or(2, |s| s.parse().unwrap()));
        0
    };
    assert_eq!(f(), 0);

    fail_parallel::cfg(registry.clone(), "return", "return(1000)").unwrap();
    assert_eq!(f(), 1000);

    fail_parallel::cfg(registry.clone(), "return", "return").unwrap();
    assert_eq!(f(), 2);
}

#[test]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_sleep() {
    let registry = Arc::new(FailPointRegistry::new());
    let f = || {
        fail_point!(registry.clone(), "sleep");
    };
    let timer = Instant::now();
    f();
    assert!(timer.elapsed() < Duration::from_millis(1000));

    let timer = Instant::now();
    fail_parallel::cfg(registry.clone(), "sleep", "sleep(1000)").unwrap();
    f();
    assert!(timer.elapsed() > Duration::from_millis(1000));
}

#[test]
#[should_panic]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_panic() {
    let registry = Arc::new(FailPointRegistry::new());
    let f = || {
        fail_point!(registry.clone(), "panic");
    };
    fail_parallel::cfg(registry.clone(), "panic", "panic(msg)").unwrap();
    f();
}

#[test]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_print() {
    let registry = Arc::new(FailPointRegistry::new());
    struct LogCollector(Arc<Mutex<Vec<String>>>);
    impl log::Log for LogCollector {
        fn enabled(&self, _: &log::Metadata) -> bool {
            true
        }
        fn log(&self, record: &log::Record) {
            let mut buf = self.0.lock().unwrap();
            buf.push(format!("{}", record.args()));
        }
        fn flush(&self) {}
    }

    let buffer = Arc::new(Mutex::new(vec![]));
    let collector = LogCollector(buffer.clone());
    log::set_max_level(log::LevelFilter::Info);
    log::set_boxed_logger(Box::new(collector)).unwrap();

    let f = || {
        fail_point!(registry.clone(), "print");
    };
    fail_parallel::cfg(registry.clone(), "print", "print(msg)").unwrap();
    f();
    let msg = buffer.lock().unwrap().pop().unwrap();
    assert_eq!(msg, "msg");

    fail_parallel::cfg(registry.clone(), "print", "print").unwrap();
    f();
    let msg = buffer.lock().unwrap().pop().unwrap();
    assert_eq!(msg, "failpoint print executed.");
}

#[test]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_pause() {
    let registry = Arc::new(FailPointRegistry::new());
    let f_registry = registry.clone();
    let f = move || {
        fail_point!(f_registry.clone(), "pause");
    };
    f();

    fail_parallel::cfg(registry.clone(), "pause", "pause").unwrap();
    let (tx, rx) = mpsc::channel();
    thread::spawn(move || {
        // pause
        f();
        tx.send(()).unwrap();
        // woken up by new order pause, and then pause again.
        f();
        tx.send(()).unwrap();
        // woken up by remove, and then quit immediately.
        f();
        tx.send(()).unwrap();
    });

    assert!(rx.recv_timeout(Duration::from_millis(500)).is_err());
    fail_parallel::cfg(registry.clone(), "pause", "pause").unwrap();
    rx.recv_timeout(Duration::from_millis(500)).unwrap();

    assert!(rx.recv_timeout(Duration::from_millis(500)).is_err());
    fail_parallel::remove(registry.clone(), "pause");
    rx.recv_timeout(Duration::from_millis(500)).unwrap();

    rx.recv_timeout(Duration::from_millis(500)).unwrap();
}

#[test]
fn test_yield() {
    let registry = Arc::new(FailPointRegistry::new());
    let f = || {
        fail_point!(registry.clone(), "yield");
    };
    fail_parallel::cfg(registry.clone(), "test", "yield").unwrap();
    f();
}

#[test]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_callback() {
    let registry = Arc::new(FailPointRegistry::new());
    let f1 = || {
        fail_point!(registry.clone(), "cb");
    };
    let f2 = || {
        fail_point!(registry.clone(), "cb");
    };

    let counter = Arc::new(AtomicUsize::new(0));
    let counter2 = counter.clone();
    fail_parallel::cfg_callback(registry.clone(), "cb", move || {
        counter2.fetch_add(1, Ordering::SeqCst);
    })
    .unwrap();
    f1();
    f2();
    assert_eq!(2, counter.load(Ordering::SeqCst));
}

#[test]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_delay() {
    let registry = Arc::new(FailPointRegistry::new());
    let f = || fail_point!(registry.clone(), "delay");
    let timer = Instant::now();
    fail_parallel::cfg(registry.clone(), "delay", "delay(1000)").unwrap();
    f();
    assert!(timer.elapsed() > Duration::from_millis(1000));
}

#[test]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_freq_and_count() {
    let registry = Arc::new(FailPointRegistry::new());
    let f = || {
        fail_point!(registry.clone(), "freq_and_count", |s: Option<String>| s
            .map_or(2, |s| s.parse().unwrap()));
        0
    };
    fail_parallel::cfg(
        registry.clone(),
        "freq_and_count",
        "50%50*return(1)->50%50*return(-1)->50*return",
    )
    .unwrap();
    let mut sum = 0;
    for _ in 0..5000 {
        let res = f();
        sum += res;
    }
    assert_eq!(sum, 100);
}

#[test]
#[cfg_attr(not(feature = "failpoints"), ignore)]
fn test_condition() {
    let registry = Arc::new(FailPointRegistry::new());
    let f = |_enabled| {
        fail_point!(registry.clone(), "condition", _enabled, |_| 2);
        0
    };
    assert_eq!(f(false), 0);

    fail_parallel::cfg(registry.clone(), "condition", "return").unwrap();
    assert_eq!(f(false), 0);

    assert_eq!(f(true), 2);
}

#[test]
fn test_list() {
    let registry = Arc::new(FailPointRegistry::new());
    assert!(
        !fail_parallel::list(registry.clone()).contains(&("list".to_string(), "off".to_string()))
    );
    fail_parallel::cfg(registry.clone(), "list", "off").unwrap();
    assert!(
        fail_parallel::list(registry.clone()).contains(&("list".to_string(), "off".to_string()))
    );
    fail_parallel::cfg(registry.clone(), "list", "return").unwrap();
    assert!(
        fail_parallel::list(registry.clone()).contains(&("list".to_string(), "return".to_string()))
    );
}