c ++ gtest在测试结束时打印附加信息,当且仅当测试失败时

时间:2016-12-07 20:38:24

标签: c++ assert googletest assertions expectations

我想这样想:

TEST(MyTestFixture, printAfterExpectationFailure)
{
  const string request("bring me tea");

  const string&& response = sendRequestAndGetResponse(request);

  checkResponseWithExpectarions1(response);
  checkResponseWithExpectarions2(response);
  checkResponseWithExpectarions3(response);
  checkResponseWithExpectarions4(response);

  if (anyOfExpectsFailed())
      cout << "Request: " << request << "\nresponse: " << response << endl;
}

TEST(MyTestFixture, printAfterAssertionFailure)
{
  const string request("bring me tea");

  const string&& response = sendRequestAndGetResponse(request);

  doWhenFailure([&request, &response]()
  {
      cout << "Request: " << request << "\nresponse: " << response << endl;
  });

  checkResponseWithAssertion1(response);
  checkResponseWithAssertion2(response);
  checkResponseWithAssertion3(response);
  checkResponseWithAssertion4(response);
}

当且仅当期望/断言失败时,我想打印一些额外的信息。

我知道我可以这样做:

#define MY_ASSERT_EQ(lhr, rhs, message) if(lhs != rhs) ASSERT_EQ(lhs, rhs) << message

但是这种解决方案并不舒服,因为:

  1. 我检查了两次
  2. 我使用预处理器,因此可能需要一些时间才能找到 错误。
  3. 当函数真正嵌套时,解决方案很难使用。
  4. 当许多EXPECT失败时,它会多次打印消息。
  5. 为所有类型的检查重新定义宏是必要的

2 个答案:

答案 0 :(得分:4)

事实上,做你想做的事情很难实际上是一个考验code smell。特别是,这两个测试(1)做得太多,(2)是不可读的,因为它们没有描述被测单元的作用。

我建议使用两个读数:Unit Tests are FIRST和书籍Modern C++ Programming with Test-Driven Development

我没有尝试调用4个函数,每个函数检查一些内容,然后想知道如何在出现故障时打印错误消息,我建议如下:

  • 问问自己:&#34;我在这里测试的是什么?&#34;得到答案后,请使用答案为测试命名。如果你找不到答案,那就意味着(我怀疑)测试做得太多了。尝试遵循&#34;每个测试一个断言&#34;指南并相应地拆分测试。
  • 以同样的精神,看看这4个函数中的每一个,并尝试给每个函数命名。如果你不能,每个功能都检查太多。拆分这些功能。
  • 问问自己是否真的需要期望(而不是断言)。通常,获得EXPECT而不是ASSERT的唯一原因是因为单个测试做得太多。拆分它。

在此过程结束时,您应该发现自己的目标是打印有关测试失败的其他信息,只需使用以下内容:

ASSERT_THAT(Response, EQ("something")) << "Request: " << request;

注意:如果起点更好,我也不要认为上面的例子足够好。测试名称应该非常好,具有描述性,通过打印request的值可以获得零信息。

我意识到这是一种哲学的答案;另一方面,它直接来自我尝试编写良好,可维护测试的经验。编写好的测试需要比编写好的代码一样谨慎,并且会多次付出代价: - )

答案 1 :(得分:1)

一个非意识形态的答案(基于来自各地的信息):

QDebugTest.h

class QDebugTest : public ::testing::Test
{
public:
    void SetUp() override;
    void TearDown() override;
};

QDebugTest.cpp

static std::ostringstream qdebugString;

static void myMessageOutput(QtMsgType type, const QMessageLogContext &context, const QString &msg) {
    switch (type) {
        case QtDebugMsg:    qdebugString << "qDebug";    break;
        case QtInfoMsg:     qdebugString << "qInfo";     break;
        case QtWarningMsg:  qdebugString << "qWarning";  break;
        case QtCriticalMsg: qdebugString << "qCritical"; break;
        case QtFatalMsg:    qdebugString << "qFatal";    break;
    }
    if (context.file) {
        qdebugString << " (" << context.file << ":" << context.line ;
    }
    if (context.function) {
        qdebugString << " " << context.function;
    }
    if(context.file || context.function) {
        qdebugString << ")";
    }
    qdebugString << ": ";
    qdebugString << msg.toLocal8Bit().constData();
    qdebugString << "\n";
}

void QDebugTest::SetUp()
{
    assert(qdebugString.str().empty());
    qInstallMessageHandler(myMessageOutput);
}

void QDebugTest::TearDown()
{
    qInstallMessageHandler(0);
    if(!qdebugString.str().empty()) {
        const ::testing::TestInfo* const test_info = ::testing::UnitTest::GetInstance()->current_test_info();
        if (test_info->result()->Failed()) {
            std::cout << std::endl << qdebugString.str();
        }
        qdebugString.clear();
    }
}

现在从 QDebugTest 而不是 ::testing::Test 派生您的 Fixture-class。