使用gtest編寫的測試案例通常本身就是一個可執行文件,因此運行起來非常方便。同時,gtest也為我們提供了一系列的運行參數(環境變量、命令行參數或代碼里指定),使得我們可以對案例的執行進行一些有效的控制。
前面提到,對于運行參數,gtest提供了三種設置的途徑:
1. 系統環境變量
2. 命令行參數
3. 代碼中指定FLAG
因為提供了三種途徑,就會有優先級的問題, 有一個原則是,最后設置的那個會生效。不過總結一下,通常情況下,比較理想的優先級為:
命令行參數 > 代碼中指定FLAG > 系統環境變量
為什么我們編寫的測試案例能夠處理這些命令行參數呢?是因為我們在main函數中,將命令行參數交給了gtest,由gtest來搞定命令行參數的問題。
int _tmain(int argc, _TCHAR* argv[]){ testing::InitGoogleTest(&argc, argv); return RUN_ALL_TESTS();}
這樣,我們就擁有了接收和響應gtest命令行參數的能力。如果需要在代碼中指定FLAG,可以使用testing::GTEST_FLAG這個宏來設置。比如相對于命令行參數--gtest_output,可以使用testing::GTEST_FLAG(output) = "xml:";來設置。注意到了,不需要加--gtest前綴了。同時,推薦將這句放置InitGoogleTest之前,這樣就可以使得對于同樣的參數,命令行參數優先級高于代碼中指定。
最后再來說下第一種設置方式-系統環境變量。如果需要gtest的設置系統環境變量,必須注意的是:
1. 系統環境變量全大寫,比如對于--gtest_output,響應的系統環境變量為:GTEST_OUTPUT
2. 有一個命令行參數例外,那就是--gtest_list_tests,它是不接受系統環境變量的。(只是用來羅列測試案例名稱)
了解了上面的內容,我這里就直接將所有命令行參數總結和羅列一下。如果想要獲得詳細的命令行說明,直接運行你的案例,輸入命令行參數:/? 或 --help 或 -help
1. 測試案例集合
命令行參數 | 說明 |
--gtest_list_tests | 使用這個參數時,將不會執行里面的測試案例,而是輸出一個案例的列表。 |
--gtest_filter | 對執行的測試案例進行過濾,支持通配符 ? 單個字符 * 任意字符 - 排除,如,-a 表示除了a : 取或,如,a:b 表示a或b 比如下面的例子: ./foo_test 沒有指定過濾條件,運行所有案例./foo_test --gtest_filter=* 使用通配符*,表示運行所有案例./foo_test --gtest_filter=FooTest.* 運行所有“測試案例名稱(testcase_name)”為FooTest的案例./foo_test --gtest_filter=*Null*:*Constructor* 運行所有“測試案例名稱(testcase_name)”或“測試名稱(test_name)”包含Null或Constructor的案例。./foo_test --gtest_filter=-*DeathTest.* 運行所有非死亡測試案例。./foo_test --gtest_filter=FooTest.*-FooTest.Bar 運行所有“測試案例名稱(testcase_name)”為FooTest的案例,但是除了FooTest.Bar這個案例 |
--gtest_also_run_disabled_tests | 執行案例時,同時也執行被置為無效的測試案例。關于設置測試案例無效的方法為: 在測試案例名稱或測試名稱中添加DISABLED前綴,比如: ![]() ![]() ![]() ![]() ![]() |
--gtest_repeat=[COUNT] | 設置案例重復運行次數,非常棒的功能!比如: --gtest_repeat=1000 重復執行1000次,即使中途出現錯誤。--gtest_repeat=-1 無限次數執行。。。。--gtest_repeat=1000 --gtest_break_on_failure 重復執行1000次,并且在第一個錯誤發生時立即停止。這個功能對調試非常有用。--gtest_repeat=1000 --gtest_filter=FooBar 重復執行1000次測試案例名稱為FooBar的案例。 |
2. 測試案例輸出
命令行參數 | 說明 |
--gtest_color=(yes|no|auto) | 輸出命令行時是否使用一些五顏六色的顏色。默認是auto。 |
--gtest_PRint_time | 輸出命令行時是否打印每個測試案例的執行時間。默認是不打印的。 |
--gtest_output=xml[:DIRECTORY_PATH/|:FILE_PATH] | 將測試結果輸出到一個xml中。 1.--gtest_output=xml: 不指定輸出路徑時,默認為案例當前路徑。 2.--gtest_output=xml:d:/ 指定輸出到某個目錄 3.--gtest_output=xml:d:/foo.xml 指定輸出到d:/foo.xml 如果不是指定了特定的文件路徑,gtest每次輸出的報告不會覆蓋,而會以數字后綴的方式創建。xml的輸出內容后面介紹吧。 |
3. 對案例的異常處理
命令行參數 | 說明 |
--gtest_break_on_failure | 調試模式下,當案例失敗時停止,方便調試 |
--gtest_throw_on_failure | 當案例失敗時以C++異常的方式拋出 |
--gtest_catch_exceptions | 是否捕捉異常。gtest默認是不捕捉異常的,因此假如你的測試案例拋了一個異常,很可能會彈出一個對話框,這非常的不友好,同時也阻礙了測試案例的運行。如果想不彈這個框,可以通過設置這個參數來實現。如將--gtest_catch_exceptions設置為一個非零的數。 注意:這個參數只在Windows下有效。 |
從報告里可以看出,我們之前在TEST等宏中定義的測試案例名稱(testcase_name)在xml測試報告中其實是一個testsuite name,而宏中的測試名稱(test_name)在xml測試報告中是一個testcase name,概念上似乎有點混淆,就看你怎么看吧。
當檢查點通過時,不會輸出任何檢查點的信息。當檢查點失敗時,會有詳細的失敗信息輸出來failure節點。
在我使用過程中發現一個問題,當我同時設置了--gtest_filter參數時,輸出的xml報告中還是會包含所有測試案例的信息,只不過那些不被執行的測試案例的status值為“notrun”。而我之前認為的輸出的xml報告應該只包含我需要運行的測試案例的信息。不知是否可提供一個只輸出需要執行的測試案例的xml報告。因為當我需要在1000個案例中執行其中1個案例時,在報告中很難找到我運行的那個案例,雖然可以查找,但還是很麻煩。
本篇主要介紹了gtest案例執行時提供的一些參數的使用方法,這些參數都非常有用。在實際編寫gtest測試案例時肯定會需要用到的時候。至少我現在比較常用的就是:
1. --gtest_filter
2. --gtest_output=xml[:DIRECTORY_PATH/|:FILE_PATH]
3. --gtest_catch_exceptions
最后再總結一下我使用過程中遇到的幾個問題:
1. 同時使用--gtest_filter和--gtest_output=xml:時,在xml測試報告中能否只包含過濾后的測試案例的信息。
2. 有時,我在代碼中設置 testing::GTEST_FLAG(catch_exceptions) = 1和我在命令行中使用--gtest_catch_exceptions結果稍有不同,在代碼中設置FLAG方式有時候捕捉不了某些異常,但是通過命令行參數的方式一般都不會有問題。這是我曾經遇到過的一個問題,最后我的處理辦法是既在代碼中設置FLAG,又在命令行參數中傳入--gtest_catch_exceptions。不知道是gtest在catch_exceptions方面不夠穩定,還是我自己測試案例的問題。
新聞熱點
疑難解答
圖片精選