我有一个小型静态库项目,我正在重写它,从使用 Makefiles 构建到现代 CMake,我正在尝试学习。 我的项目大量使用断言来检查前提条件,因此我编写了一个非常简单的自定义断言宏,该宏有条件地扩展为一个打印格式化诊断的函数,然后在调试模式下编译库时中止,或者如果库在发布模式下编译,则扩展为无。
但是,我希望能够测试这些断言是否正确触发。Cmocka 允许您通过在库代码中调用mock_assert
来测试这一点,cmocka 将在测试过程中拦截这些代码。为此,我想有另一个宏,比如LIBRARY_TESTING
,它将重新定义我的自定义断言宏以调用mock_assert
而不是我自己的断言函数,以便可以测试断言。最终的断言宏在道德上可以被视为等效于以下内容:
// In file include/assertion.h
#ifdef LIBRARY_DEBUG
#ifdef LIBRARY_TESTING
// mock_assert is provided by cmocka
void mock_assert(
int const result,
char const *const expression,
char const *const file,
int const line);
#define ASSERT(cond)
mock_assert((cond), #cond, __FILE__, __LINE__)
#else
// emit_assertion is defined in src/assertion.c
void emit_assertion(int cond, char const *const msg);
#define ASSERT(cond) emit_assertion((cond), #cond)
#endif
#else
#define ASSERT(cond) // Nothing
#endif
我已经能够通过以下 Cmake 代码段获得在调试模式(ASSERT
扩展到对emit_assertion
的调用)和发布模式(ASSERT
根据需要扩展到无)下构建所需的行为src/CMakeLists.txt
):
target_compile_options(library PRIVATE
$<$<CONFIG:Debug>:-Og -ggdb3 -DLIBRARY_DEBUG >>
$<$<CONFIG:Testing>:-Og -ggdb3 -DLIBRAY_DEBUG -DLIBRARY_TESTING >>
)
从哪个具有-DCMAKE_BUILD_TYPE=Debug
或-DCMAKE_BUILD_TYPE=Release
的建筑物产生预期的行为。推断CONFIG
在这里是如何工作的,我还添加了一个检查Testing
的生成器表达式,它在编译时定义了BASIC_TESTING
。到目前为止,一切都很好。
我在执行单元测试时开始遇到问题。为了说明的目的,我要测试的函数等价于这个,在include/example.h
中定义:
static inline bool example(int *arg)
{
ASSERT(arg != NULL);
return *arg == 0;
}
在tests/example.c
中具有相应的单元测试:
#include "example.h"
#include <cmocka.h>
// Other cmocka required #includes
static void test_example(void **state)
{
(void) state;
expect_assert_failure(example(NULL));
}
而test/CMakeLists.txt
的内容:
add_executable(example
${CMAKE_CURRENT_SOURCE_DIR}/example.c
)
add_test(example example)
target_include_directories(example PRIVATE
"${PROJECT_SOURCE_DIR}/include"
)
# 'library' is the static library target defined in the top-level
# CMakeLists.txt
target_link_libraries(example library cmocka)
现在,为了对我的库进行单元测试,我希望我的自定义断言扩展到mock_assert
,所以我编译我的库进行测试(据我所知):
# In ./build
$ cmake -DCMAKE_BUILD_TYPE=Testing .. && make
一切都正确构建,我的静态库liblibrary.a
我期望的位置。此外,我的测试可执行文件example
也成功编译和链接,但是当我运行它时,测试失败并出现分段错误,就好像我的自定义断言从未被调用过一样(并且该函数尝试取消引用我故意给它以触发断言的NULL
指针)。我有理由相信与 cmocka 本身链接没有问题,因为运行测试的结果是 cmocka 花哨的命令行输出格式。
在我的原始面向 makefile 的构建中,所有测试可执行目标都将编译一个特殊的"测试"库目标,并且测试可执行文件链接到该库目标,并且所有断言都被 cmocka 正确拦截,正如我所期望的那样。但是,在这种情况下,似乎我编译的静态库的行为好像没有定义LIBRARY_DEBUG
或LIBRARY_TESTING
- 正如分段错误所证明的那样。
我对现代cmake很陌生,所以我觉得我误解了一些概念。我的问题是:
如何确保我的静态库是使用特定的(一组)编译选项(此处-DBASIC_TESTING
)编译的,以确保可以使用 cmocka 测试它触发的自定义断言?
我通过定义一个专门用于构建测试库的新库目标来解决此问题,并将所有测试可执行文件链接到测试库。 我必须在测试库目标上设置编译选项,以便PUBLIC
这些选项应用于构建测试目标。然后,我不再在编译选项中使用生成器表达式library-testing
因为暗示此目标将仅用于与测试可执行文件链接。
在src/CMakeLists.txt
add_library(
library,
src/example.c)
+add_library(
+ library-testing,
+ src/example.c)
target_compile_options(library PRIVATE
$<$<CONFIG:Debug>:-Og -ggdb3 -DLIBRARY_DEBUG >>
)
+target_compile_options(library-testing PUBLIC
+ -Og -ggdb3 -DLIBRARY_DEBUG -DLIBRARY_TESTING
+)
然后在test/CMakeLists.txt
:
add_executable(example
${CMAKE_CURRENT_SOURCE_DIR}/example.c
)
add_test(example example)
target_include_directories(example PRIVATE
"${PROJECT_SOURCE_DIR}/include"
)
# Link with library-testing target instead of library target
-target_link_libraries(example library cmocka)
+target_link_libraries(example library-testing cmocka)
进行这些更改后,我的测试可执行文件都按预期运行。