摘要：作者張博康本文為源碼解析系列的第五篇，為大家介紹在測試中使用的周邊庫。而對于行為的情況會特殊一些，在中并不做實(shí)際的動作，而是返回并通過傳參給閉包產(chǎn)生自定義的返回值。

作者：張博康

本文為 TiKV 源碼解析系列的第五篇，為大家介紹 TiKV 在測試中使用的周邊庫 fail-rs。

fail-rs 的設(shè)計(jì)啟發(fā)于 FreeBSD 的 failpoints，由 Rust 實(shí)現(xiàn)。通過代碼或者環(huán)境變量，其允許程序在特定的地方動態(tài)地注入錯誤或者其他行為。在 TiKV 中通常在測試中使用 fail point 來構(gòu)建異常的情況，是一個非常方便的測試工具。

在我們的集成測試中，都是簡單的構(gòu)建一個 KV 實(shí)例，然后發(fā)送請求，檢查返回值和狀態(tài)的改變。這樣的測試可以較為完整地測試功能，但是對于一些需要精細(xì)化控制的測試就鞭長莫及了。我們當(dāng)然可以通過 mock 網(wǎng)絡(luò)層提供網(wǎng)絡(luò)的精細(xì)模擬控制，但是對于諸如磁盤 IO、系統(tǒng)調(diào)度等方面的控制就沒辦法做到了。

同時，在分布式系統(tǒng)中時序的關(guān)系是非常關(guān)鍵的，可能兩個操作的執(zhí)行順行相反，就導(dǎo)致了迥然不同的結(jié)果。尤其對于數(shù)據(jù)庫來說，保證數(shù)據(jù)的一致性是至關(guān)重要的，因此需要去做一些相關(guān)的測試。

基于以上原因，我們就需要使用 fail point 來復(fù)現(xiàn)一些 corner case，比如模擬數(shù)據(jù)落盤特別慢、raftstore 繁忙、特殊的操作處理順序、錯誤 panic 等等。

在詳細(xì)介紹之前，先舉一個簡單的例子給大家一個直觀的認(rèn)識。

還是那個老生常談的 Hello World：

#[macro_use]
extern crate fail;

fn say_hello() {
    fail_point!(“before_print”);
    println!(“Hello World~”);
}

fn main() {
    say_hello();
    fail::cfg("before_print", "panic");
    say_hello();
}

運(yùn)行結(jié)果如下：

Hello World~
thread "main" panicked at "failpoint before_print panic" ...

可以看到最終只打印出一個 Hello World～，而在打印第二個之前就 panic 了。這是因?yàn)槲覀冊诘谝淮未蛴⊥旰蟛胖付诉@個 fail point 行為是 panic，因此第一次在 fail point 不做任何事情之后正常輸出，而第二次在執(zhí)行到 fail point 時就會根據(jù)配置的行為 panic 掉！

當(dāng)然 fail point 不僅僅能注入 panic，還可以是其他的操作，并且可以按照一定的概率出現(xiàn)。描述行為的格式如下：

[%][*][(args...)][->]

pct：行為被執(zhí)行時有百分之 pct 的機(jī)率觸發(fā)

cnt：行為總共能被觸發(fā)的次數(shù)

type：行為類型

off：不做任何事

return(arg)：提前返回，需要 fail point 定義時指定 expr，arg 會作為字符串傳給 expr 計(jì)算返回值

sleep(arg)：使當(dāng)前線程睡眠 arg 毫秒

panic(arg)：使當(dāng)前線程崩潰，崩潰消息為 arg

print(arg)：打印出 arg

pause：暫停當(dāng)前線程，直到該 fail point 設(shè)置為其他行為為止

yield：使當(dāng)前線程放棄剩余時間片

delay(arg)：和 sleep 類似，但是讓 CPU 空轉(zhuǎn) arg 毫秒

args：行為的參數(shù)

比如我們想在 before_print 處先 sleep 1s 然后有 1% 的機(jī)率 panic，那么就可以這么寫：

"sleep(1000)->1%panic"

只需要使用宏 fail_point! 就可以在相應(yīng)代碼中提前定義好 fail point，而具體的行為在之后動態(tài)注入。

fail_point!("failpoint_name");
fail_point!("failpoint_name", |_| { // 指定生成自定義返回值的閉包，只有當(dāng) fail point 的行為為 return 時，才會調(diào)用該閉包并返回結(jié)果
    return Error
});
fail_point!("failpoint_name", a == b, |_| { // 當(dāng)滿足條件時，fail point 才被觸發(fā)
    return Error
})

通過設(shè)置環(huán)境變量指定相應(yīng) fail point 的行為：

FAILPOINTS="=;=;..."

注意，在實(shí)際運(yùn)行的代碼需要先使用 fail::setup() 以環(huán)境變量去設(shè)置相應(yīng) fail point，否則 FAILPOINTS 并不會起作用。

#[macro_use]
extern crate fail;

fn main() {
    fail::setup(); // 初始化 fail point 設(shè)置
    do_fallible_work();
    fail::teardown(); // 清除所有 fail point 設(shè)置，并且恢復(fù)所有被 fail point 暫停的線程
}

不同于環(huán)境變量方式，代碼控制更加靈活，可以在程序中根據(jù)情況動態(tài)調(diào)整 fail point 的行為。這種方式主要應(yīng)用于集成測試，以此可以很輕松地構(gòu)建出各種異常情況。

fail::cfg("failpoint_name", "actions"); // 設(shè)置相應(yīng)的 fail point 的行為
fail::remove("failpoint_name"); // 解除相應(yīng)的 fail point 的行為

以下我們將以 fail-rs v0.2.1 版本代碼為基礎(chǔ)，從 API 出發(fā)來看看其背后的具體實(shí)現(xiàn)。

fail-rs 的實(shí)現(xiàn)非常簡單，總的來說，就是內(nèi)部維護(hù)了一個全局 map，其保存著相應(yīng) fail point 所對應(yīng)的行為。當(dāng)程序執(zhí)行到某個 fail point 時，獲取并執(zhí)行該全局 map 中所保存的相應(yīng)的行為。

全局 map 其具體定義在 FailPointRegistry。

struct FailPointRegistry {
    registry: RwLock>>,
}

其中 FailPoint 的定義如下：

struct FailPoint {
    pause: Mutex,
    pause_notifier: Condvar,
    actions: RwLock>,
    actions_str: RwLock,
}

pause 和 pause_notifier 是用于實(shí)現(xiàn)線程的暫停和恢復(fù)，感興趣的同學(xué)可以去看看代碼，太過細(xì)節(jié)在此不展開了；actions_str 保存著描述行為的字符串，用于輸出；而 actions 就是保存著 failpoint 的行為，包括概率、次數(shù)、以及具體行為。Action 實(shí)現(xiàn)了 FromStr 的 trait，可以將滿足格式要求的字符串轉(zhuǎn)換成 Action。這樣各個 API 的操作也就顯而易見了，實(shí)際上就是對于這個全局 map 的增刪查改：

fail::setup() 讀取環(huán)境變量 FAILPOINTS 的值，以 ; 分割，解析出多個 failpoint name 和相應(yīng)的 actions 并保存在 registry 中。

fail::teardown() 設(shè)置 registry 中所有 fail point 對應(yīng)的 actions 為空。

fail::cfg(name, actions) 將 name 和對應(yīng)解析出的 actions 保存在 registry 中。

fail::remove(name) 設(shè)置 registry 中 name 對應(yīng)的 actions 為空。

而代碼到執(zhí)行到 fail point 的時候到底發(fā)生了什么呢，我們可以展開 fail_point! 宏定義看一下：

macro_rules! fail_point {
    ($name:expr) => {{
        $crate::eval($name, |_| {
            panic!("Return is not supported for the fail point "{}"", $name);
        });
    }};
    ($name:expr, $e:expr) => {{
        if let Some(res) = $crate::eval($name, $e) {
            return res;
        }
    }};
    ($name:expr, $cond:expr, $e:expr) => {{
        if $cond {
            fail_point!($name, $e);
        }
    }};
}

現(xiàn)在一切都變得豁然開朗了，實(shí)際上就是對于 eval 函數(shù)的調(diào)用，當(dāng)函數(shù)返回值為 Some 時則提前返回。而 eval 就是從全局 map 中獲取相應(yīng)的行為，在 p.eval(name) 中執(zhí)行相應(yīng)的動作，比如輸出、等待亦或者 panic。而對于 return 行為的情況會特殊一些，在 p.eval(name) 中并不做實(shí)際的動作，而是返回 Some(arg) 并通過 .map(f) 傳參給閉包產(chǎn)生自定義的返回值。

pub fn eval) -> R>(name: &str, f: F) -> Option {
    let p = {
        let registry = REGISTRY.registry.read().unwrap();
        match registry.get(name) {
            None => return None,
            Some(p) => p.clone(),
        }
    };
    p.eval(name).map(f)
}

至此，關(guān)于 fail-rs 背后的秘密也就清清楚楚了。關(guān)于在 TiKV 中使用 fail point 的測試詳見 github.com/tikv/tikv/tree/master/tests/failpoints，大家感興趣可以看看在 TiKV 中是如何來構(gòu)建異常情況的。

同時，fail-rs 計(jì)劃支持 HTTP API，歡迎感興趣的小伙伴提交 PR。