用于编译测试的 CMake 和 CMocka 标准断言

Question

我有一个小型静态库项目，我正在将其从使用 Makefile 构建改写为现代 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

我已经能够在调试模式（其中 ASSERT 扩展为对 emit_assertion 的调用）和发布模式（其中 ASSERT 扩展为无）中获得所需的行为，根据需要）通过 src/CMakeLists.txt 中的以下 Cmake 片段）：

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 也编译并 link 成功，但是当我运行它时，测试失败并出现分段错误，就好像我的自定义断言从未被调用过一样（和函数试图取消引用我故意给它的 NULL 指针来触发断言）。我有理由相信 linking cmocka 本身没有问题，因为运行ing 测试结果采用 cmocka 的精美命令行输出格式。

在我最初的面向 makefile 的构建中，所有测试可执行目标都会编译一个特殊的 "testing" 库目标，测试可执行文件 link 到这个库目标，所有断言都被 cmocka 正确拦截正如我所料。但是，在这种情况下，我编译的静态库似乎表现得好像 LIBRARY_DEBUG 或 LIBRARY_TESTING 都没有被定义——正如分段所证明的那样错误。

我对现代 cmake 很陌生，所以我觉得我误解了一些概念性的东西。我的问题是：

我怎样才能确保我的静态库是用特定的（一组）编译选项（这里是 -DBASIC_TESTING）编译的，以确保它的自定义断言可以用 cmocka 测试火灾吗？

Answer 1

我通过定义一个专门用于构建测试库的新库目标解决了这个问题，并将所有测试可执行文件链接到测试库。我必须将测试库目标上的编译选项设置为 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)

进行这些更改后，我的测试可执行文件都按预期运行。

用于编译测试的 CMake 和 CMocka 标准断言

CMake and CMocka standard assertions for compiling tests

c

unit-testing

cmake

cmocka