gtest的使用和简单例子

首先需要安装gtest的库，命令如下：

git clone https://github.com/google/googletest.git
cd googletest
mkdir build
cd build
cmake ..
sudo make install

后续就可以直接包含gtest头文件进行测试了。

这里给出一个测试的简单例子，这里使用了二分查找来充当例子

首先是创建c++项目，目录结构如下

mr4@DESKTOP-7BS4T8L:~/cpp$ tree -I out -I build
.
├── CMakeLists.txt
├── CMakePresets.json
├── bin
│   └── binary_search_test
├── doc
├── include
│   └── binary_search.h
├── lib
│   └── libbinary_search.a
├── src
│   └── binary_search
│       ├── CMakeLists.txt
│       └── binary_search.cc
└── tests
    ├── CMakeLists.txt
    └── binary_search_test.cc

8 directories, 9 files

顶层有一个CMakeLists.txt，bin是用来存储可执行的二进制文件的，lib用来存储编译的库文件的，include用来存储项目中的头文件，src是项目的源代码，tests是存储测试的代码的，我们自己写的函数就放在src下面，测试的代码就写在tests下面，下面来详细查看源码内容。

我们先看一下顶层的CMakeLists.txt文件的内容，基本上没有什么内容，设置一下库和可执行文件的输出路径，包含以下头文件的搜索路径，添加子CMakeLists.txt目录，东西不多，不难理解。

cmake_minimum_required(VERSION 3.0.0)
project(cpp VERSION 0.1.0 LANGUAGES C CXX)

set(LIBRARY_OUTPUT_PATH ${CMAKE_CURRENT_SOURCE_DIR}/lib)
set(EXECUTABLE_OUTPUT_PATH ${CMAKE_CURRENT_SOURCE_DIR}/bin)

include_directories(${CMAKE_SOURCE_DIR}/include)

add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/src/binary_search)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/tests)

include(CTest)
enable_testing()

set(CPACK_PROJECT_NAME ${PROJECT_NAME})
set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
include(CPack)

然后看我们写的函数源码（用来被测试），也就是binary_search.cc和头文件binary_search.h，这个就是简单的实现二分查找，并生成静态库，代码如下，实现细节就不细说了，这次仅是讲如何测试

头文件

// binary_search.h

#include <iostream>
#include <string>
#include <vector>
using std::vector;
using std::cout;
using std::endl;
int binary(const vector<int> &val,int elem);
int binaryLeft(const vector<int> &val,int elem);
int binaryRight(const vector<int> &val,int elem);

源码

// binary_search.cc
#include<binary_search.h>
int binary(const vector<int> &val,int elem){
	int L = 0;
	int R = val.size();
	while(L < R){
		int mid = L + (R - L)/2;
		if(val[mid] == elem){
			return mid;
		} else if(val[mid] > elem){
			R = mid;
		} else{
			L = mid + 1;
		}
	}
	return -1;
}

int binaryLeft(const vector<int> &val,int elem){
	int L = 0;
	int R = val.size() - 1;
	while(L < R){
		int mid = L + (R - L)/2;
		if(val[mid] == elem){
			R = mid;
		} else if(val[mid] > elem){
			R = mid;
		} else if(val[mid] < elem){
			L = mid + 1;
		}
	}
	return val[L] == elem ? L : -1;
}

int binaryRight(const vector<int> &val,int elem){
	int L = 0;
	int R = val.size() - 1;
	while(L < R){
		int mid = L + (R - L)/2 + 1;
		if(val[mid] == elem){
			L = mid;
		} else if(val[mid] > elem){
			R = mid  - 1;
		} else {
			L = mid;
		}
	}
	return val[R] == elem ? R : -1;
}

还有和binary_search.cc文件同目录的CMakeLists.txt文件，这个cmake文件较为简单，仅是生成一个静态库语句，如下:

add_library(binary_search ${CMAKE_CURRENT_SOURCE_DIR}/binary_search.cc)

重要的是tests文件夹里的内容，分别是测试源码文件和cmake文件，我们简单看一下

测试源码文件如下，教学目的，下面的例子也比较简单也比较经典，首先需要包含gtest的头文件，然后就可以写测试内容了，模板如下

TEST(MainTestName, TestName){
    test...
}

这里test...主要使用gtest的一些宏来进行测试，具体有什么宏并且如何使用，这里不涉及，需要者可以自行google，测试的代码大概就是这些。

// binary_search_test.cc
#include <gtest/gtest.h>
#include <binary_search.h>

TEST(BianrySearchTest,binary_search){
    vector<int> temp{
		2,5,8,12,12,12,12,56,59,63,85
	};
    GTEST_ASSERT_EQ(1,binary(temp,5));
    GTEST_ASSERT_EQ(5,binary(temp,12));
    GTEST_ASSERT_EQ(7,binary(temp,56));
    GTEST_ASSERT_EQ(8,binary(temp,59));
    GTEST_ASSERT_EQ(9,binary(temp,63));
    GTEST_ASSERT_EQ(10,binary(temp,85));
    GTEST_ASSERT_EQ(-1,binary(temp,0));
}

还有一个比较重要的就是tests文件下的CMakeLists.txt文件内容，涉及如何写测试相关的cmake文件，内容如下，首先查找一下GTest库文件，然后生成二进制可执行文件，测试都需要生成可执行文件的，然后是链接需要的库，其实这里的binary_search库是如何找到的，我不太理解，是编译过程中生成的，不知道测试代码如何链接的，可能和cmake默认搜索路径有关，然后就是对gtest库的链接了，这里使用比较简单的方式，直接使用变量GTEST_BOTH_LIBRARIES来链接的，最后就是测试相关的代码了，也就是add_test，其中NAME是可以随便设置的，COMMAND需要设置成可执行文件的名字，然后进行测试就可以了。

find_package(GTest REQUIRED)
add_executable(binary_search_test binary_search_test.cc)
target_link_libraries(binary_search_test binary_search ${GTEST_BOTH_LIBRARIES})

add_test(
    NAME binary_search_test
    COMMAND binary_search_test
)

编译完后，就会发现lib文件夹下面生成的静态库，和bin文件夹下面生成的可执行文件，可以直接运行可执行文件查看测试结果。

大家可能好奇，为啥binary_search_test.cc中并没有main函数，也可以生成可执行文件呢，这就和我们链接gtest时用到的变量GTEST_BOTH_LIBRARIES有关了，其中包含一个gtest集成的main函数，也就不需要我们写了，当然，也可以自己写，自己写的话需要稍微改动一下CMakeLists.txt文件，并添加一个带有main函数的源码文件，内容如下:

#include <gtest/gtest.h>
int main(int argc, char** argv) {
  testing::InitGoogleTest(&argc, argv);
 
  return RUN_ALL_TESTS();
}

大概就是这么多，有错误的请提醒我，我也是初学，cmake初学并且gtest初学。