Kenji Arai / mbed-os_TYBLE16

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.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/frameworks/unity/README.md@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
mbed-os5 only for TYBLE16

Who changed what in which revision?

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