使用Catch2、JUnit和GitLab CI进行C++单元测试开发

使用Catch2、JUnit和GitLab CI进行C++单元测试开发

💡 原文英文,约3900词,阅读约需15分钟。
📝

内容提要

本教程介绍了使用Catch2和GitLab CI在C++项目中设置单元测试,包括安装Catch2、项目结构化和自动化测试过程。还展示了如何在GitLab中查看测试报告。

🔎

延伸解读

模拟API请求在单元测试中的价值

文章使用mockHttpRequest函数模拟OpenWeatherMap API的响应,使测试不依赖真实网络请求。这样做可以控制输入数据、预定义响应,避免因外部API变化或网络问题导致测试不稳定。同时,通过模拟不同端点(地理编码、空气质量、天气),能全面验证函数逻辑,并方便模拟失败场景。这种隔离外部依赖的做法是单元测试的最佳实践。

条件编译宏TESTING解决链接冲突

在测试中覆盖httpRequest函数会导致与functions.cpp中的原函数冲突,产生链接错误。文章通过定义TESTING宏,在CMake中为测试目标添加编译定义,并在functions.cpp中用#ifndef TESTING包裹原函数,使得测试编译时排除原实现,仅使用mock版本。这种条件编译技巧有效解决了测试替身带来的符号重复问题,保持了生产代码的完整性。

GitLab CI集成JUnit报告提升测试可见性

文章配置.gitlab-ci.yml,在test阶段运行测试并指定--reporter junit -o test-results.xml,生成JUnit格式报告。GitLab CI通过artifacts.reports.junit解析该报告,在Pipeline的Tests标签页展示测试结果。这使团队能直观看到每个测试用例的通过/失败状态,快速定位问题。文章还演示了故意引入bug导致测试失败,验证了报告功能的有效性。

使用SECTION宏优化测试组织

随着测试增多,文章建议用Catch2的SECTION宏将相关测试分组。例如将API密钥验证和地理编码验证归入“Preprocessing Steps”测试用例,将空气质量和天气获取归入“API Data Retrieval”。SECTION允许在单个TEST_CASE内定义多个独立场景,共享setup代码,且每个SECTION独立运行。这提高了测试的可读性和可维护性,便于按功能分类管理。

❓

Q&A

如何在C++项目中安装Catch2测试框架?

可以通过将Catch2作为子模块添加到项目中,使用命令:git submodule add https://github.com/catchorg/Catch2.git externals/Catch2。

如何在GitLab CI中设置自动化测试?

需要创建.gitlab-ci.yml文件,定义构建和测试阶段,并在测试阶段运行测试命令生成JUnit XML报告。

如何编写Catch2测试用例?

使用TEST_CASE宏定义测试用例,并使用REQUIRE或CHECK宏进行断言来验证代码行为。

如何模拟API请求进行测试?

可以创建一个mockHttpRequest函数,根据请求的URL返回预定义的JSON响应,以控制输入数据。

如何在CMake中定义条件编译宏?

在CMakeLists.txt中使用target_compile_definitions命令定义宏,例如:target_compile_definitions(tests PRIVATE TESTING)。

如何查看GitLab中的测试报告?

在GitLab UI的Pipeline视图中,点击Tests标签可以查看测试结果和报告。

🏷️

标签

➡️

继续阅读