将枚举类与 Boost 测试一起使用

Question

我有一个想在单元测试中使用的枚举类：

enum class MyEnumClass
{
    MyEntryA,
    MyEntryB
};

我想如下使用它：

MyEnumClass myEnumValue = MyEnumClass::MyEntryA;
BOOST_CHECK_EQUAL(myEnumValue, MyEnumClass::MyEntryB);

但是我得到了这个错误，显然是因为 boost test 正在尝试输出值：

include/boost/test/test_tools.hpp:326:14: error: cannot bind 'std::ostream {aka std::basic_ostream<char>}' lvalue to 'std::basic_ostream<char>&&'
         ostr << t; // by default print the value
              ^

添加丑陋的static_cast“解决”了问题：

BOOST_CHECK_EQUAL(static_cast<int>(myEnumValue), static_cast<int>(MyEnumClass::MyEntryB));

但我想避免对每个枚举类都这样做。我还想避免为每个枚举类定义 << 流运算符。

有没有更简单的方法来使用枚举类和 boost 测试？

或者其他单元测试框架有更好的方法来处理枚举类？

Answer 1

另一种解决方案是使用BOOST_CHECK(myEnumValue == MyEnumClass::MyEntryB)，而不是BOOST_CHECK_EQUAL。这对我有用，我假设对于简单的真/假检查，boost 不需要打印出枚举类。

Answer 2

您可以使用BOOST_TEST_DONT_PRINT_LOG_VALUE() 禁用相关类型的打印。来自Boost docs：

typedef std::pair<int,float> pair_type;

BOOST_TEST_DONT_PRINT_LOG_VALUE( pair_type )

在这种情况下，如果您得到不匹配，测试错误消息会告诉您，但不会打印实际的不同值。

Answer 3

问题在于 Boost.Test 必须打印值以防它们不相等，并且它在流上使用 operator<< 来做到这一点。

在这种情况下，没有比在std::ostream 上简单定义operator<< 或将static_cast 定义为int 更简洁的方法了，我可以看到。

另一方面，像 Catch 这样的库没有这个要求，他们可能使用一些宏魔法来完成它。

Answer 4

解决方案：

enum class MyEnumClass {
  MyEntryA,
  MyEntryB
};

MyEnumClass myEnumValue = MyEnumClass::MyEntryA;
BOOST_TEST((myEnumValue == MyEnumClass::MyEntryA)); // Note extra pair of brackets
BOOST_TEST((myEnumValue == MyEnumClass::MyEntryB)); // Note extra pair of brackets

结果：

info: check (myEnumValue == MyEnumClass::MyEntryA) has passed
error: in "Suite/Test": check (myEnumValue == MyEnumClass::MyEntryB) has failed

详情：

1. 使用 BOOST_TEST() 作为测试通用宏 (Assertion Boost Test Universal Macro)：

   • BOOST_TEST // 或 BOOST_TEST_CHECK
   • BOOST_TEST_REQUIRE
   • BOOST_TEST_WARN

2. 似乎应该将作用域枚举（枚举类）添加到需要一对额外括号的Limitations and workaround。

Answer 5

这是我的解决方案（很简单）

将其添加到测试文件的顶部

#define CHECK_ENUM_CLASS_EQUAL(L, R) BOOST_CHECK_EQUAL(static_cast<int>(L), static_cast<int>(R))

例子：

CHECK_ENUM_CLASS_EQUAL(a, MyEnumClass::MyEntryA);