c++单元测试之gtest测试框架快速上手

单元测试

---

模块级测试，与系统测试、集成测试等不同，它是对软件模块细分后的单元进行的细粒度测试，应该在开发过程中进行。

单元测试（ Unit Test ，模块测试）是开发者编写的一小段代码，用于检验被测代码的一个很小的、很明确的功能是否正确，通过编写单元测试可以在编码阶段发现程序编码错误，甚至是程序设计错误。

单元测试有很多好处：

• 增加开发人员的信心
• 修改代码后进行快速的回归测试
• 提高开发质量
• 加快迭代进度

单元测试不必从头开始，目前已经有很多优秀的测试框架可供选择。本文主要介绍google的gtest框架，其github地址：https://github.com/google/googletest

gtest安装

---

从github的release中下载发布版本，目前最新版本为v1.10.0。以在windows下安装为例，Linux下类似。

解压后进入目录，新建 build 目录，在build目录中打开终端执行：cmake ..。

完成后，会在当前目录生成 gtest.sln 文件，使用vs2015打开，选择好平台，编译gtest，默认编译静态库。

关于 gtest 和 gtest_main 的区别：

• gtest 就是gtest库
• gtest_main仅比gtest多了main函数，使用gtest库
• 使用 gtest_main 时不必自己写main函数了，后续会说到

使用

---

gtest提供了很多测试用的宏，使用很方便，我们暂且不列出，先直接看示例。

打开vs2015新建空项目，本示例分别演示对函数和类进行单元测试。

配置gtest的头文件和库文件，略。

新建文件，用于测试函数，如 demo1.cpp:

// demo1.cpp，用于测试单个函数
#include <iostream>
#include <gtest/gtest.h>

using namespace std;

// 待测试函数
int Foo(int a, int b)
{
	if (a == 0 || b == 0)
	{
		throw "don't do that";
	}
	int c = a % b;
	if (c == 0)
		return b;
	return Foo(b, c);
}

// 测试代码，使用gtest提供的宏TEST
TEST(FooTest, HandleZeroInputAndException)
{
	EXPECT_EQ(2, Foo(4, 10)); // 可通过 ASSERT_* 和 EXPECT_* 断言来对程序运行结果进行检查
	EXPECT_EQ(6, Foo(30, 18));
	EXPECT_ANY_THROW(Foo(10, 0)) << "params: " << 10 << ", " << 0;
	EXPECT_THROW(Foo(0, 5), char*);
}

这就完成了测试函数的流程，增加main函数即可测试。对于具体的函数，需要写多个测试用例。

测试类的代码(包含2个cpp和1个h)如下：

// Configure.h

#pragma once

#include <string> 
#include <vector> 

class Configure
{
private:
	std::vector<std::string> vItems;

public:
	int addItem(std::string str);
	std::string getItem(int index);
	int getSize();
};

// Configure.cpp
#include "Configure.h" 
#include <algorithm> 

/**
* @brief Add an item to configuration store. Duplicate item will be ignored
* @param str item to be stored
* @return the index of added configuration item
*/
int Configure::addItem(std::string str)
{
	std::vector<std::string>::const_iterator vi = std::find(vItems.begin(), vItems.end(), str);
	if (vi != vItems.end())
		return vi - vItems.begin();

	vItems.push_back(str);
	return vItems.size() - 1;
}

/**
* @brief Return the configure item at specified index.
* If the index is out of range, "" will be returned
* @param index the index of item
* @return the item at specified index
*/
std::string Configure::getItem(int index)
{
	if (index >= vItems.size())
		return "";
	else
		return vItems.at(index);
}

/// Retrieve the information about how many configuration items we have had 
int Configure::getSize()
{
	return vItems.size();
}

// ConfigureTest.cpp
#include <gtest/gtest.h> 
#include "Configure.h" 

// 测试函数
TEST(ConfigureTest, addItem)
{
	// do some initialization 
	Configure* pc = new Configure();

	// validate the pointer is not null 
	ASSERT_TRUE(pc != NULL);

	// call the method we want to test 
	pc->addItem("A");
	pc->addItem("B");
	pc->addItem("A");

	// validate the result after operation 
	EXPECT_EQ(pc->getSize(), 2);
	EXPECT_STREQ(pc->getItem(0).c_str(), "A");
	EXPECT_STREQ(pc->getItem(1).c_str(), "B");
	EXPECT_STREQ(pc->getItem(10).c_str(), "");

	delete pc;
}

// 程序入口
int main(int argc, char* argv[])
{
	testing::InitGoogleTest(&argc, argv);
	RUN_ALL_TESTS();
	std::cin.get();

	return 0;
}

代码最后的main就是gtest_main库中已经内置的main

RUN_ALL_TESTS()会运行项目中所有的测试用例，包括为函数定义的TEST和为类定义的TEST（来自不同的文件）。该函数成功返回0，失败返回1。

从示例可以看出gtest的大致使用方法：

• 为每个待测试类分别创建测试文件，并在该文件实现单元测试代码
• 创建包含main函数的文件，从此处运行所有的单元测试
• 编译链接运行即可

在具体编写测试代码时：

• TEST函数的第一个参数为测试套件名称，第二个参数为测试套件内的测试用例名称，都是用户自定义
• gtest会依据测试套件名称对测试结果分组，所以如果是关联的测试，应该把它们的第一个参数设置为相同。
• 不同的测试套件可以有相同的测试用例名称

上述测试代码中共两个测试套件，每个测试套件中有一个测试用例。

以上测试的运行结果如下：

gtest提供的便利

---

首选是断言测试宏。

1. 基本断言

注意：

• EXPECT_* 版本的断言失败时产生非致命失败，不会中止当前函数
• ASSERT_* 版本的断言失败时会产生致命失败，并结束当前函数
• EXPECT_* 则用于即使失败也不会影响后续测试逻辑的处理结果的断言，如某个方法返回结果的多个属性的检查
• ASSERT_* 常常被用于后续测试逻辑强制依赖的处理结果的断言，如创建对象后检查指针是否为空，若为空，则后续对象方法调用会失败

2. 二进制比较

3. 字符串比较

其次是通过命令行参数筛选要执行的测试用例。

在执行程序时，可以指定命令行参数：

• ./foo_test 没有指定filter，运行所有测试
• ./foo_test --gtest_filter=* 指定filter为*，运行所有测试
• ./foo_test --gtest_filter=FooTest.* 运行测试用例FooTest的所有测试
• ./foo_test --gtest_filter=Null:Constructor 运行所有全名（即测试用例名 + “ . ” + 测试名，如 GlobalConfigurationTest.noConfigureFileTest）含有"Null"或"Constructor"的测试
• ./foo_test --gtest_filter=FooTest.*-FooTest.Bar 运行测试用例FooTest的所有测试，但不包括FooTest.Bar

这一特性在包含大量测试用例的项目中会十分有用。

对于高阶用法，请参考相关文档。

参考资料

---

googletest
Googletest Primer
googletest make options
轻松编写 C++ 单元测试