Qt代码单元测试以及报告生成

简介

单元测试是所有测试中最底层的一类测试，是第一个环节，也是最重要的一个环节，是唯一一次有保证能够代码覆盖率达到100%的测试，是整个软件测试过程的基础和前提，单元测试防止了开发的后期因bug过多而失控，单元测试的性价比是最好的。
覆盖率（code coverage rate）是反映测试用例对被测软件覆盖程度的重要指标，也是衡量测试工作进展情况的重要指标。在代码逻辑比较复杂的情况下，测试工作往往只能覆盖到显而易见的逻辑分支，而更多的深层次的逻辑分支则不容易被测试人员发现。为了保证测试的覆盖率，有些开发人员会尝试协助测试人员写出所有的测试用例，这不仅会牺牲大量的宝贵的开发时间，同时也拥有一定的难度，最重要原因就是因为测试难以量化。而代码覆盖工具就是用来量化代码测试的覆盖率，让测试人员可以直观的发现那些没有覆盖到的代码分支。

先介绍Qt代码做单元测试和生成报告的途径有哪些，后面会详细介绍具体怎么操作

一、单元测试以及生成报告途径

1、单元测试的主要途径：

• 使用Visual Studio下的OpenCppCoverage工具
• 在Qt下直接使用gtest和qtest配合一起做

2、生成报告的途径，主要有：OpenCppCoverage、gcovr、lcov。

推荐使用：在 Linux下通过Qt使用gtest和qtest，然后通过lcov导出生成报告。 下面介绍原因。

二、详细介绍

1、VS中使用OpenCppCoverage测试以及生成报告方式（生成报告速度较慢）

对于界面来说，需要点击才能产生覆盖率，这个不是特别友好

2、在Linux环境下通过Qt使用gtest和qtest测试，然后通过lcov导出生成报告

1. 环境的准备
   > 其中gtest需要下载，下载后修改成子工程模式加到工程中就可以了，gtest下载地址： https://github.com/google/googletest
   可以修改Pro文件为子工程文件，具体忘记修改了哪些内容，自己研究一下吧。抱歉╮(╯▽╰)╭
   > lcov在Linux下通过apt-get命令下载安装就可以
2. pro文件的修改

include(../test/test.pri)   							    # 测试子工程
include(../gtest/googletest/gtest_dependency.pri)			# gtest 子工程

QMAKE_LFLAGS +=-fprofile-arcs -ftest-coverage
QMAKE_CXXFLAGS += --coverage								# 申明为要做单元测试
LIBS += -lgcov								                # 引入库文件

3. main中的修改

// 依赖的头文件
#include <gtest/gtest.h>
#include <gmock/gmock.h>

::testing::InitGoogleTest(&argc, argv); 		// 在mian函数中 初始化测试环境

return RUN_ALL_TESTS();						// 运行所有测试单元

4. 单元测试的编写，以一个测试用例为例（具体可以网上查询）

TEST(test_case_name, test_name)
{
    std::unique_ptr<***> p = std::make_unique<***>();
}

• test_case_name第一个参数是测试用例名,通常是取测试函数名或者测试类名
• test_name 第二个参数是测试名这个随便取，但最好取有意义的名称
• 当测试完成后显示的测试结果将以"测试用例名.测试名"的形式给出
• 私有函数测试小技巧：可以通过友元类来完成测试

Qt下查看测试情况：

5. 生成测试报告(在有.gcno和.gcda文件的文件夹下通过终端执行以下命令:)

命令	意义
ENABLE BRANCH="–rc lcov branch coverage=1	打开分支覆盖率显示
lcov -d .-c -o r.info $(ENABLE BRANCH} 1>/dev/null	1>/dev/null也可以去掉，它的作用是不输出信息到终端
genhtml --branch-coverage -o result $ENABLE BRANCHI rinfo	生成全部覆盖率信息 r.info 总的覆盖率信息，并生成到result 文件夹中
lcov --extract rinfo '* /path/*i -o resultinfo	抽取想要的覆盖率信息，eg：抽取path下的覆盖率信息 ，具体可以通过result文件夹下indes.html 中查看要抽取部分，可以多个
genhtml result.info -o output/	重新生成报告，并导出到 output文件夹中

6. 最终报告
   

3、在Windows环境下通过Qt使用gtest和qtest测试，然后通过gcovr导出生成报告

除了导出报告方法和Linux不一样外，其他步骤和Linux一样
生成报告命令**(coverage.html报告名，可修改)**：

gcovr -r . --html --html-details -o coverage.html

但是有个问题，只能生成ui_.h和moc_.cpp的报告，具体怎么生成源码测试报告的方案没研究明白
有研究明白的或者知道怎么生成的，希望留言指教，谢谢**