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

Question

我有一个小的静态库项目，我正在重写这个项目，从用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

我已经能够获得在调试模式(其中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也成功编译和链接，但是当我运行它时，测试失败了，出现了分段错误，就好像我的自定义断言从未被调用过一样(函数试图取消引用我故意给它的NULL指针来触发断言)。我有理由相信，与cmocka本身没有关联问题，因为在cmocka的高级命令行输出格式中运行测试结果。

在我最初的面向makefile的构建中，所有的测试可执行目标都会编译一个特殊的“测试”库目标，测试可执行文件链接到这个库目标，所有断言都会像我预期的那样被cmocka正确地拦截。但是，在这种情况下，我编译的静态库似乎没有定义LIBRARY_DEBUG或LIBRARY_TESTING --分段错误就证明了这一点。

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

如何确保使用特定(一组)编译选项编译我的静态库(这里是-DBASIC_TESTING**)，以确保它触发的自定义断言可以用进行测试？**)

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)

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