本文主要探讨cmake在测试和项目中的应用。
add_test
add_test(NAME <name> COMMAND <command> [<arg>...]
[CONFIGURATIONS <config>...] [WORKING_DIRECTORY <dir>]
[COMMAND_EXPAND_LISTS]) add_test(NAME test_uni COMMAND $<TARGET_FILE:${PROJECT_NAME}> 1)
添加测试
main函数返回值0成功
set_tests_properties(test PROPERTIES PASS_REGULAR_EXPRESSION "0" )
set_tests_properties(test PROPERTIES FAIL_REGULAR_EXPRESSION "-1")
PASS_REGULAR_EXPRESSION
成功输出
FAIL_REGULAR_EXPRESSION
失败输出
设置成功/失败输出匹配
set_tests_properties(test PROPERTIES TIMEOUT 2)
设置超时
enable_testing()
使能测试
execute_process(COMMAND shell)
执行shell
ctest -V --output-junit results.xml
详细输出结果为xml文件
FetchContent
cmake版本大于3.14
include(FetchContent)
导入FetchContent
FetchContent_Declare(
<项目名称> # 自定义名称
GIT_REPOSITORY <仓库URL> # 仓库的URL
GIT_TAG <标签或分支> # 使用的标签或分支
)
下载模块
FetchContent_MakeAvailable(<项目名称>)
使用项目
add_dependencies
add_dependencies(target-name depend-target1 [depend-target2 ...])
设置目标(如可执行文件、库或自定义目标)之间的依赖关系
demo1:
add_test & gtest
文件目录
代码示例
run.sh
#!/bin/bash
#
# sh run.sh 1 ==> compile install gooletest
#
# sh run.sh 0 ==> FetchCotent install gooletest
#
cmake -S . -B build -D COMP_INSTALL=${1}
cmake --build build
echo -e "==================================\n"
cd build && ctest -V --output-junit ../results.xml
cd ..
clean.sh
#!/bin/bash
rm -rf build lib include gooletest release-1.11.0.tar.gz Testing results.xml
CMakeLists.txt
cmake_minimum_required(VERSION 3.0)
project(test)
#ctest
add_executable(ctests ctest.cpp)
add_test(NAME ctest_test_sucess COMMAND ctests sucess)
add_test(NAME ctest_test_fail COMMAND ctests)
set_tests_properties(ctest_test_sucess PROPERTIES PASS_REGULAR_EXPRESSION "sucess" )
#gooletest
if(COMP_INSTALL)
message("compile install gooletest")
if(NOT EXISTS release-1.11.0.tar.gz)
execute_process(COMMAND wget http://cdn.tarsyun.com/src/release-1.11.0.tar.gz)
endif()
if(NOT EXISTS gooletest)
execute_process(COMMAND mkdir gooletest)
endif()
set(UNTAR_FILE ${CMAKE_SOURCE_DIR}/gooletest)
set(COM_PUT ${CMAKE_SOURCE_DIR}/gooletest/googletest-release-1.11.0/build)
execute_process(COMMAND tar -zxf release-1.11.0.tar.gz -C ${UNTAR_FILE})
execute_process(COMMAND ${CMAKE_COMMAND} -S ${UNTAR_FILE}/googletest-release-1.11.0 -B ${COM_PUT})
execute_process(COMMAND ${CMAKE_COMMAND} --build ${COM_PUT})
execute_process(COMMAND ${CMAKE_COMMAND} --install ${COM_PUT} --prefix=${CMAKE_SOURCE_DIR})
set(CMAKE_PREFIX_PATH ${CMAKE_SOURCE_DIR}/lib/cmake/)
find_package(GTest)
else()
#gtest(FetchContent)
message("FetchContent install gooletest")
include(FetchContent)
FetchContent_Declare(
googletest
URL http://cdn.tarsyun.com/src/release-1.11.0.tar.gz
)
FetchContent_MakeAvailable(googletest)
endif()
add_executable(gtests gtest.cpp)
target_link_libraries(gtests GTest::gtest_main)
include(GoogleTest)
gtest_discover_tests(gtests)
enable_testing()
gtest.cpp
#include <gtest/gtest.h>
TEST(Test,TestDownload)
{
EXPECT_EQ(2*7,14);
}
int main(int argc,char *argv[])
{
//初始化gtest
testing::InitGoogleTest(&argc,argv);
return RUN_ALL_TESTS();
}
ctest.cpp
#include <iostream>
int main(int argc, char *argv[])
{
if(argc <= 1)
{
std::cout << "ex: ctests param" << std::endl;
return -1;
}
std::cout << "param : " << argv[1] << std::endl;
return 0;
}
结果示例
sh run.sh 1
sh run.sh
sh clean.sh
demo2:
test project
文件目录
run.sh
#!/bin/bash
out=${1}
cmake -S . -B ${out}
cmake --build ${out}
cd ${out} && make install && cd ..
echo "=================Math=============="
$(pwd)/bin/Math_test
echo "=================Thread==========="
$(pwd)/bin/Thread_test
echo "=================unit Thread test ==========="
$(pwd)/${out}/src/Math/unit_test_Math/Math_unit_test
echo "=================unit Math test ==========="
$(pwd)/${out}/src/Thread/unit_test_Thread/Thread_unit_test
clean.sh
#!/bin/bash
out=${1}
rm -rf ${out} bin lib include
CMakeLists.txt
###############
#
# cmake_project
#
##############
cmake_minimum_required(VERSION 3.0)
project(cmake_project)
option(BUILD_MATH "" ON)
option(BUILD_THREAD "" ON)
option(BUILD_SAMPLES "" ON)
option(BUILD_UNIT_TEST "" ON)
if(BUILD_MATH)
add_subdirectory(src/Math)
endif()
if(BUILD_THREAD)
add_subdirectory(src/Thread)
endif()
if(BUILD_SAMPLES)
add_subdirectory(src/samples)
#添加依赖
add_dependencies(Thread_test Thread)
add_dependencies(Math_test Math)
endif()
if(BUILD_UNIT_TEST)
enable_testing()
add_subdirectory(src/Math/unit_test_Math)
add_subdirectory(src/Thread/unit_test_Thread)
endif()
root@kaxi-virtual-machine:~/cmake_project#
root@kaxi-virtual-machine:~/cmake_project#
root@kaxi-virtual-machine:~/cmake_project# cat CMakeLists.txt
###############
#
# cmake_project
#
##############
cmake_minimum_required(VERSION 3.0)
project(cmake_project)
option(BUILD_MATH "" ON)
option(BUILD_THREAD "" ON)
option(BUILD_SAMPLES "" ON)
option(BUILD_UNIT_TEST "" ON)
if(BUILD_MATH)
add_subdirectory(src/Math)
endif()
if(BUILD_THREAD)
add_subdirectory(src/Thread)
endif()
if(BUILD_SAMPLES)
add_subdirectory(src/samples)
#添加依赖
add_dependencies(Thread_test Thread)
add_dependencies(Math_test Math)
endif()
if(BUILD_UNIT_TEST)
enable_testing()
add_subdirectory(src/Math/unit_test_Math)
add_subdirectory(src/Thread/unit_test_Thread)
endif()
common.cmake
###########
#
# common.cmake
#
##########
#设置bin,lib路径
set(RUNTIME_DIR ${CMAKE_CURRENT_LIST_DIR}/../bin)
set(LIBRARY_DIR ${CMAKE_CURRENT_LIST_DIR}/../lib)
#项目顶层目录
set(TOP_DIR "/root/cmake_project")
#获取源码和头文件
macro(get_src_include)
#获取源码
aux_source_directory(${CMAKE_CURRENT_LIST_DIR} SRC)
#获取头文件
FILE(GLOB H_FILE ${CMAKE_CURRENT_LIST_DIR}/include/*.h ${CMAKE_CURRENT_LIST_DIR}/include/../*.h)
endmacro()
#配置编译参数
macro(set_config param)
#设置头文件查找路径
target_include_directories(${name} PRIVATE ${CMAKE_CURRENT_LIST_DIR}/include ${CMAKE_CURRENT_LIST_DIR}/../include)
#配置参数
target_compile_features(${name} PRIVATE cxx_std_11)
#debug/release配置
if(CMAKE_BUILD_TYPE STREQUAL "")
set(CMAKE_BUILD_TYPE DEBUG)
endif()
#设置输出路径
set_target_properties(${name} PROPERTIES
RUNTIME_OUTPUT_DIRECTORY ${RUNTIME_DIR} #exe
LIBRARY_OUTPUT_DIRECTORY ${LIBRARY_DIR} #.so
ARCHIVE_OUTPUT_DIRECTORY ${LIBRARY_DIR} #.a
)
#设置debug标识
set_target_properties(${name} PROPERTIES BEBUG_POSTFIX "d")
#添加库路径
target_link_directories(${name} PRIVATE ${LIBRARY_DIR})
endmacro()
#单元测试
include(${CMAKE_CURRENT_LIST_DIR}/gtest.cmake)
function(moudle_test name)
#构建gtest
setup_gtest()
#获取模块单元测试源码
get_src_include()
# 获取模块源码
aux_source_directory(${CMAKE_CURRENT_LIST_DIR} TEST_SRC)
list(APPEND SRC ${TEST_SRC})
#生成可执行程序
add_executable(${name} ${SRC} ${H_FILE})
#设置头文件查找路径
target_include_directories(${name} PRIVATE ${CMAKE_CURRENT_LIST_DIR}/../include)
#连接gtest库
target_link_libraries(${name} GTest::gtest_main)
#链库
math(EXPR size "${ARGC} - 1")
if(size GREATER 0)
foreach(i RANGE 1 ${size})
target_link_libraries(${name} ${ARGV${i}})
endforeach()
endif()
#联合ctest和gtest
include(GoogleTest)
gtest_discover_tests(${name})
#使能ctest
enable_testing()
endfunction()
#编译可执行程序
function(compile_exe name)
#获取源码和头文件
get_src_include()
#编译生成可执行程序
add_executable(${name} ${SRC} ${H_FILE})
#设置编译配置
set_config(${name})
#链库
math(EXPR size "${ARGC} - 1")
if(size GREATER 0)
foreach(i RANGE 1 ${size})
target_link_libraries(${name} ${ARGV${i}})
endforeach()
endif()
endfunction()
#库配置
function(project_lib name)
#静态/动态库配置
string(TOUPPER ${name} NAME)
option(${NAME}_SHARED "OFF is static lib" ON)
if(${NAME}_SHARED)
set(TYPE SHARED)
else()
set(TYPE STATIC)
endif()
#获取源码和头文件
get_src_include()
#生成库
add_library(${name} ${TYPE} ${SRC} ${H_FILE})
#设置编译配置
set_config(${name})
#安装lib/include/bin
set(version 1.0)
set_target_properties(${name} PROPERTIES PUBLIC_HEADER ${H_FILE})
install(TARGETS ${name}
EXPORT ${name}
RUNTIME DESTINATION ${TOP_DIR}/bin
LIBRARY DESTINATION ${TOP_DIR}/lib
PUBLIC_HEADER DESTINATION ${TOP_DIR}/include
)
#安装pakage的配置文件
install(EXPORT ${name} FILE ${name}Config.cmake DESTINATION ${TOP_DIR}/lib/config/${name}-${version})
#版本文件
set(CONF_VER_FILE ${TOP_DIR}/../../lib/conf/${name}-${version}/${name}ConfigVersion.cmake)
include(CMakePackageConfigHelpers)
write_basic_package_version_file(${CONF_VER_FILE} VERSION ${version}
COMPATIBILITY SameMajorVersion # 主版本兼容
)
#安装版本配置文件
install(FILES ${CONF_VER_FILE}
DESTINATION ${TOP_DIR}/lib/config/${name}-${version}
)
endfunction()
gtest.cmake
###########
#
# gtest
#
##########
macro(setup_gtest)
#gtest(FetchContent)
message("FetchContent install gooletest")
include(FetchContent)
FetchContent_Declare(
googletest
URL http://cdn.tarsyun.com/src/release-1.11.0.tar.gz
)
FetchContent_MakeAvailable(googletest)
endmacro()
Thread/CMakeLists.txt
##############
#
# Thread
#
#############
cmake_minimum_required(VERSION 3.0)
project(Thread)
include(${CMAKE_CURRENT_LIST_DIR}/../../cmake/common.cmake)
project_lib(${PROJECT_NAME})
Thread.h
#ifndef __THREAD__H__
#define __THREAD__H__
#include <thread>
class Thread
{
public:
virtual void start_pthread();
virtual void wait_pthread();
virtual void pthread_task() = 0;
private:
std::thread th;
};
#endif
Thread.cpp
#include <iostream>
#include "Thread.h"
void Thread::start_pthread()
{
std::cout << " start pthread" << std::endl;
th = std::thread(&Thread::pthread_task,this);
}
void Thread::wait_pthread()
{
th.join();
}
unit_test_Thread/CMakeLists.txt
#####################
#
# Thread unit test
#
####################
cmake_minimum_required(VERSION 3.0)
project(Thread_unit_test)
include(${CMAKE_CURRENT_LIST_DIR}/../../../cmake/common.cmake)
moudle_test(${PROJECT_NAME} Thread)
enable_testing()
unit_test_Thread.cpp
#include <iostream>
#include <chrono>
#include <thread>
#include "Thread.h"
#include "gtest/gtest.h"
class Task: public Thread
{
public:
Task(int num):num(num){};
void pthread_task()
{
std::cout << "num : " << num << std::endl;
}
private:
unsigned int num;
};
TEST(Test_Thread,test_Thread)
{
Task t(1);
t.start_pthread();
t.wait_pthread();
}
int main()
{
std::cout << "=================unit test thread start=================";
testing::InitGoogleTest();
return RUN_ALL_TESTS();
std::cout << "=================unit test thread end=================";
}
Math/CMakeLists.txt
############
#
# Math
#
###########
cmake_minimum_required(VERSION 3.0)
project(Math)
include(${PROJECT_SOURCE_DIR}/../../cmake/common.cmake)
project_lib(${PROJECT_NAME})
Math.h
#ifndef __MATH_H__
#define __MATH_H__
class Math
{
public:
Math(){};
Math(int num_1, int num_2):num_1(num_1),num_2(num_2){};
void get_num();
void set_num(int num_1, int num_2);
int add_num();
int dec_num();
private:
int num_1;
int num_2;
};
#endif
Math.cpp
#include <iostream>
#include "Math.h"
int Math::add_num()
{
return num_1 + num_2;
}
int Math::dec_num()
{
return num_1 - num_2;
}
void Math::get_num()
{
std::cout << "num_1:" << num_1 << std::endl;
std::cout << "num_2:" << num_2 << std::endl;
}
void Math::set_num(int num_1, int num_2)
{
this->num_1 = num_1;
this->num_2 = num_2;
}
unit_test_Math/CMakeLists.txt
#################
#
# Math unit test
#
################
cmake_minimum_required(VERSION 3.0)
project(Math_unit_test)
include(${CMAKE_CURRENT_LIST_DIR}/../../../cmake/common.cmake)
moudle_test(${PROJECT_NAME} Math)
enable_testing()
unit_test_Math.cpp
#include <iostream>
#include "Math.h"
#include "gtest/gtest.h"
TEST(Math_test, Init_Math)
{
Math m;
m.set_num(1,2);
m.get_num();
}
TEST(Math_test_add, Math_Add)
{
Math m;
m.set_num(1,2);
ASSERT_EQ(m.add_num(),3);
}
TEST(Math_test_, Math_Add)
{
Math m;
m.set_num(1,2);
ASSERT_EQ(m.dec_num(),-1);
}
int main()
{
std::cout << "=================unit test math start=================";
testing::InitGoogleTest();
return RUN_ALL_TESTS();
std::cout << "=================unit test math end=================";
}
samples/CMakeLists.txt
#####################
#
# samples
#
####################
cmake_minimum_required(VERSION 3.0)
project(samples)
file(GLOB dirs LIST_DIRECTORIES true ${CMAKE_CURRENT_LIST_DIR}/*)
set(samp)
foreach(dir IN LISTS dirs)
if(EXISTS ${dir}/CMakeLists.txt)
list(APPEND samp ${dir})
endif()
endforeach()
foreach(s IN LISTS samp)
add_subdirectory(${s})
endforeach()
test_Math/CMakeLists.txt
########################
#
# Math test
#
#######################
cmake_minimum_required(VERSION 3.0)
project(Math_test)
include(${CMAKE_CURRENT_LIST_DIR}/../../../cmake/common.cmake)
compile_exe(${PROJECT_NAME} Math)
target_include_directories(${PROJECT_NAME} PRIVATE "../../Math/include")
test_Math.cpp
#include <iostream>
#include "Math.h"
int main()
{
std::cout << "===============test Math start=============";
Math m(1,2);
m.get_num();
std::cout << "1 + 2 = " << m.add_num() << std::endl;
std::cout << "1 - 2 = " << m.dec_num() << std::endl;
m.set_num(2,1);
m.get_num();
std::cout << "2 + 1 = " << m.add_num() << std::endl;
std::cout << "2 - 1 = " << m.dec_num() << std::endl;
std::cout << "===============test Math end=============";
return 0;
}
test_Thread/CMakeLists.txt
########################
#
# Thread test
#
#######################
cmake_minimum_required(VERSION 3.0)
project(Thread_test)
include(${CMAKE_CURRENT_LIST_DIR}/../../../cmake/common.cmake)
compile_exe(${PROJECT_NAME} Thread)
target_include_directories(${PROJECT_NAME} PRIVATE "../../Thread/include")
test_Thread.cpp
#include <iostream>
#include <chrono>
#include <thread>
#include "Thread.h"
class Task: public Thread
{
public:
Task(int num):num(num){};
void pthread_task()
{
std::cout << "num :" << num << std::endl;
}
private:
unsigned int num;
};
int main()
{
Task t(1);
t.start_pthread();
t.wait_pthread();
return 0;
}
编译运行结果
编译清理结果