单元测试 C 生成 python 代码

Question

我有一个项目，其中包含一些（相当简单的）C 代码生成作为构建系统的一部分。本质上，我有一些与项目（嵌入式 C）相关的版本信息，我想在我的二进制文件中公开这些信息，以便我可以轻松地确定为特定设备编程的固件版本以进行调试。

我正在编写一些简单的 Python 工具来执行此操作，并且我想确保它们经过彻底的测试。一般来说，这相当简单，但我不确定代码生成部分的最佳策略是什么。本质上，我想确保生成的文件都：

• 语法正确
• 包含必要的信息

第二，我可以（我相信）通过正则表达式匹配达到合理的程度。然而，第一个任务是一项更大的任务。我可能可以使用 pycparser 之类的东西并检查生成的 AST 以实现这两个目标，但这似乎是一个不必要的重量级解决方案。

编辑：我的构建层次结构的数据流程图

Answer 1

感谢您的图表！由于您没有测试覆盖率，如果是我，我只会编译生成的 C 代码并查看它是否有效:)。您没有提及您的工具链，但在类 Unix 环境中，gcc <whatever build flags> -c generated-file.c || echo 'Oops!' 应该足够了。

现在，生成的代码可能不是独立的编译单元。没问题：写一个垫片。示例shim.c：

#include <stdio.h>
#include "generated-file.c"
main() { 
    printf("%s\n", GENERATED_VERSION);  //or whatever is in generated-file.c
}

那么gcc -o shim shim.c && diff <(./shim) "name of a file holding the expected output" || echo 'Oops!'应该会给你一个基本的测试。 （<() 是 bash process substitution。）保存预期结果的文件可能已经在您的 git 存储库中，或者您可以使用 Python 例程将其写入磁盘。

编辑 2 即使您的实际工具链不适合自动化，这种方法也可以工作。要测试代码的语法有效性，即使您为目标处理器使用不同的编译器，也可以使用gcc。例如，使用gcc -ansi 编译将禁用许多GNU 扩展，这意味着使用gcc -ansi 编译的代码比使用完整的GNU 扩展gcc 编译的代码更有可能在另一个编译器上编译。请参阅"C Dialect Options" 上的 gcc 页面，了解您可以使用的所有不同风格 (ditto C++)。

编辑 顺便提一下，GNU autoconf 使用的方法相同：将一个小测试程序写入磁盘（autoconf 将其称为conftest.c），编译它，然后查看编译是否成功。测试程序（最好）是测试一切是否正常所需的最低限度。根据您的 Python 的复杂程度，您可能希望使用各自不同的 shim 测试生成代码的几个不同方面。