名称: cpp-测试 描述: 仅在编写/更新/修复C++测试、配置GoogleTest/CTest、诊断失败或不稳定的测试,或添加覆盖率/消毒器时使用。
C++ 测试 (代理技能)
专注于现代C++ (C++17/20) 使用GoogleTest/GoogleMock与CMake/CTest的测试工作流。
何时使用
- 编写新的C++测试或修复现有测试
- 为C++组件设计单元/集成测试覆盖
- 添加测试覆盖、CI门控或回归保护
- 配置CMake/CTest工作流以确保一致执行
- 调查测试失败或不稳定行为
- 启用消毒器以进行内存/竞争诊断
何时不使用
- 实现与测试变更无关的新产品功能
- 与测试覆盖或失败无关的大规模重构
- 无需测试回归验证的性能调优
- 非C++项目或非测试任务
核心概念
- TDD循环: 红 → 绿 → 重构 (测试先行,最小修复,然后清理)。
- 隔离: 优先使用依赖注入和仿制品,而非全局状态。
- 测试布局:
tests/unit,tests/integration,tests/testdata。 - 模拟 vs 仿制品: 模拟用于交互,仿制品用于有状态行为。
- CTest发现: 使用
gtest_discover_tests()进行稳定的测试发现。 - CI信号: 先运行子集,然后使用
--output-on-failure运行完整套件。
TDD 工作流
遵循 红 → 绿 → 重构 循环:
- 红: 编写一个捕获新行为的失败测试
- 绿: 实现最小的变更以通过测试
- 重构: 在测试保持通过的情况下清理代码
// tests/add_test.cpp
#include <gtest/gtest.h>
int Add(int a, int b); // 由生产代码提供。
TEST(AddTest, AddsTwoNumbers) { // 红
EXPECT_EQ(Add(2, 3), 5);
}
// src/add.cpp
int Add(int a, int b) { // 绿
return a + b;
}
// 重构: 测试通过后简化/重命名
代码示例
基础单元测试 (gtest)
// tests/calculator_test.cpp
#include <gtest/gtest.h>
int Add(int a, int b); // 由生产代码提供。
TEST(CalculatorTest, AddsTwoNumbers) {
EXPECT_EQ(Add(2, 3), 5);
}
测试夹具 (gtest)
// tests/user_store_test.cpp
// 伪代码存根: 用项目类型替换 UserStore/User。
#include <gtest/gtest.h>
#include <memory>
#include <optional>
#include <string>
struct User { std::string name; };
class UserStore {
public:
explicit UserStore(std::string /*path*/) {}
void Seed(std::initializer_list<User> /*users*/) {}
std::optional<User> Find(const std::string &/*name*/) { return User{"alice"}; }
};
class UserStoreTest : public ::testing::Test {
protected:
void SetUp() override {
store = std::make_unique<UserStore>(":memory:");
store->Seed({{"alice"}, {"bob"}});
}
std::unique_ptr<UserStore> store;
};
TEST_F(UserStoreTest, FindsExistingUser) {
auto user = store->Find("alice");
ASSERT_TRUE(user.has_value());
EXPECT_EQ(user->name, "alice");
}
模拟 (gmock)
// tests/notifier_test.cpp
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <string>
class Notifier {
public:
virtual ~Notifier() = default;
virtual void Send(const std::string &message) = 0;
};
class MockNotifier : public Notifier {
public:
MOCK_METHOD(void, Send, (const std::string &message), (override));
};
class Service {
public:
explicit Service(Notifier ¬ifier) : notifier_(notifier) {}
void Publish(const std::string &message) { notifier_.Send(message); }
private:
Notifier ¬ifier_;
};
TEST(ServiceTest, SendsNotifications) {
MockNotifier notifier;
Service service(notifier);
EXPECT_CALL(notifier, Send("hello")).Times(1);
service.Publish("hello");
}
CMake/CTest 快速入门
# CMakeLists.txt (节选)
cmake_minimum_required(VERSION 3.20)
project(example LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
include(FetchContent)
# 优先使用项目锁定版本。如果使用标签,请根据项目策略使用固定版本。
set(GTEST_VERSION v1.17.0) # 根据项目策略调整。
FetchContent_Declare(
googletest
URL https://github.com/google/googletest/archive/refs/tags/${GTEST_VERSION}.zip
)
FetchContent_MakeAvailable(googletest)
add_executable(example_tests
tests/calculator_test.cpp
src/calculator.cpp
)
target_link_libraries(example_tests GTest::gtest GTest::gmock GTest::gtest_main)
enable_testing()
include(GoogleTest)
gtest_discover_tests(example_tests)
cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build -j
ctest --test-dir build --output-on-failure
运行测试
ctest --test-dir build --output-on-failure
ctest --test-dir build -R ClampTest
ctest --test-dir build -R "UserStoreTest.*" --output-on-failure
./build/example_tests --gtest_filter=ClampTest.*
./build/example_tests --gtest_filter=UserStoreTest.FindsExistingUser
调试失败
- 使用 gtest 过滤器重新运行单个失败的测试。
- 在失败的断言周围添加作用域日志记录。
- 启用消毒器重新运行。
- 根本原因修复后扩展到完整套件。
覆盖率
优先使用目标级设置,而非全局标志。
option(ENABLE_COVERAGE "启用覆盖率标志" OFF)
if(ENABLE_COVERAGE)
if(CMAKE_CXX_COMPILER_ID MATCHES "GNU")
target_compile_options(example_tests PRIVATE --coverage)
target_link_options(example_tests PRIVATE --coverage)
elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
target_compile_options(example_tests PRIVATE -fprofile-instr-generate -fcoverage-mapping)
target_link_options(example_tests PRIVATE -fprofile-instr-generate)
endif()
endif()
GCC + gcov + lcov:
cmake -S . -B build-cov -DENABLE_COVERAGE=ON
cmake --build build-cov -j
ctest --test-dir build-cov
lcov --capture --directory build-cov --output-file coverage.info
lcov --remove coverage.info '/usr/*' --output-file coverage.info
genhtml coverage.info --output-directory coverage
Clang + llvm-cov:
cmake -S . -B build-llvm -DENABLE_COVERAGE=ON -DCMAKE_CXX_COMPILER=clang++
cmake --build build-llvm -j
LLVM_PROFILE_FILE="build-llvm/default.profraw" ctest --test-dir build-llvm
llvm-profdata merge -sparse build-llvm/default.profraw -o build-llvm/default.profdata
llvm-cov report build-llvm/example_tests -instr-profile=build-llvm/default.profdata
消毒器
option(ENABLE_ASAN "启用地址消毒器" OFF)
option(ENABLE_UBSAN "启用未定义行为消毒器" OFF)
option(ENABLE_TSAN "启用线程消毒器" OFF)
if(ENABLE_ASAN)
add_compile_options(-fsanitize=address -fno-omit-frame-pointer)
add_link_options(-fsanitize=address)
endif()
if(ENABLE_UBSAN)
add_compile_options(-fsanitize=undefined -fno-omit-frame-pointer)
add_link_options(-fsanitize=undefined)
endif()
if(ENABLE_TSAN)
add_compile_options(-fsanitize=thread)
add_link_options(-fsanitize=thread)
endif()
不稳定测试防护措施
- 切勿使用
sleep进行同步;使用条件变量或门闩。 - 为每个测试创建唯一的临时目录并始终清理它们。
- 避免在单元测试中依赖真实时间、网络或文件系统。
- 对随机输入使用确定性种子。
最佳实践
应该做的
- 保持测试的确定性和隔离性
- 优先使用依赖注入而非全局变量
- 使用
ASSERT_*进行前提条件检查,EXPECT_*进行多重检查 - 在 CTest 标签或目录中分离单元测试与集成测试
- 在 CI 中运行消毒器以进行内存和竞争检测
不应该做的
- 不要在单元测试中依赖真实时间或网络
- 当可以使用条件变量时,不要使用 sleep 作为同步手段
- 不要过度模拟简单的值对象
- 不要对非关键日志使用脆弱的字符串匹配
常见陷阱
- 使用固定的临时路径 → 为每个测试生成唯一的临时目录并清理它们。
- 依赖挂钟时间 → 注入时钟或使用模拟时间源。
- 不稳定的并发测试 → 使用条件变量/门闩和有界等待。
- 隐藏的全局状态 → 在夹具中重置全局状态或移除全局变量。
- 过度模拟 → 优先使用仿制品处理有状态行为,仅模拟交互。
- 缺少消毒器运行 → 在 CI 中添加 ASan/UBSan/TSan 构建。
- 仅在调试构建上运行覆盖率 → 确保覆盖率目标使用一致的标志。
可选附录: 模糊测试 / 属性测试
仅在项目已支持 LLVM/libFuzzer 或属性测试库时使用。
- libFuzzer: 最适合具有最小 I/O 的纯函数。
- RapidCheck: 基于属性的测试,用于验证不变量。
最小 libFuzzer 测试工具 (伪代码: 替换 ParseConfig):
#include <cstddef>
#include <cstdint>
#include <string>
extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
std::string input(reinterpret_cast<const char *>(data), size);
// ParseConfig(input); // 项目函数
return 0;
}
GoogleTest 的替代方案
- Catch2: 仅头文件,表达性匹配器
- doctest: 轻量级,最小的编译开销