cmake - 编写单元测试

在cmake中构建测试例就是enable_testing()+add_test()这一套。本篇文章是我在学习cmake构建单元测试的一个总结笔记。

工程概览

如下是我所定义的一个简单的工程，各个子文件夹的功能如名字所示：src是源文件夹，header是头文件夹，test则是相应的测试代码

$ tree
.
├── CMakeLists.txt
├── header
│   └── Solution.h
├── src
│   ├── CMakeLists.txt
│   └── Solution.cpp
└── test
    ├── CMakeLists.txt
    └── Solution_test.cpp

3 directories, 6 files

源文件Solution.cpp中代码的功能就是：找出一个一维数组中的主要元素（所谓主要元素，指的就是个数超过数组size一半的元素）。源文件如下：

$ cat src/Solution.cpp

#include "Solution.h"
int Solution::majorityElement(vector<int>& nums) {
    int len = nums.size();
    if(len == 0)  return -1;
    int ans = nums[0], cnt = 1;
    for(int i = 1; i < len; ++i){
        cnt += (nums[i]==ans ? 1 : -1);
        if(cnt <= 0){
            ans = nums[i];
            cnt = 1;
        }
    }
    cnt = 0;
    for(int i = 0; i < len; ++i){
        if(nums[i] == ans)  ++cnt;
    }
    return cnt > len/2 ? ans : -1;
}

这里需要注意了，#include "Solution.h"并没有指定头文件的具体位置，所以，在编写CMakeLists.txt中，需要为target使用target_include_directories来增加对应的property.

头文件很简单，如下：

$ cat header/Solution.h

#include <bits/stdc++.h>
using namespace std;

class Solution {
public:
    int majorityElement(vector<int>& nums);
};

最后是单元测试，如下：

cat test/Solution_test.cpp

#include "Solution.h"

int main(int argc, const char** argv) {
    vector<int> nums{1,2,5,9,5,9,5,5,5};
    assert(Solution().majorityElement(nums) == 5);
    return 0;
}

工程构建

接下来就要开始编写各个CMakeLists.txt了。首先要把Solution对应的算法包装为静态库，方便单元测试进行调用。前面说过target_include_directories的问题，所以src/CMakeLists.txt的内容如下所示。可以看到，需要指定../header以告诉系统应该包含的头文件夹的具体位置。另外，PUBLIC指明了，无论是静态库，还是使用这个静态库的客户代码，都需要包含这个头文件夹。

add_library(MajorEle
    Solution.cpp)

target_include_directories(MajorEle
    PUBLIC ../header)

下面是测试集的CMakeLists.txt，如下所示。通过add_test()告诉系统需要增加一个测试例，后续直接使用ctest即可进行测试。内部的COMMAND关键字是告诉系统测试的具体命令，此处当然就是这个executable了。

add_executable(MajorEleTest
    Solution_test.cpp)

target_link_libraries(MajorEleTest
    MajorEle)

add_test(NAME majoreletest COMMAND MajorEleTest)

最后是项目根文件夹的CMakeLists.txt，如下所示，直接包含各个子文件夹的cmake工程即可。

cmake_minimum_required(VERSION 3.18)
project(TEST_CMAKE)

enable_testing()

add_subdirectory(src)
add_subdirectory(test)

结果展示

如下是结果的展示，-DCMAKE_EXPORT_COMPILE_COMMANDS=1可以让系统生成compile_commands.json文件，方便clangd机制的编辑器去进行符号跳转。（比如我用的nvim）

$ cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -S . -B build
$ la build
total 56
drwxr-xr-x 5 zhongzedu zhongzedu  4096 Jul 30 17:59 .
drwxr-xr-x 6 zhongzedu zhongzedu  4096 Jul 30 17:59 ..
-rw-r--r-- 1 zhongzedu zhongzedu 13942 Jul 30 17:59 CMakeCache.txt
drwxr-xr-x 4 zhongzedu zhongzedu  4096 Jul 30 17:59 CMakeFiles
-rw-r--r-- 1 zhongzedu zhongzedu   278 Jul 30 17:59 CTestTestfile.cmake
-rw-r--r-- 1 zhongzedu zhongzedu  5450 Jul 30 17:59 Makefile
-rw-r--r-- 1 zhongzedu zhongzedu  1911 Jul 30 17:59 cmake_install.cmake
-rw-r--r-- 1 zhongzedu zhongzedu   486 Jul 30 17:59 compile_commands.json
drwxr-xr-x 3 zhongzedu zhongzedu  4096 Jul 30 17:59 src
drwxr-xr-x 3 zhongzedu zhongzedu  4096 Jul 30 17:59 test
$
$ cd build
$ make
Scanning dependencies of target MajorEle
[ 25%] Building CXX object src/CMakeFiles/MajorEle.dir/Solution.cpp.o
[ 50%] Linking CXX static library libMajorEle.a
[ 50%] Built target MajorEle
Scanning dependencies of target MajorEleTest
[ 75%] Building CXX object test/CMakeFiles/MajorEleTest.dir/Solution_test.cpp.o
[100%] Linking CXX executable MajorEleTest
[100%] Built target MajorEleTest
$
$
$ ctest
Test project /tmp/testCmake/build
    Start 1: majoreletest
1/1 Test #1: majoreletest .....................   Passed    0.00 sec

100% tests passed, 0 tests failed out of 1

Total Test time (real) =   0.00 sec

最后，打开编辑器后，发现没有任何报错，系统知道Solution.h的位置。因此可以证明compile_commands.json发挥了作用。

支持跳转