PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/features/frameworks/unity/README.md@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 # UNITY: Unit Testing for C
demayer 0:6bf0743ece18 2
demayer 0:6bf0743ece18 3 This yotta module is a fork of the [UNITY test framework](http://www.throwtheswitch.org/unity/) with minor modifications to be able to use it with the [utest harness](https://github.com/ARMmbed/utest) for mbed OS.
demayer 0:6bf0743ece18 4
demayer 0:6bf0743ece18 5 Please note that this module only contains the unity test macros, and no additions such as the unity fixtures.
demayer 0:6bf0743ece18 6 Furthermore the failure macros have been modified to integrate with `utest` failure handlers, as `setjmp` and `longjmp` are not supported by `utest`.
demayer 0:6bf0743ece18 7
demayer 0:6bf0743ece18 8 Specifically
demayer 0:6bf0743ece18 9 - `UNITY_FAIL_AND_BAIL` calls `utest_unity_assert_failure()`, and
demayer 0:6bf0743ece18 10 - `UNITY_IGNORE_AND_BAIL` calls `utest_unity_ignore_failure()`
demayer 0:6bf0743ece18 11
demayer 0:6bf0743ece18 12 which then invoke the appropriate action in `utest`.
demayer 0:6bf0743ece18 13
demayer 0:6bf0743ece18 14 **To use these macros you need to depend on both `unity` and `utest`!**
demayer 0:6bf0743ece18 15
demayer 0:6bf0743ece18 16 For the original documentation of UNITY, please [visit the project's homepage](http://www.throwtheswitch.org/unity/).
demayer 0:6bf0743ece18 17
demayer 0:6bf0743ece18 18 ## Macros
demayer 0:6bf0743ece18 19
demayer 0:6bf0743ece18 20 UNITY provides a lot of test macros.
demayer 0:6bf0743ece18 21
demayer 0:6bf0743ece18 22 **Be aware of the macro argument order**: (EXPECTED VALUE, ACTUAL VALUE).
demayer 0:6bf0743ece18 23 So `TEST_ASSERT_EQUAL(4, value);` is the right way around.
demayer 0:6bf0743ece18 24
demayer 0:6bf0743ece18 25 Note, that you can provide a custom failure message by appending `_MESSAGE` to any macro and passing the message string as the _last argument_.
demayer 0:6bf0743ece18 26
demayer 0:6bf0743ece18 27 #### Generic:
demayer 0:6bf0743ece18 28
demayer 0:6bf0743ece18 29 - `TEST_FAIL()`
demayer 0:6bf0743ece18 30 - `TEST_IGNORE()`
demayer 0:6bf0743ece18 31 - `TEST_ONLY()`
demayer 0:6bf0743ece18 32
demayer 0:6bf0743ece18 33 #### Boolean:
demayer 0:6bf0743ece18 34
demayer 0:6bf0743ece18 35 - `TEST_ASSERT(condition)`
demayer 0:6bf0743ece18 36 - `TEST_ASSERT_TRUE(condition)`
demayer 0:6bf0743ece18 37 - `TEST_ASSERT_UNLESS(condition)`
demayer 0:6bf0743ece18 38 - `TEST_ASSERT_FALSE(condition)`
demayer 0:6bf0743ece18 39
demayer 0:6bf0743ece18 40 #### Pointer:
demayer 0:6bf0743ece18 41
demayer 0:6bf0743ece18 42 - `TEST_ASSERT_NULL(pointer)`
demayer 0:6bf0743ece18 43 - `TEST_ASSERT_NOT_NULL(pointer)`
demayer 0:6bf0743ece18 44
demayer 0:6bf0743ece18 45 #### Equality:
demayer 0:6bf0743ece18 46
demayer 0:6bf0743ece18 47 - `TEST_ASSERT_EQUAL(expected, actual)`
demayer 0:6bf0743ece18 48 - `TEST_ASSERT_NOT_EQUAL(expected, actual)`
demayer 0:6bf0743ece18 49 - `TEST_ASSERT_EQUAL_INT(expected, actual)`
demayer 0:6bf0743ece18 50 - `TEST_ASSERT_EQUAL_INT8(expected, actual)`
demayer 0:6bf0743ece18 51 - `TEST_ASSERT_EQUAL_INT16(expected, actual)`
demayer 0:6bf0743ece18 52 - `TEST_ASSERT_EQUAL_INT32(expected, actual)`
demayer 0:6bf0743ece18 53 - `TEST_ASSERT_EQUAL_INT64(expected, actual)`
demayer 0:6bf0743ece18 54 - `TEST_ASSERT_EQUAL_UINT(expected, actual)`
demayer 0:6bf0743ece18 55 - `TEST_ASSERT_EQUAL_UINT8(expected, actual)`
demayer 0:6bf0743ece18 56 - `TEST_ASSERT_EQUAL_UINT16(expected, actual)`
demayer 0:6bf0743ece18 57 - `TEST_ASSERT_EQUAL_UINT32(expected, actual)`
demayer 0:6bf0743ece18 58 - `TEST_ASSERT_EQUAL_UINT64(expected, actual)`
demayer 0:6bf0743ece18 59 - `TEST_ASSERT_EQUAL_HEX(expected, actual)`
demayer 0:6bf0743ece18 60 - `TEST_ASSERT_EQUAL_HEX8(expected, actual)`
demayer 0:6bf0743ece18 61 - `TEST_ASSERT_EQUAL_HEX16(expected, actual)`
demayer 0:6bf0743ece18 62 - `TEST_ASSERT_EQUAL_HEX32(expected, actual)`
demayer 0:6bf0743ece18 63 - `TEST_ASSERT_EQUAL_HEX64(expected, actual)`
demayer 0:6bf0743ece18 64
demayer 0:6bf0743ece18 65 #### Bit Masks:
demayer 0:6bf0743ece18 66
demayer 0:6bf0743ece18 67 - `TEST_ASSERT_BITS(mask, expected, actual)`
demayer 0:6bf0743ece18 68 - `TEST_ASSERT_BITS_HIGH(mask, actual)`
demayer 0:6bf0743ece18 69 - `TEST_ASSERT_BITS_LOW(mask, actual)`
demayer 0:6bf0743ece18 70 - `TEST_ASSERT_BIT_HIGH(bit, actual)`
demayer 0:6bf0743ece18 71 - `TEST_ASSERT_BIT_LOW(bit, actual)`
demayer 0:6bf0743ece18 72
demayer 0:6bf0743ece18 73 #### Deltas:
demayer 0:6bf0743ece18 74
demayer 0:6bf0743ece18 75 - `TEST_ASSERT_INT_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 76 - `TEST_ASSERT_INT8_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 77 - `TEST_ASSERT_INT16_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 78 - `TEST_ASSERT_INT32_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 79 - `TEST_ASSERT_INT64_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 80 - `TEST_ASSERT_UINT_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 81 - `TEST_ASSERT_UINT8_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 82 - `TEST_ASSERT_UINT16_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 83 - `TEST_ASSERT_UINT32_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 84 - `TEST_ASSERT_UINT64_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 85 - `TEST_ASSERT_HEX_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 86 - `TEST_ASSERT_HEX8_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 87 - `TEST_ASSERT_HEX16_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 88 - `TEST_ASSERT_HEX32_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 89 - `TEST_ASSERT_HEX64_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 90
demayer 0:6bf0743ece18 91 #### Memory:
demayer 0:6bf0743ece18 92
demayer 0:6bf0743ece18 93 - `TEST_ASSERT_EQUAL_PTR(expected, actual)`
demayer 0:6bf0743ece18 94 - `TEST_ASSERT_EQUAL_STRING(expected, actual)`
demayer 0:6bf0743ece18 95 - `TEST_ASSERT_EQUAL_STRING_LEN(expected, actual, len)`
demayer 0:6bf0743ece18 96 - `TEST_ASSERT_EQUAL_MEMORY(expected, actual, len)`
demayer 0:6bf0743ece18 97
demayer 0:6bf0743ece18 98 #### Array:
demayer 0:6bf0743ece18 99
demayer 0:6bf0743ece18 100 - `TEST_ASSERT_EQUAL_INT_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 101 - `TEST_ASSERT_EQUAL_INT8_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 102 - `TEST_ASSERT_EQUAL_INT16_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 103 - `TEST_ASSERT_EQUAL_INT32_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 104 - `TEST_ASSERT_EQUAL_INT64_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 105 - `TEST_ASSERT_EQUAL_UINT_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 106 - `TEST_ASSERT_EQUAL_UINT8_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 107 - `TEST_ASSERT_EQUAL_UINT16_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 108 - `TEST_ASSERT_EQUAL_UINT32_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 109 - `TEST_ASSERT_EQUAL_UINT64_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 110 - `TEST_ASSERT_EQUAL_HEX_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 111 - `TEST_ASSERT_EQUAL_HEX8_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 112 - `TEST_ASSERT_EQUAL_HEX16_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 113 - `TEST_ASSERT_EQUAL_HEX32_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 114 - `TEST_ASSERT_EQUAL_HEX64_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 115 - `TEST_ASSERT_EQUAL_PTR_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 116 - `TEST_ASSERT_EQUAL_STRING_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 117 - `TEST_ASSERT_EQUAL_MEMORY_ARRAY(expected, actual, len, num_elements)`
demayer 0:6bf0743ece18 118
demayer 0:6bf0743ece18 119 #### Single Precision Floating Point:
demayer 0:6bf0743ece18 120
demayer 0:6bf0743ece18 121 - `TEST_ASSERT_FLOAT_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 122 - `TEST_ASSERT_EQUAL_FLOAT(expected, actual)`
demayer 0:6bf0743ece18 123 - `TEST_ASSERT_EQUAL_FLOAT_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 124 - `TEST_ASSERT_FLOAT_IS_INF(actual)`
demayer 0:6bf0743ece18 125 - `TEST_ASSERT_FLOAT_IS_NEG_INF(actual)`
demayer 0:6bf0743ece18 126 - `TEST_ASSERT_FLOAT_IS_NAN(actual)`
demayer 0:6bf0743ece18 127 - `TEST_ASSERT_FLOAT_IS_DETERMINATE(actual)`
demayer 0:6bf0743ece18 128 - `TEST_ASSERT_FLOAT_IS_NOT_INF(actual)`
demayer 0:6bf0743ece18 129 - `TEST_ASSERT_FLOAT_IS_NOT_NEG_INF(actual)`
demayer 0:6bf0743ece18 130 - `TEST_ASSERT_FLOAT_IS_NOT_NAN(actual)`
demayer 0:6bf0743ece18 131 - `TEST_ASSERT_FLOAT_IS_NOT_DETERMINATE(actual)`
demayer 0:6bf0743ece18 132
demayer 0:6bf0743ece18 133 #### Double Precision Floating Point:
demayer 0:6bf0743ece18 134
demayer 0:6bf0743ece18 135 - `TEST_ASSERT_DOUBLE_WITHIN(delta, expected, actual)`
demayer 0:6bf0743ece18 136 - `TEST_ASSERT_EQUAL_DOUBLE(expected, actual)`
demayer 0:6bf0743ece18 137 - `TEST_ASSERT_EQUAL_DOUBLE_ARRAY(expected, actual, num_elements)`
demayer 0:6bf0743ece18 138 - `TEST_ASSERT_DOUBLE_IS_INF(actual)`
demayer 0:6bf0743ece18 139 - `TEST_ASSERT_DOUBLE_IS_NEG_INF(actual)`
demayer 0:6bf0743ece18 140 - `TEST_ASSERT_DOUBLE_IS_NAN(actual)`
demayer 0:6bf0743ece18 141 - `TEST_ASSERT_DOUBLE_IS_DETERMINATE(actual)`
demayer 0:6bf0743ece18 142 - `TEST_ASSERT_DOUBLE_IS_NOT_INF(actual)`
demayer 0:6bf0743ece18 143 - `TEST_ASSERT_DOUBLE_IS_NOT_NEG_INF(actual)`
demayer 0:6bf0743ece18 144 - `TEST_ASSERT_DOUBLE_IS_NOT_NAN(actual)`
demayer 0:6bf0743ece18 145 - `TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE(actual)`