Assertions

The different assertion macros available are described below. These are available in AssertImpl.h

Defines

TEST_ASSERT_EQUAL_STRING(expected, actual)

Assert string equality

Parameters

  • expected: Expected value

  • actual: Actual value

TEST_ASSERT_EQUAL_MEMORY(expected, actual, size)

Assert memory equality

Parameters

  • expected: Expected value

  • actual: Actual value

  • size: Size of the memory to compare

TEST_ASSERT_EQUAL_INT(expected, actual)

Assert signed integer equality

Parameters

  • expected: Expected value

  • actual: Actual value

TEST_ASSERT_EQUAL_UINT(expected, actual)

Assert unsigned integer equality

Parameters

  • expected: Expected value

  • actual: Actual value

TEST_ASSERT_EQUAL_HEX(expected, actual)

Assert hexadecimal integer equality

Parameters

  • expected: Expected value

  • actual: Actual value

TEST_ASSERT_EQUAL_PTR(expected, actual)

Assert pointer equality

Parameters

  • expected: Expected poiunter

  • actual: Actual pointer

TEST_ASSERT_EQUAL_INT_WITH_MARGIN(expected, actual, margin)

Assert signed integer equality with margin

Parameters

  • expected: Expected value

  • actual: Actual value

  • margin: Allowed margin to be applied during assertion

TEST_ASSERT_EQUAL_WITH_MARGIN(expected, actual, margin)

Assert signed integer equality with margin

Parameters

  • expected: Expected value

  • actual: Actual value

  • margin: Allowed margin to be applied during assertion

TEST_ASSERT_EQUAL_UINT_WITH_MARGIN(expected, actual, margin)

Assert unsigned integer equality with margin

Parameters

  • expected: Expected value

  • actual: Actual value

  • margin: Allowed margin to be applied during assertion

TEST_ASSERT_NOT_LOWER_THAN_INT(min, actual)

Assert signed integer to be higher than or equal to a minimum value

Parameters

  • min: Minimum allowed value

  • actual: Actual value

TEST_ASSERT_NOT_HIGHER_THAN_INT(max, actual)

Assert signed integer to be lower than or equal to a maximum value

Parameters

  • max: Maximum allowed value

  • actual: Actual value

TEST_ASSERT_RANGE_INT(min, max, actual)

Assert signed integer to be within the range (boundaries are allowed) of given minimum and maximum

Parameters

  • min: Minimum allowed value

  • max: Maximum allowed value

  • actual: Actual value

TEST_ASSERT_NOT_LOWER_THAN_UINT(min, actual)

Assert unsigned integer to be higher than or equal to a minimum value

Parameters

  • min: Minimum allowed value

  • actual: Actual value

TEST_ASSERT_NOT_HIGHER_THAN_UINT(max, actual)

Assert unsigned integer to be lower than or equal to a maximum value

Parameters

  • max: Maximum allowed value

  • actual: Actual value

TEST_ASSERT_RANGE_UINT(min, max, actual)

Assert unsigned integer to be within the range (boundaries are allowed) of given minimum and maximum

Parameters

  • min: Minimum allowed value

  • max: Maximum allowed value

  • actual: Actual value

TEST_ASSERT_NULL(pointer)

Assert a pointer to be NULL

Parameters

  • pointer: Pointer under test

TEST_ASSERT_NOT_NULL(pointer)

Assert a pointer to be non-NULL

Parameters

  • pointer: Pointer under test

TEST_ASSERT_MESSAGE(condition, message)

Assert a condition to pass

Parameters

  • condition: Condition under test

  • message: Message to print when assertion fails

TEST_ASSERT(condition)

Assert a condition to pass

Parameters

  • condition: Condition under test

TEST_FAIL(message)

Mark a test as failed

Parameters

  • message: Message to print