您如何使用 FFF 和 Google 测试在 C/C++ 中模拟和测试相同的功能？

Question

我正在探索 TDD（测试驱动开发）来测试我用 C 和 C++ 编写的代码。我选择使用 Google Test 作为单元测试框架。我选择使用 FFF 作为模拟框架。

我写了一些测试运行它们，效果很好。但是我遇到了一个问题，我无法在网上找到任何参考资料，我希望社区能帮助我（这也会帮助其他人）。

我遇到的问题是我想为函数 A1 编写一个测试（参见下面的场景 1）。因为它调用了另外三个函数（B1、B2 和 B3）并且它们有很多依赖关系，所以我决定模拟它们以便测试可能影响函数 A1 行为的各种场景。为了让模拟工作并避免链接器错误（例如“B1 的多重定义”），我需要在函数 (B1, B2) 之前写“attribute((weak))”和 B3)。到目前为止，一切都很好。一切都很好。

现在，考虑下面的场景 2。在这种情况下，我想在单独的测试中测试功能 B1。同样，我也会模拟它调用的函数（C1、C2、C3）。但是，问题是我无法调用“真正的”B1 函数，因为如果我这样做，我将获得我之前在测试 A1 函数（在场景 1 下）中定义的模拟函数。

遇到这种情况怎么办？谢谢

Answer 1

我在 James Grenning 的书中做了一些挖掘和挖掘“Test Driven Development for Embedded C”至少有两个解决这个问题的方法。

Link-time 替换
函数指针替换

Link-time 替换:

此选项的一般摘要：
总的来说，这似乎不太容易实施和遵循，并且需要一些学习曲线。然而，好的一面是您不需要更改生产代码中的任何内容，这一点非常重要。

在这种情况下，您需要使用 makefile 来执行以下步骤：

将生产代码构建到库中
一定要将您的测试分成不同的文件，以便需要使用某个函数作为模拟的测试与需要使用同一函数的原始实现的测试分开。
使用 make 文件，您需要对部分代码进行微构建，最后将它们组合在一起。例如，对于一个特定的函数，您希望在不同的测试中同时模拟和使用原始实现，例如，两个文件（test1.cpp 包含 mock func A1 的实现和 test2.cpp 包含函数 A1 的原始实现）你将做：

首先，构建 test1.cpp 和生产代码库，但不包含 test2.cpp。模拟函数将在 link 时间内优先。
其次，将 test2.cpp 与生产代码库一起构建，但不包含 test1.cpp。函数 A1 库中的原始实现将在 link 时间内优先（因为它是那里唯一的实现）。
将一起创建的两个二进制文件合并为一个可执行文件。

现在这三个步骤只是一个high-level解释。我知道这并不理想，但它仍然值得。我承认我自己没有这样做，但我确实读过 James Grenning 的书，如果你愿意，他在他书中的附录 1（标题为开发系统测试环境）中更详细地解释了它，你可能会看到 makefile 结构他在 book-code-example 中使用了：https://pragprog.com/titles/jgade/test-driven-development-for-embedded-c/

函数指针替换:

此选项的一般摘要：
这更加直观且易于实现。但是，缺点是它需要对声明和定义函数的生产代码进行细微更改。

假设您要模拟一个名为 A1 的函数，该函数在 Production.c 文件中定义为：

//Production.c    
int A1(void)
{
  ... original implementation written here
}

在Production.h中声明为：

//Production.h    
int A1(void);

因此您可以这样更改函数声明和定义：

//Production.c    
int A1_original(void)
{
  ... original implementation written here
}

int (*A1)(void) = A1_original;

在Production.h中声明为：

//Production.h    
extern int (*A1)(void);

#ifdef TDD_ENABLED // use ifdef with TDD_ENABLED which is defined only in unit test project. This is because you want to declare the original implementation function as a public function so that you can freely assign it to the function pointer A1 in the test files.
    int A1_original(void);
#endif

现在，对于要在其中使用原始函数实现的每个测试，只需按照更改前的方式调用它即可：

A1();

如您所见，这也意味着，在整个生产代码中，您无需更改调用函数的方式。您的测试文件也是如此。

现在，如果您想为此功能使用模拟，只需执行以下操作：

//Test1.cpp
int Fake_A1(void)
{
   ... fake function implementation
}

TEST(test_group_name,test_name)
{
    int (*temp_holder)(void) = A1;  // hold the original pointer in a temp pointer
    A1 = Fake_A1;      // assign A1 to call the mock function 

    ... run all the test here

   A1 = temp_holder; // assign A1 to call the original function back again so that the mock function is used only in the scope of this test
}

理想情况下，如果您打算进行多个此类测试，您可以在将 class 与 Setup() 和 Teardown() 一起使用时将分配给模拟并重新分配给原始函数使用这样的测试夹具 (TEST_F)：

//Test1.cpp
class A1_Func_Test : public ::testing::Test
{
protected:
    int (*temp_holder)(void) = A1;  // hold the original pointer in a temp pointer
    virtual void SetUp()
    {
        A1 = Fake_A1;  // assign A1 to call the mock function
    }

    virtual void TearDown()
    {
        A1 = temp_holder; // assign A1 to call the original function back again so that the mock function exists only in the scope of this test
    }
};

TEST_F(A1_Func_Test , Test1_A1)
{
    write tests here...
}

TEST_F(A1_Func_Test , Test2_A1)
{
    write tests here...
}

如何使用 FFF Mock 框架实现函数指针替换：

按照上面的说明进行操作后，应对您的生产代码文件（Production.c 和 Production.h）进行相同的更改。然而，对于你的单元测试文件，如果你想模拟函数，你只需执行以下操作（如果你想测试函数而不模拟它，那么只需定期调用它）：

//Test1.cpp
//Using FFF Mocking framework:

DEFINE_FFF_GLOBALS;
FAKE_VALUE_FUNC(int, A1_mock);

int A1_custom(void)
{
   write code here for mock function implementation...
}

TEST(test_group_name,test_name)
{
    int (*temp_holder)(void) = A1;  // hold the original pointer in a temp pointer
    // setting customized mock function for this test
    A1_mock_fake.custom_fake = A1_custom;
    A1 = A1_mock;

    // simple example of a test using the the FFF framework:
    int x;
    x = A1();
    ASSERT_EQ(A1_mock_fake.call_count, 1);

    // assign A1 to call the original function back again so that the mock function exists only in the scope of this test
    A1 = temp_holder;
    RESET_FAKE(A1_mock); // reset all parameters of the mock function used so when used in a subsequent test we will start "clean"
}

总结

我相信这回答了关于如何着手做我所问的问题。

您如何使用 FFF 和 Google 测试在 C/C++ 中模拟和测试相同的功能？

How do you mock and test the same function in C/C++ with FFF and Google Test?

c++

unit-testing

mocking

googletest

fake-function-framework

Link-time 替换:

函数指针替换:

如何使用 FFF Mock 框架实现函数指针替换：

总结