當前位置：首頁 > 人文社科 > 生活经验 >内容正文

生活经验

Google Test(GTest)使用方法和源码解析——结果统计机制分析

發布時間：2023/11/27 生活经验 25 豆豆

生活随笔收集整理的這篇文章主要介紹了 Google Test(GTest)使用方法和源码解析——结果统计机制分析小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

? ? ? ? 在分析源碼之前，我們先看一個例子。以《Google Test(GTest)使用方法和源碼解析——概況?》一文中最后一個實例代碼為基準，修改最后一個“局部測試”結果為錯誤。（轉載請指明出于breaksoftware的csdn博客）

class ListTest : public testing::Test {protected:virtual void SetUp() {_m_list[0] = 11;_m_list[1] = 12;_m_list[2] = 13;}int _m_list[3];
};
TEST_F(ListTest, FirstElement) {EXPECT_EQ(11, _m_list[0]);
}TEST_F(ListTest, SecondElement) {EXPECT_EQ(12, _m_list[1]);
}TEST_F(ListTest, ThirdElement) {EXPECT_EQ(0, _m_list[2]);
}

? ? ? ? 然后我們觀察其輸出，從下面的結果我們可以分析出GTest幫我們統計了：

有多少測試用例
一個測試用例中有多少測試特例
一個測試用例中有多少測試特例成功
一個測試用例中有多少測試特例失敗
失敗的原因、位置、期待結果、實際結果

Running main() from gtest_main.cc
[==========] Running 3 tests from 1 test case.
[----------] Global test environment set-up.
[----------] 3 tests from ListTest
[ RUN      ] ListTest.FirstElement
[       OK ] ListTest.FirstElement (0 ms)
[ RUN      ] ListTest.SecondElement
[       OK ] ListTest.SecondElement (0 ms)
[ RUN      ] ListTest.ThirdElement
../samples/sample11_unittest.cc:86: FailureExpected: 0
To be equal to: _m_list[2]Which is: 13
[  FAILED  ] ListTest.ThirdElement (0 ms)
[----------] 3 tests from ListTest (0 ms total)[----------] Global test environment tear-down
[==========] 3 tests from 1 test case ran. (0 ms total)
[  PASSED  ] 2 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] ListTest.ThirdElement1 FAILED TEST

? ? ? ? 在《Google Test(GTest)使用方法和源碼解析——自動調度機制分析》一文中，我們分析了，測試用例對象指針將保存在類UnitTestImpl中

// The vector of TestCases in their original order.  It owns the
// elements in the vector.std::vector<TestCase*> test_cases_;

? ? ? ? 那么結果的統計，肯定也是針對這個vector變量的。實際也是如此，我們在代碼中找到如下函數，從函數注釋，我們就可以知道其對應于上面輸出中那個結果的統計

// Gets the number of successful test cases.
int UnitTestImpl::successful_test_case_count() const {return CountIf(test_cases_, TestCasePassed);
}// Gets the number of failed test cases.
int UnitTestImpl::failed_test_case_count() const {return CountIf(test_cases_, TestCaseFailed);
}// Gets the number of all test cases.
int UnitTestImpl::total_test_case_count() const {return static_cast<int>(test_cases_.size());
}// Gets the number of all test cases that contain at least one test
// that should run.
int UnitTestImpl::test_case_to_run_count() const {return CountIf(test_cases_, ShouldRunTestCase);
}// Gets the number of successful tests.
int UnitTestImpl::successful_test_count() const {return SumOverTestCaseList(test_cases_, &TestCase::successful_test_count);
}// Gets the number of failed tests.
int UnitTestImpl::failed_test_count() const {return SumOverTestCaseList(test_cases_, &TestCase::failed_test_count);
}// Gets the number of disabled tests that will be reported in the XML report.
int UnitTestImpl::reportable_disabled_test_count() const {return SumOverTestCaseList(test_cases_,&TestCase::reportable_disabled_test_count);
}// Gets the number of disabled tests.
int UnitTestImpl::disabled_test_count() const {return SumOverTestCaseList(test_cases_, &TestCase::disabled_test_count);
}// Gets the number of tests to be printed in the XML report.
int UnitTestImpl::reportable_test_count() const {return SumOverTestCaseList(test_cases_, &TestCase::reportable_test_count);
}// Gets the number of all tests.
int UnitTestImpl::total_test_count() const {return SumOverTestCaseList(test_cases_, &TestCase::total_test_count);
}// Gets the number of tests that should run.
int UnitTestImpl::test_to_run_count() const {return SumOverTestCaseList(test_cases_, &TestCase::test_to_run_count);
}

? ? ? ??CountIf函數返回符合條件的測試用例個數，SumOverTestCaseList函數返回符合條件的所有測試特例的個數。其實現也非常簡單，我們以CountIf為例

template <class Container, typename Predicate>
inline int CountIf(const Container& c, Predicate predicate) {// Implemented as an explicit loop since std::count_if() in libCstd on// Solaris has a non-standard signature.int count = 0;for (typename Container::const_iterator it = c.begin(); it != c.end(); ++it) {if (predicate(*it))++count;}return count;
}

? ? ? ? 這種寫法的一個好處就是我們封裝了函數調用迭代器中元素，從而不用到處都是遍歷。然后我們將重點放在傳入的函數指針，以TestCaseFailed為例

// Returns true iff the test case failed.
static bool TestCaseFailed(const TestCase* test_case) {return test_case->should_run() && test_case->Failed();
}

? ? ? ? 它和TestCasePassed區別就是將test_case調用的Failed函數變成Passed函數。而TestCase的Passed函數只是對Failed函數取反，所以最終還是調用到Failed中，我們看下其實現

bool Failed() const { return failed_test_count() > 0; }
int TestCase::failed_test_count() const {return CountIf(test_info_list_, TestFailed);
}

? ? ? ? 可見TestCase測試用例對象最終還是要對其下的測試特例對象指針逐個調用TestFailed

  // Returns true iff test failed.static bool TestFailed(const TestInfo* test_info) {return test_info->should_run() && test_info->result()->Failed();}

? ? ? ? 經過這層傳遞，最終邏輯運行到TestResult的Failed函數中

bool TestResult::Failed() const {for (int i = 0; i < total_part_count(); ++i) {if (GetTestPartResult(i).failed())return true;}return false;
}

? ? ? ? GetTestPartResult獲取的一個測試特例中“局部測試”的結果。比如

TEST(IsPrimeTest, Negative) {// This test belongs to the IsPrimeTest test case.EXPECT_FALSE(IsPrime(-1));EXPECT_FALSE(IsPrime(-2));EXPECT_FALSE(IsPrime(INT_MIN));
}

? ? ? ? 這個測試特例中有三個“局部測試”（3、4和5行）。它們的結果保存在TestResult的（實際上并不是所有情況都保存，我們將在之后分析）

// The vector of TestPartResultsstd::vector<TestPartResult> test_part_results_;

? ? ? ? 現在我們看到了數據的統計邏輯，接下來我們需要關注源碼是如何將結果填充到test_part_results_中的。

? ? ? ? 在源碼中，TestResult只提供了AddTestPartResult方法用于保存“局部測試”結果。而調用該方法的地方只有一處

void DefaultGlobalTestPartResultReporter::ReportTestPartResult(const TestPartResult& result) {unit_test_->current_test_result()->AddTestPartResult(result);unit_test_->listeners()->repeater()->OnTestPartResult(result);
}

? ? ? ? 其調用邏輯最終會歸于如下邏輯

void AssertHelper::operator=(const Message& message) const {UnitTest::GetInstance()->AddTestPartResult(data_->type, data_->file, data_->line,AppendUserMessage(data_->message, message),UnitTest::GetInstance()->impl()->CurrentOsStackTraceExceptTop(1)// Skips the stack frame for this function itself.);  // NOLINT
}

? ? ? ? 到此，我們只要關注于AssertHelper的賦值符就行了。但是事情并不像我們想象的那么簡單，甚至我認為GTest在這兒實現有個缺陷。為什么這么說呢？我們搜索完代碼，發現該類的賦值符調用只有一處

#define GTEST_MESSAGE_AT_(file, line, message, result_type) \::testing::internal::AssertHelper(result_type, file, line, message) \= ::testing::Message()

? ? ? ? 調用GTEST_MESSAGE_AT_的地方只有

// Generates a nonfatal failure at the given source file location with
// a generic message.
#define ADD_FAILURE_AT(file, line) \GTEST_MESSAGE_AT_(file, line, "Failed", \::testing::TestPartResult::kNonFatalFailure)

? ? ? ? 和

#define GTEST_MESSAGE_(message, result_type) \GTEST_MESSAGE_AT_(__FILE__, __LINE__, message, result_type)

? ? ? ? 對ADD_FAILURE_AT的調用只有一處，且只是在出錯時。而對GTEST_MESSAGE_的調用則有三處

#define GTEST_FATAL_FAILURE_(message) \return GTEST_MESSAGE_(message, ::testing::TestPartResult::kFatalFailure)#define GTEST_NONFATAL_FAILURE_(message) \GTEST_MESSAGE_(message, ::testing::TestPartResult::kNonFatalFailure)#define GTEST_SUCCESS_(message) \GTEST_MESSAGE_(message, ::testing::TestPartResult::kSuccess)

? ? ? ??GTEST_FATAL_FAILURE_和GTEST_NONFATAL_FAILURE_都將在出錯時被調用，如EXPECT_EQ在內部是這么調用的

#define EXPECT_PRED_FORMAT2(pred_format, v1, v2) \GTEST_PRED_FORMAT2_(pred_format, v1, v2, GTEST_NONFATAL_FAILURE_)

? ? ? ? 但是對GTEST_SUCCESS_的調用只有一處

// Generates a success with a generic message.
#define GTEST_SUCCEED() GTEST_SUCCESS_("Succeeded")

? ? ? ??GTEST_SUCCEED并不會出現在每個判斷的宏中。比如EXPECT_EQ的實現是

#define EXPECT_EQ(val1, val2) \EXPECT_PRED_FORMAT2(::testing::internal:: \EqHelper<GTEST_IS_NULL_LITERAL_(val1)>::Compare, \val1, val2)

? ? ? ??EXPECT_PRED_FORMAT2宏中只處理了出錯的情況——調用GTEST_NONFATAL_FAILURE_——從而觸發AssertHelper的賦值符——將結果保存到“局部測試”結果集合中。而正確的情況下并不會保存結果到“局部測試”結果集中！！但是TestResult計算局部測試個數的函數注釋說明它包含了所有情況的結果

// Gets the number of all test parts.  This is the sum of the number
// of successful test parts and the number of failed test parts.
int TestResult::total_part_count() const {return static_cast<int>(test_part_results_.size());
}

? ? ? ? 所以，它的注釋是錯誤的！！只有出錯的情況會保存“局部測試”錯誤結果，或者人為調用GTEST_SUCCEED保存“局部測試”正確結果，而其他情況不保存。我一直覺得test_part_results_保存的數據有點混亂，沒有準確的表達其意義。

? ? ? ? 但是這種混亂的保存為什么不會影響測試結果統計呢？我們再看下TestResult的Failed函數

bool TestResult::Failed() const {for (int i = 0; i < total_part_count(); ++i) {if (GetTestPartResult(i).failed())return true;}return false;
}

? ? ? ? 當我們沒有人為調用GTEST_SUCCEED保存“局部測試”正確結果時，test_part_results_只保存了錯誤結果。如果沒有錯誤結果，total_part_count函數返回0。而從Failed函數返回false，即沒有出錯。
? ? ? ? 到此，我們將結果統計的實現講完了。

總結

以上是生活随笔為你收集整理的Google Test(GTest)使用方法和源码解析——结果统计机制分析的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇： Google Test(GTest)使用
下一篇： Google Test(GTest)使用