C++基于googletest做单元测试

2020年1月30日 评论

一、安装googletest

单测对程序员而言是提升代码质量最重要、最有效的一个措施,对程序员来说,要想写一个好的程序,那么必定少不了好的单元测试。googletest(gtest)是google开发出来的一个开源的、跨平台的测试框架,是C++中最出名的测试框架。

gtest支持linux、windows以及mac系统,安装它依赖下面几项:

  1. gtest源码:gtest属于开源项目,代码仓库https://github.com/google/googletest
  2. cmake:gtest使用cmake构建项目,编译需要cmake环境,cmake下载地址
  3. 编译器:linux环境下可使用g++编译,windows环境下使用vs或者clion等工具编译,mac环境使用xcode或clion等工具编译。

这里的测试环境为mac+clion(付费),clion下载地址,选择clion是因为clion跨平台。

windows环境除了配置clion编译环境以外,其他步骤和mac系统一致。

1.1 环境配置

第一步,先使用git克隆代码到本地,注意最好不要放到中文路径了。

第二步,安装cmake,不同系统的的安装方式不一样,windows在上面的页面下载一直下一步安装就行了,其他系统可以直接使用对应平台的包管理工具安装。

第三步,安装clion,linux和mac环境下安装clion和gcc环境就可以使用了,windows配置clion编译环境可参考Window10上CLion极简配置教程

1.2 编译gtest库

配置好环境后,使用clion打开代码目录,然后载入代码目录,选择gtest项目编译生成:

C++基于googletest做单元测试

编译成功后生成libgtestd.a文件到cmake编译路径的lib路径下:

C++基于googletest做单元测试

生成的libgtestd.a即为gtest的库文件,项目中引用这个库文件就能使用gtest了。

二、使用googletest

2.1 引入库

将libgtestd.a文件拷贝到代码根路径的lib路径下,在CMakeList.txt中加上以下内容:

2.2 引入头文件

拷贝googletest/include目录下的gtest目录到当前目录下,然后在CMakeList.txt中添加上对应的调用:

然后在代码中添加头文件gtest/gtest.h就可以使用了。

2.3 测试

添加代码add.cpp

执行结果:

![](/Users/maqian/Library/Application Support/typora-user-images/image-20200208101215701.png)

三、gtest的使用教程

参考文档:Googletest Primer,google官方出品。

3.1 基本用法

gtest最基本的用法就是断言,它内部提供了很多种断言方式,例如:

其中ASSERT_*的断言,在条件不满足后会终止,而EXPECT_*不会终止。

以上面的代码为例,代码编写了一个add函数,返回两个传参的和:

然后引入gtest并写了三个测试用例:

三个用例分别表示:

  • 测试零值相加
  • 测试正数相加
  • 测试负数相加

主函数中添加启动gtest的入口:

运行程序,系统就会自动调用三个测试用例的函数来测试,并输出测试报告:

如果中间有断言失败的地方,报告也会表达出来。例如修改上面测试中的负数相加函数来制造错误场景:

再执行测试,报告中就会把不通过的案例展示出来,并且会定位到对应的行,打印出失败的详细原因:

C++基于googletest做单元测试

当案例执行失败后,我们也可以打印出一些我们自己的数据以供调试使用,例如:

案例失败后,不仅会打印出失败原因,还会打印出我们自己添加的语句:

C++基于googletest做单元测试

3.2 常用断言

基本断言

致命断言 非致命断言 验证
ASSERT_TRUE(condition); EXPECT_TRUE(condition); 条件condition为真
ASSERT_FALSE(condition); EXPECT_FALSE(condition); 条件condition为假

二进制比较

致命断言 非致命断言 验证
ASSERT_EQ(val1, val2); EXPECT_EQ(val1, val2); val1 == val2
ASSERT_NE(val1, val2); EXPECT_NE(val1, val2); val1 != val2
ASSERT_LT(val1, val2); EXPECT_LT(val1, val2); val1 < val2
ASSERT_LE(val1, val2); EXPECT_LE(val1, val2); val1 <= val2
ASSERT_GT(val1, val2); EXPECT_GT(val1, val2); val1 > val2
ASSERT_GE(val1, val2); EXPECT_GE(val1, val2); val1 >= val2

字符串比较

致命断言 非致命断言 验证
ASSERT_STREQ(str1,str2); EXPECT_STREQ(str1,str2); 两个c字符串内容相同
ASSERT_STRNE(str1,str2); EXPECT_STRNE(str1,str2); 两个c字符串内容不同
ASSERT_STRCASEEQ(str1,str2); EXPECT_STRCASEEQ(str1,str2); 两个c字符串内容相同(忽略大小写)
ASSERT_STRCASENE(str1,str2); EXPECT_STRCASENE(str1,str2); 两个c字符串内容不同(忽略大小写)

四、使用Test Fixtures

Test Fixtures使用场景:测试案例需要初始化数据或者多个测试案例使用相同的测试数据。

例如在对一个的做单元测试时,测试pop功能,按照上面的测试方法,测试案例得这么写:

测试过程可以描述为:

  1. 创建一个栈对象的实例s。
  2. 推入3个元素,以便后面pop使用。
  3. 开始测试pop。

从直观上来看,所有和pop相关的测试案例都要这么来写,要先推入元素,再弹出。而实际上,步骤1和步骤2是和本轮测试无关,它只起到了初始化数据的作用,它是多余的,但是所有的测试案例又不得不做这一步操作。那么有没有办法解决这个问题呢?有!Test Fixtures的就是解决这种问题的,它可以在测试案例开始前自动生成好需要的数据。

定义了一个简单的的类:

再定义一个测试类stack_test

它要公有继承于::testing::Test,其中的SetUpTearDown函数分别是初始化和清理函数,也就是类生成前和使用后要做的工作。

此时使用TEST_F宏定义来测试:

在执行TEST_F之前,gtest会自动构建一个stack_test的实例,并执行SetUp函数。也就是说,当真正执行到我们的测试代码的时候,就已经存在一个初始化好的测试环境了。这个时候可以直接访问stack_test的内部成员,通过成员变量来做单元测试。

原理来看其实很简单,就是把初始化的过程交给了gtest来完成,它来帮我们实例对象,进行初始化,我们直接用就行。

测试结果:

C++基于googletest做单元测试

五、其他

5.1 clion环境跨平台使用gtest

如何在不改变CMakeList.txt的情况下跨平台使用gtest?配置CMakeList,根据不同平台读取不同的库:

六、参考

Google Test support

Googletest Primer

如何通过原始套接字修改IP数据包头 编程语言

如何通过原始套接字修改IP数据包头

背景:我们的设备上有个链路探测的功能,会定时请求公网的某个IP地址,以探测网络是不是连通的。具体的做法是会使用icmp或dns探测远端服务器,看请求能否正常响应,如果有响应,则认为链路正常,否则则认为...
给socket分配随机端口 C/C++

给socket分配随机端口

客户端的socket不需要手动执行bind绑定地址,但这不意味着客户端socket真的不需要绑定端口,实际上是内核它帮我们做了这个操作,在执行connect时,内核发现没有绑定端口,就会自动选择一个合...
匿名

发表评论

匿名网友