Header 中没有函数的单元测试 C

Question

我开始进行单元测试，但我在理解某些东西时遇到了困难。我的挣扎归结为我将如何测试仅在 .c 源中而不是在 .h header 中声明的函数。有些函数不需要在实现之外调用，因为它们只与特定文件相关。由于它们对程序的其他部分不可见，这意味着我的单元测试用例文件看不到这些内部函数，因此我无法测试它们。我已经通过在测试用例文件中使用前向声明解决了这个问题，但这看起来有点混乱，如果我修改函数参数，改变起来会很痛苦。

这些功能是不是不应该被单元测试覆盖？我读过 OOP，你不应该测试私有函数，因为它们是通过 public 函数隐式测试的，但是不覆盖这些函数感觉不舒服（其中一些可能会变得非常复杂） .

Answer 1

黑盒测试是关于测试 public 可见界面与用户之间的软件契约。为了对此进行测试，人们通常使用工具或单独的测试程序创建一组测试用例，#include 是您的 header 文件 .h，它定义了您的外部接口。听起来你已经有了这个。太棒了！

缺少的是白盒测试的概念。对于电信、铁路、航空航天或任何其他需要高度保证高可用性和质量的行业，这与黑盒测试一样重要。

对于白盒测试，创建一个单独的 "private" 接口，仅供您的白盒测试程序使用。请注意，在 C 中，您可以为给定的 C 实现文件创建多个 header 文件。从编译器的角度来看，没有真正强制执行 header 的数量或它们的名称。最好遵守您的项目或团队规定的约定。

对于我们的项目，我们为我们的外部接口创建了一个 public header（带有一个简单的 .h 后缀），并为私有的 header (_pi.h)我们的私有接口面向 select 少数需要访问私有接口的人，例如白盒测试、审计数据结构、内部配置和诊断以及调试工具。当然，_pi.h后缀只是约定俗成，但在实践中效果很好。

白盒测试对于测试您的内部功能和数据结构非常有用，并且可以远远超出黑盒测试的限制。例如，我们使用白盒测试用例来测试内部接口，看看当我们的数据结构被破坏时会发生什么，以及测试当内部传递一个意外的参数值时我们的代码做了什么。

例如，假设我们有一个名为 foo.c 的文件，我们希望对其执行白盒测试。然后我们将创建两个 header：foo.h 和 foo_pi.h 分别用于外部和内部用户。

文件foo.h

#ifndef FOO_H
#define FOO_H

typedef int FooType;

// Public header for Foo
void Foo(FooType fooVal);
void Bar(void);

#endif

文件 foo_pi.h

#ifndef FOO_PI_H
#define FOO_PI_H

// PI should also include the public interface
#include "foo.h"

// Private header for Foo
// Called by White Box test tool 
void FooBar_Test1(FooType fooVal);
void Foo_Internal(void);
void Bar_Internal(void);

#endif

文件foo.c

#include "foo.h"
#include "foo_pi.h"
// Notice you need to include both headers

// Define internal helpers here
static FooType myFooVal = 0; 
void FooBar_Test1(FooType fooVal) {myFooVal = fooVal;}

void Foo_Internal() {Bar_Internal();}
void Bar_Internal(void) {myFooVal++;}      


// Define external interfaces after the helpers
void Foo(FooType fooVal) {myFooVal = fooVal; Foo_Internal();}
void Bar(void)           {Bar_Internal();}

// Main() not typically included 
// if this is just one module of a bigger project!
int main(int argc, char** argv)
{
 Foo(argc);
}

如果您对所有这些 #ifndef/#define/#endif 的东西感到困惑，这些是 CPP 宏，这种用法在 C 中没有强制执行，但是这是一个广泛使用的约定。有关详细信息，请参阅 https://whosebug.com/a/42744341/6693299

虽然我没有在上面的示例中显示它，但 Foobar_test() 例程（以及任何其他内部测试方法，通常会放置在为内部测试功能保留的单独模块中。然后他们可以从最终产品中打包出来。连同一些我不会在这里描述的花哨的 CPP 预处理，你可以 conditionally-compile 出私有 headers 和测试函数，并使接口安全生产负载（白盒测试完成后）。但这可能太详细了！

Answer 2

@ScottK 对黑盒与白盒测试的描述很有用。我的白盒测试方法不同。

根据项目结构，我要么

将单元测试与被测单元放在同一个文件中，通常在文件末尾，都在 #if UNIT_TEST ... #endif
#include单元测试代码中被测C文件；这提供了对所有内部功能的访问，而无需对原始源代码进行任何更改

Header 中没有函数的单元测试 C

Unit Testing C With Functions Not in Header

c

unit-testing

automated-tests

private