CppUTest 技术文档

1. 安装指南

1.1 克隆项目

从GitHub上克隆CppUTest项目，执行以下命令：

git clone https://github.com/cpputest/cpputest.git

1.2 构建项目

对于基于Unix的系统（包括Linux、Cygwin和MacOS），可以使用以下步骤构建项目：

cd cpputest
mkdir cpputest_build
cd cpputest_build
autoreconf .. -i
../configure
make

如果你希望将CppUTest安装到系统范围内，可以使用make install命令。

你也可以使用CMake，它也支持Windows的Visual Studio：

cd cpputest
mkdir cpputest_build
cmake -B cpputest_build
cmake --build cpputest_build

1.3 使用vcpkg安装

你也可以使用vcpkg依赖管理器来安装cpputest：

vcpkg install cpputest

更多关于vcpkg的信息，请访问：vcpkg GitHub页面。

2. 项目的使用说明

要开始使用CppUTest，你需要进行以下设置：

• 将包含路径添加到Makefile中，例如：

  CPPFLAGS += -I$(CPPUTEST_HOME)/include
  

• 将内存泄漏宏添加到Makefile中（用于额外的调试信息）：

  CXXFLAGS += -include $(CPPUTEST_HOME)/include/CppUTest/MemoryLeakDetectorNewMacros.h
  CFLAGS += -include $(CPPUTEST_HOME)/include/CppUTest/MemoryLeakDetectorMallocMacros.h
  

• 将库链接添加到Makefile中：

  LD_LIBRARIES = -L$(CPPUTEST_HOME)/lib -lCppUTest -lCppUTestExt
  

之后，你可以编写你的第一个测试：

TEST_GROUP(FirstTestGroup)
{
};

TEST(FirstTestGroup, FirstTest)
{
   FAIL("Fail me!");
}

3. 项目API使用文档

以下是一些常用的宏和类，它们是CppUTest框架的一部分：

测试宏

• TEST(group, name) - 定义一个测试。
• IGNORE_TEST(group, name) - 禁用测试的执行。
• TEST_GROUP(group) - 声明一个测试组，特定的测试属于这个组。
• TEST_GROUP_BASE(group, base) - 与TEST_GROUP相同，但是使用不同的基类。
• TEST_SETUP() - 在TEST_GROUP中声明一个设置方法。
• TEST_TEARDOWN() - 在TEST_GROUP中声明一个拆卸方法。
• IMPORT_TEST_GROUP(group) - 导出测试组的名称，以便从库中链接。

断言宏

以下断言宏会在条件失败时立即退出当前测试：

• CHECK(boolean condition) - 检查任何布尔条件。
• CHECK_TRUE(boolean condition) - 检查是否为真。
• CHECK_FALSE(boolean condition) - 检查是否为假。
• CHECK_EQUAL(expected, actual) - 使用==检查两个实体之间的相等性。
• STRCMP_EQUAL(expected, actual) - 使用strcmp检查字符串的相等性。
• LONGS_EQUAL(expected, actual) - 比较两个数字。
• BYTES_EQUAL(expected, actual) - 比较两个八位宽的数字。
• POINTERS_EQUAL(expected, actual) - 比较两个const void *指针。
• DOUBLES_EQUAL(expected, actual, tolerance) - 在某个公差范围内比较两个双精度数字。
• ENUMS_EQUAL_INT(expected, actual) - 比较两个底层类型为int的枚举。
• ENUMS_EQUAL_TYPE(underlying_type, expected, actual) - 比较两个具有相同底层类型的枚举。
• FAIL(text) - 总是失败。
• TEST_EXIT - 退出测试而不是失败，这对于合同测试（实现断言伪造）很有用。

测试插件

CppUTest可以通过插入测试插件来支持额外的检查功能。测试插件从TestPlugin类继承，并通过installPlugin方法插入到TestRegistry中。

4. 项目安装方式

安装方式已在安装指南中描述，支持以下方式：

• 源码构建：在Unix-based、Cygwin、MacOS系统上使用autoreconf、configure和make步骤。
• CMake：使用CMake构建系统，适用于多种编译器，包括Visual Studio。
• vcpkg：使用vcpkg依赖管理器进行安装。

以上内容为您提供了CppUTest框架的基本安装和使用方法，具体细节请参考项目官方文档和源代码。