EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/frameworks/unity/README.md@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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