C / C++ / 系统课时
为核心网络组件编写测试
为核心网络组件编写测试
网络库最难复现的缺陷通常藏在边界条件里:Buffer 扩容后的读写位置、Codec 半包粘包、Timer 同时到期、EventLoop 跨线程唤醒,以及连接关闭时的状态竞争。测试的目标是把这些问题固定成自动化回归用例,让一次修复以后不再反复出现。
学习目标
- 为 Buffer、Codec、Timer、EventLoop 和连接状态设计最小但有效的测试集合
- 区分同步单元测试与需要事件循环参与的异步测试
- 用 CTest 统一执行并把历史缺陷固化成回归测试
先按组件的失效方式设计用例
不要从“给每个类写几个测试”出发,而要从最容易出错的状态边界反推用例。核心覆盖面可以收敛为下面几类:
| 组件 | 优先测试内容 | 典型断言 |
|---|---|---|
| Buffer | 扩容、读写游标、回收已读空间、空读 | 数据不丢失,长度与游标一致 |
| Codec | 半包、粘包、非法长度、连续多帧 | 只在完整帧到齐时产出消息 |
| Timer | 单次、重复、取消、同刻到期 | 次数正确,被取消任务不执行 |
| EventLoop | 本线程执行、跨线程投递、唤醒与退出 | 任务最终在目标 Loop 执行 |
| Connection | 建连、关闭、半关闭、错误、重复 close | 状态只沿合法方向迁移 |
连接测试尤其适合按状态迁移来检查,而不是只断言某个布尔字段。

先把纯同步组件测扎实
Buffer 和多数长度字段 Codec 都可以不启动线程,直接输入数据并断言结果。这类测试执行快、失败定位准,应该占回归测试的大多数。
下面是 GoogleTest 风格的片段示例,假设工程中已经存在 Buffer 和 LengthFieldCodec,并分别提供 append、readableBytes、retrieveAsString 与 feed 接口。片段依赖你的实际网络库类型,接口名不同时应做对应替换。
#include <gtest/gtest.h>
#include "net/buffer.h"
#include "net/length_field_codec.h"
TEST(BufferTest, PreserveDataAfterGrow) {
Buffer buffer(4);
buffer.append("abcd", 4);
buffer.append("efgh", 4); // 触发扩容后,原数据必须仍连续可读。
EXPECT_EQ(buffer.readableBytes(), 8u);
EXPECT_EQ(buffer.retrieveAsString(8), "abcdefgh");
}
TEST(LengthFieldCodecTest, WaitForCompleteFrame) {
LengthFieldCodec codec;
const std::string part1{"\x00\x00\x00\x05he", 6};
const std::string part2{"llo", 3};
EXPECT_TRUE(codec.feed(part1).empty());
const auto messages = codec.feed(part2);
ASSERT_EQ(messages.size(), 1u);
EXPECT_EQ(messages.front(), "hello");
}这两个测试的价值不在代码量,而在于它们固定了两个高频回归点:Buffer 扩容不能破坏已有数据;Codec 收到半包时不能提前产出消息。
异步组件要控制时间和线程边界
Timer 和 EventLoop 测试最容易变成偶发失败。不要用很大的 sleep 猜任务“应该执行完了”,而要用 promise、future、latch 或条件变量等待明确事件,并给整个等待设置超时。
下面的片段示例假设 EventLoopThread 能创建独立 Loop,queueInLoop 支持跨线程投递。测试通过 promise 确认任务确实在目标线程执行,而不是依赖日志肉眼判断。
#include <chrono>
#include <future>
#include <thread>
#include <gtest/gtest.h>
#include "net/event_loop.h"
#include "net/event_loop_thread.h"
TEST(EventLoopTest, RunQueuedTaskInLoopThread) {
EventLoopThread loopThread;
EventLoop* loop = loopThread.startLoop();
std::promise<std::thread::id> executed;
auto future = executed.get_future();
// 从测试线程投递任务,验证 Loop 能被唤醒并在自己的线程执行回调。
loop->queueInLoop([&executed] {
executed.set_value(std::this_thread::get_id());
});
ASSERT_EQ(future.wait_for(std::chrono::seconds(1)),
std::future_status::ready);
EXPECT_NE(future.get(), std::this_thread::get_id());
loop->quit();
}这个测试如果超时,通常说明跨线程唤醒、任务队列可见性或 Loop 退出机制存在问题。Timer 测试也应采用同样思路:等待“计时器实际触发”这一事件,而不是固定休眠后猜测结果。
把连接状态和历史缺陷固化成回归测试
连接对象通常涉及 Channel、socket、EventLoop 和回调,适合用 fake 或最小测试桩隔离外部依赖。每发现一次线上缺陷,都应新增一个能在修复前稳定失败、修复后稳定通过的测试。
例如“重复 close 导致析构两次”不要只修实现,而应新增用例:第一次 close 后状态进入 Closing 或 Closed;第二次 close 不重复注销 Channel、不重复触发用户关闭回调;最终资源释放次数仍为一次。对于 peer EOF、写缓冲未清空等情况,也应分别固定状态转换结果。
状态测试的核心不是覆盖每一行代码,而是证明非法迁移不会发生。只要状态机约束清楚,很多竞态问题就能在单测阶段暴露。
用 CTest 做统一回归入口
建议把所有网络库测试注册到 CTest,让本地、CI 和发布前检查使用同一条命令。下面的配置片段假设已经通过包管理或工程依赖提供 GoogleTest。
enable_testing()
add_executable(network_tests
buffer_test.cpp
codec_test.cpp
timer_test.cpp
event_loop_test.cpp
connection_test.cpp
)
target_link_libraries(network_tests
PRIVATE
network
GTest::gtest_main
)
include(GoogleTest)
gtest_discover_tests(network_tests)该配置生效后,先构建测试目标,再执行:
cmake -S . -B build
cmake --build build --target network_tests
ctest --test-dir build --output-on-failure预期结果:
100% tests passed, 0 tests failed out of <N>
Total Test time (real) = <TIME><N> 取决于当前注册的测试数量,<TIME> 会随机器性能变化。只要失败用例能打印断言位置和实际值,CI 就能直接定位回归点。
测试完成度不应按“类覆盖率”衡量,而应看关键边界是否被固定:数据分片、线程切换、定时取消、连接关闭和过去真实发生过的缺陷,都应该有一条自动化测试守住。