自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

深入理解gtest C/C++單元測(cè)試經(jīng)驗(yàn)談

原創(chuàng)
開(kāi)發(fā) 后端
本文基于筆者的實(shí)際開(kāi)發(fā)經(jīng)驗(yàn),言簡(jiǎn)意賅地講解了C/C++單元測(cè)試框架gtest的主要使用方法和注意事項(xiàng),并設(shè)計(jì)了若干可編譯的精簡(jiǎn)示例,給出了運(yùn)行效果圖。既可以用作gtest的入門(mén)教程,也適合作為工作中的快速參考。

Google C++ Testing Framework(簡(jiǎn)稱gtest,http://code.google.com/p/googletest/)是Google公司發(fā)布的一個(gè)開(kāi)源C/C++單元測(cè)試框架,已被應(yīng)用于多個(gè)開(kāi)源項(xiàng)目及Google內(nèi)部項(xiàng)目中,知名的例子包括Chrome Web瀏覽器、LLVM編譯器架構(gòu)、Protocol Buffers數(shù)據(jù)交換格式及工具等。

優(yōu)秀的C/C++單元測(cè)試框架并不算少,相比之下gtest仍具有明顯優(yōu)勢(shì)。與CppUnit比,gtest需要使用的頭文件和函數(shù)宏更集中,并支持測(cè)試用例的自動(dòng)注冊(cè)。與CxxUnit比,gtest不要求Python等外部工具的存在。與Boost.Test比,gtest更簡(jiǎn)潔容易上手,實(shí)用性也并不遜色。Wikipedia給出了各種編程語(yǔ)言的單元測(cè)試框架列表(http://en.wikipedia.org/wiki/List_of_unit_testing_frameworks)。

一、基本用法

gtest當(dāng)前的版本是1.5.0,如果使用Visual C++編譯,要求編譯器版本不低于7.1(Visual C++ 2003)。如下圖所示,它的msvc文件夾包含Visual C++工程和項(xiàng)目文件,samples文件夾包含10個(gè)使用范例。

一般情況下,我們的單元測(cè)試代碼只需要包含頭文件gtest.h。gtest中常用的所有結(jié)構(gòu)體、類、函數(shù)、常量等,都通過(guò)命名空間testing訪問(wèn),不過(guò)gtest已經(jīng)把最簡(jiǎn)單常用的單元測(cè)試功能包裝成了一些帶參數(shù)宏,因此在簡(jiǎn)單的測(cè)試中常??梢院雎悦臻g的存在。

按照gtest的叫法,宏TEST為特定的測(cè)試用例(Test Case)定義了一個(gè)可執(zhí)行的測(cè)試(Test)。它接受用戶指定的測(cè)試用例名(一般取被測(cè)對(duì)象名)和測(cè)試名作為參數(shù),并劃出了一個(gè)作用域供填充測(cè)試宏語(yǔ)句和普通的C++代碼。一系列TEST的集合就構(gòu)成一個(gè)簡(jiǎn)單的測(cè)試程序。
常用的測(cè)試宏如下表所示。以ASSERT_開(kāi)頭和以EXPECT_開(kāi)頭的宏的區(qū)別是,前者在測(cè)試失敗時(shí)會(huì)給出報(bào)告并立即終止測(cè)試程序,后者在報(bào)告后繼續(xù)執(zhí)行測(cè)試程序。

ASSERT
EXPECT
功能
ASSERT_TRUE
EXPECT_TRUE
判真
ASSERT_FALSE
EXPECT_FALSE
判假
ASSERT_EQ
EXPECT_EQ
相等
ASSERT_NE
EXPECT_NE
不等
ASSERT_GT
EXPECT_GT
大于
ASSERT_LT
EXPECT_LT
小于
ASSERT_GE
EXPECT_GE
大于或等于
ASSERT_LE
EXPECT_LE
小于或等于
ASSERT_FLOAT_EQ
EXPECT_FLOAT_EQ
單精度浮點(diǎn)值相等
ASSERT_DOUBLE_EQ
EXPECT_DOUBLE_EQ
雙精度浮點(diǎn)值相等
ASSERT_NEAR
EXPECT_NEAR
浮點(diǎn)值接近(第3個(gè)參數(shù)為誤差閾值)
ASSERT_STREQ
EXPECT_STREQ
C字符串相等
ASSERT_STRNE
EXPECT_STRNE
C字符串不等
ASSERT_STRCASEEQ
EXPECT_STRCASEEQ
C字符串相等(忽略大小寫(xiě))
ASSERT_STRCASENE
EXPECT_STRCASENE
C字符串不等(忽略大小寫(xiě))
ASSERT_PRED1
EXPECT_PRED1
自定義謂詞函數(shù),(pred, arg1)(還有_PRED2, ..., _PRED5

 
寫(xiě)個(gè)簡(jiǎn)單的測(cè)試試一下。假設(shè)我們實(shí)現(xiàn)了一個(gè)加法函數(shù):
  1. // add.h  
  2. #pragma once  
  3. inline int Add(int i, int j) { return i+j; } 
對(duì)應(yīng)的單元測(cè)試程序可以這樣寫(xiě):
  1. // add_unittest.cpp  
  2. #include "add.h"  
  3. #include <gtest/gtest.h>  
  4.    
  5. TEST(Add, 負(fù)數(shù)) {  
  6.  EXPECT_EQ(Add(-1,-2), -3);  
  7.  EXPECT_GT(Add(-4,-5), -6); // 故意的  
  8. }  
  9.    
  10. TEST(Add, 正數(shù)) {  
  11.  EXPECT_EQ(Add(1,2), 3);  
  12.  EXPECT_GT(Add(4,5), 6);  
代碼中,測(cè)試用例Add包含兩個(gè)測(cè)試,正數(shù)和負(fù)數(shù)(這里利用了Visual C++ 2005以上允許標(biāo)識(shí)符包含Unicode字符的特性)。編譯運(yùn)行效果如下:
在控制臺(tái)界面中,通過(guò)的測(cè)試用綠色表示,失敗的測(cè)試用紅色表示。雙橫線分隔了不同的測(cè)試用例,其中包含的每個(gè)測(cè)試的啟動(dòng)與結(jié)果用單橫線和RUN ... OK或RUN ... FAILED標(biāo)出。失敗的測(cè)試會(huì)打印出代碼行和原因,測(cè)試程序***為所有用例和測(cè)試顯示統(tǒng)計(jì)結(jié)果。建議讀者試一下?lián)Q成ASSERT_宏的不同之處。
每個(gè)測(cè)試宏還可以使用<<運(yùn)算符在測(cè)試失敗時(shí)輸出自定義信息,如:
  1. ASSERT_EQ(M[i], N[j]) << "i = " << i << ", j = " << j; 
編譯命令行中,gtest_mt.lib和gtest_main_mt.lib就是前面使用VC項(xiàng)目文件生成的靜態(tài)庫(kù)。有意思的是,測(cè)試代碼不需要注冊(cè)測(cè)試用例,也不需要定義main函數(shù),這是gtest通過(guò)后一個(gè)靜態(tài)庫(kù)自動(dòng)完成的,它的實(shí)現(xiàn)代碼如下:
  1. // gtest-main.cc  
  2. int main(int argc, char **argv) {  
  3.  std::cout << "Running main() from gtest_main.cc\n";  
  4.  testing::InitGoogleTest(&argc, argv);  
  5.  return RUN_ALL_TESTS();  
其中,函數(shù)InitGoogleTest負(fù)責(zé)注冊(cè)需要運(yùn)行的所有測(cè)試用例,宏RUN_ALL_TEST負(fù)責(zé)執(zhí)行所有測(cè)試,如果全部成功則返回0,否則返回1。當(dāng)然,我們也可以僅鏈接gtest_mt.lib,自己提供main函數(shù)。
二、測(cè)試固件
很多時(shí)候,我們想在不同的測(cè)試執(zhí)行前創(chuàng)建相同的配置環(huán)境,在測(cè)試執(zhí)行結(jié)束后執(zhí)行相應(yīng)的清理工作,測(cè)試固件(Test Fixture)為這種需求提供了方便。“Fixture”是一個(gè)漢語(yǔ)中不易直接對(duì)應(yīng)的詞,《美國(guó)傳統(tǒng)詞典》對(duì)它的解釋是“(作為附屬物的)固定裝置;被固定的狀態(tài)”。在單元測(cè)試中,F(xiàn)ixture的作用是為測(cè)試創(chuàng)建輔助性的上下文環(huán)境,實(shí)現(xiàn)測(cè)試的初始化和終結(jié)與測(cè)試過(guò)程本身的分離,便于不同測(cè)試使用相同代碼來(lái)搭建固定的配置環(huán)境。用體操比賽的說(shuō)法,測(cè)試過(guò)程體現(xiàn)了特定測(cè)試的自選動(dòng)作,測(cè)試固件則體現(xiàn)了對(duì)一系列測(cè)試(在開(kāi)始和結(jié)束時(shí))的規(guī)定動(dòng)作。有些講單元測(cè)試的書(shū)籍直接把測(cè)試固件稱為Scaffolding(腳手架)。
使用測(cè)試固件比單純調(diào)用TEST宏稍微麻煩一些:
1.         從gtest的testing::Test類派生一個(gè)類,用publicprotected定義以下所有成員。
2.         (可選)建立環(huán)境:使用默認(rèn)構(gòu)造函數(shù),或定義一個(gè)虛成員函數(shù)virtual void SetUp()。
3.         (可選)銷(xiāo)毀環(huán)境:使用析構(gòu)函數(shù),或定義一個(gè)虛成員函數(shù)virtual void TearDown()。
4.         TEST_F定義測(cè)試,寫(xiě)法與TEST相同,但測(cè)試用例名必須為上面定義的類名。
每個(gè)帶固件的測(cè)試的執(zhí)行順序是:
1.         調(diào)用默認(rèn)構(gòu)造函數(shù)創(chuàng)建一個(gè)新的帶固件對(duì)象。
2.         立即調(diào)用SetUp函數(shù)。
3.         運(yùn)行TEST_F體。
4.         立即調(diào)用TearDown函數(shù)。
5.         調(diào)用析構(gòu)函數(shù)銷(xiāo)毀類對(duì)象。

從gtest的實(shí)現(xiàn)代碼可以看到,TEST_F又從用戶定義的類自動(dòng)派生了一個(gè)類,因此要求publicprotected的訪問(wèn)權(quán)限;大括號(hào)里的內(nèi)容被擴(kuò)展成一個(gè)名為TestBody的虛成員函數(shù)的函數(shù)體,因此可以在其中直接訪問(wèn)成員變量和成員函數(shù)。其實(shí)TEST也采用了相同的實(shí)現(xiàn)機(jī)制,只是它直接從gtest的testing::Test自動(dòng)派生類,所以可以指定任意用例名。testing::Test類的SetUpTearDown都是空函數(shù),所以它只執(zhí)行測(cè)試步驟,沒(méi)有環(huán)境的創(chuàng)建和銷(xiāo)毀。
借用上面Add函數(shù)寫(xiě)個(gè)固件測(cè)試的例子:
  1. // add_unittest2.cpp  
  2. #include "add.h"  
  3. #include <stdio.h>  
  4. #include <gtest/gtest.h>  
  5.    
  6. class AddTest: public testing::Test  
  7. {  
  8. public:  
  9.  virtual void SetUp()    { puts("SetUp()"); }  
  10.  virtual void TearDown() { puts("TearDown()"); }  
  11. };  
  12.    
  13. TEST_F(AddTest, 正數(shù)) {  
  14.  ASSERT_GT(Add(1,2), 3); // 故意的  
  15.  ASSERT_EQ(Add(4,5), 6); // 也是故意的  
編譯運(yùn)行效果如下:
必須強(qiáng)調(diào),每個(gè)TEST_F開(kāi)始都創(chuàng)建了一個(gè)新的帶固件對(duì)象,因此每個(gè)測(cè)試都使用獨(dú)立的完全相同的初始環(huán)境,各測(cè)試可以按任意順序執(zhí)行(參見(jiàn)--gtest_shuffle命令行選項(xiàng))。但在某些情況下,我們可能需要在各個(gè)測(cè)試間共享一個(gè)相同的環(huán)境來(lái)保存和傳遞狀態(tài),或者環(huán)境的狀態(tài)是只讀的,可以只初始化一次,再或者創(chuàng)建環(huán)境的過(guò)程開(kāi)銷(xiāo)很高,要求只初始化一次。共享某個(gè)固件環(huán)境的所有測(cè)試合稱為一個(gè)“測(cè)試套件”(Test Suite),gtest中利用靜態(tài)成員變量和靜態(tài)成員函數(shù)實(shí)現(xiàn)這個(gè)概念:
1.         (可選)在testing::Test的派生類中,定義若干靜態(tài)成員變量來(lái)維護(hù)套件的狀態(tài)。
2.         (可選)建立共享環(huán)境:定義一個(gè)靜態(tài)成員函數(shù)static void SetUpTestCase()。
3.         (可選)銷(xiāo)毀共享環(huán)境:定義一個(gè)靜態(tài)成員函數(shù)static void TearDownCase()。
另外,還可以使用gtest的Environment類來(lái)建立和銷(xiāo)毀所有測(cè)試共用的全局環(huán)境(對(duì)應(yīng)于上圖顯示的“Global test environment set-up”和“Global test environment tear-down”):
  1. class Environment {  
  2.  public:  
  3.  virtual ~Environment() {}  
  4.  virtual void SetUp() {}  
  5.  virtual void TearDown() {}  
  6. }; 
gtest文檔建議測(cè)試程序自己定義main函數(shù)并在其中創(chuàng)建和注冊(cè)全局環(huán)境對(duì)象:
  1. Environment* AddGlobalTestEnvironment(Environment* env); 
三、異常測(cè)試
C程序中要返回出錯(cuò)信息,可以利用特定的函數(shù)返回值、函數(shù)的輸出(outbound)參數(shù)、或者設(shè)置全局變量(如C標(biāo)準(zhǔn)庫(kù)定義的errno,Windows API中的“上次錯(cuò)誤”(last error)代碼,Winsock中與每個(gè)socket相關(guān)聯(lián)的錯(cuò)誤代碼)。C++程序常用異常(exception)來(lái)返回出錯(cuò)信息,gtest為異常測(cè)試提供了專用的測(cè)試宏:

ASSERT
EXPECT
功能
ASSERT_NO_THROW
EXPECT_NO_THROW
不拋出異常,參數(shù)為(statement)
ASSERT_ANY_THROW
EXPECT_ANY_THROW
拋出異常,參數(shù)為(statement)
ASSERT_THROW
EXPECT_THROW
拋出特定類型的異常,參數(shù)為(statement, type)

 
需要注意,這些測(cè)試宏都接受C/C++語(yǔ)句作為參數(shù),所以既可以像前面那樣傳遞表達(dá)式,也可以傳遞用大括號(hào)包起來(lái)的代碼塊。
借助下面的被測(cè)函數(shù):
  1. // divide.h  
  2. #pragma once  
  3. #include <stdexcept>  
  4.    
  5. int divide(int dividend, int divisor) {  
  6.  if(!divisor) {  
  7.     throw std::length_error("can't be divided by 0"); // 故意的  
  8.  }  
  9.  return dividend / divisor;  
測(cè)試程序如下:
  1. // divide-unittest.cpp  
  2. #include <gtest/gtest.h>  
  3. #include "./divide.h"  
  4.    
  5. TEST(Divide, ByZero) {  
  6.  EXPECT_NO_THROW(divide(-1, 2));  
  7.    
  8.  EXPECT_ANY_THROW({  
  9.     int k = 0;  
  10.     divide(k, k);  
  11.  });  
  12.    
  13.  EXPECT_THROW(divide(100000, 0), std::invalid_argument);  
編譯運(yùn)行效果如下

容易想到,gtest的這些異常測(cè)試宏是用C++的try ... catch語(yǔ)句來(lái)實(shí)現(xiàn)的:
  1. try {  
  2.  statement;  
  3. }  
  4. catch(type const&) {  
  5.  // throw  
  6. }  
  7. catch(...) {  
  8.  // any throw  
  9. }  
  10. // no throw 
如果把上圖中Visual C++的編譯選項(xiàng)/EHsc換成/EHa,try ... catch就可以同時(shí)支持C++風(fēng)格的異常和Windows系統(tǒng)的結(jié)構(gòu)化異常(SEH)。這樣,即使刪掉divide函數(shù)里的if判斷,測(cè)試代碼的EXPECT_ANY_THROW宏也會(huì)成功捕獲異常。
遺憾的是,目前僅使用這些測(cè)試宏無(wú)法得到獲得被拋出異常的詳細(xì)信息(如divide函數(shù)中的報(bào)錯(cuò)文本),這和gtest自身不愿意使用C++異常有關(guān)。
四、值參數(shù)化測(cè)試
有些時(shí)候,我們需要對(duì)代碼實(shí)現(xiàn)的功能使用不同的參數(shù)進(jìn)行測(cè)試,比如使用大量隨機(jī)值來(lái)檢驗(yàn)算法實(shí)現(xiàn)的正確性,或者比較同一個(gè)接口的不同實(shí)現(xiàn)之間的差別。gtest把“集中輸入測(cè)試參數(shù)”的需求抽象出來(lái)提供支持,稱為值參數(shù)化測(cè)試(Value Parameterized Test)。
值參數(shù)化測(cè)試包括4個(gè)步驟:
1.         從gtest的TestWithParam模板類派生一個(gè)類(記為C),模板參數(shù)為需要輸入的測(cè)試參數(shù)的類型。由于TestWithParam本身是從Test派生的,所以C就成了一個(gè)測(cè)試固件類。
2.         C中,可以實(shí)現(xiàn)諸如SetUp、TearDown等方法。特別地,測(cè)試參數(shù)由TestWithParam實(shí)現(xiàn)的GetParam()方法依次返回。
3.         使用TEST_P(而不是TEST_F)定義測(cè)試。
4.         使用INSTANTIATE_TEST_CASE_P宏集中輸入測(cè)試參數(shù),它接受3個(gè)參數(shù):任意的文本前綴,測(cè)試類名(這里即為C),以及測(cè)試參數(shù)值序列。gtest框架依次使用這些參數(shù)值生成測(cè)試固件類實(shí)例,并執(zhí)行用戶定義的測(cè)試。
gtest提供了專門(mén)的模板函數(shù)來(lái)生成參數(shù)值序列,如下表所示:

參數(shù)值序列生成函數(shù)
含義
Bool()
生成序列{false, true}
Range(begin, end[, step])
生成序列{begin, begin+step, begin+2*step, ...} (不含end),step默認(rèn)為1
Values(v1, v2, ..., vN)
生成序列{v1, v2, ..., vN}
ValuesIn(container)ValuesIn(iter1, iter2)
枚舉STL container,或枚舉迭代器范圍[iter1, iter2)
Combine(g1, g2, ..., gN)
生成g1g2, ..., gN的笛卡爾積,其中g1g2, ..., gN均為參數(shù)值序列生成函數(shù)(要求C++0x的<tr1/tuple>

 
寫(xiě)個(gè)小程序試一下。假設(shè)我們實(shí)現(xiàn)了一種快速累加算法,希望使用另一種直觀算法進(jìn)行正確性校驗(yàn)。算法實(shí)現(xiàn)和測(cè)試代碼如下
  1. // addupto.h  
  2.    
  3. #pragma once  
  4.    
  5. inline unsigned NaiveAddUpTo(unsigned n) {  
  6.     unsigned sum = 0;  
  7.     for(unsigned i = 1; i <= n; ++i) sum += i;  
  8.     return sum;  
  9. }  
  10.    
  11. inline unsigned FastAddUpTo(unsigned n) {  
  12.     return n*(n+1)/2;  
測(cè)試程序如下:
  1. // addupto_test.cpp  
  2.    
  3. #include <gtest/gtest.h>  
  4. #include "addupto.h"  
  5.    
  6. class AddUpToTest : public testing::TestWithParam<unsigned>  
  7. {  
  8. public:  
  9.     AddUpToTest() { n_ = GetParam(); }  
  10. protected:  
  11.     unsigned n_;  
  12. };  
  13.    
  14. TEST_P(AddUpToTest, Calibration) {  
  15.     EXPECT_EQ(NaiveAddUpTo(n_), FastAddUpTo(n_));  
  16. }  
  17.    
  18. INSTANTIATE_TEST_CASE_P(  
  19.     NaiveAndFast, // prefix  
  20.     AddUpToTest,   // test case name  
  21.     testing::Range(1u, 1000u) // parameters  
  22. ); 
 
注意TestWithParam的模板參數(shù)設(shè)置為unsigned類型,而在代碼倒數(shù)第2行,兩個(gè)常量值都加了u后綴來(lái)指定為unsigned類型。熟悉C++的讀者應(yīng)該知道,模板函數(shù)在進(jìn)行類型推斷(deduction)時(shí)匹配相當(dāng)嚴(yán)格,不像普通函數(shù)那樣允許類型提升(promotion)。如果上面省略u后綴,就會(huì)造成編譯錯(cuò)誤。當(dāng)然還可以顯式指定模板參數(shù):testing::Range<unsigned>(1, 1000)。
運(yùn)行效果如下,這里省略了開(kāi)頭的大部分輸出(命令行窗口設(shè)置的緩沖區(qū)高度為3000行)。

作者簡(jiǎn)介
楊玚,1980年生,2009年畢業(yè)于中國(guó)科學(xué)技術(shù)大學(xué),獲博士學(xué)位。2009年8月加入中國(guó)軟件評(píng)測(cè)中心重大專項(xiàng)測(cè)試部,任開(kāi)發(fā)測(cè)試工程師,負(fù)責(zé)“軟件測(cè)試能力優(yōu)化升級(jí)” 項(xiàng)目工具研發(fā)。關(guān)注領(lǐng)域?yàn)榫W(wǎng)絡(luò)信息安全。
【編輯推薦】
責(zé)任編輯:彭凡 來(lái)源: 51CTO
相關(guān)推薦

2011-02-21 09:54:14

PHPPHPUnit

2024-08-15 08:11:10

2010-01-15 14:10:42

C++單元測(cè)試

2024-04-10 12:14:36

C++指針算術(shù)運(yùn)算

2022-05-06 16:18:00

Block和 C++OC 類lambda

2019-10-22 08:11:43

Socket網(wǎng)絡(luò)通信網(wǎng)絡(luò)協(xié)議

2023-09-12 11:44:02

C++數(shù)據(jù)對(duì)齊

2014-04-24 13:43:37

CC++單元測(cè)試框架

2022-08-05 09:30:57

單元測(cè)試C++

2010-01-13 09:38:17

C++單元測(cè)試

2012-06-18 10:03:46

Visual Stud

2009-08-07 17:38:08

C#無(wú)詞尾符號(hào)

2022-02-16 12:52:22

C++項(xiàng)目編譯器

2022-02-14 22:22:30

單元測(cè)試Junit5

2024-07-25 14:18:29

2015-12-28 11:25:51

C++異常處理機(jī)制

2023-10-04 00:04:00

C++extern

2023-11-22 13:40:17

C++函數(shù)

2023-12-31 12:56:02

C++內(nèi)存編程

2024-03-28 18:12:28

指針函數(shù)指針C++
點(diǎn)贊
收藏

51CTO技術(shù)棧公眾號(hào)