天天看點

一文掌握google開源單元測試架構Google Test

作者:linux技術棧

我們在開發的過程中,需要做一些驗證測試,來保證我們的代碼是按照設計要求工作的,這就需要單元測試了。單元測試(Unit Test),我們稱為“UT測試”。對于一個複雜的系統來說,需要編寫大量的單元測試用例,有人會覺得這麼多的測試代碼,将會花費大量的時間,影響開發的進度,會得不償失。真的是這樣嗎?其實,對于越是複雜的系統就越是需要單元測試來保證我們的代碼的開發品質,及時測試出代碼的問題,在開發階段發現問題總比在系統釋出之後發現問題能夠較少的節省資源或成本。

對于單元測試應該是每個開發工程師必備的技能,尤其是高階的開發工程師會更加注重UT的重要性。同時,我們在開發功能子產品之前會考慮到測試用例的實作,這樣自然的就會考慮到功能子產品的子產品化便于UT的編寫,從這一方面來說也能提高開發人員開發的代碼品質。另外,單元測試用例還可以作為示例供開發人員參考,進而能夠更輕松的掌握子產品的使用。

今天就和大家一起學習一個開源的C++的單元測試架構Google test,大家看名字就知道它是由牛逼的Google公司出品。Google Test可以在多種平台上使用,它可以支援:

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

安裝和配置

我們可以從github擷取Google Test的源碼。

github下載下傳位址: https://github.com/google/googletest

因為我們下載下傳到的gTest是源代碼,還需要将其編譯成庫檔案再進行使用。下面将和大家一起學習如何在windows環境下生成gTest的庫檔案。在這之前我們需要安裝CMake和MinGW。

将下載下傳的gTest的源碼進行解壓,源碼目錄如下圖所示。

一文掌握google開源單元測試架構Google Test

打開指令行工具cmd,進入源碼的工程目錄,建立一個build目錄用來存放建構檔案,然後,進入build目錄執行cmake指令生成Makefile檔案。

mkdir build
cd build
cmake -G "MinGW Makefiles" ..           
一文掌握google開源單元測試架構Google Test
一文掌握google開源單元測試架構Google Test

Makefile檔案生成後,再執行下面的指令mingw32-make編譯庫檔案。編譯成功後就會發現有libgtest.a 和libgtest_main.a兩個靜态庫生成。這裡注意,Windows下mingw安裝的make工具名稱是mingw32-make而不是make。

mingw32-make           
一文掌握google開源單元測試架構Google Test

接下來我們在VS Code寫一個測試用例,使用生成的gTest靜态庫測試下。按下快捷鍵【Ctrl+Shift+p】,在彈出的搜尋框中搜尋【C/C++:Edit Configurations】,可以建立c_cpp_properties.json配置檔案。

一文掌握google開源單元測試架構Google Test

在c_cpp_properties.json配置檔案添加gTest的頭檔案目錄。

一文掌握google開源單元測試架構Google Test

在task.json配置檔案中添加gTest頭檔案目錄和庫檔案,task.json配置檔案可以通過菜單欄中Terminal選項下的【Configure Default Build Task】選項建立。

一文掌握google開源單元測試架構Google Test
一文掌握google開源單元測試架構Google Test

上面配置好之後,我們寫個測試用例跑一下。

#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(); 
}            

運作結果如下圖所示,代碼中的TEST是一個宏,用來建立測試用例,它有test_case_name和test_name兩個參數。分别是測試用例名和測試名,在後面的文章中我們會對其有更深刻的了解,這裡就不細說了。RUN_ALL_TESTS也是一個宏,它是測試用例的入口。EXPECT_EQ這個是一個斷言相關的宏,用來檢測兩個數值是否相等。

一文掌握google開源單元測試架構Google Test

相關視訊推薦

程式員精進之路-從googletest測試架構開始

c++後端必學:googletest中的設計模式

2022年c++後端學習路線,含思維導圖詳細講解

需要C/C++ Linux伺服器架構師學習資料加qun812855908擷取(資料包括C/C++,Linux,golang技術,Nginx,ZeroMQ,MySQL,Redis,fastdfs,MongoDB,ZK,流媒體,CDN,P2P,K8S,Docker,TCP/IP,協程,DPDK,ffmpeg等),免費分享

一文掌握google開源單元測試架構Google Test

斷言

除了上面示例裡的EXPECT_EQ,在gTest裡有很多斷言相關的宏。斷言可以檢查出某些條件的真假,是以,我們可以通過它來判斷被測試的函數的成功與否。這裡斷言我們主要可以分為兩類:

  • 以"ASSERT_"開頭的斷言,緻命性斷言(Fatal assertion)
  • 以"EXPECT_"開頭的斷言 ,非緻命性斷言(Nonfatal assertion)

上面的兩種斷言會在斷言條件不滿足時會有差別,即當不滿足條件時, "ASSERT_"斷言會在目前函數終止,而不會繼續執行下去;而"EXPECT_"則會繼續執行。我們可以通過下面一個例子來了解下他們的差別。

#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(); 
}           

從下面的運作結果上看,assert斷言檢查出被測函數add不滿足條件,是以程式就沒有繼續執行下去;而expect雖然檢查出被測試函數add不滿足條件,但是程式還是繼續去測試sub函數。

一文掌握google開源單元測試架構Google Test

上面的示例用到的都是判斷相等條件的斷言,還有其他條件檢查的斷言。主要可以分為布爾檢查,數值比較檢查,字元串檢查,浮點數檢查,異常檢查等等。下面我們逐一認識這些斷言。

布爾檢查

布爾檢查主要用來檢查布爾類型資料,檢查其條件是真還是假。

一文掌握google開源單元測試架構Google Test

數值比較檢查

數值比較檢查主要用來比較兩個數值之間的大小關系,這裡有兩個參數。

一文掌握google開源單元測試架構Google Test

字元串檢查

字元串檢查主要用來比較字元串的内容。

一文掌握google開源單元測試架構Google Test

浮點數檢查

對于浮點數來說,因為其精度原因,我們無法确定其是否完全相等,實際上對于浮點數我比較兩個浮點數近似相等。

一文掌握google開源單元測試架構Google Test

異常檢查

異常檢查可以将異常轉換成斷言的形式。

一文掌握google開源單元測試架構Google Test

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

顯示成功或失敗

這一類斷言會在測試運作中标記成功或失敗。它主要有三個宏:

  • SUCCED():标記成功。
  • FAIL() : 标記失敗,類似ASSERT斷言标記緻命錯誤;
  • ADD_FAILURE():标記,類似EXPECT斷言标記非緻命錯誤。
#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(); 
}            

執行結果如下:

一文掌握google開源單元測試架構Google Test

死亡測試

死亡測試是用來檢測測試程式是否按照預期的方式崩潰。

一文掌握google開源單元測試架構Google Test
#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(); 
}            

上面這個例子就是死亡測試,其運作結果如下,這裡需要注意的是test_case_name如果使用DeathTest為字尾,gTest會優先運作。

一文掌握google開源單元測試架構Google Test

測試事件

在學習測試事件之前,我們先來了解下三個概念,它們分别是測試程式,測試套件,測試用例。

  • 測試程式是一個可執行程式,它有一個測試程式的入口main函數。
  • 測試用例是用來定義需要驗證的内容。
  • 測試套件是測試用例的集合,運作測試。

我們回過來看測試事件,在GTest中有了測試事件的這個機制,就能能夠在測試之前或之後能夠做一些準備/清理的操作。根據事件執行的位置不同,我們可将測試事件分為三種:

  • TestCase級别測試事件:這個級别的事件會在TestCase之前與之後執行;
  • TestSuite級别測試事件:這個級别的事件會在TestSuite中第一個TestCase之前與最後一個TestCase之後執行;
  • 全局測試事件:這是級别的事件會在所有TestCase中第一個執行前,與最後一個之後執行。

這些測試事件都是基于類的,是以需要在類上實作。下面我們依次來學習這三種測試事件。

TestCase測試事件

TestCase測試事件,需要實作兩個函數SetUp()和TearDown()。

  • SetUp()函數是在TestCase之前執行。
  • TearDown()函數是在TestCase之後執行。

這兩個函數是不是有點像類的構造函數和析構函數,但是切記他們并不是構造函數和析構函數,隻是打個比方才這麼說而已。我們可以借助下面的代碼示例來加深對它的了解。這兩個函數是testing::Test的成員函數,我們在編寫測試類時需要繼承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(); 
}            

測試結果如下,兩個函數都是是在每個TestCase(test_add和test_sub)之前和之後執行。

一文掌握google開源單元測試架構Google Test

TestSuite測試事件

TestSuite測試事件,同樣的也需要實作的兩個函數SetUpTestCase()和TearDownTestCase(),而這兩個函數是靜态函數。這兩個靜态函數同樣也是testing::Test類的成員,我們直接改寫下測試類calcFunctionTest,添加兩個靜态函數SetUpTestCase()和TearDownTestCase()到測試類中即可。

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;

};           

改寫好之後,我們再看一下運作結果。這兩個函數分别是在本TestSuite中的第一個TestCase之前和最後一個TestCase之後執行。

一文掌握google開源單元測試架構Google Test

全局測試事件

全局測試事件,也需要繼承一個類,但是它需要繼承testing::Environment類實作SetUp()和TearDown()兩個函數。還需要在main函數中調用testing::AddGlobalTestEnvironment方法注冊全局事件。我們直接上代碼吧!

#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(); 
}            

從測試結果上看,全局事件的這兩個函數分别是在第一個TestSuite之前和最後一個TestSuite之後執行的。

一文掌握google開源單元測試架構Google Test

以上三種測試事件我們可以根據需要進行靈活使用。另外,細心的同學會發現,這裡測試用例我們該用了TEST_F這個宏,這是因為繼承了testing::Test,與之對應就需要使用TEST_F宏。

參數化

在學習gTest參數化之前我們先看一個測試例子。

#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(); 
}            

示例執行結果:

一文掌握google開源單元測試架構Google Test

​上面的測試用例中我們寫了多個測試用例,但是其參數都是同樣的,有的實際應用場景可能比這個程式寫的測試檢查還要多。寫這麼多重複的代碼實在是太累了。gTest提供了一個非常友好的工具,将這些測試的值進行參數化,就不用寫那麼多重複的代碼了。

如何對其進行參數化呢?直接上代碼,我們再來看下面一個例子。

#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(); 
}            

執行結果和前面的例子一樣。

一文掌握google開源單元測試架構Google Test

從這個例子中,我們不難發現和之前的測試程式有一些不同。這裡繼承了::testing::TestWithParam類,參數T就是需要參數化的資料類型,這個例子裡參數化資料類型是TestParam結構體。這裡還需要使用另外一個宏TEST_P而不是TEST_F這個宏,它的兩個參數和TEST_F和TEST一緻。另外,程式中還增加一個宏INSTANTIATE_TEST_CASE_P用來輸入測試參數,它有三個參數(第一個參數大家可任意取名,第二個參數是test_case_name和TEST_P宏的名稱一緻,第三個參數是需要傳遞的參數)。

以上就是今天的所有内容,感謝大家耐心的閱讀,希望大家都有所收獲,願大家代碼無bug。

繼續閱讀