大家好，又见面了，我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

简介

gtest是一个跨平台的C++单元测试框架。它提供了丰富的断言、致命和非致命判断、参数化、死亡测试等等。

使用目的

• 测试代码逻辑是否正确。编译器只能检测出语法错误但是无法检测到 逻辑错误，比如一个函数或类是否完成了期望的功能。
• gtest可以帮助我们判断代码 设计得是否清晰合理。一块代码的逻辑越清晰，它的测试就可以设计得越简单。
• 方便并行开发。一个程序有不同模块相互耦合，某个模块未完成可能影响其他已完成模块的测试，这时可以利用gmock 隔离 这些模块，模拟未完成模块的功能，进而测试已完成模块的逻辑。
• 每完成一个模块就用gtest进行验证。这比完成了整个程序再查找bug轻松许多。

使用时机

• 使用gtest需要维护额外的测试代码，花费额外的时间，但是可以轻松验证各个模块的逻辑功能是否正确，保证程序整体的正确性。
• 使用手动测试比较快捷，但是测试不全面，而且有些跟其他模块相关的功能测试起来难度很大。
• 对于那些会长期维护的大项目像服务器，使用gtest验证逻辑是有必要的。
• 对于那些短期使用的，后期不会进行维护的，功能比较简单的程序，手动测试的效果会更好。

使用方法

使用流程

1. 包含必要的头文件：声明了待测试代码的头文件、“gtest/gtest.h”、“gmock/gmock.h”(使用模拟时会用到)。
2. 使用宏编写测试主体：在测试宏中调用断言宏完成单元测试，对于复杂的单元测试，可以使用测试夹具。
3. 调用 ::testing::InitGoogleTest(int* argc, char**argv) 用参数初始化测试，RUN_ALL_TESTS() 运行所有测试并输出结果到控制台或文件中(默认控制台)。

传入参数

1. 参数种类

2. 传入方式：
   • 通过cmd调用程序时传入。
   • 在代码中设置对应的值。
   • 利用系统环境变量(不常用)。
   • 在命令行中传入 –help 可以查看所有参数说明。

用法

最简单的单元测试

// sample1.h
#ifndef GOOGLETEST_SAMPLES_SAMPLE1_H_
#define GOOGLETEST_SAMPLES_SAMPLE1_H_
// 返回n的阶乘
static int Factorial(int n)
{ 
   
	int result = 1;
	for (int i = 1; i <= n; i++) 
	{ 
   
		result *= i;
	}
  return result;
}
#endif // GOOGLETEST_SAMPLES_SAMPLE1_H_

// sample1_unittest.cc
// Step.1 包含必要头文件
#include "sample1.h"
#include "gtest/gtest.h"
// Step.2 编写测试主体
TEST(FactorialTest, Negative) { 
   
  // This test is named "Negative", and belongs to the "FactorialTest"
  // test case.
  EXPECT_EQ(1, Factorial(-5));
  EXPECT_EQ(1, Factorial(-1));
  EXPECT_GT(Factorial(-10), 0);
}

// Tests factorial of 0.
TEST(FactorialTest, Zero) { 
   
  EXPECT_EQ(1, Factorial(0));
}

// Tests factorial of positive numbers.
TEST(FactorialTest, Positive) { 
   
  EXPECT_EQ(1, Factorial(1));
  EXPECT_EQ(2, Factorial(2));
  EXPECT_EQ(6, Factorial(3));
  EXPECT_EQ(40320, Factorial(8));
}

// main.cpp
// Step.3 初始化测试，执行所有测试
int main(int argc, char** argv)
{ 
   
    ::testing::InitGoogleTest(&argc, argv);
    return RUN_ALL_TESTS();
}

普通测试夹具

1. 属性：普通测试夹具是继承了 ::testing::Test 的类，可以保存对象和函数方法，让所有属于这个测试案例的测试都共享这些对象和函数方法。但是只是共享这些测试的代码而已，一个测试对数据的改动不会传递给下一个测试，因为一个测试的结果不应该影响到下一个测试，如果需要，那这两个测试应该合并为一个。
2. 用法：继承 ::testing::Test ，测试宏应使用 TEST_F ，测试案例名必须与夹具名相同，测试才能使用夹具中的对象和方法，夹具类可以重载 SetUp 和 TearDown 两个函数，这两个函数在每个测试开始前和结束后都会调用一次，用于初始化和释放资源。
3. 注意：夹具可以多重继承，使得夹具可以拥有多种属性。
4. 样例代码

// func.h
class TestClass
{ 
   
public:
	TestClass() { 
   }
	~TestClass() { 
   }
	// 偶数返回真，奇数返回假
	bool Check()
	{ 
   
		return num % 2 == 0 ? true : false;
	}
	int num;
};

// UniteTest.cpp
#include "func.h"
#include <gtest/gtest.h>
class TestFixture : public ::testing::Test
{ 
   
public:
    TestFixture() { 
   }
    virtual ~TestFixture() { 
   }

protected:
    // 测试案例中的每个测试开始前都会调用
    virtual void SetUp() override { 
    testClass = new TestClass; }
    // 测试案例中的每个测试结束后都会调用
    virtual void TearDown() override { 
    delete testClass; }
    TestClass* testClass;
};

TEST_F(TestFixture, odd)
{ 
   
	testClass->num = 3;
	EXPECT_FALSE(testClass->Check());
}
TEST_F(TestFixture, even)
{ 
   
	testClass->num = 4;
	EXPECT_TRUE(testClass->Check());
}

模板测试夹具

1. 属性：模板测试夹具是一个继承了 ::testing::Test 的模板类，这种测试夹具可以用于测试同一个接口类(父类)的多种实现。
2. 用法:
   • 创建继承 ::testing::Test 的模板类，模板的类型是接口类的实现类型(子类)，因此夹具中要保存接口类的对象指针(可以指向所有子类对象)，然后根据不同情况选择下面两步。
   • 如果已知参数类型，那么在编写测试主体前先使用 TYPED_TEST_SUITE(TestCaseName, TypeList) 传入所有类型， 再使用 TYPED_TEST(TestCaseName, TestName) 编写测试主体。
   • 如果参数类型未知(假设你是接口的设计者，在编写单元测试时并不知道接口会被如何实现)，那么先使用 TYPED_TEST_SUITE_P(TestCaseName) 声明测试夹具，再使用 TYPED_TEST_P(TestCaseName, TestName) 编写测试主体，最后使用 REGISTER_TYPED_TEST_SUITE_P(TestCaseName, TestList) 枚举出测试的名字，此时单元测试已经开发完成，但是不会运行任何测试，等到确定了待测试的类型后，使用 INSTANTIATE_TYPED_TEST_SUITE_P(Instancename, TestCaseName, Typelist) 即可运行所有类型的测试。
3. 样例代码：

// interface.h
// 待测试接口类
class CTest
{ 
   
public:
	virtual bool TestFunc() = 0;
};

class CA : public CTest
{ 
   
	virtual bool TestFunc() override { 
    //... }
};
class CB : public CTest
{ 
   
	virtual bool TestFunc() override { 
    //... }
} ;

// UnitTest.h
#include "interface.h"
#include "gtest/gtest.h"
// 工厂函数
template<class T>
CTest* CreateFunc() { 
    return new T(); }
template<class T>
class TestFixture : public ::testing::Test
{ 
   
protected:
	TestFixture() { 
    pTest = CreateFunc<T>(); }
	virtual ~TestFixture () { 
    delete pTest; }
	// 基类指针
	CTest* pTest;
};

//==========测试类型已知==========
// 声明要测试的类型
TYPED_TEST_SUITE(TestFixture, ::testing::Types<CA, CB>);
// 测试主体
TYPED_TEST(TestFixture, A)
{ 
   
// ...
}

//==========测试类型未知==========
// 声明测试夹具
TYPED_TEST_SUITE_P(TestFixture);
// 测试主体
TYPED_TEST_P(TestFixture, A)
{ 
   
// ...
}
TYPED_TEST_P(TestFixture, B)
{ 
   
// ...
}
// 枚举所有测试
REGISTER_TYPED_TEST_SUITE_P(TestFixture, A, B);
// 声明所有测试类型
INSTANTIATE_TYPED_TEST_SUITE_P(TestInstance, TestFixture, ::testing::Types<CA, CB>);

参数测试夹具

1. 属性：参数测试夹具继承了 ::testing::TestWithParam<T> ，T是参数类型，要在声明时指定，可以在类中调用 GetParam() 获取传入的参数，从而设置内部对象或函数的属性。
2. 用法：参数测试夹具的用法与测试类型未知的模板测试夹具类似。
   • 创建继承 ::testing::TestWithParam<T> 的测试夹具类，在类中可以调用 GetParam() 获取参数，设置内部对象或函数的属性，然后使用 TEST_P(TestCaseName, TestName) 编写测试主体，最后使用 INSTANTIATE_TEST_SUITE_P(Instancename, TestCaseName, Typelist) 注册所有参数。
3. 样例代码：

#include "interface.h"
#include "gtest/gtest.h"
// 函数指针
typedef CTest* CreateCTestPtr();
// 工厂函数
CTest* CreateA() { 
    return new CA(); }
CTest* CreateB() { 
    return new CB(); ]
// 参数测试夹具，参数类型是函数指针
class TestFixture : public ::testing::TestWithParam<CreateCTestPtr*>
{ 
   
public:
	virtual ~TestFixture() { 
    delete pTest; }
	virtual void SetUp() override { 
    pTest = (*GetParam())(); }
	virtual void TearDown() override 
	{ 
    
		delete pTest;
		pTest = nullptr;
	}
protected:
	CTest* pTest;
};
// 测试主体
TEST_P(TestFixture, A)
{ 
   
// ...
}
// 注册参数，参数是构造不同类型实例的函数
INSTANTIATE_TEST_SUITE_P(TestInstance, TestFixture, ::testing::Values(&CreateA, &CreateB));

4. 补充：
   如果参数类型可以由多个变量组合而成如 std::tuple<bool, int> ，如果想覆盖所有测试路径，使用传统的注册参数方法势必会很麻烦，可以使用 ::testing::Combine 函数，该函数会自动组合出参数中所有组合情况，以 std::tuple<bool, int> 为例，代码修改为如下形式：

class TestFixture : public ::testing::TestWithParam<std::tuple<bool, int>> // ... INSTANTIATE_TEST_SUITE_P(TestInstance, TestFixture, ::testing::Combine(::testing::Bool(), ::testing::Values(1, 10)));

::testing::Bool() 会生成 true 和 false两种值，::testing::Combine 把 {true，false} 和 {1， 10} 这两个集合的值组合起来，相当于

::testing::Values(
	std::tuple<bool, int>(true, 1), 
	std::tuple<bool, int>(false, 1), 
	std::tuple<bool, int>(true, 10),
	std::tuple<bool, int>(false, 10)
)

宏定义总结

测试宏

1. TEST(TestCaseName, TestName), TestCaseName表示测试案例名， TestName表示测试名，逻辑上相关的测试应该属于相同的测试案例，测试一个函数时，测试案例名可以是函数名，测试名可以是不同输入情况的名字；测试一个类时案例名可以是类名，测试名可以是不同函数的名字。这些名字必须是c++风格的合法字符串，不能带有下划线_。
2. TEST_F(TestCaseName, TestName)，与测试夹具配套使用，测试案例名必须是测试夹具的名字。
3. TYPED_TEST(TestCaseName, TestName)，与已知类型的模板测试夹具配套使用，在测试体中可以使用TypeParam指代模板参数类型，使用TestFixture指代夹具类类型。
4. TYPED_TEST_P(TestCaseName, TestName)，与未知类型的模板测试夹具配套使用，在测试体中可以使用TypeParam指代模板参数类型，使用TestFixture指代夹具类类型。
5. TEST_P(TestCaseName, TestName)，与参数夹具配套使用。

声明宏

1. TYPED_TEST_SUITE(TestCaseName, TypeList)， 声明模板测试夹具要测试的类型，TestCaseName是模板测试夹具的名字，TypeList代表待测试的类型，用 ::testing::Types<类型1, 类型2, ...> 定义，在已知全部需要测试的类型时使用。
2. TYPED_TEST_SUITE_P(TestCaseName)， TestCaseName是模板测试夹具名，在不知道要测试的类型时使用。
3. REGISTER_TYPED_TEST_SUITE_P(TestCaseName, TestName1, TestName2, ...)，TestCaseName是模板测试夹具名，TestName是测试的名字，把所有测试的名字枚举出来。
4. INSTANTIATE_TYPED_TEST_SUITE_P(Instancename, TestCaseName, Typelist)，Instancename是测试实例名，TestCaseName是测试夹具名，Typelist代表待测试类型列表，用::testing::Types<类型1, 类型2, ...> 定义。
5. INSTANTIATE_TEST_SUITE_P(Instancename, TestCaseName, Typelist), Instancename是测试实例名，TestCaseName是测试夹具名，Typelist代表参数列表，用::testing::Values(参数1, 参数2, ...)定义。

断言宏

• 区别：中断断言在失败后会立刻退出测试，不会执行后续代码，期望断言失败后会继续运行后续代码。
• 用法：一个测试中可以包含多个断言宏，所有断言均通过则测试通过。

gmock

1. 使用场景：当待测模块耦合了一个尚未完成或者运行环境非常复杂无法搭建的模块时，强行等待这个模块完成或者搭建环境都会耗费大量的时间，这时我们可以利用gmock模拟这个模块，将它的实际代码从我们要测试的模块从中隔离出来。
2. 用法：gmock的用法与类的继承差不多，直接看代码吧。

class Tmp
{ 
   
public:
	virtual bool FuncA(int, int) = 0;
	virtual bool FuncB(int) = 0;
};
// 待测试模块
class TestClass
{ 
   
public:
	bool TestFunc(Tmp* pTmp)
	{ 
   
		// ...
		if( pTmp->FuncA(1, 2) )
		{ 
   
			// ...
			return pTmp->FuncB(3);
		}
		// ...
		return false;
	}
};
// 模拟
class MockTmp : public Tmp
{ 
   
public:
	MOCK_METHOD2(FuncA, bool(int, int));
	MOCK_METHOD1(FuncB, bool(int));
};

TEST(MockCase, MockTest)
{ 
   
	MockTmp mock;
	EXPECT_CALL(mock, FuncA(::testing::Ne(0), ::testing::_))
	.With(::testing::Lt())
	.With(::testing::AllArgs(::testing::Lt()))
	.With(::testing::Args<0, 1>(::testing::Lt()))
	.Times(1)
	.WillOnce(::testing::Return(true));
	
	EXPECT_CALL(mock, FuncB(::testing::_))
	.WillOnce(::testing::Return(true));
	
	TestClass test;
	Tmp* pTmp = (Tmp*)&mock;
	EXPECT_TRUE(test.TestFunc(pTmp));
}

3. MOCK_METHOD*(函数名，A(B, C, …))
   *代表函数的参数个数，A表示函数返回值类型，B，C，…，代表函数的各个参数
4. EXPECT_CALL
   原型：
   EXPECT_CALL(mock_object, method(matcher1, matcher2, ...))
.With(multi_argument_matcher)
.Times(cardinality)
.InSequence(sequences)
.After(expectations)
.WillOnce(action)
.WillRepeatedly(action)
.RetiresOnSaturation();

• EXPECT_CALL内的参数意义

  • mock_object表示Mock类的对象(mock)
  • method表示Mock的方法(Func)
  • matcher是匹配器，可以用于定义函数方法参数的值，也可以判断输入的参数是否符合匹配器，匹配器给出的功能与断言类似，名称也很像，下面只列出其中一部分，可以参考gtest和gmock的文档。

  匹配器	说明
  ::testing::_	不在乎输入参数是什么
  ::testing::Ne(val)	参数不等于val
  ::testing::Eq(val)	参数要与val相等
  ::testing::Lt(val)	参数要小于val
  ::testing::Le(val)	参数小于等于val
  ::testing::Gt(val)	参数大于val
  ::testing::Ge(val)	参数大于等于val
  …	…

• 设置EXPECT_CALL的属性

  • .With(multi_argument_matcher)
    这个函数可以设置参数之间的大小关系，相等、从大到小或从小到大等。当对全部参数设置大小关系时（比如所有参数递增），可以使用下面两种等效方法：.With(::testing::AllArgs(::testing::Lt()))、.With(::testing::Lt())，可以注意到 ::testing::Lt() 其实就是上面的匹配器，使用在.With中时，不需要填参数。如果想指定所有参数中的某些参数的关系可以使用 ::testing::Args<k1, k2, ..., kn> 替换 ::testing::AllArgs ，来指定n个参数的关系。

  • .Times(cardinality)
    这个函数可以设置被模拟的函数将被调用多少次。参数 cardinality 可以使用如下几个函数设置：

    函数方法	说明
    AnyNumber()	这个函数可以被调用任意次
    AtLeast(n)	这个函数最少被调用n次
    AtMost(n)	这个函数最多被调用n次
    Between(m, n)	这个函数被调用m到n次之间(包括m和n)
    Exactly(n) or n	这个函数只能被调用n次

    如果.Times缺省，gtest遵循下列原则：

    • 如果既没有设置 .WillOnce 也没有 .WillRepeatedly， 则视为调用了 .Times(1)；
    • 如果调用了 n 次 WillOnce (n >= 1) 且没有调用 .WillRepeatedly，则视为调用了.Times(n)；
    • 如果调用了 n 次WillOnce (n >= 0) 且调用了一次 .WillRepeatedly，则视为调用了Times(AtLeast(n))。

  • .InSequence(sequences)
    这个函数用来设置多个EXPECT_CALL的运行顺序。参数 sequences 可以任意多个 Sequence 类型的变量。如果想设置所有调用的顺序，可以直接在所有EXPECT_CALL之前声明一个 InSequence 类型的变量， 这样无需调用 .InSequence ，后面所有的函数都将按照 EXPECT_CALL 调用的顺序执行。但是如果我们只希望部分函数按照顺序执行而不关心其他部分的顺序呢，可以定义多个 Sequence 类型对象，所有调用 .InSequence 的 EXPECT_CALL 都将按照声明的顺序调用，上代码。

    // 设置全部顺序
    using ::testing::_;
    using ::testing::InSequence;
    { 
           
        InSequence s;
        EXPECT_CALL(foo, DoThis(5));
        EXPECT_CALL(bar, DoThat(_))
            .Times(2);
        EXPECT_CALL(foo, DoThis(6));
    }
    

    调用顺序：foo.DoThis(5) -> bar.DoThat(_) -> bar.DoThat(_) -> foo.DoThis(6)
    

    // 设置部分顺序
    using ::testing::Sequence;
    ...
      Sequence s1, s2;
    
      EXPECT_CALL(foo, A())
          .InSequence(s1, s2);
      EXPECT_CALL(bar, B())
          .InSequence(s1);
      EXPECT_CALL(bar, C())
          .InSequence(s2);
      EXPECT_CALL(foo, D())
          .InSequence(s2);
    

    调用顺序：
           +---> B
           |
      A ---|
           |
           +---> C ---> D
    

    • .After(expectations)
      这个函数用来指定一个函数在某个或多个函数之后调用。参数 expectations 可以是最多五个 Expectation 类型变量( EXPECT_CALL 的返回值)，也可以是 ExpectationSet 类型变量( Expectation 的集合)。

    using ::testing::Expectation;
    ...
    Expectation init_x = EXPECT_CALL(my_mock, InitX());
    Expectation init_y = EXPECT_CALL(my_mock, InitY());
    EXPECT_CALL(my_mock, Describe())
        .After(init_x, init_y);
    

    my_mock.Describe() 在 my_mock.InitX() 和 my_mock.InitY() 都调用而完成后再调用。
    

    using ::testing::ExpectationSet;
    ...
    ExpectationSet all_inits;
    // Collect all expectations of InitElement() calls
    for (int i = 0; i < element_count; i++) { 
           
      all_inits += EXPECT_CALL(my_mock, InitElement(i));
    }
    EXPECT_CALL(my_mock, Describe())
        .After(all_inits);  // Expect Describe() call after all InitElement() calls
    

    my_mock.Describe() 在最后调用，这种使用方法在需要指定大量重复函数时很有用。
    

    • .WillOnce(action)
      这个函数设置被调用一次时的动作，只进行一次，不能重复。参数 action 表示动作。下面列举一些常用的动作，详细信息可以查阅文档 googletest/doc/reference/actions.md 。与.Times(n)一起使用时，调用.WillOnce(action)的次数应该与n相等，如果不等应该在后面调用.WillRepeatedly(action)，否则测试会失败。

    Action	说明
    ::testing::Return()	返回空
    ::testing::Return(value)	返回value
    ::testing::Invoke(f)	f是一个函数，返回类型和参数类型与被模拟函数相同，可以是全局静态函数或累的成员
    …	…

    • .WillRepeatedly(action)
      这个函数可以认为是.WillOnce(action)的可重复版本。重复次数与Times(n)和实际调用次数有关。
    • .RetiresOnSaturation()
      这个函数的意义是：当被模拟的函数的调用次数达到指定上限时，这个预期的模拟将不再处于活跃状态。在下面的示例中，m_mock.SetNumber(7) 前两次的调用满足预期2，此时预期2将不再处于活跃状态，从第三次开始只会满足预期1。

    using ::testing::_;
    using ::testing::AnyNumber;
    ...
    EXPECT_CALL(my_mock, SetNumber(_))  // Expectation 1
      .Times(AnyNumber());
    EXPECT_CALL(my_mock, SetNumber(7))  // Expectation 2
      .Times(2)
      .RetiresOnSaturation();
    

使用心得

• 如果一个模块(函数)的输入、输出以及功能都很清晰，那么这个模块的测试流程会比较简单，相反如果一个模块实现了多个功能，编写测试时就要考虑多种功能之间的影响和组合，比如前一个功能的运行结果是否会影响下一个功能，这时测试会变得很复杂，所以尽量保证我们的代码 每个模块只完成一个功能，便于测试也便于维护。
• 一个好的测试应该是可重用的，这样不管是初期开发还是后期维护都能享受到测试带来的好处，因此在设计程序的时候尽量让业务模块(以后有可能会有变动的模块) 接口化，这样即便未来业务模块真的有变动，我们也能把修改代码的代价降到最小(上层可能只需要修改接口的实现或替换调用的接口就可以了)。