单元测试访问私有变量

Question

我有一个单元测试类Tester；我希望它访问 Working 类的私有字段。

class Working {
    // ...
    private:
    int m_variable;
};

class Tester {
    void testVariable() {
        Working w;
        test( w.m_variable );
    }
}

我有以下选择：

• 使 m_variable public - 丑陋
• 制作方法test_getVariable() - 过于复杂
• 将 friend class Tester 添加到 Working - 然后 Working 明确地“了解”测试人员，这不好

我的理想是

class Working {
    // ...
    private:
    int m_variable;

    friend class TestBase;
};

class TestBase {};

class Tester : public TestBase {
    void testVariable() {
        Working w;
        test( w.m_variable );
    }
}

Working 知道 TestBase 但不是每个测试...但它不起作用。显然，友谊不适用于继承。

这里最优雅的解决方案是什么？

Answer 1

-fno-access-control

如果您只使用 GCC，则可以在编译单元测试时使用编译器选项 -fno-access-control。这将导致 GCC 跳过所有访问检查，但仍保持类布局相同。我不知道其他编译器是否有类似的选项，所以这不是一个通用的解决方案。

Answer 2

我同意Trott's answer，但有时您会将单元测试添加到不是为它设计的遗留代码中。在这些情况下，我会联系#define private public。它只是在单元测试中，它只是用于重构太昂贵而无法打扰的时候。这很丑陋，在技术上是非法的，而且非常有效。

Answer 3

通常，您的单元测试不应评估私有变量。将测试写入接口，而不是实现。

如果您确实需要检查私有变量是否具有特定特征，请考虑使用assert()，而不是尝试为其编写单元测试。

https://stackoverflow.com/a/1093481/436641 有一个更长的答案（为 C# 而不是 C++ 编写，但适用相同的原则）。

Answer 4

努力使用您的公共接口测试您的所有私有代码。不仅最初的工作量较少，而且当您更改实现时，单元测试仍然有效的可能性要高得多。

也就是说，有时您只需要戳内部结构即可获得良好的测试覆盖率。在这种情况下，我使用了一个称为expose 的成语。仔细想想，里面有一个笑话。

需要测试的Foo类

class Foo
{
public:
   // everyone is on their honor to only use Test for unit testing.
   // Technically someone could use this for other purposes, but if you have
   // coders purposely doing bad thing you have bigger problems.
   class Test;

   void baz( void );

private:
   int m_int;
   void bar( void );
};

foo_exposed.h 仅适用于单元测试代码。

class Foo::Test : public Foo
{
public:
   // NOTE baz isn't listed

   // also note that I don't need to duplicate the
   // types / signatures of the private data.  I just
   // need to use the name which is fairly minimal.

   // When i do this I don't list every private variable here.
   // I only add them as I need them in an actual unit test, YAGNI.

   using Foo::m_int;
   using Foo::bar;
};


// yes I'm purposely const smashing here.
// The truth is sometimes you need to get around const
// just like you need to get around private

inline Foo::Test& expose( const Foo& foo )
{
   return * reinterpret_cast<Foo::Test*>(
         &const_cast<Foo::Test&>( foo )
      );
}

如何在单元测试代码中使用它

#include "foo_exposed.hpp"

void test_case()
{
   const Foo foo;

   // dangerous as hell, but this is a unit test, we do crazy things
   expose(foo).m_int = 20;
   expose(foo).baz();
}

Answer 5

如果您绝对必须这样做，您可以有条件地编译您的代码，以便 TestBase 仅在单元测试时成为朋友：

class Working {
    // ...
    private:
    int m_variable;

#ifdef UNIT_TESTING
    friend class TestBase;
#endif
};

Answer 6

我通过在测试中使用缺少“私有”访问说明符的类头文件的副本来做到这一点。该副本由 test 目录中的 makefile 生成，以便在原始更改时重新生成副本：

 perl -ne 'print unless m/private:/;' < ../include/class_header.h > mock_class_header.h

而“测试”的 make 目标取决于 mock_class_header.h。

这将授予对测试中所有私有成员变量的访问权限，即使在编译真实库时这些成员变量是私有的。