欢迎访问个人网络日志🌹🌹知行空间🌹🌹
使用CMake和CTest组织工程测试
软件测试
软件相关的测试包括:
1.冒烟测试(SMOKE TEST)
,这是最基本的测试,例如代码能不能成功编译,能不能执行简单的测试用例。2.回归测试(Regression Test)
,回归测试确保软件更新后还能保证以前的功能可以正常运行。3.黑白盒测试(Black-, and White-box Testing)
,白盒测试是在知道代码如何编写的情况下测试代码可能存在的潜在的问题,黑盒测试是在只知道公开API信息而不知道代码实现的情况下,对软件功能进行测试。4.软件标准兼容性测试(Software Standard Compliance Testing)
,前面三种测试主要聚焦在代码可否正常编译,可否实现功能,软件标准兼容性测试是来测试代码是否工程标准,增强代码可维护性的。如代码规范维护使用的静态分析工具cppchecker
等
CMake中如何组织测试
CMake
中对测试的支持主要是使用add_test
命令。
要使用add_test
命令,需要先在CMakeLists.txt
中添加include(CTest)
,add_test
的命令格式为:
add_test(NAME TestName COMMAND ExecutableToRun arg1 arg2 ...)
- 第一个参数
TestName
是一个字符串,指定当前测试的名字 - 第二个参数
ExecutableToRun
是可执行文件的名称,arg1/arg2/...
是可执行文件需要的参数,可执行文件的名称可以是当前工程中编译生成的文件名,也可以是外部可执行文件,如Python
。
使用方式十分简单,
add_executable(TestInstantiator TestInstantiator.cxx)
target_link_libraries(TestInstantiator vtkCommon)
add_test(NAME TestInstantiator
COMMAND TestInstantiator)
测试属性
当一个测试满足以下3个条件时才会认为测试用例通过,
- 测试执行文件可以找到
- 测试运行没有异常
- 测试执行成功并返回0
通过cmake
中的一些命令,可以改变这些属性:
set_property
命令格式:
set_property(TEST test_name
PROPERTY prop1 value1 value2 ...)
prop1
的可选项主要有:
ENVIRONMENT
指定运行当前测试时需要的环境变量LABELS
指定当前测试的标签WILL_FAIL
这个选项被设置为true
时,如果测试可执行文件返回的结果不是0
,测试用例也能通过PASS_REGULAR_EXPRESSION
,测试程序的输出和这个属性设置的值不同时,测试用例将会提示测试失败。FAIL_REGULAR_EXPRESSION
,测试程序的输出和这个属性设置的值不同时,测试用例将会提示测试成功。
include(CTest)
add_test(NAME outputTest COMMAND ${TARGET_NAME})
set (passRegex "^Test passed" "^All ok")
set (failRegex "Error" "Fail")
set_property (TEST outputTest
PROPERTY PASS_REGULAR_EXPRESSION "${passRegex}")
set_property (TEST outputTest
PROPERTY FAIL_REGULAR_EXPRESSION "${failRegex}")
使用CTest
使用CMake
在构建环境中使用测试是通过CTest
来实现的,CTest
是一个可执行程序,CTest
主要是通过CTestTestfile.cmake
文件来实现控制运行哪些测试用例的。
CTest
会执行当前构建树中的所有测试用例,包括subdirectory
中的测试用例。CTest
程序支持一些参数,用来控制执行测试程序的策略。
- ‵-R `参数,执行名字满足正则表达式的测试
-E <regex>
参数,排除名字满足正则表达式的测试-L <regex>
参数,执行label
满足正则表达式的测试-LE <regex>
参数,排除label
满足正则表达式的测试-C <config>
参数-V,--verbose
参数,输出测试输出的详细信息,默认会保存在Testing
文件夹下。-N,--show-only
参数,只统计有哪些测试,不执行实际的测试程序-I [Start,End,Stride,test#,test#|Test file]
参数,指定执行哪些测试用例-H
查看帮助信息
参考工程https://gitee.com/lx_r/basic_cplusplus_examples