Adds GoogleTest like methods. More...

Functions
def	ASSERT_TRUE (expr, msg=None, logOnSuccess=None)
	Throw exception if given expression does not evaluate to true. More...

def	EXPECT_TRUE (expr, msg=None, logOnSuccess=None)
	Expect given expression to evaluate to true. More...

def	ASSERT_FALSE (expr, msg=None, logOnSuccess=None)
	Throw exception if given expression does not evaluate to false. More...

def	EXPECT_FALSE (expr, msg=None, logOnSuccess=None)
	Expect given expression to evaluate to false. More...

def	ASSERT_EQ (expected, actual, msg=None, logOnSuccess=None)
	Throw exception if given values are not equal. More...

def	EXPECT_EQ (expected, actual, msg=None, logOnSuccess=None)
	Expect given values to be equal. More...

def	ASSERT_NE (expected, actual, msg=None, logOnSuccess=None)
	Throw exception if given values are equal. More...

def	EXPECT_NE (expected, actual, msg=None, logOnSuccess=None)
	Expect given values to be not equal. More...

def	ASSERT_GT (a, b, msg=None, logOnSuccess=None)
	Throw exception if first given value is less than or equal to the second. More...

def	EXPECT_GT (a, b, msg=None, logOnSuccess=None)
	Expect first given value to be greater than the second. More...

def	ASSERT_GE (a, b, msg=None, logOnSuccess=None)
	Throw exception if first given value is less than the second. More...

def	EXPECT_GE (a, b, msg=None, logOnSuccess=None)
	Expect first given value to be greater than or equal to the second. More...

def	ASSERT_LT (a, b, msg=None, logOnSuccess=None)
	Throw exception if first given value is not less than the second. More...

def	EXPECT_LT (a, b, msg=None, logOnSuccess=None)
	Expect first given value to be less than the second. More...

def	ASSERT_LE (a, b, msg=None, logOnSuccess=None)
	Throw exception if first given value is not less than or equal to the second. More...

def	EXPECT_LE (a, b, msg=None, logOnSuccess=None)
	Expect first given value to be less than or equal to the second. More...

def	ASSERT_FLOAT_EQ (expected, actual, msg=None, epsilon=0.0001, logOnSuccess=None)
	Throw exception if given values are not equal. More...

def	EXPECT_FLOAT_EQ (expected, actual, msg=None, epsilon=0.0001, logOnSuccess=None)
	Expect given values to be equal. More...

def	ASSERT_FLOAT_NE (expected, actual, msg=None, epsilon=0.0001, logOnSuccess=None)
	Throw exception if given values are equal. More...

def	EXPECT_FLOAT_NE (expected, actual, msg=None, epsilon=0.0001, logOnSuccess=None)
	Expect given values to be not equal. More...

def	ASSERT_FLOAT_GT (a, b, msg=None, logOnSuccess=None)
	Throw exception if first given value is not greater than the second. More...

def	EXPECT_FLOAT_GT (a, b, msg=None, logOnSuccess=None)
	Expect first given value to be greater than the second. More...

def	ASSERT_FLOAT_GE (a, b, msg=None, epsilon=0.0001, logOnSuccess=None)
	Throw exception if first given value is not greater than or equal to the second. More...

def	EXPECT_FLOAT_GE (a, b, msg=None, epsilon=0.0001, logOnSuccess=None)
	Expect first given value to be greater than or equal to the second. More...

def	ASSERT_FLOAT_LT (a, b, msg=None, logOnSuccess=None)
	Throw exception if first given value is not less than the second. More...

def	EXPECT_FLOAT_LT (a, b, msg=None, logOnSuccess=None)
	Expect first given value to be less than the second. More...

def	ASSERT_FLOAT_LE (a, b, msg=None, epsilon=0.0001, logOnSuccess=None)
	Throw exception if first given value is not less than or equal to the second. More...

def	EXPECT_FLOAT_LE (a, b, msg=None, epsilon=0.0001, logOnSuccess=None)
	Expect first given value to be less than or equal to the second. More...

def	EXPECT_EMPTY (a, msg=None, logOnSuccess=None)
	Expect given container to be empty. More...

def	ASSERT_EMPTY (a, msg=None, logOnSuccess=None)
	Throw exception if given container is not empty. More...

def	EXPECT_NOT_EMPTY (a, msg=None, logOnSuccess=None)
	Expect given container to be not empty. More...

def	ASSERT_NOT_EMPTY (a, msg=None, logOnSuccess=None)
	Throw exception if given container is empty. More...

def	EXPECT_SIZE (a, size, msg=None, logOnSuccess=None)
	Expect given container to have the given size. More...

def	ASSERT_SIZE (a, size, msg=None, logOnSuccess=None)
	Throw exception if given container does not have the given size. More...

def	EXPECT_PATH_EXISTS (path, msg=None, logOnSuccess=None)
	Expect the given path to exist. More...

def	EXPECT_PATH_MISSING (path, msg=None, logOnSuccess=None)
	Expect the given path to be missing, i.e. More...

def	ASSERT_PATH_EXISTS (path, msg=None, logOnSuccess=None)
	Throw exception if given path does not exists. More...

def	ASSERT_PATH_MISSING (path, msg=None, logOnSuccess=None)
	Throw exception if given path is not missing, i.e. More...

def	INFO (msg)
	Create an info message. More...

def	WARNING (msg)
	Create a warning message. More...

def	ERROR (msg)
	Create an error message. More...

def	DEBUG_STOP ()
	Stops a test immediately for debugging purposes. More...

Detailed Description

Adds GoogleTest like methods.

GoogleTest has a set of macros to be used for testing. These methods are all written in upper case which helps identifying the relevant parts of a test function. This module add similar methods but note that the piping feature used in GoogleTest is not available in Python and therefore additional user information must be appended as method argument. This does not mean a restriction as piping is used as string concatenation in C++ is way harder than in Python.

By default, all macros log an info message if the assertion or expectation succeeds. This can be disabled for each call of a macro by passing logOnSuccess=False. It can also be disabled for a single test function by using the TestSupport.Base.MacrosShouldLogOnSuccessDecorator. And finally it can also be disabled by calling TestSupport.Base.setMacrosShouldLogOnSuccess in the setUpTestCase() method. It does not have to be reset, because the TestCenter enables it before each TestCase.

Function Documentation

◆ ASSERT_EMPTY()

def TestSupport.Macros.ASSERT_EMPTY	(	a,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given container is not empty.

Parameters

a	Container.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 422 of file Macros.py.

◆ ASSERT_EQ()

def TestSupport.Macros.ASSERT_EQ	(	expected,
		actual,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given values are not equal.

Parameters

expected	First value.
actual	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 116 of file Macros.py.

◆ ASSERT_FALSE()

def TestSupport.Macros.ASSERT_FALSE	(	expr,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given expression does not evaluate to false.

Parameters

expr	Expression to be evaluated.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 92 of file Macros.py.

◆ ASSERT_FLOAT_EQ()

def TestSupport.Macros.ASSERT_FLOAT_EQ	(	expected,
		actual,
		msg = `None`,
		epsilon = `0.0001`,
		logOnSuccess = `None`
	)

Throw exception if given values are not equal.

Parameters

expected	First value.
actual	Second value.
msg	Message to be printed in case of failure.
epsilon	Epsilon to use for equality check.
logOnSuccess	Print message in case of success.

Definition at line 262 of file Macros.py.

◆ ASSERT_FLOAT_GE()

def TestSupport.Macros.ASSERT_FLOAT_GE	(	a,
		b,
		msg = `None`,
		epsilon = `0.0001`,
		logOnSuccess = `None`
	)

Throw exception if first given value is not greater than or equal to the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
epsilon	Epsilon to use for equality check.
logOnSuccess	Print message in case of success.

Definition at line 338 of file Macros.py.

◆ ASSERT_FLOAT_GT()

def TestSupport.Macros.ASSERT_FLOAT_GT	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if first given value is not greater than the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 313 of file Macros.py.

◆ ASSERT_FLOAT_LE()

def TestSupport.Macros.ASSERT_FLOAT_LE	(	a,
		b,
		msg = `None`,
		epsilon = `0.0001`,
		logOnSuccess = `None`
	)

Throw exception if first given value is not less than or equal to the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
epsilon	Epsilon to use for equality check.
logOnSuccess	Print message in case of success.

Definition at line 388 of file Macros.py.

◆ ASSERT_FLOAT_LT()

def TestSupport.Macros.ASSERT_FLOAT_LT	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if first given value is not less than the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 363 of file Macros.py.

◆ ASSERT_FLOAT_NE()

def TestSupport.Macros.ASSERT_FLOAT_NE	(	expected,
		actual,
		msg = `None`,
		epsilon = `0.0001`,
		logOnSuccess = `None`
	)

Throw exception if given values are equal.

Parameters

expected	First value.
actual	Second value.
msg	Message to be printed in case of failure.
epsilon	Epsilon to use for equality check.
logOnSuccess	Print message in case of success.

Definition at line 288 of file Macros.py.

◆ ASSERT_GE()

def TestSupport.Macros.ASSERT_GE	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if first given value is less than the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 189 of file Macros.py.

◆ ASSERT_GT()

def TestSupport.Macros.ASSERT_GT	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if first given value is less than or equal to the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 165 of file Macros.py.

◆ ASSERT_LE()

def TestSupport.Macros.ASSERT_LE	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if first given value is not less than or equal to the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 237 of file Macros.py.

◆ ASSERT_LT()

def TestSupport.Macros.ASSERT_LT	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if first given value is not less than the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 213 of file Macros.py.

◆ ASSERT_NE()

def TestSupport.Macros.ASSERT_NE	(	expected,
		actual,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given values are equal.

Parameters

expected	First value.
actual	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 140 of file Macros.py.

◆ ASSERT_NOT_EMPTY()

def TestSupport.Macros.ASSERT_NOT_EMPTY	(	a,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given container is empty.

Parameters

a	Container.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 442 of file Macros.py.

◆ ASSERT_PATH_EXISTS()

def TestSupport.Macros.ASSERT_PATH_EXISTS	(	path,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given path does not exists.

Parameters

path	The path to check.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 494 of file Macros.py.

◆ ASSERT_PATH_MISSING()

def TestSupport.Macros.ASSERT_PATH_MISSING	(	path,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given path is not missing, i.e.

if it exists.

Parameters

path	The path to check.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 505 of file Macros.py.

◆ ASSERT_SIZE()

def TestSupport.Macros.ASSERT_SIZE	(	a,
		size,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given container does not have the given size.

Parameters

a	Container.
size	Expected size.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 464 of file Macros.py.

◆ ASSERT_TRUE()

def TestSupport.Macros.ASSERT_TRUE	(	expr,
		msg = `None`,
		logOnSuccess = `None`
	)

Throw exception if given expression does not evaluate to true.

Parameters

expr	Expression to be evaluated.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 69 of file Macros.py.

Referenced by TestSupport.HelperFunctions.initModuleFromTemplate().

◆ DEBUG_STOP()

def TestSupport.Macros.DEBUG_STOP ( )

Stops a test immediately for debugging purposes.

Definition at line 534 of file Macros.py.

◆ ERROR()

def TestSupport.Macros.ERROR ( msg )

Create an error message.

Definition at line 527 of file Macros.py.

Referenced by TestSupport.HelperFunctions.compareImages3D(), and TestSupport.HelperFunctions.compareImages6D().

◆ EXPECT_EMPTY()

def TestSupport.Macros.EXPECT_EMPTY	(	a,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect given container to be empty.

Parameters

a	Container.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 413 of file Macros.py.

◆ EXPECT_EQ()

def TestSupport.Macros.EXPECT_EQ	(	expected,
		actual,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect given values to be equal.

Parameters

expected	First value.
actual	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 129 of file Macros.py.

◆ EXPECT_FALSE()

def TestSupport.Macros.EXPECT_FALSE	(	expr,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect given expression to evaluate to false.

Parameters

expr	Expression that must be false.
msg	Message to be printed if expression true.
logOnSuccess	Print message in case of success.

Returns: True if expression evaluates to false.

Definition at line 105 of file Macros.py.

◆ EXPECT_FLOAT_EQ()

def TestSupport.Macros.EXPECT_FLOAT_EQ	(	expected,
		actual,
		msg = `None`,
		epsilon = `0.0001`,
		logOnSuccess = `None`
	)

Expect given values to be equal.

Parameters

expected	First value.
actual	Second value.
msg	Message to be printed in case of failure.
epsilon	Epsilon to use for equality check.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 276 of file Macros.py.

◆ EXPECT_FLOAT_GE()

def TestSupport.Macros.EXPECT_FLOAT_GE	(	a,
		b,
		msg = `None`,
		epsilon = `0.0001`,
		logOnSuccess = `None`
	)

Expect first given value to be greater than or equal to the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
epsilon	Epsilon to use for equality check.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 352 of file Macros.py.

◆ EXPECT_FLOAT_GT()

def TestSupport.Macros.EXPECT_FLOAT_GT	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect first given value to be greater than the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 326 of file Macros.py.

◆ EXPECT_FLOAT_LE()

def TestSupport.Macros.EXPECT_FLOAT_LE	(	a,
		b,
		msg = `None`,
		epsilon = `0.0001`,
		logOnSuccess = `None`
	)

Expect first given value to be less than or equal to the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
epsilon	Epsilon to use for equality check.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 402 of file Macros.py.

◆ EXPECT_FLOAT_LT()

def TestSupport.Macros.EXPECT_FLOAT_LT	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect first given value to be less than the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 376 of file Macros.py.

◆ EXPECT_FLOAT_NE()

def TestSupport.Macros.EXPECT_FLOAT_NE	(	expected,
		actual,
		msg = `None`,
		epsilon = `0.0001`,
		logOnSuccess = `None`
	)

Expect given values to be not equal.

Parameters

expected	First value.
actual	Second value.
msg	Message to be printed in case of failure.
epsilon	Epsilon to use for equality check.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 302 of file Macros.py.

◆ EXPECT_GE()

def TestSupport.Macros.EXPECT_GE	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect first given value to be greater than or equal to the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 202 of file Macros.py.

◆ EXPECT_GT()

def TestSupport.Macros.EXPECT_GT	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect first given value to be greater than the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 178 of file Macros.py.

◆ EXPECT_LE()

def TestSupport.Macros.EXPECT_LE	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect first given value to be less than or equal to the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 250 of file Macros.py.

◆ EXPECT_LT()

def TestSupport.Macros.EXPECT_LT	(	a,
		b,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect first given value to be less than the second.

Parameters

a	First value.
b	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 226 of file Macros.py.

◆ EXPECT_NE()

def TestSupport.Macros.EXPECT_NE	(	expected,
		actual,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect given values to be not equal.

Parameters

expected	First value.
actual	Second value.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 153 of file Macros.py.

◆ EXPECT_NOT_EMPTY()

def TestSupport.Macros.EXPECT_NOT_EMPTY	(	a,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect given container to be not empty.

Parameters

a	Container.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 433 of file Macros.py.

◆ EXPECT_PATH_EXISTS()

def TestSupport.Macros.EXPECT_PATH_EXISTS	(	path,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect the given path to exist.

Parameters

path	The path to check.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 474 of file Macros.py.

◆ EXPECT_PATH_MISSING()

def TestSupport.Macros.EXPECT_PATH_MISSING	(	path,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect the given path to be missing, i.e.

it should not exist.

Parameters

path	The path to check.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Definition at line 484 of file Macros.py.

◆ EXPECT_SIZE()

def TestSupport.Macros.EXPECT_SIZE	(	a,
		size,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect given container to have the given size.

Parameters

a	Container.
size	Expected size.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true in case of success.

Definition at line 454 of file Macros.py.

◆ EXPECT_TRUE()

def TestSupport.Macros.EXPECT_TRUE	(	expr,
		msg = `None`,
		logOnSuccess = `None`
	)

Expect given expression to evaluate to true.

Parameters

expr	Expression to be evaluated.
msg	Message to be printed in case of failure.
logOnSuccess	Print message in case of success.

Returns: Returns true if expression evaluates to true.

Definition at line 81 of file Macros.py.

Referenced by TestSupport.RemoteRenderingEventReplay.EventReplay.imageReceived().

◆ INFO()

def TestSupport.Macros.INFO ( msg )

Create an info message.

Definition at line 513 of file Macros.py.

Referenced by TestSupport.HelperFunctions.compareImages3D(), and TestSupport.HelperFunctions.compareImages6D().

◆ WARNING()

def TestSupport.Macros.WARNING ( msg )

Create a warning message.

Definition at line 520 of file Macros.py.