Fake Function Framework (fff) 技术文档

1. 安装指南

1.1 下载 fff.h 文件

首先，你需要从项目的 GitHub 仓库下载 fff.h 文件。这个文件是框架的核心，包含了所有用于创建假函数的宏和结构。

1.2 包含 fff.h 文件

在你的测试代码中，通过 #include "fff.h" 包含这个头文件。由于 fff 是一个头文件库，因此不需要额外的编译步骤。

1.3 设置全局变量

在使用 fff 之前，你需要定义全局变量 DEFINE_FFF_GLOBALS;。这个宏会初始化 fff 内部的一些全局结构。

2. 项目的使用说明

2.1 创建假函数

fff 提供了两种主要的宏来创建假函数：

• FAKE_VOID_FUNC：用于创建返回 void 的假函数。
• FAKE_VALUE_FUNC：用于创建返回值的假函数。

示例：

// 创建一个返回 void 的假函数
FAKE_VOID_FUNC(DISPLAY_init);

// 创建一个返回 unsigned int 的假函数
FAKE_VALUE_FUNC(unsigned int, DISPLAY_get_line_capacity);

2.2 捕获参数

当你需要捕获函数调用时的参数时，fff 会自动为每个参数创建一个变量，存储在 function_name_fake.argN_val 中。

示例：

FAKE_VOID_FUNC(DISPLAY_output, char *);

TEST_F(UITests, write_line_outputs_lines_to_display)
{
    char msg[] = "helloworld";
    UI_write_line(msg);
    ASSERT_EQ(DISPLAY_output_fake.call_count, 1);
    ASSERT_EQ(strncmp(DISPLAY_output_fake.arg0_val, msg, 26), 0);
}

2.3 设置返回值

对于返回值的假函数，你可以通过 return_val 属性来设置返回值。

示例：

FAKE_VALUE_FUNC(unsigned int, DISPLAY_get_line_insert_index);

TEST_F(UITests, 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_EQ(DISPLAY_clear_fake.call_count, 0);
}

2.4 重置假函数

在每个测试用例的 setup 函数中，你应该重置所有假函数的状态，以确保测试的隔离性。

示例：

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);
}

3. 项目API使用文档

3.1 FAKE_VOID_FUNC

• 描述：用于创建返回 void 的假函数。
• 参数：
  • function_name：假函数的名称。
  • arg1, arg2, ...：函数的参数类型。
• 返回值：无。

3.2 FAKE_VALUE_FUNC

• 描述：用于创建返回值的假函数。
• 参数：
  • return_type：返回值的类型。
  • function_name：假函数的名称。
  • arg1, arg2, ...：函数的参数类型。
• 返回值：返回 return_type 类型的值。

3.3 RESET_FAKE

• 描述：重置假函数的状态，包括调用次数和参数历史。
• 参数：
  • function_name：需要重置的假函数名称。
• 返回值：无。

3.4 SET_RETURN_SEQ

• 描述：设置假函数的返回值序列。
• 参数：
  • function_name：假函数的名称。
  • return_values：返回值数组。
  • num_values：返回值的数量。
• 返回值：无。

3.5 FFF_RESET_HISTORY

• 描述：重置 fff 的调用历史记录。
• 参数：无。
• 返回值：无。

4. 项目安装方式

4.1 手动安装

1. 从 GitHub 仓库下载 fff.h 文件。
2. 将 fff.h 文件放置在你的项目目录中。
3. 在测试代码中通过 #include "fff.h" 包含该文件。

4.2 使用 CMake 构建

如果你使用 CMake 进行项目管理，可以通过以下命令构建和测试项目：

cmake -B build -DFFF_GENERATE=ON -DFFF_UNIT_TESTING=ON
cmake --build build
ctest --test-dir build --output-on-failure

通过以上步骤，你可以轻松地使用 fff 框架来创建和管理假函数，从而简化你的单元测试工作。