Catch2 开源测试框架教程
项目介绍
Catch2 是一个主要用于 C++ 的单元测试框架,同时也提供了基本的微基准测试功能和简单的 BDD(行为驱动开发)宏。Catch2 的主要优势在于使用它既简单又自然。测试名称不需要是有效的标识符,断言看起来像正常的 C++ 布尔表达式,并且部分测试提供了共享设置和拆卸代码的便捷方式。
项目快速启动
安装 Catch2
Catch2 是一个头文件库,因此安装非常简单。只需下载 catch.hpp
文件并包含在你的项目中即可。
# 下载 catch.hpp
wget https://github.com/catchorg/Catch2/releases/download/v2.13.8/catch.hpp
编写第一个测试
在你的项目中创建一个测试文件 test.cpp
,并添加以下代码:
#define CATCH_CONFIG_MAIN // This tells Catch to provide a main() - only do this in one cpp file
#include "catch.hpp"
unsigned int Factorial( unsigned int number ) {
return number <= 1 ? number : Factorial(number-1)*number;
}
TEST_CASE( "Factorials are computed", "[factorial]" ) {
REQUIRE( Factorial(1) == 1 );
REQUIRE( Factorial(2) == 2 );
REQUIRE( Factorial(3) == 6 );
REQUIRE( Factorial(10) == 3628800 );
}
运行测试
编译并运行你的测试:
g++ -o test test.cpp
./test
应用案例和最佳实践
单元测试
Catch2 非常适合编写单元测试。以下是一个简单的单元测试示例:
#include "catch.hpp"
int Add(int a, int b) {
return a + b;
}
TEST_CASE( "Addition is correct", "[math]" ) {
REQUIRE( Add(1, 2) == 3 );
REQUIRE( Add(-1, -1) == -2 );
REQUIRE( Add(0, 0) == 0 );
}
BDD 风格测试
Catch2 也支持 BDD 风格的测试:
#include "catch.hpp"
SCENARIO( "Vectors can be sized and resized", "[vector]" ) {
GIVEN( "A vector with some items" ) {
std::vector<int> v(5);
REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );
WHEN( "the size is increased" ) {
v.resize(10);
THEN( "the size and capacity change" ) {
REQUIRE( v.size() == 10 );
REQUIRE( v.capacity() >= 10 );
}
}
WHEN( "the size is reduced" ) {
v.resize(0);
THEN( "the size changes but not capacity" ) {
REQUIRE( v.size() == 0 );
REQUIRE( v.capacity() >= 5 );
}
}
}
}
典型生态项目
Catch2 可以与其他 C++ 工具和库集成,例如:
- CMake: 用于构建系统,可以轻松集成 Catch2 测试。
- Conan: 用于包管理,可以方便地安装和管理 Catch2。
- Google Test: 另一个流行的 C++ 测试框架,可以与 Catch2 结合使用。
通过这些工具和库,你可以更高效地开发和测试你的 C++ 项目。