C++ 的单元测试工具 —— Catch

[原文地址：http://blog.guorongfei.com/2016/08/22/cpp-unit-test-catch/]
如果你平常使用 Java 语言做开发，当你听到单元测试工具的时候，你很可能马上会想起 JUnit。作为一名C++软件工程师，当我第一次打算给我的程序做单元测试的时候，我的第一 想法是：有这样的工具吗？经过一段时间的搜索之后，我的反应变成了：我该用哪一个？

我在学校的时候，很少听说C++的单元测试工具，以至于我一直认为这样的工具是不存在。 后来慢慢的发现我们可以选择的远比你想象中的要多得多：Catch, Boost.Test, UnitTest++, lest, bandit, igloo, xUnit++, CppTest, CppUnit, CxxTest, cpputest, googletest, cute。

那我们应该使用哪一个呢？如果你在 Google 里面搜索：best c++ unit testing framework。头两条，一条是 stackoverflow 的问答，另一条是 reddit 的问答 。这两个问题都指向同一个单元测试框架：Catch。

为什么使用 Catch

在 Catch 的官方文档中有一篇：Why do we need yet another C++ test framework? 有兴趣的可以去看看。对我来说，它最吸引我的地方主要是：

  • 几乎不用配置，它是一个单头文件的测试框架，压根不要什么<header class="post-header" style="opacity: 1; display: block; transform: translateY(0px);">

C++ 的单元测试工具 —— Catch

发表于 <time title="创建于" itemprop="dateCreated datePublished" datetime="2016-08-22T15:37:30+08:00">2016-08-22</time> | 阅读次数: 2356

</header>

如果你平常使用 Java 语言做开发，当你听到单元测试工具的时候，你很可能马上会想起 JUnit。作为一名C++软件工程师，当我第一次打算给我的程序做单元测试的时候，我的第一 想法是：有这样的工具吗？经过一段时间的搜索之后，我的反应变成了：我该用哪一个？

我在学校的时候，很少听说C++的单元测试工具，以至于我一直认为这样的工具是不存在。 后来慢慢的发现我们可以选择的远比你想象中的要多得多：Catch, Boost.Test, UnitTest++, lest, bandit, igloo, xUnit++, CppTest, CppUnit, CxxTest, cpputest, googletest, cute。

那我们应该使用哪一个呢？如果你在 Google 里面搜索：best c++ unit testing framework。头两条，一条是 stackoverflow 的问答，另一条是 reddit 的问答 。这两个问题都指向同一个单元测试框架：Catch。

为什么使用 Catch

在 Catch 的官方文档中有一篇：Why do we need yet another C++ test framework? 有兴趣的可以去看看。对我来说，它最吸引我的地方主要是：

  • 几乎不用配置，它是一个单头文件的测试框架，压根不要什么额外的配置就可以使用
  • 语法非常简单明了，用它写的测试代码和自然语言一样易懂。

如何使用它

Catch 是单头文件库，你直接 #include “catch.hpp” 它就可以了。然后你就可以像下面 这样写测试代码：

|

<pre>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 );
}
}
WHEN( "more capacity is reserved" ) {
v.reserve( 10 );

THEN( "the capacity changes but not the size" ) {
REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 10 );
}
}
WHEN( "less capacity is reserved" ) {
v.reserve( 0 );

THEN( "neither size nor capacity are changed" ) {
REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );
}
}
}
}
</pre>

|

这几乎是不需要解释就可以理解的读懂的代码。这种测试方式称为 BDD（Behaviour Driven Development），是最新的一种测试方式，它强调的是“行为”而不是“测试”，有兴趣可以看 看这篇文章。

如果你习惯传统的TDD测试，你可以像下面这样写测试代码：

|

<pre>TEST_CASE( "vectors can be sized and resized", "[vector]" ) {

std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

SECTION( "resizing bigger changes size and capacity" ) {
v.resize( 10 );

REQUIRE( v.size() == 10 );
REQUIRE( v.capacity() >= 10 );
}
SECTION( "resizing smaller changes size but not capacity" ) {
v.resize( 0 );

REQUIRE( v.size() == 0 );
REQUIRE( v.capacity() >= 5 );
}
SECTION( "reserving bigger changes capacity but not size" ) {
v.reserve( 10 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 10 );
}
SECTION( "reserving smaller does not change size or capacity" ) {
v.reserve( 0 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );
}
}
</pre>

|

实际上这两种方式是等价，SCENARIO 只是 TEST_CASE 的别名，GIVEN、WHEN、THEN 最终 也是 map 到 SECTION 上面的。这其中的差异只是存在于测试的思维不同而已，你完全可以 根据自己的喜好使用你最喜欢的方式即可。

SECTION 的执行顺序

上面的代码很清晰易懂，不过有一个地方需要注意，那就是 SECTION 的执行方式。在上一 小节的代码中，TEST_CASE 中有 4 个 SECTION，它们并不是单纯的顺序执行关系。在第 一个 SECTION 执行完成之后，会重头开始执行并跳过已经执行过的 SECTION。也就是说上 面的代码的执行路径大概是这样的（去掉了 SECTION 宏之后）：

|

<pre>// SECTION 1
std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

v.resize( 10 );

REQUIRE( v.size() == 10 );
REQUIRE( v.capacity() >= 10 );

// SECTION 2
std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

v.resize( 0 );

REQUIRE( v.size() == 0 );
REQUIRE( v.capacity() >= 5 );

// SECTION 3
std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

v.reserve( 10 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 10 );

// SECTION 4
std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

v.reserve( 0 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );
</pre>

|

测试代码的执行入口

在C++中任何代码需要执行，都需要通过 main 函数这个入口，测试代码也不例外。Catch 不需要我们自己编写 main 函数去调用这些测试代码。它提供了默认的 main 函数入口，你 只需要在（而且仅在）一个文件中加入下面的配置宏：

|

<pre>#define CATCH_CONFIG_MAIN

include "catch.hpp"

</pre>

|

最佳实践

最佳实践是单独用一个文件放这两行代码，把测试代码写在其他的文件中。

之所以这样做是因为Catch是单头文件库，这意味着它里面的内容会最终出现在所有的包含 这个头文件的编译单元中。如果我们把测试代码和上面两行代码放在一起会导致每次编译测 试代码的时候都需要编译 Catch 的内核，这会导致编译速度非常非常的慢。如果把两者分 开，Catch 的内核只需要在一个文件中编译一次（因为 Catch 内部做了判断，如果内核编 译过了是不需要再次编译的，即使你在多个文件中使用了 #include “catch.hpp”）。这个 文件的编译速度相对较慢，但是这个文件不会改动所以整个开发周期中它只需要编译一次， 而不断更新的测试代码的编译速度会因此快很多。

命令行参数

Catch 提供的这个 main 函数实现的另一个强大的功能是丰富的命令行参数，你可以选择执 行其中的某些 TEST_CASE，也可以选择不执行其中的某些 TEST_CASE，你可以用它调整 输出到 xml 文件，也可以用它从文件中读取需要测试的用例。这些命令的具体使用请参考 Catch 的官方文档Command line一节。

TAG

需要注意的是，这些强大的命令行大多数是基于 TAG 的，也就是 TEST_CASE 定义中的第 二个参数。

|

<pre>TEST_CASE( "vectors can be sized and resized", "[vector]" )
</pre>

|

上面的定义中 “[vector]” 就是一个 TAG，你可以提供多个 TAG：

|

<pre>TEST_CASE( "D", "[widget][gadget]" ) { /* ... */ }
</pre>

|

这样的话你可以在命令行中根据 TAG 去选择是否需要执行该 TEST_CASE。比如：

|

<pre>./catch "[vector]" // 只执行那些标记为 vector 的测试用例
</pre>

|

此外你还可以使用一些特殊的字符，比如 [.] 表示隐藏。[.integration] 则表示默认 隐藏，但是可以在命令行中使用 [.integration] 这个 TAG 执行。其他的一些特殊的字符 请参考官方文档的Test cases and sections一节

|

<pre>./catch // 默认不执行 integration

./catch "[.integration]" // 使用 TAG 执行 integration
</pre>

|

提供自己的 main 函数入口

如果你不喜欢上面的处理方式，想要自己提供 main 函数，你可以使用 CATCH_CONFIG_RUNNER，具体的细节请查看官方文档中的 Supplying main() yourself一节。

其他内容

其实 Catch 本身相对来说比较简单，不需要太多其他的学习，大部分的用法是非常的直观 的，看完它的官方教程之后基本上可以上手了，然后有时间慢慢的读一读它的官方文 档集合
额外的配置就可以使用

  • 语法非常简单明了，用它写的测试代码和自然语言一样易懂。

如何使用它

Catch 是单头文件库，你直接 #include “catch.hpp” 它就可以了。然后你就可以像下面 这样写测试代码：

|

<pre>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 );
}
}
WHEN( "more capacity is reserved" ) {
v.reserve( 10 );

THEN( "the capacity changes but not the size" ) {
REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 10 );
}
}
WHEN( "less capacity is reserved" ) {
v.reserve( 0 );

THEN( "neither size nor capacity are changed" ) {
REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );
}
}
}
}
</pre>

|

这几乎是不需要解释就可以理解的读懂的代码。这种测试方式称为 BDD（Behaviour Driven Development），是最新的一种测试方式，它强调的是“行为”而不是“测试”，有兴趣可以看 看这篇文章。

如果你习惯传统的TDD测试，你可以像下面这样写测试代码：

|

<pre>TEST_CASE( "vectors can be sized and resized", "[vector]" ) {

std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

SECTION( "resizing bigger changes size and capacity" ) {
v.resize( 10 );

REQUIRE( v.size() == 10 );
REQUIRE( v.capacity() >= 10 );
}
SECTION( "resizing smaller changes size but not capacity" ) {
v.resize( 0 );

REQUIRE( v.size() == 0 );
REQUIRE( v.capacity() >= 5 );
}
SECTION( "reserving bigger changes capacity but not size" ) {
v.reserve( 10 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 10 );
}
SECTION( "reserving smaller does not change size or capacity" ) {
v.reserve( 0 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );
}
}
</pre>

|

实际上这两种方式是等价，SCENARIO 只是 TEST_CASE 的别名，GIVEN、WHEN、THEN 最终 也是 map 到 SECTION 上面的。这其中的差异只是存在于测试的思维不同而已，你完全可以 根据自己的喜好使用你最喜欢的方式即可。

SECTION 的执行顺序

上面的代码很清晰易懂，不过有一个地方需要注意，那就是 SECTION 的执行方式。在上一 小节的代码中，TEST_CASE 中有 4 个 SECTION，它们并不是单纯的顺序执行关系。在第 一个 SECTION 执行完成之后，会重头开始执行并跳过已经执行过的 SECTION。也就是说上 面的代码的执行路径大概是这样的（去掉了 SECTION 宏之后）：

|

<pre>// SECTION 1
std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

v.resize( 10 );

REQUIRE( v.size() == 10 );
REQUIRE( v.capacity() >= 10 );

// SECTION 2
std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

v.resize( 0 );

REQUIRE( v.size() == 0 );
REQUIRE( v.capacity() >= 5 );

// SECTION 3
std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

v.reserve( 10 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 10 );

// SECTION 4
std::vector<int> v( 5 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );

v.reserve( 0 );

REQUIRE( v.size() == 5 );
REQUIRE( v.capacity() >= 5 );
</pre>

|

测试代码的执行入口

在C++中任何代码需要执行，都需要通过 main 函数这个入口，测试代码也不例外。Catch 不需要我们自己编写 main 函数去调用这些测试代码。它提供了默认的 main 函数入口，你 只需要在（而且仅在）一个文件中加入下面的配置宏：

|

<pre>#define CATCH_CONFIG_MAIN

include "catch.hpp"

</pre>

|

最佳实践

最佳实践是单独用一个文件放这两行代码，把测试代码写在其他的文件中。

之所以这样做是因为Catch是单头文件库，这意味着它里面的内容会最终出现在所有的包含 这个头文件的编译单元中。如果我们把测试代码和上面两行代码放在一起会导致每次编译测 试代码的时候都需要编译 Catch 的内核，这会导致编译速度非常非常的慢。如果把两者分 开，Catch 的内核只需要在一个文件中编译一次（因为 Catch 内部做了判断，如果内核编 译过了是不需要再次编译的，即使你在多个文件中使用了 #include “catch.hpp”）。这个 文件的编译速度相对较慢，但是这个文件不会改动所以整个开发周期中它只需要编译一次， 而不断更新的测试代码的编译速度会因此快很多。

命令行参数

Catch 提供的这个 main 函数实现的另一个强大的功能是丰富的命令行参数，你可以选择执 行其中的某些 TEST_CASE，也可以选择不执行其中的某些 TEST_CASE，你可以用它调整 输出到 xml 文件，也可以用它从文件中读取需要测试的用例。这些命令的具体使用请参考 Catch 的官方文档Command line一节。

TAG

需要注意的是，这些强大的命令行大多数是基于 TAG 的，也就是 TEST_CASE 定义中的第 二个参数。

|

<pre>TEST_CASE( "vectors can be sized and resized", "[vector]" )
</pre>

|

上面的定义中 “[vector]” 就是一个 TAG，你可以提供多个 TAG：

|

<pre>TEST_CASE( "D", "[widget][gadget]" ) { /* ... */ }
</pre>

|

这样的话你可以在命令行中根据 TAG 去选择是否需要执行该 TEST_CASE。比如：

|

<pre>./catch "[vector]" // 只执行那些标记为 vector 的测试用例
</pre>

|

此外你还可以使用一些特殊的字符，比如 [.] 表示隐藏。[.integration] 则表示默认 隐藏，但是可以在命令行中使用 [.integration] 这个 TAG 执行。其他的一些特殊的字符 请参考官方文档的Test cases and sections一节

|

<pre>./catch // 默认不执行 integration

./catch "[.integration]" // 使用 TAG 执行 integration
</pre>

|

提供自己的 main 函数入口

如果你不喜欢上面的处理方式，想要自己提供 main 函数，你可以使用 CATCH_CONFIG_RUNNER，具体的细节请查看官方文档中的 Supplying main() yourself一节。

其他内容

其实 Catch 本身相对来说比较简单，不需要太多其他的学习，大部分的用法是非常的直观 的，看完它的官方教程之后基本上可以上手了，然后有时间慢慢的读一读它的官方文 档集合

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 195,898评论 5赞 462
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 82,401评论 2赞 373
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 143,058评论 0赞 325
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,539评论 1赞 267
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 61,382评论 5赞 358
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,319评论 1赞 273
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,706评论 3赞 386
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,370评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,664评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,715评论 2赞 312
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,476评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,326评论 3赞 313
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,730评论 3赞 299
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,003评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,275评论 1赞 251
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,683评论 2赞 342
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,877评论 2赞 335