libreoffice-online/test/lokassert.hpp
Ashod Nakashian 82560d9657 wsd: test assertion macros
Because the new-style tests are intrustive,
the exception that CppUnit throws on assertion
failures is caught and processed with the
application logic, which is far from ideal,
because it's very difficult to find the
cause of failure.

What we'd like is a way to control what happens
when an test assertion fails, such that we can
properly log/print the failure, and even break
in the debugger.

The new macros allow us to control the behavior
at compile-time and have added flexibility.
For now, they log an assertion failure before
invoking the CPPUNIT macro, and support a
compile-time directive to assert, which is
useful for breaking in the debugger.

Change-Id: If464ba246e3ec747f31496a4215cb73ef735dfaf
Reviewed-on: https://gerrit.libreoffice.org/c/online/+/87625
Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com>
Reviewed-by: Michael Meeks <michael.meeks@collabora.com>
2020-03-14 15:45:00 +01:00

88 lines
5.3 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDED_ASSERT_HPP
#define INCLUDED_ASSERT_HPP
#include <assert.h>
#include <cppunit/extensions/HelperMacros.h>
inline std::ostream& operator<<(std::ostream& os, const std::vector<char>& v)
{
const size_t size = v.size();
if (size <= 32)
os << std::string(v.data(), size);
else
os << std::string(v.data(), 32) << "...";
return os;
}
#ifdef LOK_ABORT_ON_ASSERTION
#define LOK_ASSERT_IMPL(X) assert(X);
#else
#define LOK_ASSERT_IMPL(X)
#endif //LOK_BREAK_ON_ASSERTION
#define LOK_ASSERT(condition) \
do \
{ \
if (!(condition)) \
{ \
std::cerr << "Assertion failure: " << (#condition) << std::endl; \
LOK_ASSERT_IMPL(condition); \
CPPUNIT_ASSERT(condition); \
} \
} while (false)
#define LOK_ASSERT_EQUAL(expected, actual) \
do \
{ \
if (!((expected) == (actual))) \
{ \
std::cerr << "Assertion failure: Expected [" << (expected) << "] but got [" \
<< (actual) << "]" << std::endl; \
LOK_ASSERT_IMPL((expected) == (actual)); \
CPPUNIT_ASSERT_EQUAL((expected), (actual)); \
} \
} while (false)
#define LOK_ASSERT_EQUAL_MESSAGE(message, expected, actual) \
do \
{ \
if (!((expected) == (actual))) \
{ \
std::cerr << "Assertion failure: " << (message) << ". Expected [" << (expected) \
<< "] but got [" << (actual) << "]: " << std::endl; \
LOK_ASSERT_IMPL((expected) == (actual)); \
CPPUNIT_ASSERT_EQUAL_MESSAGE((message), (expected), (actual)); \
} \
} while (false)
#define LOK_ASSERT_MESSAGE(message, condition) \
do \
{ \
if (!(condition)) \
{ \
std::cerr << "Assertion failure: " << (#condition) << std::endl; \
LOK_ASSERT_IMPL(condition); \
CPPUNIT_ASSERT_MESSAGE((message), (condition)); \
} \
} while (false)
#define LOK_ASSERT_FAIL(message) \
do \
{ \
std::cerr << "Forced failure: " << (message) << std::endl; \
LOK_ASSERT_IMPL(!"Forced failure"); \
CPPUNIT_FAIL((message)); \
} while (false)
#endif //INCLUDED_ASSERT_HPP