GTest使用手册

玩转Google开源C++单元测试框架GoogleTest系列(gtest)(总)前段时间学习和了解了下Google的开源C++单元测试框架GoogleTest，简称gtest，非常的不错。我们原来使用的是自己实现的一套单元测试框架，在使用过程中，发现越来越多使用不便之处，而这样不便之处，gtest恰恰很好的解决了。其实gtest本身的实现并不复杂，我们完全可以模仿gtest，不断的完善我们的测试框架，但最后我们还是决定使用gtest取代掉原来的自己的测试框架，原因是：1.不断完善我们的测试框架之后就会发觉相当于把gtest重新做了一遍，虽然轮子造的很爽，但是不是必要的。2.使用gtest可以免去维护测试框架的麻烦，让我们有更多精力投入到案例设计上。3.gtest提高了非常完善的功能，并且简单易用，极大的提高了编写测试案例的效率。如果想对gtest内部探个究竟，就把它的代码下载下来研究吧，这就是开源的好处，哈！官方已经有如此完备的文档了，为什么我还要写呢？一方面是自己记记笔记，好记性不如烂笔头，以后自己想查查一些用法也可以直接在这里查到，一方面是对于不想去看一大堆英文文档的朋友，在我这里可以快速的找到gtest相关的内容。一、初识gtest1、前言本篇将介绍一些gtest的基本使用，包括下载，安装，编译，建立我们第一个测试Demo工程，以及编写一个最简单的测试案例。2、下载如果不记得网址，直接在google里搜gtest，第一个就是。目前gtest的最新版本为1.3.03、编译下载解压后，里面有个msvc目录：使用VS的同学可以直接打开msvc里面的工程文件，如果你在使用的是VS2005或是VS2008，打开后会提示你升级，升完级后，我们直接编译里面的“gtest”工程，可以直接编过的。这里要提醒一下的是，如果你升级为VS2008的工程，那么你的测试Demo最好也是VS2008工程，不然你会发现很郁闷，你的Demo怎么也编不过，我也曾折腾了好久，当时我升级为了VS2008工程，结果我使用VS2005工程建Demo，死活编不过。(这里有人误解了，并不是说只能在VS2008中编译，在VS2005中同样可以。如果要编译VS2005版本，最好保证gtest和你的测试工程都使用VS2005工程。)编译之后，在msvc里面的Debug或是Release目录里看到编译出来的gtestd.lib或是gtest.lib文件。4、第一个Demo下面我们开始建立我们的第一个Demo了，假如之前使用的VS2008编译的gtest，那么，我们在VS2008中，新建一个Win32ConsoleApplication。接着就是设置工程属性，总结如下：1.设置gtest头文件路径2.设置gtest.lib路径3.RuntimeLibrary设置如果是Release版本，RuntimeLibrary设为/MT。当然，其实你也可以选择动态链接（/MD），前提是你之前编译的gtest也使用了同样是/MD选项。工程设置后了后，我们来编写一个最简单测试案例试试，我们先来写一个被测试函数：intFoo(inta,intb){if(a==0||b==0){throwdon'tdothat;}intc=a%b;if(c==0)returnb;returnFoo(b,c);}没错，上面的函数是用来求最大公约数的。下面我们就来编写一个简单的测试案例。#includegtest/gtest.hTEST(FooTest,HandleNoneZeroInput){EXPECT_EQ(2,Foo(4,10));EXPECT_EQ(6,Foo(30,18));}上面可以看到，编写一个测试案例是多么的简单。我们使用了TEST这个宏，它有两个参数，官方的对这两个参数的解释为：[TestCaseName，TestName]，而我对这两个参数的定义是：[TestSuiteName，TestCaseName]，在下一篇我们再来看为什么这样定义。对检查点的检查，我们上面使用到了EXPECT_EQ这个宏，这个宏用来比较两个数字是否相等。Google还包装了一系列EXPECT_*和ASSERT_*的宏，而EXPECT系列和ASSERT系列的区别是：1.EXPECT_*失败时，案例继续往下执行。2.ASSERT_*失败时，直接在当前函数中返回，当前函数中ASSERT_*后面的语句将不会执行。在下一篇，我们再来具体讨论这些断言宏。为了让我们的案例运行起来，我们还需要在main函数中添加如下代码：int_tmain(intargc,_TCHAR*argv[]){testing::InitGoogleTest(&argc,argv);returnRUN_ALL_TESTS();}“testing::InitGoogleTest(&argc,argv);”：gtest的测试案例允许接收一系列的命令行参数，因此，我们将命令行参数传递给gtest，进行一些初始化操作。gtest的命令行参数非常丰富，在后面我们也会详细了解到。“RUN_ALL_TESTS()”：运行所有测试案例OK，一切就绪了，我们直接运行案例试试（一片绿色，非常爽）：5、总结本篇内容确实是非常的初级，目的是让从来没有接触过gtest的同学了解gtest最基本的使用。gtest还有很多更高级的使用方法，我们将会在后面讨论。总结本篇的内容的话：1.使用VS编译gtest.lib文件2.设置测试工程的属性（头文件，lib文件，/MT参数（和编译gtest时使用一样的参数就行了））3.使用TEST宏开始一个测试案例，使用EXPECT_*,ASSER_*系列设置检查点。4.在Main函数中初始化环境，再使用RUN_ALL_TEST()宏运行测试案例。优点：1.我们的测试案例本身就是一个exe工程，编译之后可以直接运行，非常的方便。2.编写测试案例变的非常简单（使用一些简单的宏如TEST），让我们将更多精力花在案例的设计和编写上。3.提供了强大丰富的断言的宏，用于对各种不同检查点的检查。4.提高了丰富的命令行参数对案例运行进行一系列的设置。二、断言1、前言这篇文章主要总结gtest中的所有断言相关的宏。gtest中，断言的宏可以理解为分为两类，一类是ASSERT系列，一类是EXPECT系列。一个直观的解释就是：1.ASSERT_*系列的断言，当检查点失败时，退出当前函数（注意：并非退出当前案例）。2.EXPECT_*系列的断言，当检查点失败时，继续往下执行。2、示例//int型比较，预期值：3，实际值：Add(1,2)EXPECT_EQ(3,Add(1,2))//假如你的Add(1,2)结果为4的话，会在结果中输出：g:\myproject\c++\gtestdemo\gtestdemo\gtestdemo.cpp(16):error:Valueof:Add(1,2)Actual:4Expected:3如果是将结果输出到xml里的话，将输出：testcasename=Demostatus=runtime=0classname=AddTestfailuremessage=Valueof:Add(1,2)Actual:4Expected:3type=![CDATA[g:\myproject\c++\gtestdemo\gtestdemo\gtestdemo.cpp:16Valueof:Add(1,2)Actual:4Expected:3]]/failure/testcase如果你对自动输出的出错信息不满意的话，你还可以通过操作符将一些自定义的信息输出，通常，这对于调试或是对一些检查点的补充说明来说，非常有用！下面举个例子：如果不使用操作符自定义输出的话：for(inti=0;ix.size();++i){EXPECT_EQ(x[i],y[i]);}看到的结果将是这样的，你根本不知道出错时i等于几：g:\myproject\c++\gtestdemo\gtestdemo\gtestdemo.cpp(25):error:Valueof:y[i]Actual:4Expected:x[i]Whichis:3如果使用操作符将一些重要信息输出的话：for(inti=0;ix.size();++i){EXPECT_EQ(x[i],y[i])Vectorsxandydifferatindexi;}从输出结果中就可以定位到在i=2时出现了错误。这样的输出结果看起来更加有用，容易理解：g:\myproject\c++\gtestdemo\gtestdemo\gtestdemo.cpp(25):error:Valueof:y[i]Actual:4Expected:x[i]Whichis:3Vectorsxandydifferatindex23、布尔值检查FatalassertionNonfatalassertionVerifiesASSERT_TRUE(condition);EXPECT_TRUE(condition);conditionistrueASSERT_FALSE(condition);EXPECT_FALSE(condition);conditionisfalse4、数值型数据检查FatalassertionNonfatalassertionVerifiesASSERT_EQ(expected,actual);EXPECT_EQ(expected,actual);expected==actualASSERT_NE(val1,val2);EXPECT_NE(val1,val2);val1!=val2ASSERT_LT(val1,val2);EXPECT_LT(val1,val2);val1val2ASSERT_LE(val1,val2);EXPECT_LE(val1,val2);val1=val2ASSERT_GT(val1,val2);EXPECT_GT(val1,val2);val1val2ASSERT_GE(val1,val2);EXPECT_GE(val1,val2);val1=val25、字符串检查FatalassertionNonfatalassertionVerifiesASSERT_STREQ(expected_str,actual_str);EXPECT_STREQ(expected_str,actual_str);thetwoCstringshavethesamecontentASSERT_STRNE(str1,str2);EXPECT_STRNE(str1,str2);thetwoCstringshavedifferentcontentASSERT_STRCASEEQ(expected_str,actual_str);EXPECT_STRCASEEQ(expected_str,actual_str);thetwoCstringshavethesamecontent,ignoringcaseASSERT_STRCASENE(str1,str2);EXPECT_STRCASENE(str1,str2);thetwoCstringshavedifferentcontent,ignoringcase*STREQ*和*STRNE*同时支持char*和wchar_t*类型的，*STRCASEEQ*和*STRCASENE*却只接收char*，估计是不常用吧。下面是几个例子：TEST(StringCmpTest,Demo){char*pszCoderZh=CoderZh;wchar_t*wszCoderZh=LCoderZh;std::stringstrCoderZh=CoderZh;std::wstringwstrCoderZh=LCoderZh;EXPECT_STREQ(CoderZh,pszCoderZh);EXPECT_STREQ(LCoderZh,wszCoderZh);EXPECT_ST