单元测试(UT,C++版)经验总结(gtest+gmock)
最近做了一段测试工作,其中包括单元测试,编程语言是C++。这里提供一些基本知识总结,方便入门单元测试。
1.单元测试介绍
单元测试(Unit Testing, 简称UT)是软件测试的一种方法,目的是通过对单个软件组件(即单元)的验证,确保其按预期工作。对于C++程序开发者来说,单元测试是一项重要的质量保障手段,能够帮助开发者在代码开发过程中及时发现和修复问题。
单元测试的优点:
- 提高代码质量:通过自动化的测试,能够有效捕捉到程序中的潜在缺陷。
- 回归测试:随着代码的不断重构和修改,单元测试能够确保原有功能没有被破坏。
- 文档化代码:良好的单元测试不仅是验证代码的工具,也充当了文档角色,帮助开发人员更容易理解代码的预期行为。
- 减少调试时间:因为测试能够尽早发现问题,能够帮助开发者避免在较后阶段出现难以调试的问题。
单元测试的挑战:
- 测试覆盖率:虽然单元测试能够有效发现许多问题,但并不是每个错误都能被检测到,因此测试覆盖率需要设计得足够高。
- 维护性:随着项目规模的增大,单元测试本身也可能会变得非常庞大和复杂,维护起来可能会成为一个负担。
2.google test
Google Test(gtest)是由Google开发的一个C++测试框架,用于编写和执行单元测试。它提供了许多功能,使得编写和执行单元测试变得更加简便和高效。gtest支持断言(assertion)、异常捕获、参数化测试等功能。
在项目中使用: 在Cmakelist里通过 find_package(GTest REQUIRED)
来引入Google Test库
头文件:
#include <gtest/gtest.h>
常用断言:
EXPECT_EQ(val1, val2):断言两个值相等。
EXPECT_NE(val1, val2):断言两个值不相等。
EXPECT_TRUE(expression):断言表达式为true。
EXPECT_FALSE(expression):断言表达式为false。
ASSERT_* 和 EXPECT_*:两者的区别在于ASSERT_*失败时会立即终止当前测试用例的执行,而EXPECT_*会继续执行。
参数化测试:
gtest支持参数化测试,允许使用不同的参数多次运行同一个测试逻辑。
class MyTest : public ::testing::TestWithParam<int> {};
TEST_P(MyTest, TestWithParam) {
EXPECT_EQ(GetParam(), 1); // 断言传入的参数与1相等
}
INSTANTIATE_TEST_SUITE_P(MyTests, MyTest, ::testing::Values(1, 2, 3));
3. goole mock
Google Mock(gmock)是Google推出的一个用于C++的模拟框架,用于为依赖的外部对象创建模拟(Mock)对象。在单元测试中,经常需要模拟外部依赖,以便测试目标函数的行为,而Google Mock正是提供了这种能力。
在项目中使用: 在Cmakelist里通过 find_package(GMock REQUIRED)
来引入Google Test库
头文件:
#include <gmock/gmock.h>
使用gmock时,我们通过模拟对象来替代真实的对象,避免依赖外部系统。以下是gmock的一些基本用法。
-
创建 Mock 类:通过继承
testing::Mock
,然后模拟所需的成员函数。
-
class MyClass { public: virtual int Multiply(int a, int b) { return a * b; } }; class MockMyClass : public MyClass { public: MOCK_METHOD(int, Multiply, (int a, int b), (override)); };
-
2. 设置期望:使用
EXPECT_CALL
来设置期望,断言模拟对象的方法是否按预期被调用。 -
TEST(MockTest, MultiplyTest) { MockMyClass mock; EXPECT_CALL(mock, Multiply(2, 3)).WillOnce(testing::Return(6)); // 设置期望:Multiply(2, 3)返回6 EXPECT_EQ(mock.Multiply(2, 3), 6); // 断言返回值是否为6 }
-
3. 模拟行为:可以通过
WillOnce
或WillRepeatedly
指定模拟方法的返回值或行为。 -
EXPECT_CALL(mock, Multiply(testing::Gt(0), testing::Lt(10))) .WillRepeatedly(testing::Return(42)); // 所有大于0且小于10的输入都会返回42
-
4. 模拟void函数:对于返回类型为
void
的函数,使用MOCK_METHOD
时,可以通过WillOnce
模拟其行为。class MyClass { public: virtual void DoSomething() { // Do something } }; class MockMyClass : public MyClass { public: MOCK_METHOD(void, DoSomething, (), (override)); }; TEST(MockTest, DoSomethingTest) { MockMyClass mock; EXPECT_CALL(mock, DoSomething()).Times(1); // 期望DoSomething()被调用一次 mock.DoSomething(); // 调用 }
-
5. 验证期望:gmock会根据
EXPECT_CALL
的期望来验证实际行为。如果期望的行为未被触发或被触发的次数不正确,gmock会报告错误。 -
6. 匹配器(Matchers):gmock提供了强大的匹配器,能够对函数参数进行更灵活的验证。例如:
testing::Eq(val)
:匹配相等的值。testing::Gt(val)
:匹配大于val
的值。testing::Lt(val)
:匹配小于val
的值。
进阶使用:
- 动作链式调用:通过
WillOnce
和WillRepeatedly
可以设置多个返回值。 - Mock方法的调用顺序:可以通过
InSequence
来检查多个期望的调用顺序。
TEST(MockTest, CallOrderTest) {
MockMyClass mock;
{
testing::InSequence seq; // 保证调用顺序
EXPECT_CALL(mock, Multiply(2, 3)).WillOnce(testing::Return(6));
EXPECT_CALL(mock, Multiply(4, 5)).WillOnce(testing::Return(20));
}
mock.Multiply(2, 3);
mock.Multiply(4, 5);
}