c - 为 C 代码编写单元测试

Question

我是一名 C++ 开发人员，当涉及到测试时，通过注入(inject)依赖项、覆盖成员函数等方式很容易测试类，因此您可以轻松地测试边缘情况。然而，在 C 中，您不能使用那些美妙的特性。由于 C 代码的一些“标准”编写方式，我发现很难将单元测试添加到代码中。解决以下问题的最佳方法是什么:

传递一个大的“上下文”结构指针:

void some_func( global_context_t *ctx, .... )
{
  /* lots of code, depending on the state of context */
}

没有简单的方法来测试依赖函数的失败:

void some_func( .... )
{
  if (!get_network_state() && !some_other_func()) {
    do_something_func();
    ....
  }
  ...
}

有很多参数的函数:

void some_func( global_context_t *, int i, int j, other_struct_t *t, out_param_t **out, ...)
{
  /* hundreds and hundreds of lines of code */
}

静态或隐藏函数:

static void foo( ... )
{
  /* some code */
} 

void some_public_func( ... }
{
  /* call static functions */
  foo( ... );
}

Answer 1

总的来说，我同意 Wes 的回答 - 将测试添加到没有考虑测试的代码中会更加困难。 C 中没有任何内在的东西使其无法测试 - 但是，由于 C 不会强制您以特定的风格编写，因此编写难以测试的 C 代码也非常容易。

在我看来，在编写代码时考虑到测试会鼓励使用更短的函数和更少的参数，这有助于减轻示例中的一些痛苦。

首先，您需要选择一个单元测试框架。 this question里面有很多例子(虽然遗憾的是很多答案都是 C++ 框架——我建议不要使用 C++ 来测试 C)。

我个人使用TestDept ，因为它使用简单，重量轻，并且允许 stub 。但是，我认为它还没有被广泛使用。如果你正在寻找一个更流行的框架，很多人推荐Check - 如果您使用 automake，那就太好了。

以下是针对您的用例的一些具体答案:

Passing around a large 'context' struct pointer

对于这种情况，您可以在手动设置前提条件的情况下构建结构的实例，然后在函数运行后检查结构的状态。使用短函数，每个测试都将相当简单。

No easy way to test failure on dependent functions

我认为这是单元测试 C 的最大障碍之一。我已经成功使用 TestDept ，它允许依赖函数的运行时 stub 。这对于分解紧密耦合的代码非常有用。这是他们文档中的示例:

void test_stringify_cannot_malloc_returns_sane_result() {
  replace_function(&malloc, &always_failing_malloc);
  char *h = stringify('h');
  assert_string_equals("cannot_stringify", h);
}

根据您的目标环境，这可能适合您，也可能不适合您。参见 their documentation了解更多详情。

Functions with lots of parameters

这可能不是您正在寻找的答案，但我会将它们分解为参数较少的较小函数。测试起来容易得多。

Static or hidden functions

它不是 super 干净，但我通过直接包含源文件来测试静态函数，启用静态函数的调用。与 TestDept 相结合以清除任何未测试的内容，效果相当好。

 #include "implementation.c"

 /* Now I can call foo(), defined static in implementation.c */

---

许多 C 代码是遗留代码，测试很少 - 在这些情况下，添加首先测试大部分代码的集成测试通常比细粒度的单元测试更容易。这使您可以开始将集成测试下的代码重构为单元可测试状态——尽管它可能值得或可能不值得投资，具体取决于您的情况。当然，您会希望能够向在此期间编写的任何新代码添加单元测试，因此尽早启动并运行可靠的框架是个好主意。

如果您正在使用遗留代码，this book (Michael Feathers 的有效处理遗留代码)是很好的进一步阅读。