gtest&gmock单元测试&lcov生成覆盖率

1.  目标

本文旨在对Linux下C++工程接入Google单元测试框架的过程进行说明。

通过本文可以方便接入gtest/gmock框架，编写简单的测试用例，并且通过lcov工具生成可视化的代码覆盖率。

2. 概述

gtest是一个跨平台的(Liunx、Mac OS X、Windows、Cygwin、Windows CE and Symbian)C++单元测试框架，由google公司发布。gtest是为在不同平台上为编写C++测试而生成的。它提供了丰富的断言、致命和非致命判断、参数化、”死亡测试”等等。

单元测试是开发者必备技能，在大公司甚至要求单测代码覆盖率。

3. 流程

Ø 安装GTest/GMock

Ø 使用GTest/GMock

Ø 生成代码覆盖率

4. 具体步骤

本地环境如下：

Ø 系统：CentOS7

Ø GCC版本：4.8.5

不同环境的执行步骤可能不完全一样。

4.1. 安装GTest

4.1.1. 下载gtest

git clone https://github.com/google/googletest

修改googletest中的CMakeLists.txt文件，新增一行：

add_definitions(-std=c++11)

4.1.2. 编译gtest

cd googletest/

mkdir mybuild

cmake ../

make

编译成功会在mybuild/lib下生成静态库：

libgmock_main.a、libgmock.a、libgtest_main.a、libgtest.a

4.1.3. 安装gtest/gmock

将静态库和头文件拷贝到系统路径下：

至此，gtest/gmock已经完成安装且可以使用了。

4.2. 使用gtest/gmock

进入项目工程目录，创建单元测试目录：

mkdir unittest

cd unittest/

4.2.1. 对本地工具类方法编写测试用例

本地工具类都是纯本地操作，不存在服务间交互，该场景最简单，非常容易对工具类中的方法进行测试。例如：

#include

using namespace std;

#include

// 该方法实际可能是属于正式工程中的方法，此处为方便演示

int Abs(int x)

{

     return x > 0 ? x : -x;

}

TEST(IsAbsTest,HandlerTrueReturn)

{

    ASSERT_TRUE(Abs(1) == 1) << "Abs(1)=1";  //ASSERT_TRUE期待结果是true,operator<<输出一些自定义的信息

    ASSERT_TRUE(Abs(-1) == 1) << "Abs(-1)=1";

    ASSERT_FALSE(Abs(-2) == -2);  //期待结果是false

    ASSERT_EQ(Abs(1),Abs(-1));

    ASSERT_NE(Abs(-1),0);

    ASSERT_LT(Abs(-1),2);

    ASSERT_GT(Abs(-1),0);

    ASSERT_LE(Abs(-1),2);

    ASSERT_GE(Abs(-1),0);

}

参考：https://blog.csdn.net/linhai1028/article/details/81675724

ASSERT_TRUE是gtest框架提供的宏，表示期望为真，如果都满足，则该case就测试通过，否则失败。

4.2.2. 对依赖网络的类方法编写测试用例

例如现在对CAAA类中的request方法进行单元测试，该方法会通过连接池对象到依赖服务做网络请求。从概念来说，单元测试不应该依赖其他服务，而是专注于测试自身业务的正确性，因此需要对连接池对象做Mock，此处就用到了gmock框架。该场景相对复杂，可能需要对现有代码进行调整，以方便进行单元测试。

如果希望比较方便的对类做mock，需要目标类中的方法是virtual类，mock的原理就是继承目标类，然后重写虚拟类型的方法，在单元测试中执行mock对象，而不是实际的对象，这样才能模拟依赖服务的返回，从而顺利进行单元测试。

当然，如果希望对非virtual类型的方法做mock，需要使用模板，导致代码更加复杂。

参考：

https://github.com/google/googletest/blob/master/googlemock/docs/for_dummies.md

4.2.3. 编译并执行测试程序

至此，已经可以编写并执行测试用例了。

4.3. 生成代码测试覆盖度

通过lcov工具生成代码覆盖度。

4.3.1. 安装lcov

git clone https://github.com/linux-test-project/lcov.git

cd lcov/

make install

4.3.2. 修改编译选项

在所有CMakeLists文件中（包括项目本身和单元测试）的编译选项中增加 -fprofile-arcs -ftest-coverage。如下：

4.3.3. 重新编译自身项目和单元测试项目

4.3.4. 执行测试程序

只有执行测试程序，才会生成对应的*.gcda文件，lcov就是根据gcda文件生成覆盖率的。

编写生成覆盖率脚本gen_code_coverage.sh并执行：

执行成功会在指定目录生成html文件

4.3.5. 查看代码覆盖情况

打开html文件即可查看代码覆盖情况。lcov会从行和函数角度显示代码覆盖情况。

至此，完成了整个单元测试和生成代码覆盖率过程。

5. 问题

安装lcov失败，参考：https://testerhome.com/topics/22108

6. 参考

https://github.com/google/googletest

https://github.com/google/googletest/blob/master/googletest/README.md

https://github.com/google/googletest/blob/master/googlemock/docs/for_dummies.md

https://github.com/linux-test-project/lcov