CMockery单元测试框架入门指南

1、项目介绍

1.1 何为CMockery?

CMockery是由Google发起并维护的一款用于C语言的轻量级单元测试框架。它以其简洁的设计、轻量化和广泛的兼容性著称，尤其适合那些对资源敏感的嵌入式系统开发者。通过模拟（Mocking）技术，CMockery能够简化对外部依赖的管理和测试，从而提高测试覆盖率和代码质量。

1.2 特点概览

• 免费及开源: 采用Apache-2.0许可证。
• 谷歌支持: 享有强大的社区和持续更新保障。
• 轻量级架构: 不依赖于外部包，减少学习曲线和部署复杂度。
• 高性能: 避免高级编译器特性的使用，确保旧版编译器的兼容性和广泛的应用场景。
• 灵活性: 不强制遵循C99标准，拓宽了其在不同平台上的适用范围，特别对于嵌入式设备而言。

2、项目快速启动

2.1 系统需求

• Linux环境（支持包括但不限于Ubuntu、CentOS等主流发行版）
• GCC编译器或其他兼容C/C++的编译器
• 基础shell脚本知识

2.2 快速安装

2.2.1 下载源码

首先，你需要克隆或下载CMockery的源码仓库：

git clone https://github.com/google/cmockery.git
cd cmockery

2.2.2 构建并安装

使用以下命令进行配置、构建和安装CMockery:

./autogen.sh    # 如果缺少configure文件则运行这一步
./configure     # 自动检测和配置构建参数
make            # 编译源代码
sudo make install  # 安装至系统路径，默认位置为/usr/local/

2.3 环境验证

确保环境变量正确设置了CMockery的库和头文件的位置：

export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH   # 更新LD_LIBRARY_PATH
source /etc/environment                   # 使更改立即生效 (某些系统)

验证安装:

echo $LD_LIBRARY_PATH | grep '/usr/local/lib'

如无错误信息，则表示CMockery已经成功集成到你的开发环境中。

3、应用案例和最佳实践

3.1 创建第一个测试

假设我们有一个简单的数学计算模块，我们将创建一个名为math.c的源文件来存放我们的函数：

#include <stdio.h>

// 加法函数
int add(int x, int y) {
    return x + y;
}

接下来，在同一目录中，创建一个测试文件add_test.c，引入math.c中的函数并通过CMockery编写测试用例：

#define _GNU_SOURCE         // Required for mock functions in CMockery

#include "math.h"
#include <stdlib.h>
#include <cmocka.h>

static void test_add(void **state) {
    int result = add(2, 3);
    assert_int_equal(result, 5);  // 断言结果等于期望值
}

int main(void) {
    const struct CMUnitTest tests[] = { 
        cmocka_unit_test(test_add),
    };
    return cmocka_run_group_tests(tests, NULL, NULL);
}

3.2 编译与运行

确保你在同一目录中有math.c和add_test.c两个文件，然后你可以通过以下命令编译它们，并运行测试：

gcc -o test_add add_test.c math.c `pkg-config --libs --cflags cmockery`
./test_add

正常情况下，你应该看到类似下面的输出，表明所有测试都已经通过：

Starting 1 test...
1. test_add.........................................OK
Results:
  Tests OK:                 1
  Tests skipped:           0
  Tests failed:            0
  Tests total:             1
  Failures total:          0
Time taken:                0.01 seconds

这样你就完成了第一个使用CMockery的单元测试。

4、典型生态项目

虽然CMockery主要聚焦于C语言的单元测试，但其与其他相关开源项目结合得相当紧密，例如：

• gtest （Google Test）: C++ 的测试框架，与CMockery相比提供了更多高级特性，适合更复杂的C++代码基。
• ctemplate: Google的文本模板引擎，常被用来生成测试报告和日志。
• valgrind: 内存检查工具，与CMockery配合可用于内存泄漏检测。
• doxygen: 文档生成工具，帮助理解CMockery和其他相关模块的使用手册和API说明。

这些项目相互补充，共同构成了全面的测试和开发解决方案。

综上所述，CMockery不仅是一款功能强大的单元测试工具，更是整个开发流程中不可或缺的一环。通过深入理解和熟练运用，你将能够大幅度提升代码质量和开发效率。