c++ - 如何获取 JUnit 格式的 CMocka 报告？

Question

我能够使用 cmocka 并在屏幕上获得默认结果。我想获得 JUnit 格式的单元测试结果。

CMocka 通过使用环境变量 CMOCKA_MESSAGE_OUTPUT 或使用 API cmocka_set_message_output(CM_OUTPUT_XML);

支持 JUnit 格式

但仍然没有生成 xml 文件。谁能帮忙获得 JUnit 格式的结果？

Answer 1

最可靠的来源实际上是包含整个框架实现的cmocka.c 源文件。这个文件不是太大，所以我将引用源文件版本 1.0.1 中的一些内容。

cmocka 生成 XML 输出有两个条件，第三个条件是将输出存储在文件中。

<强>1。仅当 cmocka_run_group_tests()

调用测试时才能生成 XML 输出

可自定义的输出格式只能从测试运行器 cmocka_run_group_tests() 或其完整变体 cmocka_run_group_tests_name() 获得。

没有其他途径可以导致 XML 输出。如果单个测试由 run_test() 启动，则输出不能是 XML。

摘要格式

[  PASSED  ] 0 test(s).
[  FAILED  ] 1 test(s), listed below:

可以在以下可能的情况之一中生成:

• 测试由已弃用的测试运行程序之一启动:run_tests()、_run_tests() 或 run_group_tests()、_run_group_tests();在这种情况下，甚至可以看到有关使用已弃用函数的编译警告；
• 测试由 cmocka_run_group_tests() 开始，输出格式为 CM_OUTPUT_STDOUT。

<强>2。 cmocka 消息输出应设置为 CM_OUTPUT_XML

在运行测试之前，可以通过调用 cmocka_set_message_output(CM_OUTPUT_XML) 来设置默认输出格式。然而，即使在测试源中设置了这样的默认值，它也可以被环境变量 CMOCKA_MESSAGE_OUTPUT 覆盖。该变量的优先级高于 cmocka_set_message_output() 设置的默认值。

CMOCKA_MESSAGE_OUTPUT 的值不区分大小写。如果变量等于以下值之一，则考虑该变量:stdout、subunit、tab 或 xml.

因此，如果环境变量的值为 stdout，则函数 mocka_set_message_output() 无效。

该变量可用于强制已编译二进制文件的不同输出格式:

CMOCKA_MESSAGE_OUTPUT=stdout ./nulltest
CMOCKA_MESSAGE_OUTPUT=subunit ./nulltest
CMOCKA_MESSAGE_OUTPUT=tap ./nulltest
CMOCKA_MESSAGE_OUTPUT=xml ./nulltest

因此，如果测试由 cmocka_run_group_tests() 启动，但输出不受 mocka_set_message_output() 影响，则意味着存在设置变量 CMOKA_MESSAGE_OUTPUT= shell 中的标准输出。

<强>3。应该可以通过 cmocka 创建一个新文件，将其 XML 输出直接写入该文件

如果前面两个条件都满足，则可以要求 cmocka 将其 XML 输出直接写入文件。如果设置了环境变量 CMOCKA_XML_FILE，则 cmocka 将尝试将 XML 写入具有该变量值名称的文件。

使用示例:

CMOCKA_XML_FILE='./out.xml' CMOCKA_MESSAGE_OUTPUT=xml ./nulltest

文件被写入如果:

• 该名称的文件不存在；
• 可以创建这样的文件。

因此，如果在一个已编译的二进制测试应用程序中有多个测试运行程序，则只有第一个运行程序可以将其输出写入该文件。

即使设置了 CMOCKA_XML_FILE，输出也会写入 shell，但文件已经存在或无法创建。

当然，可以将 shell 输出重定向到一个文件，覆盖现有文件或附加到现有文件(如果存在这样的文件)。

下面的示例可用于检查不同的输出选项。可以通过命令构建

gcc -g nulltest.c -o nulltest -Ipath_to_cmocka_headers -Lpath_to_cmocka_library_binary -lcmocka

nulltest.c

#include <stdarg.h>
#include <stddef.h>
#include <setjmp.h>
#include <cmocka.h>

/* A test case that fails. */
static void null_test_failed(void **state) {
    (void) state; /* unused */
    assert_int_equal(0, 1);
}

int main(void) {
    const struct CMUnitTest tests[] = {
        cmocka_unit_test(null_test_failed),
    };
    const struct UnitTest tests_deprecated[] = {
        unit_test(null_test_failed),
    };

    cmocka_set_message_output(CM_OUTPUT_XML);

    /* group test functions that use customizable output format */
    cmocka_run_group_tests(tests, NULL, NULL);
    cmocka_run_group_tests_name("custom group name", tests, NULL, NULL);

    /* run single test with standard output */
    run_test(null_test_failed);

    /* DEPRECATED TEST RUNNER functions that can give only standard output */
    run_tests(tests_deprecated);
    _run_tests(tests_deprecated, 1);
    run_group_tests(tests_deprecated);
    _run_group_tests(tests_deprecated, 1);

    return 0;
}