一文掌握Google開源單元測(cè)試框架

我們?cè)陂_發(fā)的過程中需要做一些驗(yàn)證測(cè)試，來保證我們的代碼是按照設(shè)計(jì)要求工作的，這就需要單元測(cè)試了。單元測(cè)試（Unit Test），我們稱為“UT測(cè)試”。對(duì)于一個(gè)復(fù)雜的系統(tǒng)來說，需要編寫大量的單元測(cè)試用例，有人會(huì)覺得這么多的測(cè)試代碼，將會(huì)花費(fèi)大量的時(shí)間，影響開發(fā)的進(jìn)度，會(huì)得不償失。真的是這樣嗎？其實(shí)，對(duì)于越是復(fù)雜的系統(tǒng)就越是需要單元測(cè)試來保證我們的代碼的開發(fā)質(zhì)量，及時(shí)測(cè)試出代碼的問題，在開發(fā)階段發(fā)現(xiàn)問題總比在系統(tǒng)發(fā)布之后發(fā)現(xiàn)問題能夠較少的節(jié)省資源或成本。

對(duì)于單元測(cè)試應(yīng)該是每個(gè)開發(fā)工程師必備的技能，尤其是高階的開發(fā)工程師會(huì)更加注重UT的重要性。同時(shí)，我們?cè)陂_發(fā)功能模塊之前會(huì)考慮到測(cè)試用例的實(shí)現(xiàn)，這樣自然的就會(huì)考慮到功能模塊的模塊化便于UT的編寫，從這一方面來說也能提高開發(fā)人員開發(fā)的代碼質(zhì)量。另外，單元測(cè)試用例還可以作為示例供開發(fā)人員參考，從而能夠更輕松的掌握模塊的使用。

今天就和大家一起學(xué)習(xí)一個(gè)開源的C++的單元測(cè)試框架Google test，大家看名字就知道它是由牛逼的Google公司出品。Google Test可以在多種平臺(tái)上使用，它可以支持：

Linux、Mac OS X、Windows、Cygwin、MinGW、Windows Mobile、Symbian、PlatformIO等。

安裝和配置

我們可以從github獲取Google Test的源碼，如果大家沒有g(shù)ithub賬號(hào)也可以從網(wǎng)盤下載。

github下載地址: https://github.com/google/googletest

網(wǎng)盤下載：關(guān)注公眾號(hào)【W(wǎng)ill的大食堂】回復(fù)【gTest下載】即可獲取下載地址。

因?yàn)槲覀兿螺d到的gTest是源代碼，還需要將其編譯成庫文件再進(jìn)行使用。下面將和大家一起學(xué)習(xí)如何在windows環(huán)境下生成gTest的庫文件。在這之前我們需要安裝CMake和MinGW，大家可以參考下面這兩個(gè)文章進(jìn)行安裝。

• 《VS Code 編譯和調(diào)試C/C++程序也可以這么爽》
• 《VS Code中如何安裝和使用CMake工具？》

將下載的gTest的源碼進(jìn)行解壓，源碼目錄如下圖所示。

源碼工程目錄

打開命令行工具cmd，進(jìn)入源碼的工程目錄，新建一個(gè)build目錄用來存放構(gòu)建文件，然后，進(jìn)入build目錄執(zhí)行cmake命令生成Makefile文件。

mkdir build
cd build
cmake -G "MinGW Makefiles" ..

Makefile文件生成后，再執(zhí)行下面的命令mingw32-make編譯庫文件。編譯成功后就會(huì)發(fā)現(xiàn)有l(wèi)ibgtest.a 和libgtest_main.a兩個(gè)靜態(tài)庫生成。這里注意，Windows下mingw安裝的make工具名稱是mingw32-make而不是make。

mingw32-make

執(zhí)行mingw32-make命令

接下來我們?cè)赩S Code寫一個(gè)測(cè)試用例，使用生成的gTest靜態(tài)庫測(cè)試下。按下快捷鍵【Ctrl+Shift+p】，在彈出的搜索框中搜索【C/C++:Edit Configurations】，可以創(chuàng)建c_cpp_properties.json配置文件。

C/C++:Edit Configurations

在c_cpp_properties.json配置文件添加gTest的頭文件目錄。

添加gTest頭文件目錄

在task.json配置文件中添加gTest頭文件目錄和庫文件，task.json配置文件可以通過菜單欄中Terminal選項(xiàng)下的【Configure Default Build Task】選項(xiàng)創(chuàng)建，可以參照之前的文章。

Configure Default Build Task

添加頭文件目錄和庫文件

上面配置好之后，我們寫個(gè)測(cè)試用例跑一下。

#include <iostream>
#include <gtest/gtest.h>

int add(int a, int b)
{
return a + b;
}

int sub(int a, int b)
{
return a - b;
}

TEST(testcase, test_add)
{
EXPECT_EQ(add(1,2), 3);
EXPECT_EQ(sub(1,2), -1);
}

int main(int argc, char **argv)
{
std::cout << "run google test --> " << std::endl << std::endl;
testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}
運(yùn)行結(jié)果如下圖所示，代碼中的TEST是一個(gè)宏，用來創(chuàng)建測(cè)試用例，它有test_case_name和test_name兩個(gè)參數(shù)。分別是測(cè)試用例名和測(cè)試名，在后面的文章中我們會(huì)對(duì)其有更深刻的理解，這里就不細(xì)說了。RUN_ALL_TESTS也是一個(gè)宏，它是測(cè)試用例的入口。EXPECT_EQ這個(gè)是一個(gè)斷言相關(guān)的宏，用來檢測(cè)兩個(gè)數(shù)值是否相等。

運(yùn)行結(jié)果

斷言

除了上面示例里的EXPECT_EQ，在gTest里有很多斷言相關(guān)的宏。斷言可以檢查出某些條件的真假，因此，我們可以通過它來判斷被測(cè)試的函數(shù)的成功與否。這里斷言我們主要可以分為兩類：

• 以"ASSERT_"開頭的斷言，致命性斷言（Fatal assertion）
• 以"EXPECT_"開頭的斷言 ，非致命性斷言（Nonfatal assertion）

上面的兩種斷言會(huì)在斷言條件不滿足時(shí)會(huì)有區(qū)別，即當(dāng)不滿足條件時(shí), "ASSERT_"斷言會(huì)在當(dāng)前函數(shù)終止，而不會(huì)繼續(xù)執(zhí)行下去；而"EXPECT_"則會(huì)繼續(xù)執(zhí)行。我們可以通過下面一個(gè)例子來理解下他們的區(qū)別。

#include <iostream>
#include <gtest/gtest.h>

int add(int a, int b)
{
return a + b;
}

int sub(int a, int b)
{
return a - b;
}

TEST(testcase, test_expect)
{
std::cout << "------ test_expect start-----" << std::endl;

std::cout << "add function start" << std::endl;
EXPECT_EQ(add(1,2), 2);
std::cout << "add function end" << std::endl;

std::cout << "sub function start" << std::endl;
EXPECT_EQ(sub(1,2), -1);
std::cout << "sub function end" << std::endl;

std::cout << "------ test_expect end-----" << std::endl;
}

TEST(testcase, test_assert)
{

std::cout << "------ test_assert start-----" << std::endl;

std::cout << "add function start" << std::endl;
ASSERT_EQ(add(1,2), 2);
std::cout << "add function end" << std::endl;

std::cout << "sub function start" << std::endl;
ASSERT_EQ(sub(1,2), -1);
std::cout << "sub function end" << std::endl;

std::cout << "------ test_assert end-----" << std::endl;
}

int main(int argc, char **argv)
{
testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

從下面的運(yùn)行結(jié)果上看，assert斷言檢查出被測(cè)函數(shù)add不滿足條件，所以程序就沒有繼續(xù)執(zhí)行下去；而expect雖然檢查出被測(cè)試函數(shù)add不滿足條件，但是程序還是繼續(xù)去測(cè)試sub函數(shù)。

assert 和 expect

上面的示例用到的都是判斷相等條件的斷言，還有其他條件檢查的斷言。主要可以分為布爾檢查，數(shù)值比較檢查，字符串檢查，浮點(diǎn)數(shù)檢查，異常檢查等等。下面我們逐一認(rèn)識(shí)這些斷言。

布爾檢查

布爾檢查主要用來檢查布爾類型數(shù)據(jù)，檢查其條件是真還是假。

數(shù)值比較檢查

數(shù)值比較檢查主要用來比較兩個(gè)數(shù)值之間的大小關(guān)系，這里有兩個(gè)參數(shù)。

字符串檢查

字符串檢查主要用來比較字符串的內(nèi)容。

浮點(diǎn)數(shù)檢查

對(duì)于浮點(diǎn)數(shù)來說，因?yàn)槠渚仍?，我們無法確定其是否完全相等，實(shí)際上對(duì)于浮點(diǎn)數(shù)我比較兩個(gè)浮點(diǎn)數(shù)近似相等。

異常檢查

異常檢查可以將異常轉(zhuǎn)換成斷言的形式。

除了上面的一些類型的斷言，還有一切其他的常用斷言。

顯示成功或失敗

這一類斷言會(huì)在測(cè)試運(yùn)行中標(biāo)記成功或失敗。它主要有三個(gè)宏：

• SUCCED()：標(biāo)記成功。
• FAIL() : 標(biāo)記失敗，類似ASSERT斷言標(biāo)記致命錯(cuò)誤；
• ADD_FAILURE()：標(biāo)記，類似EXPECT斷言標(biāo)記非致命錯(cuò)誤。

#include <iostream>
#include <gtest/gtest.h>

int divison(int a, int b)
{
return a / b;
}

TEST(testCaseTest, test0)
{
std::cout << "start test 0" << std::endl;
SUCCEED();
std::cout << "test pass" << std::endl;
}

TEST(testCaseTest, test1)
{
std::cout << "start test 1" << std::endl;
FAIL();
std::cout << "test fail" << std::endl;
}

TEST(testCaseTest, test2)
{
std::cout << "start test 2" << std::endl;
ADD_FAILURE();
std::cout << "test fail" << std::endl;
}

int main(int argc, char **argv)
{
testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

執(zhí)行結(jié)果如下：

成功失敗斷言

死亡測(cè)試

死亡測(cè)試是用來檢測(cè)測(cè)試程序是否按照預(yù)期的方式崩潰。

Assert Expect Description
ASSERT_DEATH(statement, regex) EXPECT_DEATH(statement, regex) 檢查按照代碼給定的方式崩潰

#include <iostream>
#include <gtest/gtest.h>

int divison(int a, int b)
{
return a / b;
}

TEST(testCaseDeathTest, test_div)
{
EXPECT_DEATH(divison(1, 0), "");
}
int main(int argc, char **argv)
{
testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

上面這個(gè)例子就是死亡測(cè)試，其運(yùn)行結(jié)果如下，這里需要注意的是test_case_name如果使用DeathTest為后綴，gTest會(huì)優(yōu)先運(yùn)行。

死亡測(cè)試

測(cè)試事件

在學(xué)習(xí)測(cè)試事件之前，我們先來了解下三個(gè)概念，它們分別是測(cè)試程序，測(cè)試套件，測(cè)試用例。

• 測(cè)試程序是一個(gè)可執(zhí)行程序，它有一個(gè)測(cè)試程序的入口main函數(shù)。
• 測(cè)試用例是用來定義需要驗(yàn)證的內(nèi)容。
• 測(cè)試套件是測(cè)試用例的集合，運(yùn)行測(cè)試。

我們回過來看測(cè)試事件，在GTest中有了測(cè)試事件的這個(gè)機(jī)制，就能能夠在測(cè)試之前或之后能夠做一些準(zhǔn)備/清理的操作。根據(jù)事件執(zhí)行的位置不同，我們可將測(cè)試事件分為三種：

• TestCase級(jí)別測(cè)試事件：這個(gè)級(jí)別的事件會(huì)在TestCase之前與之后執(zhí)行；
• TestSuite級(jí)別測(cè)試事件：這個(gè)級(jí)別的事件會(huì)在TestSuite中第一個(gè)TestCase之前與最后一個(gè)TestCase之后執(zhí)行；
• 全局測(cè)試事件：這是級(jí)別的事件會(huì)在所有TestCase中第一個(gè)執(zhí)行前，與最后一個(gè)之后執(zhí)行。

這些測(cè)試事件都是基于類的，所以需要在類上實(shí)現(xiàn)。下面我們依次來學(xué)習(xí)這三種測(cè)試事件。

TestCase測(cè)試事件

TestCase測(cè)試事件，需要實(shí)現(xiàn)兩個(gè)函數(shù)SetUp()和TearDown()。

• SetUp()函數(shù)是在TestCase之前執(zhí)行。
• TearDown()函數(shù)是在TestCase之后執(zhí)行。

這兩個(gè)函數(shù)是不是有點(diǎn)像類的構(gòu)造函數(shù)和析構(gòu)函數(shù)，但是切記他們并不是構(gòu)造函數(shù)和析構(gòu)函數(shù)，只是打個(gè)比方才這么說而已。我們可以借助下面的代碼示例來加深對(duì)它的理解。這兩個(gè)函數(shù)是testing::Test的成員函數(shù)，我們?cè)诰帉憸y(cè)試類時(shí)需要繼承testing::Test。

#include <iostream>
#include <gtest/gtest.h>

class calcFunction
{
public:
int add(int a, int b)
{
return a + b;
}

int sub(int a, int b)
{
return a - b;
}
};

class calcFunctionTest : public testing::Test
{
protected:
virtual void SetUp()
{
std::cout << "--> " << __func__ << " <--" <<std::endl;
}
virtual void TearDown()
{
std::cout << "--> " << __func__ << " <--" <<std::endl;
}

calcFunction calc;

};

TEST_F(calcFunctionTest, test_add)
{
std::cout << "--> test_add start <--" << std::endl;
EXPECT_EQ(calc.add(1,2), 3);
std::cout << "--> test_add end <--" << std::endl;
}

TEST_F(calcFunctionTest, test_sub)
{
std::cout << "--> test_sub start <--" << std::endl;
EXPECT_EQ(calc.sub(1,2), -1);
std::cout << "--> test_sub end <--" << std::endl;
}

int main(int argc, char **argv)
{
testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

測(cè)試結(jié)果如下，兩個(gè)函數(shù)都是是在每個(gè)TestCase（test_add和test_sub）之前和之后執(zhí)行。

TestCase事件

TestSuite測(cè)試事件

TestSuite測(cè)試事件，同樣的也需要實(shí)現(xiàn)的兩個(gè)函數(shù)SetUpTestCase()和TearDownTestCase()，而這兩個(gè)函數(shù)是靜態(tài)函數(shù)。這兩個(gè)靜態(tài)函數(shù)同樣也是testing::Test類的成員，我們直接改寫下測(cè)試類calcFunctionTest，添加兩個(gè)靜態(tài)函數(shù)SetUpTestCase()和TearDownTestCase()到測(cè)試類中即可。

class calcFunctionTest : public testing::Test
{
protected:
static void SetUpTestCase()
{
std::cout<< "--> " << __func__ << " <--" << std::endl;
}

static void TearDownTestCase()
{
std::cout<< "--> " << __func__ << " <--" << std::endl;
}

virtual void SetUp()
{
std::cout << "--> " << __func__ << " <--" <<std::endl;
}
virtual void TearDown()
{
std::cout << "--> " << __func__ << " <--" <<std::endl;
}

calcFunction calc;

};

改寫好之后，我們?cè)倏匆幌逻\(yùn)行結(jié)果。這兩個(gè)函數(shù)分別是在本TestSuite中的第一個(gè)TestCase之前和最后一個(gè)TestCase之后執(zhí)行。

TestSuite事件

全局測(cè)試事件

全局測(cè)試事件，也需要繼承一個(gè)類，但是它需要繼承testing::Environment類實(shí)現(xiàn)SetUp()和TearDown()兩個(gè)函數(shù)。還需要在main函數(shù)中調(diào)用testing::AddGlobalTestEnvironment方法注冊(cè)全局事件。我們直接上代碼吧！

#include <iostream>
#include <gtest/gtest.h>

class calcFunction
{
public:
int add(int a, int b)
{
return a + b;
}

int sub(int a, int b)
{
return a - b;
}
};

class calcFunctionEnvironment : public testing::Environment
{
public:
virtual void SetUp()
{
val = 123;
std::cout << "--> Environment " << __func__ << " <--" << std::endl;
}
virtual void TearDown()
{
std::cout << "--> Environment " << __func__ << " <--" << std::endl;
}

int val;
};

calcFunctionEnvironment* calc_env;

class calcFunctionTest : public testing::Test
{
protected:
static void SetUpTestCase()
{
std::cout<< "--> " << __func__ << " <--" << std::endl;
}

static void TearDownTestCase()
{
std::cout<< "--> " << __func__ << " <--" << std::endl;
}

virtual void SetUp()
{
std::cout << "--> " << __func__ << " <--" <<std::endl;
}
virtual void TearDown()
{
std::cout << "--> " << __func__ << " <--" <<std::endl;
}

calcFunction calc;

};

TEST_F(calcFunctionTest, test_add)
{
std::cout << "--> test_add start <--" << std::endl;
EXPECT_EQ(calc.add(1,2), 3);
std::cout << "Global Environment val = " << calc_env->val << std::endl;
std::cout << "--> test_add end <--" << std::endl;
}

TEST_F(calcFunctionTest, test_sub)
{
std::cout << "--> test_sub start <--" << std::endl;
EXPECT_EQ(calc.sub(1,2), -1);
std::cout << "Global Environment val = " << calc_env->val << std::endl;
std::cout << "--> test_sub end <--" << std::endl;
}

int main(int argc, char **argv)
{
calc_env = new calcFunctionEnvironment;
testing::AddGlobalTestEnvironment(calc_env);

testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

從測(cè)試結(jié)果上看，全局事件的這兩個(gè)函數(shù)分別是在第一個(gè)TestSuite之前和最后一個(gè)TestSuite之后執(zhí)行的。

全局事件

以上三種測(cè)試事件我們可以根據(jù)需要進(jìn)行靈活使用。另外，細(xì)心的同學(xué)會(huì)發(fā)現(xiàn)，這里測(cè)試用例我們?cè)撚昧薚EST_F這個(gè)宏，這是因?yàn)槔^承了testing::Test,與之對(duì)應(yīng)就需要使用TEST_F宏。

參數(shù)化

在學(xué)習(xí)gTest參數(shù)化之前我們先看一個(gè)測(cè)試?yán)印?/p>

#include <iostream>
#include <gtest/gtest.h>

class calcFunction
{
public:
int add(int a, int b)
{
std::cout << a << " + " << b << " = " << a + b << std::endl;
return a + b;
}

int sub(int a, int b)
{
std::cout << a << " - " << b << " = " << a - b << std::endl;
return a - b;
}
};

class calcFunctionTest : public testing::Test
{
protected:
calcFunction calc;
};

TEST_F(calcFunctionTest, test_add0)
{
EXPECT_EQ(calc.add(1,2), 3);
}

TEST_F(calcFunctionTest, test_add1)
{
EXPECT_EQ(calc.add(1,3), 4);
}

TEST_F(calcFunctionTest, test_add2)
{
EXPECT_EQ(calc.add(2,4), 6);
}

TEST_F(calcFunctionTest, test_add3)
{
EXPECT_EQ(calc.add(-1,-2), -3);
}

int main(int argc, char **argv)
{
testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

示例執(zhí)行結(jié)果：

未參數(shù)化例子

上面的測(cè)試用例中我們寫了多個(gè)測(cè)試用例，但是其參數(shù)都是同樣的，有的實(shí)際應(yīng)用場(chǎng)景可能比這個(gè)程序?qū)懙臏y(cè)試檢查還要多。寫這么多重復(fù)的代碼實(shí)在是太累了。gTest提供了一個(gè)非常友好的工具，將這些測(cè)試的值進(jìn)行參數(shù)化，就不用寫那么多重復(fù)的代碼了。

如何對(duì)其進(jìn)行參數(shù)化呢？直接上代碼，我們?cè)賮砜聪旅嬉粋€(gè)例子。

#include <iostream>
#include <gtest/gtest.h>

class calcFunction
{
public:
int add(int a, int b)
{
std::cout << a << " + " << b << " = " << a + b << std::endl;
return a + b;
}

int sub(int a, int b)
{
std::cout << a << " - " << b << " = " << a - b << std::endl;
return a - b;
}
};

struct TestParam
{
int a;
int b;
int c;
};

class calcFunctionTest : public ::testing::TestWithParam<struct TestParam>
{
protected:
calcFunction calc;
TestParam param;

virtual void SetUp()
{
param.a = GetParam().a;
param.b = GetParam().b;
param.c = GetParam().c;
}

};

TEST_P(calcFunctionTest, test_add)
{
EXPECT_EQ(calc.add(param.a, param.b), param.c);
}

INSTANTIATE_TEST_CASE_P(addTest, calcFunctionTest, ::testing::Values( TestParam{1, 2 , 3},
TestParam{1, 3 , 4},
TestParam{2, 4 , 6},
TestParam{-1, -2 , -3}));

int main(int argc, char **argv)
{
testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}

執(zhí)行結(jié)果和前面的例子一樣。

參數(shù)化例子

從這個(gè)例子中，我們不難發(fā)現(xiàn)和之前的測(cè)試程序有一些不同。這里繼承了::testing::TestWithParam類，參數(shù)T就是需要參數(shù)化的數(shù)據(jù)類型，這個(gè)例子里參數(shù)化數(shù)據(jù)類型是TestParam結(jié)構(gòu)體。這里還需要使用另外一個(gè)宏TEST_P而不是TEST_F這個(gè)宏，它的兩個(gè)參數(shù)和TEST_F和TEST一致。另外，程序中還增加一個(gè)宏INSTANTIATE_TEST_CASE_P用來輸入測(cè)試參數(shù)，它有三個(gè)參數(shù)（第一個(gè)參數(shù)大家可任意取名，第二個(gè)參數(shù)是test_case_name和TEST_P宏的名稱一致，第三個(gè)參數(shù)是需要傳遞的參數(shù)）。

以上就是今天的所有內(nèi)容，感謝大家耐心的閱讀，希望大家都有所收獲，還有更多精彩內(nèi)容敬請(qǐng)關(guān)注，最后愿大家代碼無bug。