【亲测免费】 Fake Function Framework (fff) 使用教程

1. 项目介绍

Fake Function Framework (fff) 是一个用于创建 C 语言函数测试替身的微框架。它旨在简化测试过程中手动编写假函数的工作，使开发者能够更高效地进行单元测试。fff 是一个头文件库，使用简单，只需包含 fff.h 文件即可开始使用。

2. 项目快速启动

2.1 安装

首先，克隆项目到本地：

git clone https://github.com/meekrosoft/fff.git

2.2 使用示例

假设你有一个需要测试的函数 DISPLAY_init()，你可以按照以下步骤创建一个假函数并进行测试。

2.2.1 定义假函数

在测试文件中包含 fff.h 并定义假函数：

#include "fff.h"
DEFINE_FFF_GLOBALS;

FAKE_VOID_FUNC(DISPLAY_init);

2.2.2 编写测试用例

编写一个简单的测试用例来验证 DISPLAY_init() 是否被正确调用：

#include <assert.h>

void test_init_initialises_display() {
    // 调用被测试的函数
    UI_init();

    // 验证 DISPLAY_init 是否被调用了一次
    assert(DISPLAY_init_fake.call_count == 1);
}

int main() {
    test_init_initialises_display();
    return 0;
}

2.3 运行测试

在 Linux 或 MacOS 系统上，可以使用 buildandtest 脚本来运行所有测试：

./buildandtest

3. 应用案例和最佳实践

3.1 捕获参数

假设你有一个带参数的函数 DISPLAY_output(char * message)，你可以捕获传递给该函数的参数：

FAKE_VOID_FUNC(DISPLAY_output, char *);

void test_write_line_outputs_lines_to_display() {
    char msg[] = "helloworld";
    UI_write_line(msg);

    assert(DISPLAY_output_fake.call_count == 1);
    assert(strncmp(DISPLAY_output_fake.arg0_val, msg, 26) == 0);
}

3.2 返回值

如果你需要定义一个返回值的假函数，例如 DISPLAY_get_line_capacity()，可以使用 FAKE_VALUE_FUNC 宏：

FAKE_VALUE_FUNC(unsigned int, DISPLAY_get_line_capacity);

void test_when_empty_lines_write_line_doesnt_clear_screen() {
    DISPLAY_get_line_insert_index_fake.return_val = 1;
    char msg[] = "helloworld";

    UI_write_line(msg);

    assert(DISPLAY_clear_fake.call_count == 0);
}

3.3 重置假函数

在每个测试用例中重置假函数是一个好习惯，以确保测试的隔离性：

void setup() {
    RESET_FAKE(DISPLAY_init);
    RESET_FAKE(DISPLAY_clear);
    RESET_FAKE(DISPLAY_output_message);
    RESET_FAKE(DISPLAY_get_line_capacity);
    RESET_FAKE(DISPLAY_get_line_insert_index);
}

4. 典型生态项目

fff 是一个轻量级的测试框架，通常与其他 C 语言测试框架结合使用，如：

• Unity: 一个简单的 C 语言单元测试框架，常与 fff 一起使用。
• CppUTest: 一个 C/C++ 单元测试框架，支持 fff 进行 C 语言函数的测试替身。

通过结合这些框架，开发者可以构建更全面的测试套件，确保代码的质量和稳定性。