如何为第三方遗留代码创建测试对象

Question

我有一个代码库，其中我实现的许多类都派生自公司其他部门提供的类。 与这些其他部门合作通常具有工作关系，就好像他们是第三方中间件供应商一样。

我正在尝试编写测试代码而不修改这些基类。 然而，创建有意义的测试存在问题 由于缺乏接口而导致对象：

//ACommonClass.h
#include "globalthermonuclearwar.h" //which contains deep #include dependencies...
#include "tictactoe.h" //...and need to exist at compile time to get into test...

class Something //which may or may not inherit from another class similar to this...
{
public:
  virtual void fxn1(void);  //which often calls into many other classes, similar to this
  //...
  int data1;  //will be the only thing I can test against, but is often meaningless without fxn1 implemented
  //...
};

我通常会提取一个接口并从那里工作，但由于这些是“第三方”，我无法提交这些更改。

目前，我已经创建了一个单独的文件，其中包含第三方提供的基类标头中定义的函数的虚假实现，这些函数是根据需要了解的，如“使用遗留代码”一书中所述。

我的计划是继续使用这些定义并为我需要的每个第三方类提供替代测试实现：

//SomethingRequiredImplementations.cpp
#include "ACommonClass.h"
void CGlobalThermoNuclearWar::Simulate(void) {};  // fake this and all other required functions...
// fake implementations for otherwise undefined functions in globalthermonuclearwar.h's #include files...
void Something::fxn1(void) { data1 = blah(); } //test specific functionality.

但在我开始这样做之前，我想知道是否有人尝试在与我类似的代码库上提供实际对象，这将允许创建新的测试特定类来代替实际的第三方类。

请注意，所有相关代码库都是用 C++ 编写的。

Answer 1

模拟对象适合此类任务。 它们允许您模拟其他组件的存在，而无需它们存在。 您只需在测试中定义预期的输入和输出。

Google 有一个很好的 C++ 模拟框架。

Answer 2

我现在遇到了一个非常类似的问题。 我不想添加一堆仅用于测试目的的接口，因此我无法使用任何现有的模拟对象库。 为了解决这个问题，我做了同样的事情，创建一个具有虚假实现的不同文件，并让我的测试链接虚假行为，而生产代码链接真实行为。

我希望此时能做的是获取另一个模拟框架的内部结构，并在我的假对象中使用它。 看起来有点像这样：

Production.h

class ConcreteProductionClass { // regular everyday class
protected:
    ConcreteProductionClass(); // I've found the 0 arg constructor useful
public:
    void regularFunction(); // regular function that I want to mock
}

Mock.h

class MockProductionClass 
    : public ConcreteProductionClass
    , public ClassThatLetsMeSetExpectations 
{
    friend class ConcreteProductionClass;
    MockTypes membersNeededToSetExpectations;
public:
    MockClass() : ConcreteProductionClass() {}
}

ConcreteProductionClass::regularFunction() {
    membersNeededToSetExpectations.PassOrFailTheTest();
}

ProductionCode.cpp

void doSomething(ConcreteProductionClass c) {
    c.regularFunction();
}

Test.cpp

TEST(myTest) {
    MockProductionClass m;
    m.SetExpectationsAndReturnValues();
    doSomething(m);
    ASSERT(m.verify());
}

它 这一切中最痛苦的部分是其他模拟框架与此非常接近，但没有完全做到这一点，并且宏是如此复杂，以至于适应它们并不简单。 我已经开始在业余时间研究这个问题，但进展并不很快。 即使我让我的方法按照我想要的方式工作，并且已经设置了期望设置代码，这种方法仍然有一些缺点，其中之一是，如果您必须链接到，您的构建命令可能会有点长很多 .o 文件而不是一个 .a，但这是可以管理的。 也不可能落入默认实现，因为我们没有链接它。 不管怎样，我知道这并不能回答问题，或者甚至不能告诉你任何你不知道的事情，但它显示了 C++ 社区距离模拟没有纯虚拟接口的类有多近。

Answer 3

您可能需要考虑mocking而不是伪装作为潜在的解决方案。 在某些情况下，如果原始类不是可模拟的，您可能需要编写可模拟的包装类。 我已经使用 C#/.Net 中的框架类完成了此操作，但没有使用 C++，所以 YMMV。

Answer 4

如果我有一个需要测试的类，该类派生自我无法（或不想）在测试下运行的类，我将：

1. 创建一个新的纯逻辑类。
2. 将 code-i-wanna-test 移至逻辑类。
3. 使用接口与真实的类进行对话，以与基类和/或我不能或不会放入逻辑中的东西进行交互。
4. 使用相同的接口定义一个测试类。 这个测试类除了 noop 或模拟真实类的奇特代码之外什么都没有。

如果我有一个只需要在测试中使用的类，但使用真实的类是一个问题（依赖项或不需要的行为）：

1. 我将定义一个新接口，它看起来像我需要调用的所有公共方法。
2. 我将创建支持该接口的对象的模拟版本以进行测试。
3. 我将创建另一个用该类的“真实”版本构造的类。 它也支持该接口。 所有接口调用都转发给真实对象的方法。
4. 我只会对我实际调用的方法执行此操作 - 而不是所有公共方法。 当我编写更多测试时，我将添加到这些类中。

例如，我像这样包装MFC的GDI类来测试Windows GDI绘图代码。 模板可以使这一切变得更容易 - 但我们经常由于各种技术原因而最终不这样做（Windows DLL 类导出的东西......）。

我确信所有这些都在 Feather 的《Working with Legacy Code》一书中 - 而且我所描述的内容都有实际的术语。 只是别让我把书从书架上拿下来......

Answer 5

您在问题中没有指出的一件事是您的类派生自其他部门的基类的原因。 这种关系真的是一种 IS-A 关系吗？

除非您的类需要由框架使用，否则您可以考虑支持委托而不是继承。 然后，您可以使用依赖项注入在单元测试中为您的类提供其类的模拟。

否则，一个想法是编写一个脚本来从它们提供的标头中提取和创建您需要的接口，并将其集成到编译过程中，以便您的单元测试可以签入。