Unit Testing

Unit test framework much like Google Test but with task support. More...

Macros
#define	UNIT(...)
	Define a unit test function.
#define	UNIT_ASSERT(ASSERTION, ...)
	Run an assertion and include captured output in any error message.
#define	UNIT_CAPTURE()
	A stream that collects output for comparison.
#define	UNIT_DUMP()
	Return captured output.
#define	UNIT_EQUAL_BLESSED(f)
	Compare captured output to a blessed file.
#define	UNIT_WRITE(f)
	Write captured output to file.

Typedefs
template<auto & Target>
using	driver
	A test registration.
template<auto & Target>
using	finalization
	A test finalization registration.
template<auto & Target>
using	initialization
	A test initialization registration.

Assertion macros
Values to include in a failure message may be streamed into an assertion: EXPECT_GE(foo, 0) << foo << " should be non-negative"; Macros that begin with ASSERT are identical to their EXPECT counterparts except that they abandon the current UNIT (or innermost lambda within it) on failure (usually to avoid subsequent undefined behavior).
#define	ASSERT_TRUE(c)
	Condition.
#define	EXPECT_TRUE(c)
	Condition.
#define	ASSERT_FALSE(c)
	Condition.
#define	EXPECT_FALSE(c)
	Condition.
#define	ASSERT_EQ(x, y)
	Condition.
#define	EXPECT_EQ(x, y)
	Condition.
#define	ASSERT_NE(x, y)
	Condition.
#define	EXPECT_NE(x, y)
	Condition.
#define	ASSERT_LT(x, y)
	Condition.
#define	EXPECT_LT(x, y)
	Condition.
#define	ASSERT_LE(x, y)
	Condition.
#define	EXPECT_LE(x, y)
	Condition.
#define	ASSERT_GT(x, y)
	Condition.
#define	EXPECT_GT(x, y)
	Condition.
#define	ASSERT_GE(x, y)
	Condition.
#define	EXPECT_GE(x, y)
	Condition.
#define	ASSERT_STREQ(x, y)
	Compare null-terminated strings, abandoning test on inequality.
#define	EXPECT_STREQ(x, y)
	Check equality of null-terminated strings.
#define	ASSERT_STRNE(x, y)
	Compare null-terminated strings, abandoning test on equality.
#define	EXPECT_STRNE(x, y)
	Check inequality of null-terminated strings.
#define	ASSERT_STRCASEEQ(x, y)
	Compare null-terminated strings, ignoring case and abandoning test on inequality.
#define	EXPECT_STRCASEEQ(x, y)
	Check equality of null-terminated strings, ignoring case.
#define	ASSERT_STRCASENE(x, y)
	Compare null-terminated strings, ignoring case and abandoning test on equality.
#define	EXPECT_STRCASENE(x, y)
	Check inequality of null-terminated strings, ignoring case.

Detailed Description

Unit test framework much like Google Test but with task support.

Each Target is a function with signature int(flecsi::scheduler&) or (deprecated) int(); if any returns a non-zero value, so does the process built with flecsi_add_test. Output is via Logging.

Contents are in flecsi::util::unit unless otherwise specified.

Macro Definition Documentation

UNIT

#define UNIT

(

...

)

Define a unit test function.

Should be followed by a compound statement, which can use the other unit-testing macros, and a semicolon, and should generally appear alone in a function that returns int. Optionally, provide an expression convertible to std::string to label the test results (along with __func__); the default is "TEST".

Attention

If used on a GPU, no label may be provided, nothing can be streamed into the assertions using <<, and the following macros may not be used in the compound statement:

• ASSERT_STRCASEEQ and EXPECT_STRCASEEQ
• ASSERT_STRCASENE and EXPECT_STRCASENE
• UNIT_CAPTURE
• UNIT_DUMP
• UNIT_BLESSED
• UNIT_WRITE
• UNIT_ASSERT

Note

The ASSERT/EXPECT macros can be used in a lambda defined inside the compound statement with [&].

ASSERT_TRUE

#define ASSERT_TRUE

(

c

)

Condition.

EXPECT_TRUE

#define EXPECT_TRUE

(

c

)

Condition.

ASSERT_FALSE

#define ASSERT_FALSE

(

c

)

Condition.

EXPECT_FALSE

#define EXPECT_FALSE

(

c

)

Condition.

ASSERT_EQ

#define ASSERT_EQ	(		x,
			y )

Condition.

EXPECT_EQ

#define EXPECT_EQ	(		x,
			y )

Condition.

ASSERT_NE

#define ASSERT_NE	(		x,
			y )

Condition.

EXPECT_NE

#define EXPECT_NE	(		x,
			y )

Condition.

ASSERT_LT

#define ASSERT_LT	(		x,
			y )

Condition.

EXPECT_LT

#define EXPECT_LT	(		x,
			y )

Condition.

ASSERT_LE

#define ASSERT_LE	(		x,
			y )

Condition.

EXPECT_LE

#define EXPECT_LE	(		x,
			y )

Condition.

ASSERT_GT

#define ASSERT_GT	(		x,
			y )

Condition.

EXPECT_GT

#define EXPECT_GT	(		x,
			y )

Condition.

ASSERT_GE

#define ASSERT_GE	(		x,
			y )

Condition.

EXPECT_GE

#define EXPECT_GE	(		x,
			y )

Condition.

ASSERT_STREQ

#define ASSERT_STREQ	(		x,
			y )

Compare null-terminated strings, abandoning test on inequality.

EXPECT_STREQ

#define EXPECT_STREQ	(		x,
			y )

Check equality of null-terminated strings.

ASSERT_STRNE

#define ASSERT_STRNE	(		x,
			y )

Compare null-terminated strings, abandoning test on equality.

EXPECT_STRNE

#define EXPECT_STRNE	(		x,
			y )

Check inequality of null-terminated strings.

ASSERT_STRCASEEQ

#define ASSERT_STRCASEEQ	(		x,
			y )

Compare null-terminated strings, ignoring case and abandoning test on inequality.

Deprecated

No replacement: inconsistent with other tests in that it is locale-dependent.

EXPECT_STRCASEEQ

#define EXPECT_STRCASEEQ	(		x,
			y )

Check equality of null-terminated strings, ignoring case.

Deprecated

No replacement: inconsistent with other tests in that it is locale-dependent.

ASSERT_STRCASENE

#define ASSERT_STRCASENE	(		x,
			y )

Compare null-terminated strings, ignoring case and abandoning test on equality.

Deprecated

No replacement: inconsistent with other tests in that it is locale-dependent.

EXPECT_STRCASENE

#define EXPECT_STRCASENE	(		x,
			y )

Check inequality of null-terminated strings, ignoring case.

Deprecated

No replacement: inconsistent with other tests in that it is locale-dependent.

UNIT_CAPTURE

#define UNIT_CAPTURE

(

)

A stream that collects output for comparison.

UNIT_DUMP

#define UNIT_DUMP

(

)

Return captured output.

Returns

std::string

UNIT_EQUAL_BLESSED

#define UNIT_EQUAL_BLESSED

(

f

)

Compare captured output to a blessed file.

Returns

bool

UNIT_WRITE

#define UNIT_WRITE

(

f

)

Write captured output to file.

UNIT_ASSERT

#define UNIT_ASSERT	(		ASSERTION,
			... )

Run an assertion and include captured output in any error message.

Parameters

ASSERTION

macro name (TRUE, EQ, etc.)

Typedef Documentation

initialization

template<auto & Target>

using initialization

A test initialization registration.

Declare a non-local variable of this type for each function.

Template Parameters

Target

the function to call

driver

template<auto & Target>

using driver

A test registration.

Declare a non-local variable of this type for each function.

Template Parameters

Target

the test function to call

finalization

template<auto & Target>

using finalization

A test finalization registration.

Declare a non-local variable of this type for each function.

Template Parameters

Target

the function to call