QuickCppLib 0.10
Eliminate all the tedious hassle when making state-of-the-art C++ 14 - 23 libraries!
Loading...
Searching...
No Matches
Unit test suites

Namespaces

namespace  quickcpplib
 The QuickCppLib namespace.

Macros

#define QUICKCPPLIB_BOOST_UNIT_TEST_IMPL   0
#define QUICKCPPLIB_BOOST_UNIT_TEST_FAIL   longjmp(QUICKCPPLIB_NAMESPACE::unit_test::test_case_failed(), 1)
#define QUICKCPPLIB_BOOST_UNIT_CHECK_FAIL(type, expr)
#define QUICKCPPLIB_BOOST_UNIT_CHECK_PASS(type, expr)
#define QUICKCPPLIB_BOOST_UNIT_REQUIRE_FAIL(type, expr)
#define QUICKCPPLIB_BOOST_UNIT_REQUIRE_PASS(type, expr)
#define BOOST_TEST_MESSAGE(msg)
#define BOOST_TEST_CASE_SKIPPED(reason)
 Marks the running test case as SKIPPED, giving the reason.
#define BOOST_WARN_MESSAGE(pred, msg)
#define BOOST_FAIL(msg)
#define BOOST_CHECK_MESSAGE(pred, msg)
#define BOOST_CHECK(expr)
#define BOOST_CHECK_EQUAL(expr1, expr2)
#define BOOST_CHECK_THROWS(expr)
#define BOOST_CHECK_THROW(expr, type)
#define BOOST_CHECK_NO_THROW(expr)
#define BOOST_REQUIRE(expr)
#define BOOST_REQUIRE_THROWS(expr)
#define BOOST_CHECK_REQUIRE(expr, type)
#define BOOST_REQUIRE_NO_THROW(expr)
#define BOOST_AUTO_TEST_SUITE3(a, b)
#define BOOST_AUTO_TEST_SUITE2(a, b)
#define BOOST_AUTO_TEST_SUITE(name)
#define BOOST_AUTO_TEST_SUITE_END()
#define QUICKCPPLIB_BOOST_UNIT_TEST_CASE_NAME(name)
#define QUICKCPPLIB_BOOST_UNIT_TEST_CASE_UNIQUE(prefix)
#define BOOST_AUTO_TEST_CASE2(test_name, desc, func_name)
#define BOOST_AUTO_TEST_CASE(test_name, desc)
#define QUICKCPPLIB_BOOST_UNIT_TEST_RUN_TESTS(argc, argv)
#define BOOST_BINDLIB_ENABLE_MULTIPLE_DEFINITIONS   inline

Functions

BOOST_BINDLIB_ENABLE_MULTIPLE_DEFINITIONS int main (int argc, const char *const argv[])

Detailed Description

QuickCppLib comes with a minimal emulation of Boost.Test based on one of two underlying unit test engines:

QUICKCPPLIB_BOOST_UNIT_TEST_IMPL = 0 (the default)

An internal extremely lightweight engine which works well with exceptions and RTTI disabled. It works fine with multithreaded test cases, and can write results to a JUnit XML file for consumption by Jenkins etc. Its implementation is less than two hundred lines of C++, so it isn't particularly configurable nor flexible. In particular it maintains no history of checks, no stdio redirection, no trapping of signals, no interception of failed asserts etc. If a check fails it simply prints immediately what failed to stderr and increments a fail counter. Despite its simplicity you'll probably find it works plenty well for most use cases and it has almost zero overhead either at compile or runtime.

Note that if exceptions are disabled, those checks and requires testing that things throw are implement as no ops for obvious reasons.

Warning
A requirement failure is handled by throwing a magic exception type to abort the test case and prevent execution of later code, unwinding the stack and releasing any resources allocated up to that point. If exceptions are disabled, longjmp() is used instead and therefore stack unwinding does not occur, leaking any stack based resources.
Note
Almost all the macros used by this internal engine can be redefined before including the header file. It's been deliberately made highly customisable.
QUICKCPPLIB_BOOST_UNIT_TEST_IMPL = 1
Use Phil Nash's CATCH (https://github.com/philsquared/Catch) header only test engine. The Boost.Test macros simply call CATCH equivalents. The CATCH used is actually a fork of Phil's with a giant mutex poked in so multiple threads can do checks concurrently.

Macro Definition Documentation

◆ QUICKCPPLIB_BOOST_UNIT_TEST_IMPL

#define QUICKCPPLIB_BOOST_UNIT_TEST_IMPL   0

◆ QUICKCPPLIB_BOOST_UNIT_TEST_FAIL

#define QUICKCPPLIB_BOOST_UNIT_TEST_FAIL   longjmp(QUICKCPPLIB_NAMESPACE::unit_test::test_case_failed(), 1)

◆ QUICKCPPLIB_BOOST_UNIT_CHECK_FAIL

#define QUICKCPPLIB_BOOST_UNIT_CHECK_FAIL ( type,
expr )
Value:
++QUICKCPPLIB_NAMESPACE::unit_test::current_test_case()->fails; \
std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::yellow << "CHECK " type "(" #expr ") FAILED" \
<< QUICKCPPLIB_NAMESPACE::unit_test::white << " at " << __FILE__ << ":" << __LINE__ << std::endl
506#define QUICKCPPLIB_BOOST_UNIT_CHECK_FAIL(type, expr) \
507 ++QUICKCPPLIB_NAMESPACE::unit_test::current_test_case()->fails; \
508 std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::yellow << "CHECK " type "(" #expr ") FAILED" \
509 << QUICKCPPLIB_NAMESPACE::unit_test::white << " at " << __FILE__ << ":" << __LINE__ << std::endl

◆ QUICKCPPLIB_BOOST_UNIT_CHECK_PASS

#define QUICKCPPLIB_BOOST_UNIT_CHECK_PASS ( type,
expr )
Value:
++QUICKCPPLIB_NAMESPACE::unit_test::current_test_case()->passes

◆ QUICKCPPLIB_BOOST_UNIT_REQUIRE_FAIL

#define QUICKCPPLIB_BOOST_UNIT_REQUIRE_FAIL ( type,
expr )
Value:
++QUICKCPPLIB_NAMESPACE::unit_test::current_test_case()->fails; \
std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::red << "REQUIRE " type "(" #expr ") FAILED" \
<< QUICKCPPLIB_NAMESPACE::unit_test::white << " at " << __FILE__ << ":" << __LINE__ << std::endl; \
#define QUICKCPPLIB_BOOST_UNIT_TEST_FAIL
Definition unit_test.hpp:502
515#define QUICKCPPLIB_BOOST_UNIT_REQUIRE_FAIL(type, expr) \
516 ++QUICKCPPLIB_NAMESPACE::unit_test::current_test_case()->fails; \
517 std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::red << "REQUIRE " type "(" #expr ") FAILED" \
518 << QUICKCPPLIB_NAMESPACE::unit_test::white << " at " << __FILE__ << ":" << __LINE__ << std::endl; \
519 QUICKCPPLIB_BOOST_UNIT_TEST_FAIL

◆ QUICKCPPLIB_BOOST_UNIT_REQUIRE_PASS

#define QUICKCPPLIB_BOOST_UNIT_REQUIRE_PASS ( type,
expr )
Value:
++QUICKCPPLIB_NAMESPACE::unit_test::current_test_case()->passes

◆ BOOST_TEST_MESSAGE

#define BOOST_TEST_MESSAGE ( msg)
Value:
std::cout << "INFO: " << msg << std::endl

◆ BOOST_TEST_CASE_SKIPPED

#define BOOST_TEST_CASE_SKIPPED ( reason)
Value:
QUICKCPPLIB_NAMESPACE::unit_test::test_case_skipped(reason)

Marks the running test case as SKIPPED, giving the reason.

Use this rather than a bare return; when a case cannot run in this configuration (a platform, a sanitiser, an environment): the runner counts a quiet return as PASSED, so the case would report green having asserted nothing and JUnit would carry no <skipped/> for it.

◆ BOOST_WARN_MESSAGE

#define BOOST_WARN_MESSAGE ( pred,
msg )
Value:
if(!(pred)) \
std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::yellow << "WARNING: " << msg \
<< QUICKCPPLIB_NAMESPACE::unit_test::normal << std::endl
532#define BOOST_WARN_MESSAGE(pred, msg) \
533 if(!(pred)) \
534 std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::yellow << "WARNING: " << msg \
535 << QUICKCPPLIB_NAMESPACE::unit_test::normal << std::endl

◆ BOOST_FAIL

#define BOOST_FAIL ( msg)
Value:
std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::red << "FAILURE: " << msg << QUICKCPPLIB_NAMESPACE::unit_test::normal \
<< std::endl; \
536#define BOOST_FAIL(msg) \
537 std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::red << "FAILURE: " << msg << QUICKCPPLIB_NAMESPACE::unit_test::normal \
538 << std::endl; \
539 QUICKCPPLIB_BOOST_UNIT_TEST_FAIL

◆ BOOST_CHECK_MESSAGE

#define BOOST_CHECK_MESSAGE ( pred,
msg )
Value:
if(!(pred)) \
{ \
std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::yellow << msg \
<< QUICKCPPLIB_NAMESPACE::unit_test::white << std::endl; \
QUICKCPPLIB_BOOST_UNIT_CHECK_FAIL(, pred); \
} \
else \
{ \
QUICKCPPLIB_BOOST_UNIT_CHECK_PASS(, pred); \
}
544#define BOOST_CHECK_MESSAGE(pred, msg) \
545 if(!(pred)) \
546 { \
547 std::cerr << QUICKCPPLIB_NAMESPACE::unit_test::yellow << msg \
548 << QUICKCPPLIB_NAMESPACE::unit_test::white << std::endl; \
549 QUICKCPPLIB_BOOST_UNIT_CHECK_FAIL(, pred); \
550 } \
551 else \
552 { \
553 QUICKCPPLIB_BOOST_UNIT_CHECK_PASS(, pred); \
554 }

◆ BOOST_CHECK

#define BOOST_CHECK ( expr)
Value:
if(!(expr)) \
{ \
QUICKCPPLIB_BOOST_UNIT_CHECK_FAIL(, expr); \
} \
\
else \
{ \
QUICKCPPLIB_BOOST_UNIT_CHECK_PASS(, expr); \
}
556#define BOOST_CHECK(expr) \
557 if(!(expr)) \
558 { \
559 QUICKCPPLIB_BOOST_UNIT_CHECK_FAIL(, expr); \
560 } \
561 \
562 else \
563 { \
564 QUICKCPPLIB_BOOST_UNIT_CHECK_PASS(, expr); \
565 }

◆ BOOST_CHECK_EQUAL

#define BOOST_CHECK_EQUAL ( expr1,
expr2 )
Value:
BOOST_CHECK((expr1) == (expr2))
#define BOOST_CHECK(expr)
Definition unit_test.hpp:556

◆ BOOST_CHECK_THROWS

#define BOOST_CHECK_THROWS ( expr)

◆ BOOST_CHECK_THROW

#define BOOST_CHECK_THROW ( expr,
type )

◆ BOOST_CHECK_NO_THROW

#define BOOST_CHECK_NO_THROW ( expr)
Value:
expr

◆ BOOST_REQUIRE

#define BOOST_REQUIRE ( expr)
Value:
if(!(expr)) \
{ \
QUICKCPPLIB_BOOST_UNIT_REQUIRE_FAIL(, expr); \
} \
\
{ \
QUICKCPPLIB_BOOST_UNIT_REQUIRE_PASS(, expr); \
}
627#define BOOST_REQUIRE(expr) \
628 if(!(expr)) \
629 { \
630 QUICKCPPLIB_BOOST_UNIT_REQUIRE_FAIL(, expr); \
631 } \
632 \
633 { \
634 QUICKCPPLIB_BOOST_UNIT_REQUIRE_PASS(, expr); \
635 }

◆ BOOST_REQUIRE_THROWS

#define BOOST_REQUIRE_THROWS ( expr)

◆ BOOST_CHECK_REQUIRE

#define BOOST_CHECK_REQUIRE ( expr,
type )

◆ BOOST_REQUIRE_NO_THROW

#define BOOST_REQUIRE_NO_THROW ( expr)
Value:
expr

◆ BOOST_AUTO_TEST_SUITE3

#define BOOST_AUTO_TEST_SUITE3 ( a,
b )
Value:
a##b

◆ BOOST_AUTO_TEST_SUITE2

#define BOOST_AUTO_TEST_SUITE2 ( a,
b )
Value:
#define BOOST_AUTO_TEST_SUITE3(a, b)
Definition unit_test.hpp:695

◆ BOOST_AUTO_TEST_SUITE

#define BOOST_AUTO_TEST_SUITE ( name)
Value:
namespace BOOST_AUTO_TEST_SUITE2(boostlite_auto_test_suite, __COUNTER__) \
{ \
static QUICKCPPLIB_NAMESPACE::unit_test::test_suite_registration boostlite_auto_test_suite_registration(#name);
#define BOOST_AUTO_TEST_SUITE2(a, b)
Definition unit_test.hpp:696
697#define BOOST_AUTO_TEST_SUITE(name) \
698 namespace BOOST_AUTO_TEST_SUITE2(boostlite_auto_test_suite, __COUNTER__) \
699 { \
700 static QUICKCPPLIB_NAMESPACE::unit_test::test_suite_registration boostlite_auto_test_suite_registration(#name);

◆ BOOST_AUTO_TEST_SUITE_END

#define BOOST_AUTO_TEST_SUITE_END ( )
Value:
}

◆ QUICKCPPLIB_BOOST_UNIT_TEST_CASE_NAME

#define QUICKCPPLIB_BOOST_UNIT_TEST_CASE_NAME ( name)
Value:
#name

◆ QUICKCPPLIB_BOOST_UNIT_TEST_CASE_UNIQUE

#define QUICKCPPLIB_BOOST_UNIT_TEST_CASE_UNIQUE ( prefix)
Value:
BOOST_AUTO_TEST_SUITE2(prefix, __COUNTER__)

◆ BOOST_AUTO_TEST_CASE2

#define BOOST_AUTO_TEST_CASE2 ( test_name,
desc,
func_name )
Value:
\
static void func_name(); \
\
static QUICKCPPLIB_NAMESPACE::unit_test::test_case_registration BOOST_AUTO_TEST_SUITE2(func_name, _registration)( \
static_cast<const char *>(test_name), static_cast<const char *>(desc), func_name); \
\
static void func_name()
708#define BOOST_AUTO_TEST_CASE2(test_name, desc, func_name) \
709 \
710 static void func_name(); \
711 \
712 static QUICKCPPLIB_NAMESPACE::unit_test::test_case_registration BOOST_AUTO_TEST_SUITE2(func_name, _registration)( \
713 static_cast<const char *>(test_name), static_cast<const char *>(desc), func_name); \
714 \
715 static void func_name()

◆ BOOST_AUTO_TEST_CASE

#define BOOST_AUTO_TEST_CASE ( test_name,
desc )
Value:
QUICKCPPLIB_BOOST_UNIT_TEST_CASE_UNIQUE(boostlite_auto_test_case))
#define QUICKCPPLIB_BOOST_UNIT_TEST_CASE_NAME(name)
Definition unit_test.hpp:705
#define QUICKCPPLIB_BOOST_UNIT_TEST_CASE_UNIQUE(prefix)
Definition unit_test.hpp:707
#define BOOST_AUTO_TEST_CASE2(test_name, desc, func_name)
Definition unit_test.hpp:708
716#define BOOST_AUTO_TEST_CASE(test_name, desc) \
717 BOOST_AUTO_TEST_CASE2(QUICKCPPLIB_BOOST_UNIT_TEST_CASE_NAME(test_name), desc, \
718 QUICKCPPLIB_BOOST_UNIT_TEST_CASE_UNIQUE(boostlite_auto_test_case))

◆ QUICKCPPLIB_BOOST_UNIT_TEST_RUN_TESTS

#define QUICKCPPLIB_BOOST_UNIT_TEST_RUN_TESTS ( argc,
argv )
Value:
QUICKCPPLIB_NAMESPACE::unit_test::run(argc, argv)

◆ BOOST_BINDLIB_ENABLE_MULTIPLE_DEFINITIONS

#define BOOST_BINDLIB_ENABLE_MULTIPLE_DEFINITIONS   inline

Function Documentation

◆ main()

BOOST_BINDLIB_ENABLE_MULTIPLE_DEFINITIONS int main ( int argc,
const char *const argv[] )
815{
816 int result = QUICKCPPLIB_BOOST_UNIT_TEST_RUN_TESTS(argc, argv);
817 return result;
818}
#define QUICKCPPLIB_BOOST_UNIT_TEST_RUN_TESTS(argc, argv)
Definition unit_test.hpp:720