我应该让一个成员函数 virtual 只是为了让一个类可测试吗？

Question

我正在编写一个简化版如下所示的课程：

class Http_server {
public:
    void start(int port)
    {
        start_server();
        std::string content_type = extract_content_type(get_request());
    }

private:
    void start_server()
    {
        ...
    }

    std::string get_request()
    {
        ...
    }

    std::string extract_content_type(const std::string& request) const
    {
        ...
    }
};

现在我想为extract_content_type 写一个测试用例。问题是：它是私人的，所以我不能从外面调用它。我可以测试的唯一函数是start，但实际上它会启动服务器 (start_server) 并等待请求 (get_request)。

我怎么看，我有三个选择：

1. 公开extract_content_type
2. 将extract_content_type 提取到实用程序类或命名空间中
3. 将start_server 和get_request 设为虚拟并创建一个模拟对象来覆盖它们

我不想公开任何内容或移动到仅在单个类中使用过一次的实用程序命名空间，因此最不邪恶的是选项 3。

我在 V8 代码库中至少看到过一个这样的例子： http://code.google.com/p/v8/source/browse/trunk/test/cctest/test-date.cc

不过，我不确定这是否是个好主意。 virtual 不是 C++ 中的默认值，原因有两个：

1. 这会导致性能/内存开销（但在我的情况下可能无关紧要）
2. 并非每个类都应该用作基类，使其明确也是设计决策

你会怎么做？与无用的虚拟生活在一起？还是根本不测试功能？我不喜欢 TDD，也不想这样做，但开发像 extract_content_type 这样的函数来测试会更容易。

Answer 1

我可以向您推荐允许您使用私有方法的 API。它被称为 Typemock Isolator++。例如，我创建了一个测试，更改您的 extract_content_type 方法行为，调用它（尽管它是私有的），然后断言：

TEST_METHOD(TestExtractContentType)
    {   
        Http_server* server = new Http_server();

        std::string res ("result");
        PRIVATE_WHEN_CALLED(server, extract_content_type, NULL).Return(&res);

        std::string result;
        ISOLATOR_INVOKE_MEMBER(result, server, extract_content_type, NULL);

        PRIVATE_ASSERT_WAS_CALLED(server, extract_content_type);
        Assert::AreEqual(string("result"), result);
    }

无需更改代码。我刚刚为编译器添加了 ISOLATOR_TESTABLE 标记以确保。

ISOLATOR_TESTABLE std::string extract_content_type(const std::string& request) const 

您可以阅读更多here。在单元测试中处理非公共成员时非常方便。

Answer 2

我同意 Björn 在这一点上的看法。一个类有或没有什么私有功能取决于这个类，调用者不关心。如果您删除该私有方法会发生什么，也就是说您认为提取内容类型并不难，所以您直接在您的start 函数中执行它？好吧，您会破坏测试用例，尽管该类正在按应有的方式工作。私人就是私人！ :)

我的建议是您将extract_content_type 放在一个实用程序类中以进行内容处理，并在您的测试演员中使用该类。然后不需要提供服务器代码来测试这个类。

Answer 3

我可以建议一个不同的选择，但我不确定你是否愿意。

你可以创建一个

#define TESTING_VIRTUAL

这将扩展为 virtual 或任何内容，具体取决于编译时选项。所以如果你正在编译一个测试，你可以将它设置为替换为virtual，如果它是用于生产的，它就不是一个虚拟方法。

如果宏扩展为private 或public，也可能发生同样的情况，具体取决于您是否在测试模式下编译。

Answer 4

答案是您不测试私有函数。理想情况下，您甚至不编写它们，而是通过重构来创建它们（尽管我承认这在实践中非常困难）。

在测试公共/受保护函数时，应隐式测试您的私有函数。如果私有函数的功能没有以这种方式完全断言，那么这意味着该函数所做的事情在类之外没有可见的影响。

这不仅仅是一个 TDD 问题。由于私有函数是一个实现细节，我通常假设我可以在不破坏任何东西的情况下重构它们。如果有一个函数的测试，而我决定重构它的签名，那将不再适用，让我非常困惑。

Answer 5

我想你可能还有其他选择：

让单元测试类成为你要测试的类的朋友

class Foo {
  public:
#ifdef UNITTEST
    friend class FooTest;
#endif
    ...

  protected:
    ...

  private:
    ...
};

这是参考：http://praveen.kumar.in/2008/01/02/how-to-unit-test-c-private-and-protected-member-functions/

Answer 6

如果 extract_content_type 不需要包含在您的 Http_server 类中的任何信息，则它不必属于该类。真的，看起来您需要一个请求本身的类，它可以返回自己的内容类型。然后可以测试该请求类。