在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發揮了作用。
