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也可以成功编译和链接，但是当我运行它时，测试失败并出现分段错误，就像从未调用过我的自定义声明一样（并且该函数尝试取消引用NULL指针，我故意给它触发了断言）。我有理由相信，与cmocka本身没有任何联系，因为以cmocka的精美命令行输出格式运行测试结果。

在我最初的面向makefile的构建中，所有测试可执行文件目标都将编译一个特殊的“测试”库目标，并且测试可执行文件链接到该库目标，并且所有断言都将被cmocka正确截获。但是，在这种情况下，似乎我编译的静态库的行为好像没有定义 LIBRARY_DEBUG或LIBRARY_TESTING一样-由分段错误证明。 / p>

我对现代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标准断言

1 个答案: