ToB企服应用市场:ToB评测及商务社交产业平台

标题: google gtest框架入门使用案例 [打印本页]

---

作者: 乌市泽哥    时间: 2023-11-2 20:32
标题: google gtest框架入门使用案例
通过本文可以收获：google gtest急速入门、google gtest资源网站。
google gtest是什么

google gtest是谷歌开源的c++单元测试框架，非常的好用。

起码个人感觉和spring boot自带的测试框架功能差不太多。

安装

略过，请参考：GitHub - google/googletest: GoogleTest - Google Testing and Mocking Framework或网上资料
使用案例分析

本文重点。

目前版本样例位于：googletest/googletest/samples at main · google/googletest中。
断言

与spring boot的测试框架类似，gtest判断样例是否出错用的也是断言。
断言使用（ASSERT或EXPECT）和配合上具体内容，下面案例应该是一看就懂。
ASSERT和EXPECT的区别只在于一个函数中，如果有多个断言，ASSERT断言失败后当前函数后续部分不会执行了，EXPECT断言失败后当前函数的后续部分会继续执行。
因此两种具体用哪一个需要看 当前断言失败后函数后续还有无意义。
基础的断言

Fatal assertionNonfatal assertionVerifiesASSERT_TRUE(condition);EXPECT_TRUE(condition);condition is trueASSERT_FALSE(condition);EXPECT_FALSE(condition);condition is false数值比较

Fatal assertionNonfatal assertionVerifiesASSERT_EQ(val1, val2);EXPECT_EQ(val1, val2);val1 == val2ASSERT_NE(val1, val2);EXPECT_NE(val1, val2);val1 != val2ASSERT_LT(val1, val2);EXPECT_LT(val1, val2);val1 < val2ASSERT_LE(val1, val2);EXPECT_LE(val1, val2);val1  val2ASSERT_GE(val1, val2);EXPECT_GE(val1, val2);val1 >= val2字符串比较

Fatal assertionNonfatal assertionVerifiesASSERT_STREQ(str1, str2);EXPECT_STREQ(str1, _str_2);the two C strings have the same contentASSERT_STRNE(str1, str2);EXPECT_STRNE(str1, str2);the two C strings have different contentASSERT_STRCASEEQ(str1, str2);EXPECT_STRCASEEQ(str1, str2);the two C strings have the same content, ignoring caseASSERT_STRCASENE(str1, str2);EXPECT_STRCASENE(str1, str2);the two C strings have different content, ignoring case

上面内容并不完整，gtest还有些厉害的功能，比如ASSERT_NEAR(ASSERT_NEAR(res, 3.0, 1.0e-11);)用于断言数字的接近程度，当然这种功能已经可以由基础的组合而成了。

个人样例分析

在配置好环境后来一个最简单的入门吧。

公司这边使用的是集成的插件，具体配置vscode + gtest请自行探索。

1. /*
2. * Copyright (c) Huawei Technologies Co., Ltd. 2019-2020. All rights reserved.
3. */
4. #include "gtest/gtest.h"
5. #include "leetcode24.h" //要测试的函数的头文件，其中有要测试的函数
7. int main(int argc, char** argv)
8. {
9.     ::testing::InitGoogleTest(&argc, argv);
10.     return RUN_ALL_TESTS();
11. }
13. TEST(leetcode24, add1)
14. {
15.     double res = AddNumbers(1.0, 2.0);
16.     ASSERT_NEAR(res, 3.0, 1.0e-11);
17. }

复制代码

编译后点击测试即可：

可以观察到左边名字和右边TEST宏中有对应，TEST的传入的参数只是名字，没有其他含义。

这里是已经测试成功了，除了图形化也可以在命令行进行测试：

1. 正在执行任务: cd build && cmake --build . --target all && ctest -j14 -C Debug -T test --verbose
3. [2/2] Linking CXX executable ..\bin\test_leetcode24.exe
4. UpdateCTestConfiguration  from :C:/Users/cWX1274913/Desktop/self/leetcode/leetcode24/build/DartConfiguration.tcl
5. Parse Config file:C:/Users/cWX1274913/Desktop/self/leetcode/leetcode24/build/DartConfiguration.tcl
6.    Site: P_CDTFC3-N64RRS
7.    Build name: Win32-ninja
8. UpdateCTestConfiguration  from :C:/Users/cWX1274913/Desktop/self/leetcode/leetcode24/build/DartConfiguration.tcl
9. Parse Config file:C:/Users/cWX1274913/Desktop/self/leetcode/leetcode24/build/DartConfiguration.tcl
10. Test project C:/Users/cWX1274913/Desktop/self/leetcode/leetcode24/build
11. Constructing a list of tests
12. Done constructing a list of tests
13. Updating test list for fixtures
14. Added 0 tests to meet fixture requirements
15. Checking test dependency graph...
16. Checking test dependency graph end
17. test 1
18.     Start 1: test
20. 1: Test command: C:\Users\cWX1274913\Desktop\self\leetcode\leetcode24\bin\test_leetcode24.exe
21. 1: Test timeout computed to be: 1500
22. 1: [==========] Running 1 test from 1 test case.
23. 1: [----------] Global test environment set-up.
24. 1: [----------] 1 test from leetcode24
25. 1: [ RUN      ] leetcode24.add1
26. 1: [       OK ] leetcode24.add1 (0 ms)
27. 1: [----------] 1 test from leetcode24 (0 ms total)
28. 1:
29. 1: [----------] Global test environment tear-down
30. 1: [==========] 1 test from 1 test case ran. (0 ms total)
31. 1: [  PASSED  ] 1 test.
32. 1/1 Test #1: test .............................   Passed    0.10 sec
34. 100% tests passed, 0 tests failed out of 1
36. Total Test time (real) =   0.12 sec
37. *  终端将被任务重用，按任意键关闭。

复制代码

可以看到测试已经成功了，来个失败的案例吧。
增加两个test案例，分别是ASSERT和EXPECT的失败案例。

1. TEST(leetcode24, assertFail)
2. {
3.     double res = AddNumbers2(1.0, 2.0);
4.     // EXPECT_NEAR(res, 4.0, 1.0e-11);
5.     ASSERT_NEAR(res, 4.0, 1.0e-11);
6.     res = 3;
7.     EXPECT_NEAR(res, 3.0, 1.0e-11);
8. }
11. TEST(leetcode24, expextFail)
12. {
13.     double res = AddNumbers2(1.0, 2.0);
14.     EXPECT_NEAR(res, 4.0, 1.0e-11);
15.     res = 3;
16.     EXPECT_NEAR(res, 3.0, 1.0e-11);
17. }

复制代码

运行后的命令行：

1. test 1
2.     Start 1: test
4. 1: Test command: C:\Users\cWX1274913\Desktop\self\leetcode\leetcode24\bin\test_leetcode24.exe
5. 1: Test timeout computed to be: 1500
6. 1: [==========] Running 3 tests from 1 test case.
7. 1: [----------] Global test environment set-up.
8. 1: [----------] 3 tests from leetcode24
9. 1: [ RUN      ] leetcode24.add1
10. 1: [       OK ] leetcode24.add1 (0 ms)
11. 1: [ RUN      ] leetcode24.assertFail
12. 1: ../test/test_leetcode24.cpp:23: Failure
13. 1: The difference between res and 4.0 is 1, which exceeds 1.0e-11, where
14. 1: res evaluates to 3,
15. 1: 4.0 evaluates to 4, and
16. 1: 1.0e-11 evaluates to 9.9999999999999994e-12.
17. 1: [  FAILED  ] leetcode24.assertFail (0 ms)
18. 1: [ RUN      ] leetcode24.expextFail
19. 1: ../test/test_leetcode24.cpp:32: Failure
20. 1: The difference between res and 4.0 is 1, which exceeds 1.0e-11, where
21. 1: res evaluates to 3,
22. 1: 4.0 evaluates to 4, and
23. 1: 1.0e-11 evaluates to 9.9999999999999994e-12.
24. 1: ../test/test_leetcode24.cpp:34: Failure
25. 1: The difference between res and 4.0 is 1, which exceeds 1.0e-11, where
26. 1: res evaluates to 3,
27. 1: 4.0 evaluates to 4, and
28. 1: 1.0e-11 evaluates to 9.9999999999999994e-12.
29. 1: [  FAILED  ] leetcode24.expextFail (0 ms)
30. 1: [----------] 3 tests from leetcode24 (0 ms total)
31. 1:
32. 1: [----------] Global test environment tear-down
33. 1: [==========] 3 tests from 1 test case ran. (0 ms total)
34. 1: [  PASSED  ] 1 test.
35. 1: [  FAILED  ] 2 tests, listed below:
36. 1: [  FAILED  ] leetcode24.assertFail
37. 1: [  FAILED  ] leetcode24.expextFail
38. 1:
39. 1:  2 FAILED TESTS
40. 1/1 Test #1: test .............................***Failed    0.04 sec
42. 0% tests passed, 1 tests failed out of 1
44. Total Test time (real) =   0.06 sec

复制代码

可以看到leetcode24.assertFail有一处失败，而leetcode24.expextFail有两处失败。这 验证 ASSERT断言失败后续不会再执行，而EXCEPT断言失败后续还会继续执行。
TEST_F宏

TEST_F宏的作用在于帮助很多类似的处理进行批量测试。如果我们使用的测试集需要使用一些相似的数据呢？或者有些相似的检查方法？这时就需要用到测试夹具和TEST_F宏配合了。

测试夹具和TEST_F宏 的最大的作用就在于测试开始之前和测试完成之后可以执行对应的函数，SetUp 和 TearDown 两个虚函数。

1. #include "sample3-inl.h"
2. #include "gtest/gtest.h"
4. // To use a test fixture, derive a class from testing::Test.
5. class QueueTest : public testing::Test {
6. protected:  // You should make the members protected s.t. they can be
7.              // accessed from sub-classes.
9.   // virtual void SetUp() will be called before each test is run.  You
10.   // should define it if you need to initialize the varaibles.
11.   // Otherwise, this can be skipped.
12.   virtual void SetUp() {
13.     q1_.Enqueue(1);
14.     q2_.Enqueue(2);
15.     q2_.Enqueue(3);
16.   }
18.   // virtual void TearDown() will be called after each test is run.
19.   // You should define it if there is cleanup work to do.  Otherwise,
20.   // you don't have to provide it.
21.   //
22.   // virtual void TearDown() {
23.   // }
25.   // A helper function that some test uses.
26.   static int Double(int n) {
27.     return 2*n;
28.   }
30.   // A helper function for testing Queue::Map().
31.   void MapTester(const Queue<int> * q) {
32.     // Creates a new queue, where each element is twice as big as the
33.     // corresponding one in q.
34.     const Queue<int> * const new_q = q->Map(Double);
36.     // Verifies that the new queue has the same size as q.
37.     ASSERT_EQ(q->Size(), new_q->Size());
39.     // Verifies the relationship between the elements of the two queues.
40.     for ( const QueueNode<int> * n1 = q->Head(), * n2 = new_q->Head();
41.           n1 != NULL; n1 = n1->next(), n2 = n2->next() ) {
42.       EXPECT_EQ(2 * n1->element(), n2->element());
43.     }
45.     delete new_q;
46.   }
48.   // Declares the variables your tests want to use.
49.   Queue<int> q0_;
50.   Queue<int> q1_;
51.   Queue<int> q2_;
52. };
54. // When you have a test fixture, you define a test using TEST_F
55. // instead of TEST.
57. // Tests the default c'tor.
58. TEST_F(QueueTest, DefaultConstructor) {
59.   // You can access data in the test fixture here.
60.   EXPECT_EQ(0u, q0_.Size());
61. }
63. // Tests Dequeue().
64. TEST_F(QueueTest, Dequeue) {
65.   int * n = q0_.Dequeue();
66.   EXPECT_TRUE(n == NULL);
68.   n = q1_.Dequeue();
69.   ASSERT_TRUE(n != NULL);
70.   EXPECT_EQ(1, *n);
71.   EXPECT_EQ(0u, q1_.Size());
72.   delete n;
74.   n = q2_.Dequeue();
75.   ASSERT_TRUE(n != NULL);
76.   EXPECT_EQ(2, *n);
77.   EXPECT_EQ(1u, q2_.Size());
78.   delete n;
79. }
81. // Tests the Queue::Map() function.
82. TEST_F(QueueTest, Map) {
83.   MapTester(&q0_);
84.   MapTester(&q1_);
85.   MapTester(&q2_);
86. }

复制代码

可以看到我们首先需要从 testing::Test 来派生一个自己的测试类QueueTest，在这个类里你可以定义一些必要的成员变量或者辅助函数，还可以定义 SetUp 和 TearDown 两个虚函数，来指定每个测试集运行前和运行后应该做什么。后面测试用例的每个测试集应该使用 TEST_F 宏，第一个参数是我们定义的类名，第二个是测试集的名称。
这样就可以避免在很多重复的测试的时候需要不断重复初始化相同的内容了，以及可以利用类的函数来写一些复杂的运行逻辑。

参考：
https://github.com/google/googletest/blob/main/googletest/samples/sample6_unittest.cc
https://github.com/AngryHacker/articles/blob/master/src/open_source_components/google_gtest.md

我的博客园：https://www.cnblogs.com/swx123
我的github（代码一般都放在这里）：https://github.com/578223592

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4