linux下使用gtest框架进行c/c++单元测试

港控/mmm° 2022-06-11 04:45 282阅读 0赞

原文地址[linux下使用gtest框架进行c/c++单元测试][linux_gtest_c_c]

## 前言 ##

google test（以下简称gtest）是谷歌的开源C++单元测试框架，用来做c/c++的单元测试比较方便。下面对于它在linux下的使用做简单的介绍，同时也作为自己的笔记。因为仅作示例，因此以下过程也比较简单。

## 准备gtest框架 ##

在github网站下载gtest框架https://github.com/google/googletest

解压后，进入googltetest目录。目录下有以下内容  
├── build-aux  
├── CHANGES  
├── cmake  
├── CMakeLists.txt  
├── codegear  
├── [configure.ac][]  
├── CONTRIBUTORS  
├── docs  
├── include  
├── LICENSE  
├── m4  
├── make  
├── [Makefile.am][]  
├── msvc  
├── [README.md][]  
├── samples  
├── scripts  
├── src  
├── test  
└── xcode

现在我们需要将其编译成.o文件  
编译生成gtest.o文件：

g++ -o gtest.o -I./include -I./  -c ./src/gtest-all.cc

再生成.a静态库文件：

ar -rv libgtest.a gtest.o

生成的libgtest.a以及该目录include下的头文件都是我们后面测试需要的。

## 新建测试项目 ##

新建项目目录，比如我创建了一个LeetcodeWithC目录。  
同时，在该目录下创建以下三个目录  
├── gtest //存放gtest框架内容  
├── leetcode //存放项目源代码  
├── testcase //存放测试用例代码  
└── Makefile

getest目录下有刚才所说的include头文件，lib文件。另外，我们还需要一个main函数文件。放在getst的main下

/*TestAll.cpp*/
    	#include "gtest/gtest.h"
    	#include <iostream>
    	using namespace std;
    	int main(int argc,char* argv[])
    	{
         
    		        //testing::GTEST_FLAG(output) = "xml:"; //若要生成xml结果文件
    		        testing::InitGoogleTest(&argc,argv); //初始化
    		       if( RUN_ALL_TESTS())                     //跑单元测试
    		        return 0;
    	}

leetcode目录下新建src目录和include目录，分别用于存放头文件和.c文件  
我在include下放了两个头文件,common.h 和leetcode\_functions.h  
内容分别如下：  
common.h

#pragma once
    	#include<stdio.h>
    	#include<string.h>
    	#include<stdlib.h>

leetcode\_functions.h

#pragma once
    	//leetcode_functions.h
    	#ifndef _LEETCODE_FUNCTIONS_H
    	#define _LEETCODE_FUNCTIONS_H
    	#include"common.h"
    	int* twoSum(int* nums, int numsSize, int target);
    	#endif

src目录下为项目的.c文件

/**
    	Given an array of integers, return indices of the two numbers such that they add up to a specific target.
    
    	You may assume that each input would have exactly one solution, and you may not use the same element twice.
    	
    	Example:
    	Given nums = [2, 7, 11, 15], target = 9,
    	
    	Because nums[0] + nums[1] = 2 + 7 = 9,
    	return [0, 1].
    	  Note: The returned array must be malloced, assume caller calls free().
    	 *
    	 */
    	#include"leetcode_functions.h"
    	int* twoSum(int* nums, int numsSize, int target) {
        
    	    int loop = 0;
    	    int inloop = 0;
    	    int* result = NULL;
    	    result =(int*) malloc(2*sizeof(int));
    	    memset(result,0,2*sizeof(int));
    	     printf("numsSize=%d\n",numsSize);
    	    if(NULL == nums || numsSize==0)
    	    {
        
    	        return result;
    	    }
    	    for(loop = 0;loop < numsSize;loop++)
    	    {
        
    	        for(inloop = loop+1;inloop < numsSize;inloop++)
    	        {
        
    	            if(*(nums+loop)+*(nums+inloop) == target)
    	            {
        
    	                if(NULL != result)
    	                {
        
    	                    
    	                    *result = loop;
    	                    *(result+1) = inloop;
    	                }
    	                return result;
    	            }
    	        }
    	    }
    	    return result;
    	}

testcase下新建include和src目录  
src目录下有测试用例文件leetcode\_test.cpp

//leetcode_test.cpp
    	#include "gtest/gtest.h"
    	#include "leetcode_functions.h"
    	
    	TEST(two_sum_test,twoSum001)
    	{
        
    	    int nums[4]={
        2,7,11,15};
    	    int target = 9;
    	    int numsSize = 4;
    	    int* result = twoSum(nums,numsSize,target);
    	
    	       ASSERT_EQ(0,*result);
    	       ASSERT_EQ(1,*(result+1));
    	}

## 编译链接 ##

测试之前，需要编译并链接我们得项目代码和测试框架。  
编译

g++ -o 001_two_sum.o -c ./leetcode/src/001_Two_Sum.c  -I ./leetcode/include/
    
    	g++ -o leetcode_test.o -c ./testcase/src/leetcode_test.cpp -I ./ -I ./leetcode/include/
    	
    	g++ -o TestAll.o -c ./gtest/main/TestAll.cpp -I ./

链接

g++ -o main *.o -I./include -L./gtest/lib -lgtest -lpthread

最后生成main文件。

## 运行测试 ##

运行生成的可执行文件main

./main

运行结果如下：

\[==========\] Running 1 test from 1 test case.  
\[----------\] Global test environment set-up.  
\[----------\] 1 test from two\_sum\_test  
\[ RUN \] two\_sum\_test.twoSum001  
numsSize=4  
\[ OK \] two\_sum\_test.twoSum001 (0 ms)  
\[----------\] 1 test from two\_sum\_test (0 ms total)

\[----------\] Global test environment tear-down  
\[==========\] 1 test from 1 test case ran. (0 ms total)  
\[ PASSED \] 1 test.

可以看到，共有一个用例，通过了一个用例

项目代码可以在https://github.com/yanbinghu/LeetCodeWithC下载，由于更新，可能与文章中的项目内容已经不一致了。

## 总结 ##

使用gtest框架进行单元测试还是比较方便的，有很多可用的测试方法，具体可以查看官网文档，另外它还有打桩功能，对于其他一些复杂的测试也是可以胜任的。

如果觉得测试结果不直观，还可以结合gcov进行代码覆盖率的测试，从测试报告中可以很清晰的看到用例跑到了哪些代码。

最后，欢迎交流讨论\_

本文作者： 守望  
本文链接： [https://www.yanbinghu.com/2017/07/27/51530.html][https_www.yanbinghu.com_2017_07_27_51530.html]  
版权声明： 本博客所有文章除特别声明外，均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处！

微信公众号：编程珠玑  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h5YjYxMg_size_16_color_FFFFFF_t_70]

[linux_gtest_c_c]: http://www.yanbinghu.com/2017/08/06/13315.html#more
[configure.ac]: http://configure.ac
[Makefile.am]: http://Makefile.am
[README.md]: http://README.md
[https_www.yanbinghu.com_2017_07_27_51530.html]: https://www.yanbinghu.com/2017/07/27/51530.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h5YjYxMg_size_16_color_FFFFFF_t_70]: /images/20220611/9ad84407285d408f910407e82d7dfbd7.png