mirror of
https://github.com/ThrowTheSwitch/Unity.git
synced 2026-01-23 08:25:58 +01:00
Compare commits
404 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c3d7662a1e | ||
|
|
ded22fef63 | ||
|
|
37a0f7184c | ||
|
|
2aaf3c4504 | ||
|
|
d34f72282f | ||
|
|
179b492e18 | ||
|
|
5dd5931114 | ||
|
|
94dc637d03 | ||
|
|
e40b0bf2b5 | ||
|
|
efd02920ca | ||
|
|
fbded74349 | ||
|
|
3fb86421b2 | ||
|
|
8072c5c946 | ||
|
|
32e6d93ab0 | ||
|
|
a303e08859 | ||
|
|
34ebd82d8c | ||
|
|
9c82fac380 | ||
|
|
cf5b2d2568 | ||
|
|
74d47e8afa | ||
|
|
354e2b4da6 | ||
|
|
60b23dc8a4 | ||
|
|
e1dca8fa48 | ||
|
|
3f334b8be6 | ||
|
|
be87d790c7 | ||
|
|
b75b19c969 | ||
|
|
15631f1c78 | ||
|
|
8d044e60c6 | ||
|
|
368a7d8970 | ||
|
|
d16c27b085 | ||
|
|
748efa26b5 | ||
|
|
86b19304ed | ||
|
|
eb0bd42f0d | ||
|
|
addd60edab | ||
|
|
277e844bed | ||
|
|
d10cf6645d | ||
|
|
68cc45a918 | ||
|
|
5fc72fbca1 | ||
|
|
ff697ad29c | ||
|
|
ac427b28fc | ||
|
|
2d8a69e0d1 | ||
|
|
cb8744c496 | ||
|
|
c19e3f99ce | ||
|
|
9fdcc2d3ff | ||
|
|
d9b0edf282 | ||
|
|
0793de9ef1 | ||
|
|
9842a4d03d | ||
|
|
77008edca9 | ||
|
|
210b7759dd | ||
|
|
1748f00fc7 | ||
|
|
8227ea2c36 | ||
|
|
bcbb476e20 | ||
|
|
8ce41ede72 | ||
|
|
53916f823c | ||
|
|
5cb2b63490 | ||
|
|
50db1a7e67 | ||
|
|
e1381748f8 | ||
|
|
380103ab8c | ||
|
|
7df6cca794 | ||
|
|
75e88a9bc4 | ||
|
|
fc14856321 | ||
|
|
7e3804545c | ||
|
|
f4251bf87d | ||
|
|
bc7d89a891 | ||
|
|
e6f38c2792 | ||
|
|
31ab99b860 | ||
|
|
29af4c0e0d | ||
|
|
964a58c053 | ||
|
|
f2711a87a6 | ||
|
|
822e244bd4 | ||
|
|
c2c42ce14f | ||
|
|
9578a382cc | ||
|
|
46263fc148 | ||
|
|
2939c420ed | ||
|
|
7514b89fa6 | ||
|
|
3ac73efe62 | ||
|
|
1100c5d8f0 | ||
|
|
3afc0412e1 | ||
|
|
0892db2376 | ||
|
|
3e82c0a96f | ||
|
|
0000f1e6d2 | ||
|
|
a2f25d05d8 | ||
|
|
a54d58a8fd | ||
|
|
45020b0d3b | ||
|
|
bc72eeb211 | ||
|
|
6b2eb52468 | ||
|
|
4661e67233 | ||
|
|
af4c20fa20 | ||
|
|
c10f87f1e6 | ||
|
|
c7185b3a5a | ||
|
|
e89b281e43 | ||
|
|
b1fd5ad887 | ||
|
|
ab9f8d0959 | ||
|
|
c30730faf6 | ||
|
|
f2d826c7c5 | ||
|
|
bd4d35ddd0 | ||
|
|
7dbfc4be56 | ||
|
|
10f10b5e58 | ||
|
|
a59db2bdbf | ||
|
|
2b250055bc | ||
|
|
06ddace18d | ||
|
|
885ae9638e | ||
|
|
ae3aad7b89 | ||
|
|
8168382b91 | ||
|
|
c9b1d217fd | ||
|
|
ca1c7fa823 | ||
|
|
01a907393a | ||
|
|
18430d3b4f | ||
|
|
197bf351ae | ||
|
|
e9f9638497 | ||
|
|
071044bdd6 | ||
|
|
d70047881e | ||
|
|
2697770ae9 | ||
|
|
6a1c0590a9 | ||
|
|
fc7317f103 | ||
|
|
94446cdb5e | ||
|
|
2b0d093837 | ||
|
|
25c15f632e | ||
|
|
7514de0582 | ||
|
|
93fbc3fbd0 | ||
|
|
9340582797 | ||
|
|
89465c88b0 | ||
|
|
f51e658e8a | ||
|
|
480d505cd7 | ||
|
|
0bd6bf7b2b | ||
|
|
f69fbe8a95 | ||
|
|
d01e32299e | ||
|
|
52ff8613a2 | ||
|
|
2191b2ba8e | ||
|
|
8507757c6a | ||
|
|
aecc642594 | ||
|
|
2663cb9d0d | ||
|
|
6315c4c4c3 | ||
|
|
49ffac33ec | ||
|
|
0dafa0b306 | ||
|
|
a78c799701 | ||
|
|
ead95b3ab8 | ||
|
|
3e4d064c42 | ||
|
|
9dc7cb1b5c | ||
|
|
076f0fff56 | ||
|
|
145691519b | ||
|
|
9ef1088eb7 | ||
|
|
b723c9f250 | ||
|
|
d451148907 | ||
|
|
bc2ab233ee | ||
|
|
9d1ffe26d6 | ||
|
|
38c48704c5 | ||
|
|
a6e9f85f71 | ||
|
|
69cebb5c30 | ||
|
|
5074a3d8b2 | ||
|
|
92a345b264 | ||
|
|
4f8656f658 | ||
|
|
95ccc6edc1 | ||
|
|
5918ee0cdf | ||
|
|
a284984365 | ||
|
|
516f7be045 | ||
|
|
38d8263741 | ||
|
|
5db2a3dbd9 | ||
|
|
f433480f7f | ||
|
|
8e0f54d23b | ||
|
|
d09f4953ff | ||
|
|
8a77f48634 | ||
|
|
39fbd13cae | ||
|
|
58be52f088 | ||
|
|
5cd1c33b0e | ||
|
|
6b657c6f17 | ||
|
|
28bf7954f2 | ||
|
|
e8ba63cf7b | ||
|
|
100c73d37f | ||
|
|
eab9283a98 | ||
|
|
7dd21c333e | ||
|
|
695dd04d53 | ||
|
|
27f631aaa8 | ||
|
|
50ce8a880a | ||
|
|
96127581a0 | ||
|
|
be765649f1 | ||
|
|
f1100dd19a | ||
|
|
b4ab81bbe9 | ||
|
|
e84cb29acc | ||
|
|
7d2bf62b7e | ||
|
|
01cbce870a | ||
|
|
e4dfeaa14d | ||
|
|
7cc3cf478b | ||
|
|
e025b8cd1d | ||
|
|
e2e549a22f | ||
|
|
e0d52d1a79 | ||
|
|
56f1646087 | ||
|
|
8ba35a0e52 | ||
|
|
5d2ef07054 | ||
|
|
c64cc7d4f4 | ||
|
|
f60ab920c9 | ||
|
|
ea5e51ffcc | ||
|
|
020a531e4b | ||
|
|
bfd7828e66 | ||
|
|
9987824da7 | ||
|
|
031f3bbe45 | ||
|
|
a6a35b78ae | ||
|
|
e72dfafd44 | ||
|
|
fb4b139043 | ||
|
|
f0e4571c96 | ||
|
|
ccb7faf3bd | ||
|
|
18e4fbe2ae | ||
|
|
6a1d2e8d44 | ||
|
|
ac3cde30f5 | ||
|
|
1f6c782040 | ||
|
|
2c5d09bf20 | ||
|
|
40af5e23eb | ||
|
|
199b13c099 | ||
|
|
ceecf1fae8 | ||
|
|
d915bf7ae5 | ||
|
|
e2ee98e3d6 | ||
|
|
38e1ee872c | ||
|
|
1994bf9d68 | ||
|
|
7a43766586 | ||
|
|
ea51e2b35c | ||
|
|
0937bf728c | ||
|
|
e038ae2ade | ||
|
|
436a46d8ef | ||
|
|
2480a6124e | ||
|
|
5f67ac6ab2 | ||
|
|
37271e8a13 | ||
|
|
25804f3ab4 | ||
|
|
456759296b | ||
|
|
fe950b9fa3 | ||
|
|
8efa8ffc62 | ||
|
|
d9cd6988f3 | ||
|
|
4dfb512a27 | ||
|
|
7a1157d6f6 | ||
|
|
dc9c7a7b4b | ||
|
|
9bada282f4 | ||
|
|
a6b925a01f | ||
|
|
91a2353526 | ||
|
|
0760230829 | ||
|
|
b4aca70fd9 | ||
|
|
62f6cb247a | ||
|
|
4325773e76 | ||
|
|
29803b65ac | ||
|
|
53f0f95ef8 | ||
|
|
287e076962 | ||
|
|
a6d3f3a59a | ||
|
|
2d4e32cda1 | ||
|
|
74ba70283a | ||
|
|
8ff74d6000 | ||
|
|
774da10e00 | ||
|
|
629b86d541 | ||
|
|
0914d80121 | ||
|
|
5ee55fefda | ||
|
|
38c387b76f | ||
|
|
17d4ea92e1 | ||
|
|
031b1ba469 | ||
|
|
df78aade4b | ||
|
|
a7e8797e0c | ||
|
|
94a3008a9d | ||
|
|
b119919c4f | ||
|
|
91bcbe186d | ||
|
|
8caade7e68 | ||
|
|
1381a1a4cb | ||
|
|
2593c31bb7 | ||
|
|
60def109a7 | ||
|
|
60b13f0685 | ||
|
|
f278c18fd9 | ||
|
|
bdd4cb19d6 | ||
|
|
fcd4883c5e | ||
|
|
cc909efed3 | ||
|
|
05daf95d4e | ||
|
|
7b2ad10c92 | ||
|
|
0547aab67e | ||
|
|
2ae2bdb376 | ||
|
|
dbdd168e46 | ||
|
|
0e7eb545b9 | ||
|
|
a868b2eb73 | ||
|
|
e56378e437 | ||
|
|
ad373024f2 | ||
|
|
b3de931d69 | ||
|
|
59182c4ea9 | ||
|
|
a07d07cd1a | ||
|
|
c1bc32dc58 | ||
|
|
f2fdf1a133 | ||
|
|
3b69beaa58 | ||
|
|
aef36799d8 | ||
|
|
f96c05532b | ||
|
|
2c7629a0ae | ||
|
|
b8bfb01edf | ||
|
|
e36d8b5327 | ||
|
|
1e4396745c | ||
|
|
e2cc67918d | ||
|
|
192d5176f1 | ||
|
|
c48f6c9420 | ||
|
|
2a5b24f7bf | ||
|
|
3e0a7121fb | ||
|
|
23f9c16aaa | ||
|
|
3a6cca39c5 | ||
|
|
3062c39725 | ||
|
|
550d58ba2d | ||
|
|
ee038c248c | ||
|
|
d6b350874b | ||
|
|
4ffafce309 | ||
|
|
083564b837 | ||
|
|
0dddf498c2 | ||
|
|
a11a13750d | ||
|
|
d8d67a708c | ||
|
|
b7956ea988 | ||
|
|
7fe31915d0 | ||
|
|
56eeacd0b2 | ||
|
|
7b80885c68 | ||
|
|
0781e74ac6 | ||
|
|
c3658a065d | ||
|
|
8a45ccf406 | ||
|
|
689610b864 | ||
|
|
43c751173d | ||
|
|
1c556d2e4c | ||
|
|
8723d50f0e | ||
|
|
c67a4ffcf3 | ||
|
|
41ee499e63 | ||
|
|
1f522558a6 | ||
|
|
7bce0b4f0c | ||
|
|
b5da224fd8 | ||
|
|
1bf22d39f5 | ||
|
|
2988e980fb | ||
|
|
1732698324 | ||
|
|
381737538d | ||
|
|
9d5159f940 | ||
|
|
65ce72729c | ||
|
|
4dc04d3977 | ||
|
|
1782bab0ba | ||
|
|
b10e9d0486 | ||
|
|
60d59d7043 | ||
|
|
3588e5b6d3 | ||
|
|
b4f6afa4cf | ||
|
|
ff03e1c915 | ||
|
|
e0104179ed | ||
|
|
a15f0da0d0 | ||
|
|
78938f6f05 | ||
|
|
a3fe04f6a4 | ||
|
|
97e4bd252a | ||
|
|
bb7f889f03 | ||
|
|
b29ad2ee68 | ||
|
|
9cdc3d678b | ||
|
|
185fb49380 | ||
|
|
04e10f95ee | ||
|
|
f1fdc47e40 | ||
|
|
de6f516330 | ||
|
|
437c474b07 | ||
|
|
d460a89a04 | ||
|
|
74f377f048 | ||
|
|
fb49b34979 | ||
|
|
480335061c | ||
|
|
01ca3899c2 | ||
|
|
836d7886cf | ||
|
|
ef1e2ad58c | ||
|
|
ee38219498 | ||
|
|
4d747080a9 | ||
|
|
5449f1e4d1 | ||
|
|
6695e9e975 | ||
|
|
c5e9a93418 | ||
|
|
9954d4f863 | ||
|
|
7b87a579d1 | ||
|
|
9e8ab3df84 | ||
|
|
85ef109282 | ||
|
|
6c0ca7339f | ||
|
|
5112d7dfbd | ||
|
|
41df8feaee | ||
|
|
4c78cde202 | ||
|
|
e92f2c2762 | ||
|
|
f771f0b98f | ||
|
|
bd4ac58486 | ||
|
|
a0cb138533 | ||
|
|
5f33721924 | ||
|
|
03e2209e1b | ||
|
|
994779f0ce | ||
|
|
f8c585cb93 | ||
|
|
65e401f3de | ||
|
|
64f90b1925 | ||
|
|
53bdb6897f | ||
|
|
e1e866ab45 | ||
|
|
46560a8030 | ||
|
|
5f386a42ff | ||
|
|
0603c1cf1e | ||
|
|
b0870ec8b9 | ||
|
|
ee02e3885f | ||
|
|
df2d37459b | ||
|
|
7b51355e5a | ||
|
|
8e31f5d869 | ||
|
|
b77c6b833f | ||
|
|
37049a3a20 | ||
|
|
4386cf356f | ||
|
|
4e2f0381cc | ||
|
|
aa4d773df2 | ||
|
|
25f6417351 | ||
|
|
9f4b1a332f | ||
|
|
47f6a85b8c | ||
|
|
54fe786fae | ||
|
|
4a27d14734 | ||
|
|
1dfcb54491 | ||
|
|
393f2cb544 | ||
|
|
2de0e8285d | ||
|
|
e48fe0a07c | ||
|
|
30ba118c47 | ||
|
|
9653fbf7ac | ||
|
|
012064eaea | ||
|
|
4faae4435d | ||
|
|
ac455f2798 | ||
|
|
d4a35f0949 | ||
|
|
6ec7c78b66 | ||
|
|
ae5b4c5799 |
27
.editorconfig
Normal file
27
.editorconfig
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
###############################################################################
|
||||||
|
# Unity Project - A Test Framework for C
|
||||||
|
# .editorconfig - F. Zahn 2019
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
# This is the topmost .editorconfig file
|
||||||
|
root = true
|
||||||
|
|
||||||
|
# Settings that apply to all languages / files
|
||||||
|
[*]
|
||||||
|
charset = utf-8
|
||||||
|
indent_size = 4
|
||||||
|
indent_style = space
|
||||||
|
insert_final_newline = true
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
|
||||||
|
[*.md]
|
||||||
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
|
[*.txt]
|
||||||
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
|
[*.rb]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.yml]
|
||||||
|
indent_size = 2
|
||||||
1
.gitattributes
vendored
1
.gitattributes
vendored
@@ -16,6 +16,7 @@
|
|||||||
*.md text
|
*.md text
|
||||||
makefile text
|
makefile text
|
||||||
rakefile text
|
rakefile text
|
||||||
|
meson.build text
|
||||||
|
|
||||||
|
|
||||||
#These files are binary and should not be normalized
|
#These files are binary and should not be normalized
|
||||||
|
|||||||
10
.gitignore
vendored
10
.gitignore
vendored
@@ -1,9 +1,11 @@
|
|||||||
build/
|
build/
|
||||||
|
builddir/
|
||||||
|
test/sandbox
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
examples/example_1/test1.exe
|
||||||
|
examples/example_1/test2.exe
|
||||||
|
examples/example_2/all_tests.exe
|
||||||
examples/example_1/test1.out
|
examples/example_1/test1.out
|
||||||
examples/example_1/test2.out
|
examples/example_1/test2.out
|
||||||
examples/example_2/all_tests.out
|
examples/example_2/all_tests.out
|
||||||
examples/example_3/test1.out
|
examples/example_4/builddir
|
||||||
examples/example_3/test2.out
|
|
||||||
test/testparameterized.c.results
|
|
||||||
test/testunity.c.results
|
|
||||||
|
|||||||
15
.travis.yml
15
.travis.yml
@@ -10,10 +10,23 @@ matrix:
|
|||||||
compiler: gcc
|
compiler: gcc
|
||||||
|
|
||||||
before_install:
|
before_install:
|
||||||
- if [ "$TRAVIS_OS_NAME" == "osx" ]; then rvm install 2.1 && rvm use 2.1 && ruby -v; fi
|
- if [ "$TRAVIS_OS_NAME" == "osx" ]; then rvm install 2.3 && rvm use 2.3 && ruby -v; fi
|
||||||
|
- if [ "$TRAVIS_OS_NAME" == "linux" ]; then sudo apt-get install --assume-yes --quiet gcc-multilib; fi
|
||||||
|
install:
|
||||||
|
- gem install rspec
|
||||||
|
- gem install rubocop -v 0.57.2
|
||||||
script:
|
script:
|
||||||
- cd test && rake ci
|
- cd test && rake ci
|
||||||
- make -s
|
- make -s
|
||||||
|
- make -s DEBUG=-m32 #32-bit architecture with 64-bit support
|
||||||
|
- make -s DEBUG=-m32 UNITY_SUPPORT_64= #32-bit build without 64-bit types
|
||||||
|
- make -s UNITY_INCLUDE_DOUBLE= # without double
|
||||||
- cd ../extras/fixture/test && rake ci
|
- cd ../extras/fixture/test && rake ci
|
||||||
- make -s default noStdlibMalloc
|
- make -s default noStdlibMalloc
|
||||||
- make -s C89
|
- make -s C89
|
||||||
|
- cd ../../../extras/memory/test && rake ci
|
||||||
|
- make -s default noStdlibMalloc
|
||||||
|
- make -s C89
|
||||||
|
- cd ../../../examples/example_1 && make -s ci
|
||||||
|
- cd ../example_2 && make -s ci
|
||||||
|
- cd ../example_3 && rake
|
||||||
|
|||||||
31
CMakeLists.txt
Normal file
31
CMakeLists.txt
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
###################################################################################
|
||||||
|
# #
|
||||||
|
# NAME: CMakeLists.txt #
|
||||||
|
# #
|
||||||
|
# AUTHOR: Mike Karlesky, Mark VanderVoord, Greg Williams. #
|
||||||
|
# WRITTEN BY: Michael Brockus. #
|
||||||
|
# #
|
||||||
|
# License: MIT #
|
||||||
|
# #
|
||||||
|
###################################################################################
|
||||||
|
cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
|
||||||
|
|
||||||
|
|
||||||
|
project(unity LANGUAGES C DESCRIPTION "C Unit testing framework.")
|
||||||
|
|
||||||
|
add_subdirectory(src)
|
||||||
|
target_include_directories(unity
|
||||||
|
PUBLIC
|
||||||
|
"$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>"
|
||||||
|
"$<INSTALL_INTERFACE:src>"
|
||||||
|
|
||||||
|
PRIVATE "src"
|
||||||
|
)
|
||||||
|
|
||||||
|
add_library(unity::framework ALIAS unity)
|
||||||
|
|
||||||
|
install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/src/ DESTINATION src)
|
||||||
|
install(EXPORT unityConfig DESTINATION share/unityConfig/cmake)
|
||||||
|
|
||||||
|
# This makes the project importable from the build directory
|
||||||
|
export(TARGETS unity FILE unityConfig.cmake)
|
||||||
98
README.md
98
README.md
@@ -2,56 +2,16 @@ Unity Test API
|
|||||||
==============
|
==============
|
||||||
|
|
||||||
[](https://travis-ci.org/ThrowTheSwitch/Unity)
|
[](https://travis-ci.org/ThrowTheSwitch/Unity)
|
||||||
__Copyright (c) 2007 - 2014 Unity Project by Mike Karlesky, Mark VanderVoord, and Greg Williams__
|
__Copyright (c) 2007 - 2019 Unity Project by Mike Karlesky, Mark VanderVoord, and Greg Williams__
|
||||||
|
|
||||||
Running Tests
|
|
||||||
-------------
|
|
||||||
|
|
||||||
RUN_TEST(func, linenum)
|
|
||||||
|
|
||||||
Each Test is run within the macro `RUN_TEST`. This macro performs necessary setup before the test is called and handles cleanup and result tabulation afterwards.
|
|
||||||
|
|
||||||
Ignoring Tests
|
|
||||||
--------------
|
|
||||||
|
|
||||||
There are times when a test is incomplete or not valid for some reason. At these times, TEST_IGNORE can be called. Control will immediately be returned to the caller of the test, and no failures will be returned.
|
|
||||||
|
|
||||||
TEST_IGNORE()
|
|
||||||
|
|
||||||
Ignore this test and return immediately
|
|
||||||
|
|
||||||
TEST_IGNORE_MESSAGE (message)
|
|
||||||
|
|
||||||
Ignore this test and return immediately. Output a message stating why the test was ignored.
|
|
||||||
|
|
||||||
Aborting Tests
|
|
||||||
--------------
|
|
||||||
|
|
||||||
There are times when a test will contain an infinite loop on error conditions, or there may be reason to escape from the test early without executing the rest of the test. A pair of macros support this functionality in Unity. The first `TEST_PROTECT` sets up the feature, and handles emergency abort cases. `TEST_ABORT` can then be used at any time within the tests to return to the last `TEST_PROTECT` call.
|
|
||||||
|
|
||||||
TEST_PROTECT()
|
|
||||||
|
|
||||||
Setup and Catch macro
|
|
||||||
|
|
||||||
TEST_ABORT()
|
|
||||||
|
|
||||||
Abort Test macro
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
main()
|
|
||||||
{
|
|
||||||
if (TEST_PROTECT() == 0)
|
|
||||||
{
|
|
||||||
MyTest();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
If MyTest calls `TEST_ABORT`, program control will immediately return to `TEST_PROTECT` with a non-zero return value.
|
|
||||||
|
|
||||||
|
Getting Started
|
||||||
|
===============
|
||||||
|
The [docs](docs/) folder contains a [getting started guide](docs/UnityGettingStartedGuide.md)
|
||||||
|
and much more tips about using Unity.
|
||||||
|
|
||||||
Unity Assertion Summary
|
Unity Assertion Summary
|
||||||
=======================
|
=======================
|
||||||
|
For the full list, see [UnityAssertionsReference.md](docs/UnityAssertionsReference.md).
|
||||||
|
|
||||||
Basic Validity Tests
|
Basic Validity Tests
|
||||||
--------------------
|
--------------------
|
||||||
@@ -75,7 +35,7 @@ Another way of calling `TEST_ASSERT_FALSE`
|
|||||||
TEST_FAIL()
|
TEST_FAIL()
|
||||||
TEST_FAIL_MESSAGE(message)
|
TEST_FAIL_MESSAGE(message)
|
||||||
|
|
||||||
This test is automatically marked as a failure. The message is output stating why.
|
This test is automatically marked as a failure. The message is output stating why.
|
||||||
|
|
||||||
Numerical Assertions: Integers
|
Numerical Assertions: Integers
|
||||||
------------------------------
|
------------------------------
|
||||||
@@ -87,7 +47,7 @@ Numerical Assertions: Integers
|
|||||||
TEST_ASSERT_EQUAL_INT64(expected, actual)
|
TEST_ASSERT_EQUAL_INT64(expected, actual)
|
||||||
|
|
||||||
Compare two integers for equality and display errors as signed integers. A cast will be performed
|
Compare two integers for equality and display errors as signed integers. A cast will be performed
|
||||||
to your natural integer size so often this can just be used. When you need to specify the exact size,
|
to your natural integer size so often this can just be used. When you need to specify the exact size,
|
||||||
like when comparing arrays, you can use a specific version:
|
like when comparing arrays, you can use a specific version:
|
||||||
|
|
||||||
TEST_ASSERT_EQUAL_UINT(expected, actual)
|
TEST_ASSERT_EQUAL_UINT(expected, actual)
|
||||||
@@ -96,7 +56,7 @@ like when comparing arrays, you can use a specific version:
|
|||||||
TEST_ASSERT_EQUAL_UINT32(expected, actual)
|
TEST_ASSERT_EQUAL_UINT32(expected, actual)
|
||||||
TEST_ASSERT_EQUAL_UINT64(expected, actual)
|
TEST_ASSERT_EQUAL_UINT64(expected, actual)
|
||||||
|
|
||||||
Compare two integers for equality and display errors as unsigned integers. Like INT, there are
|
Compare two integers for equality and display errors as unsigned integers. Like INT, there are
|
||||||
variants for different sizes also.
|
variants for different sizes also.
|
||||||
|
|
||||||
TEST_ASSERT_EQUAL_HEX(expected, actual)
|
TEST_ASSERT_EQUAL_HEX(expected, actual)
|
||||||
@@ -105,10 +65,33 @@ variants for different sizes also.
|
|||||||
TEST_ASSERT_EQUAL_HEX32(expected, actual)
|
TEST_ASSERT_EQUAL_HEX32(expected, actual)
|
||||||
TEST_ASSERT_EQUAL_HEX64(expected, actual)
|
TEST_ASSERT_EQUAL_HEX64(expected, actual)
|
||||||
|
|
||||||
Compares two integers for equality and display errors as hexadecimal. Like the other integer comparisons,
|
Compares two integers for equality and display errors as hexadecimal. Like the other integer comparisons,
|
||||||
you can specify the size... here the size will also effect how many nibbles are shown (for example, `HEX16`
|
you can specify the size... here the size will also effect how many nibbles are shown (for example, `HEX16`
|
||||||
will show 4 nibbles).
|
will show 4 nibbles).
|
||||||
|
|
||||||
|
TEST_ASSERT_EQUAL(expected, actual)
|
||||||
|
|
||||||
|
Another way of calling TEST_ASSERT_EQUAL_INT
|
||||||
|
|
||||||
|
TEST_ASSERT_INT_WITHIN(delta, expected, actual)
|
||||||
|
|
||||||
|
Asserts that the actual value is within plus or minus delta of the expected value. This also comes in
|
||||||
|
size specific variants.
|
||||||
|
|
||||||
|
|
||||||
|
TEST_ASSERT_GREATER_THAN(threshold, actual)
|
||||||
|
|
||||||
|
Asserts that the actual value is greater than the threshold. This also comes in size specific variants.
|
||||||
|
|
||||||
|
|
||||||
|
TEST_ASSERT_LESS_THAN(threshold, actual)
|
||||||
|
|
||||||
|
Asserts that the actual value is less than the threshold. This also comes in size specific variants.
|
||||||
|
|
||||||
|
|
||||||
|
Arrays
|
||||||
|
------
|
||||||
|
|
||||||
_ARRAY
|
_ARRAY
|
||||||
|
|
||||||
You can append `_ARRAY` to any of these macros to make an array comparison of that type. Here you will
|
You can append `_ARRAY` to any of these macros to make an array comparison of that type. Here you will
|
||||||
@@ -117,15 +100,12 @@ additional argument which is the number of elements to compare. For example:
|
|||||||
|
|
||||||
TEST_ASSERT_EQUAL_HEX8_ARRAY(expected, actual, elements)
|
TEST_ASSERT_EQUAL_HEX8_ARRAY(expected, actual, elements)
|
||||||
|
|
||||||
TEST_ASSERT_EQUAL(expected, actual)
|
_EACH_EQUAL
|
||||||
|
|
||||||
Another way of calling TEST_ASSERT_EQUAL_INT
|
Another array comparison option is to check that EVERY element of an array is equal to a single expected
|
||||||
|
value. You do this by specifying the EACH_EQUAL macro. For example:
|
||||||
TEST_ASSERT_INT_WITHIN(delta, expected, actual)
|
|
||||||
|
|
||||||
Asserts that the actual value is within plus or minus delta of the expected value. This also comes in
|
|
||||||
size specific variants.
|
|
||||||
|
|
||||||
|
TEST_ASSERT_EACH_EQUAL_INT32(expected, actual, elements)
|
||||||
|
|
||||||
Numerical Assertions: Bitwise
|
Numerical Assertions: Bitwise
|
||||||
-----------------------------
|
-----------------------------
|
||||||
@@ -179,12 +159,12 @@ Compare two null-terminate strings. Fail if any character is different or if th
|
|||||||
|
|
||||||
TEST_ASSERT_EQUAL_STRING_LEN_MESSAGE(expected, actual, len, message)
|
TEST_ASSERT_EQUAL_STRING_LEN_MESSAGE(expected, actual, len, message)
|
||||||
|
|
||||||
Compare two strings. Fail if any character is different, stop comparing after len characters. Output a custom message on failure.
|
Compare two strings. Fail if any character is different, stop comparing after len characters. Output a custom message on failure.
|
||||||
|
|
||||||
Pointer Assertions
|
Pointer Assertions
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
Most pointer operations can be performed by simply using the integer comparisons above. However, a couple of special cases are added for clarity.
|
Most pointer operations can be performed by simply using the integer comparisons above. However, a couple of special cases are added for clarity.
|
||||||
|
|
||||||
TEST_ASSERT_NULL(pointer)
|
TEST_ASSERT_NULL(pointer)
|
||||||
|
|
||||||
|
|||||||
@@ -4,63 +4,63 @@
|
|||||||
# [Released under MIT License. Please refer to license.txt for details]
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
if RUBY_PLATFORM =~/(win|w)32$/
|
if RUBY_PLATFORM =~ /(win|w)32$/
|
||||||
begin
|
begin
|
||||||
require 'Win32API'
|
require 'Win32API'
|
||||||
rescue LoadError
|
rescue LoadError
|
||||||
puts "ERROR! \"Win32API\" library not found"
|
puts 'ERROR! "Win32API" library not found'
|
||||||
puts "\"Win32API\" is required for colour on a windows machine"
|
puts '"Win32API" is required for colour on a windows machine'
|
||||||
puts " try => \"gem install Win32API\" on the command line"
|
puts ' try => "gem install Win32API" on the command line'
|
||||||
puts
|
puts
|
||||||
end
|
end
|
||||||
# puts
|
# puts
|
||||||
# puts 'Windows Environment Detected...'
|
# puts 'Windows Environment Detected...'
|
||||||
# puts 'Win32API Library Found.'
|
# puts 'Win32API Library Found.'
|
||||||
# puts
|
# puts
|
||||||
end
|
end
|
||||||
|
|
||||||
class ColourCommandLine
|
class ColourCommandLine
|
||||||
def initialize
|
def initialize
|
||||||
if RUBY_PLATFORM =~/(win|w)32$/
|
return unless RUBY_PLATFORM =~ /(win|w)32$/
|
||||||
get_std_handle = Win32API.new("kernel32", "GetStdHandle", ['L'], 'L')
|
|
||||||
@set_console_txt_attrb =
|
get_std_handle = Win32API.new('kernel32', 'GetStdHandle', ['L'], 'L')
|
||||||
Win32API.new("kernel32","SetConsoleTextAttribute",['L','N'], 'I')
|
@set_console_txt_attrb =
|
||||||
@hout = get_std_handle.call(-11)
|
Win32API.new('kernel32', 'SetConsoleTextAttribute', %w[L N], 'I')
|
||||||
end
|
@hout = get_std_handle.call(-11)
|
||||||
end
|
end
|
||||||
|
|
||||||
def change_to(new_colour)
|
def change_to(new_colour)
|
||||||
if RUBY_PLATFORM =~/(win|w)32$/
|
if RUBY_PLATFORM =~ /(win|w)32$/
|
||||||
@set_console_txt_attrb.call(@hout,self.win32_colour(new_colour))
|
@set_console_txt_attrb.call(@hout, win32_colour(new_colour))
|
||||||
else
|
else
|
||||||
"\033[30;#{posix_colour(new_colour)};22m"
|
"\033[30;#{posix_colour(new_colour)};22m"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def win32_colour(colour)
|
def win32_colour(colour)
|
||||||
case colour
|
case colour
|
||||||
when :black then 0
|
when :black then 0
|
||||||
when :dark_blue then 1
|
when :dark_blue then 1
|
||||||
when :dark_green then 2
|
when :dark_green then 2
|
||||||
when :dark_cyan then 3
|
when :dark_cyan then 3
|
||||||
when :dark_red then 4
|
when :dark_red then 4
|
||||||
when :dark_purple then 5
|
when :dark_purple then 5
|
||||||
when :dark_yellow, :narrative then 6
|
when :dark_yellow, :narrative then 6
|
||||||
when :default_white, :default, :dark_white then 7
|
when :default_white, :default, :dark_white then 7
|
||||||
when :silver then 8
|
when :silver then 8
|
||||||
when :blue then 9
|
when :blue then 9
|
||||||
when :green, :success then 10
|
when :green, :success then 10
|
||||||
when :cyan, :output then 11
|
when :cyan, :output then 11
|
||||||
when :red, :failure then 12
|
when :red, :failure then 12
|
||||||
when :purple then 13
|
when :purple then 13
|
||||||
when :yellow then 14
|
when :yellow then 14
|
||||||
when :white then 15
|
when :white then 15
|
||||||
else
|
else
|
||||||
0
|
0
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def posix_colour(colour)
|
def posix_colour(colour)
|
||||||
# ANSI Escape Codes - Foreground colors
|
# ANSI Escape Codes - Foreground colors
|
||||||
# | Code | Color |
|
# | Code | Color |
|
||||||
# | 39 | Default foreground color |
|
# | 39 | Default foreground color |
|
||||||
@@ -81,35 +81,39 @@ class ColourCommandLine
|
|||||||
# | 96 | Light cyan |
|
# | 96 | Light cyan |
|
||||||
# | 97 | White |
|
# | 97 | White |
|
||||||
|
|
||||||
case colour
|
case colour
|
||||||
when :black then 30
|
when :black then 30
|
||||||
when :red, :failure then 31
|
when :red, :failure then 31
|
||||||
when :green, :success then 32
|
when :green, :success then 32
|
||||||
when :yellow then 33
|
when :yellow then 33
|
||||||
when :blue, :narrative then 34
|
when :blue, :narrative then 34
|
||||||
when :purple, :magenta then 35
|
when :purple, :magenta then 35
|
||||||
when :cyan, :output then 36
|
when :cyan, :output then 36
|
||||||
when :white, :default_white then 37
|
when :white, :default_white then 37
|
||||||
when :default then 39
|
when :default then 39
|
||||||
else
|
else
|
||||||
39
|
39
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def out_c(mode, colour, str)
|
def out_c(mode, colour, str)
|
||||||
case RUBY_PLATFORM
|
case RUBY_PLATFORM
|
||||||
when /(win|w)32$/
|
when /(win|w)32$/
|
||||||
change_to(colour)
|
change_to(colour)
|
||||||
$stdout.puts str if mode == :puts
|
$stdout.puts str if mode == :puts
|
||||||
$stdout.print str if mode == :print
|
$stdout.print str if mode == :print
|
||||||
change_to(:default_white)
|
change_to(:default_white)
|
||||||
else
|
else
|
||||||
$stdout.puts("#{change_to(colour)}#{str}\033[0m") if mode == :puts
|
$stdout.puts("#{change_to(colour)}#{str}\033[0m") if mode == :puts
|
||||||
$stdout.print("#{change_to(colour)}#{str}\033[0m") if mode == :print
|
$stdout.print("#{change_to(colour)}#{str}\033[0m") if mode == :print
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end # ColourCommandLine
|
end
|
||||||
|
|
||||||
def colour_puts(role,str) ColourCommandLine.new.out_c(:puts, role, str) end
|
def colour_puts(role, str)
|
||||||
def colour_print(role,str) ColourCommandLine.new.out_c(:print, role, str) end
|
ColourCommandLine.new.out_c(:puts, role, str)
|
||||||
|
end
|
||||||
|
|
||||||
|
def colour_print(role, str)
|
||||||
|
ColourCommandLine.new.out_c(:print, role, str)
|
||||||
|
end
|
||||||
|
|||||||
@@ -2,38 +2,38 @@
|
|||||||
# Unity Project - A Test Framework for C
|
# Unity Project - A Test Framework for C
|
||||||
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
# [Released under MIT License. Please refer to license.txt for details]
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
require "#{File.expand_path(File.dirname(__FILE__))}/colour_prompt"
|
require_relative 'colour_prompt'
|
||||||
|
|
||||||
$colour_output = true
|
$colour_output = true
|
||||||
|
|
||||||
def report(message)
|
def report(message)
|
||||||
if not $colour_output
|
if !$colour_output
|
||||||
$stdout.puts(message)
|
$stdout.puts(message)
|
||||||
else
|
else
|
||||||
message = message.join('\n') if (message.class == Array)
|
message = message.join('\n') if message.class == Array
|
||||||
message.each_line do |line|
|
message.each_line do |line|
|
||||||
line.chomp!
|
line.chomp!
|
||||||
colour = case(line)
|
colour = case line
|
||||||
when /(?:total\s+)?tests:?\s+(\d+)\s+(?:total\s+)?failures:?\s+\d+\s+Ignored:?/i
|
when /(?:total\s+)?tests:?\s+(\d+)\s+(?:total\s+)?failures:?\s+\d+\s+Ignored:?/i
|
||||||
($1.to_i == 0) ? :green : :red
|
Regexp.last_match(1).to_i.zero? ? :green : :red
|
||||||
when /PASS/
|
when /PASS/
|
||||||
:green
|
:green
|
||||||
when /^OK$/
|
when /^OK$/
|
||||||
:green
|
:green
|
||||||
when /(?:FAIL|ERROR)/
|
when /(?:FAIL|ERROR)/
|
||||||
:red
|
:red
|
||||||
when /IGNORE/
|
when /IGNORE/
|
||||||
:yellow
|
:yellow
|
||||||
when /^(?:Creating|Compiling|Linking)/
|
when /^(?:Creating|Compiling|Linking)/
|
||||||
:white
|
:white
|
||||||
else
|
else
|
||||||
:silver
|
:silver
|
||||||
end
|
end
|
||||||
colour_puts(colour, line)
|
colour_puts(colour, line)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
$stdout.flush
|
$stdout.flush
|
||||||
$stderr.flush
|
$stderr.flush
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -10,9 +10,11 @@
|
|||||||
|
|
||||||
require 'rubygems'
|
require 'rubygems'
|
||||||
require 'fileutils'
|
require 'fileutils'
|
||||||
|
require 'pathname'
|
||||||
|
|
||||||
|
# TEMPLATE_TST
|
||||||
|
TEMPLATE_TST ||= '#include "unity.h"
|
||||||
|
|
||||||
#TEMPLATE_TST
|
|
||||||
TEMPLATE_TST ||= %q[#include "unity.h"
|
|
||||||
%2$s#include "%1$s.h"
|
%2$s#include "%1$s.h"
|
||||||
|
|
||||||
void setUp(void)
|
void setUp(void)
|
||||||
@@ -27,146 +29,190 @@ void test_%1$s_NeedToImplement(void)
|
|||||||
{
|
{
|
||||||
TEST_IGNORE_MESSAGE("Need to Implement %1$s");
|
TEST_IGNORE_MESSAGE("Need to Implement %1$s");
|
||||||
}
|
}
|
||||||
]
|
'.freeze
|
||||||
|
|
||||||
#TEMPLATE_SRC
|
# TEMPLATE_SRC
|
||||||
TEMPLATE_SRC ||= %q[%2$s#include "%1$s.h"
|
TEMPLATE_SRC ||= '%2$s#include "%1$s.h"
|
||||||
]
|
'.freeze
|
||||||
|
|
||||||
#TEMPLATE_INC
|
# TEMPLATE_INC
|
||||||
TEMPLATE_INC ||= %q[#ifndef _%3$s_H
|
TEMPLATE_INC ||= '#ifndef %3$s_H
|
||||||
#define _%3$s_H%2$s
|
#define %3$s_H
|
||||||
|
%2$s
|
||||||
|
|
||||||
#endif // _%3$s_H
|
#endif // %3$s_H
|
||||||
]
|
'.freeze
|
||||||
|
|
||||||
class UnityModuleGenerator
|
class UnityModuleGenerator
|
||||||
|
|
||||||
############################
|
############################
|
||||||
def initialize(options=nil)
|
def initialize(options = nil)
|
||||||
|
|
||||||
here = File.expand_path(File.dirname(__FILE__)) + '/'
|
|
||||||
|
|
||||||
@options = UnityModuleGenerator.default_options
|
@options = UnityModuleGenerator.default_options
|
||||||
case(options)
|
case options
|
||||||
when NilClass then @options
|
when NilClass then @options
|
||||||
when String then @options.merge!(UnityModuleGenerator.grab_config(options))
|
when String then @options.merge!(UnityModuleGenerator.grab_config(options))
|
||||||
when Hash then @options.merge!(options)
|
when Hash then @options.merge!(options)
|
||||||
else raise "If you specify arguments, it should be a filename or a hash of options"
|
else raise 'If you specify arguments, it should be a filename or a hash of options'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Create default file paths if none were provided
|
# Create default file paths if none were provided
|
||||||
@options[:path_src] = here + "../src/" if @options[:path_src].nil?
|
@options[:path_src] = "#{__dir__}/../src/" if @options[:path_src].nil?
|
||||||
@options[:path_inc] = @options[:path_src] if @options[:path_inc].nil?
|
@options[:path_inc] = @options[:path_src] if @options[:path_inc].nil?
|
||||||
@options[:path_tst] = here + "../test/" if @options[:path_tst].nil?
|
@options[:path_tst] = "#{__dir__}/../test/" if @options[:path_tst].nil?
|
||||||
@options[:path_src] += '/' unless (@options[:path_src][-1] == 47)
|
@options[:path_src] += '/' unless @options[:path_src][-1] == 47
|
||||||
@options[:path_inc] += '/' unless (@options[:path_inc][-1] == 47)
|
@options[:path_inc] += '/' unless @options[:path_inc][-1] == 47
|
||||||
@options[:path_tst] += '/' unless (@options[:path_tst][-1] == 47)
|
@options[:path_tst] += '/' unless @options[:path_tst][-1] == 47
|
||||||
|
|
||||||
#Built in patterns
|
# Built in patterns
|
||||||
@patterns = { 'src' => {'' => { :inc => [] } },
|
@patterns = {
|
||||||
'dh' => {'Driver' => { :inc => ['%1$sHardware.h'] },
|
'src' => {
|
||||||
'Hardware' => { :inc => [] }
|
'' => { inc: [] }
|
||||||
},
|
},
|
||||||
'dih' => {'Driver' => { :inc => ['%1$sHardware.h', '%1$sInterrupt.h'] },
|
'test' => {
|
||||||
'Interrupt'=> { :inc => ['%1$sHardware.h'] },
|
'' => { inc: [] }
|
||||||
'Hardware' => { :inc => [] }
|
},
|
||||||
},
|
'dh' => {
|
||||||
'mch' => {'Model' => { :inc => [] },
|
'Driver' => { inc: [create_filename('%1$s', 'Hardware.h')] },
|
||||||
'Conductor'=> { :inc => ['%1$sModel.h', '%1$sHardware.h'] },
|
'Hardware' => { inc: [] }
|
||||||
'Hardware' => { :inc => [] }
|
},
|
||||||
},
|
'dih' => {
|
||||||
'mvp' => {'Model' => { :inc => [] },
|
'Driver' => { inc: [create_filename('%1$s', 'Hardware.h'), create_filename('%1$s', 'Interrupt.h')] },
|
||||||
'Presenter'=> { :inc => ['%1$sModel.h', '%1$sView.h'] },
|
'Interrupt' => { inc: [create_filename('%1$s', 'Hardware.h')] },
|
||||||
'View' => { :inc => [] }
|
'Hardware' => { inc: [] }
|
||||||
}
|
},
|
||||||
}
|
'mch' => {
|
||||||
|
'Model' => { inc: [] },
|
||||||
|
'Conductor' => { inc: [create_filename('%1$s', 'Model.h'), create_filename('%1$s', 'Hardware.h')] },
|
||||||
|
'Hardware' => { inc: [] }
|
||||||
|
},
|
||||||
|
'mvp' => {
|
||||||
|
'Model' => { inc: [] },
|
||||||
|
'Presenter' => { inc: [create_filename('%1$s', 'Model.h'), create_filename('%1$s', 'View.h')] },
|
||||||
|
'View' => { inc: [] }
|
||||||
|
}
|
||||||
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
############################
|
############################
|
||||||
def self.default_options
|
def self.default_options
|
||||||
{
|
{
|
||||||
:pattern => "src",
|
pattern: 'src',
|
||||||
:includes =>
|
includes: {
|
||||||
{
|
src: [],
|
||||||
:src => [],
|
inc: [],
|
||||||
:inc => [],
|
tst: []
|
||||||
:tst => [],
|
|
||||||
},
|
},
|
||||||
:update_svn => false,
|
update_svn: false,
|
||||||
:boilerplates => {},
|
boilerplates: {},
|
||||||
:test_prefix => 'Test',
|
test_prefix: 'Test',
|
||||||
|
mock_prefix: 'Mock'
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
############################
|
############################
|
||||||
def self.grab_config(config_file)
|
def self.grab_config(config_file)
|
||||||
options = self.default_options
|
options = default_options
|
||||||
unless (config_file.nil? or config_file.empty?)
|
unless config_file.nil? || config_file.empty?
|
||||||
require 'yaml'
|
require 'yaml'
|
||||||
yaml_guts = YAML.load_file(config_file)
|
yaml_guts = YAML.load_file(config_file)
|
||||||
options.merge!(yaml_guts[:unity] || yaml_guts[:cmock])
|
options.merge!(yaml_guts[:unity] || yaml_guts[:cmock])
|
||||||
raise "No :unity or :cmock section found in #{config_file}" unless options
|
raise "No :unity or :cmock section found in #{config_file}" unless options
|
||||||
end
|
end
|
||||||
return(options)
|
options
|
||||||
end
|
end
|
||||||
|
|
||||||
############################
|
############################
|
||||||
def files_to_operate_on(module_name, pattern=nil)
|
def files_to_operate_on(module_name, pattern = nil)
|
||||||
#create triad definition
|
# strip any leading path information from the module name and save for later
|
||||||
prefix = @options[:test_prefix] || 'Test'
|
subfolder = File.dirname(module_name)
|
||||||
triad = [ { :ext => '.c', :path => @options[:path_src], :template => TEMPLATE_SRC, :inc => :src, :boilerplate => @options[:boilerplates][:src] },
|
module_name = File.basename(module_name)
|
||||||
{ :ext => '.h', :path => @options[:path_inc], :template => TEMPLATE_INC, :inc => :inc, :boilerplate => @options[:boilerplates][:inc] },
|
|
||||||
{ :ext => '.c', :path => @options[:path_tst]+prefix, :template => TEMPLATE_TST, :inc => :tst, :boilerplate => @options[:boilerplates][:tst] },
|
|
||||||
]
|
|
||||||
|
|
||||||
#prepare the pattern for use
|
# create triad definition
|
||||||
patterns = @patterns[(pattern || @options[:pattern] || 'src').downcase]
|
prefix = @options[:test_prefix] || 'Test'
|
||||||
|
triad = [{ ext: '.c', path: @options[:path_src], prefix: '', template: TEMPLATE_SRC, inc: :src, boilerplate: @options[:boilerplates][:src] },
|
||||||
|
{ ext: '.h', path: @options[:path_inc], prefix: '', template: TEMPLATE_INC, inc: :inc, boilerplate: @options[:boilerplates][:inc] },
|
||||||
|
{ ext: '.c', path: @options[:path_tst], prefix: prefix, template: TEMPLATE_TST, inc: :tst, boilerplate: @options[:boilerplates][:tst] }]
|
||||||
|
|
||||||
|
# prepare the pattern for use
|
||||||
|
pattern = (pattern || @options[:pattern] || 'src').downcase
|
||||||
|
patterns = @patterns[pattern]
|
||||||
raise "ERROR: The design pattern '#{pattern}' specified isn't one that I recognize!" if patterns.nil?
|
raise "ERROR: The design pattern '#{pattern}' specified isn't one that I recognize!" if patterns.nil?
|
||||||
|
|
||||||
|
# single file patterns (currently just 'test') can reject the other parts of the triad
|
||||||
|
triad.select! { |v| v[:inc] == :tst } if pattern == 'test'
|
||||||
|
|
||||||
# Assemble the path/names of the files we need to work with.
|
# Assemble the path/names of the files we need to work with.
|
||||||
files = []
|
files = []
|
||||||
triad.each do |triad|
|
triad.each do |cfg|
|
||||||
patterns.each_pair do |pattern_file, pattern_traits|
|
patterns.each_pair do |pattern_file, pattern_traits|
|
||||||
|
submodule_name = create_filename(module_name, pattern_file)
|
||||||
|
filename = cfg[:prefix] + submodule_name + cfg[:ext]
|
||||||
files << {
|
files << {
|
||||||
:path => "#{triad[:path]}#{module_name}#{pattern_file}#{triad[:ext]}",
|
path: (Pathname.new("#{cfg[:path]}#{subfolder}") + filename).cleanpath,
|
||||||
:name => "#{module_name}#{pattern_file}",
|
name: submodule_name,
|
||||||
:template => triad[:template],
|
template: cfg[:template],
|
||||||
:boilerplate => triad[:boilerplate],
|
boilerplate: cfg[:boilerplate],
|
||||||
:includes => case(triad[:inc])
|
includes: case (cfg[:inc])
|
||||||
when :src then @options[:includes][:src] | pattern_traits[:inc].map{|f| f % [module_name]}
|
when :src then (@options[:includes][:src] || []) | (pattern_traits[:inc].map { |f| format(f, module_name) })
|
||||||
when :inc then @options[:includes][:inc]
|
when :inc then (@options[:includes][:inc] || [])
|
||||||
when :tst then @options[:includes][:tst] | pattern_traits[:inc].map{|f| "Mock#{f}"% [module_name]}
|
when :tst then (@options[:includes][:tst] || []) | (pattern_traits[:inc].map { |f| format("#{@options[:mock_prefix]}#{f}", module_name) })
|
||||||
end
|
end
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
return files
|
files
|
||||||
end
|
end
|
||||||
|
|
||||||
############################
|
############################
|
||||||
def generate(module_name, pattern=nil)
|
def create_filename(part1, part2 = '')
|
||||||
|
if part2.empty?
|
||||||
|
case (@options[:naming])
|
||||||
|
when 'bumpy' then part1
|
||||||
|
when 'camel' then part1
|
||||||
|
when 'snake' then part1.downcase
|
||||||
|
when 'caps' then part1.upcase
|
||||||
|
else part1
|
||||||
|
end
|
||||||
|
else
|
||||||
|
case (@options[:naming])
|
||||||
|
when 'bumpy' then part1 + part2
|
||||||
|
when 'camel' then part1 + part2
|
||||||
|
when 'snake' then part1.downcase + '_' + part2.downcase
|
||||||
|
when 'caps' then part1.upcase + '_' + part2.upcase
|
||||||
|
else part1 + '_' + part2
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
############################
|
||||||
|
def generate(module_name, pattern = nil)
|
||||||
files = files_to_operate_on(module_name, pattern)
|
files = files_to_operate_on(module_name, pattern)
|
||||||
|
|
||||||
#Abort if any module already exists
|
# Abort if all of the module files already exist
|
||||||
|
all_files_exist = true
|
||||||
files.each do |file|
|
files.each do |file|
|
||||||
raise "ERROR: File #{file[:name]} already exists. Exiting." if File.exist?(file[:path])
|
all_files_exist = false unless File.exist?(file[:path])
|
||||||
end
|
end
|
||||||
|
raise "ERROR: File #{files[0][:name]} already exists. Exiting." if all_files_exist
|
||||||
|
|
||||||
# Create Source Modules
|
# Create Source Modules
|
||||||
files.each_with_index do |file, i|
|
files.each_with_index do |file, _i|
|
||||||
File.open(file[:path], 'w') do |f|
|
# If this file already exists, don't overwrite it.
|
||||||
f.write(file[:boilerplate] % [file[:name]]) unless file[:boilerplate].nil?
|
if File.exist?(file[:path])
|
||||||
f.write(file[:template] % [ file[:name],
|
puts "File #{file[:path]} already exists!"
|
||||||
file[:includes].map{|f| "#include \"#{f}\"\n"}.join,
|
next
|
||||||
file[:name].upcase ]
|
|
||||||
)
|
|
||||||
end
|
end
|
||||||
if (@options[:update_svn])
|
# Create the path first if necessary.
|
||||||
|
FileUtils.mkdir_p(File.dirname(file[:path]), verbose: false)
|
||||||
|
File.open(file[:path], 'w') do |f|
|
||||||
|
f.write("#{file[:boilerplate]}\n" % [file[:name]]) unless file[:boilerplate].nil?
|
||||||
|
f.write(file[:template] % [file[:name],
|
||||||
|
file[:includes].map { |ff| "#include \"#{ff}\"\n" }.join,
|
||||||
|
file[:name].upcase])
|
||||||
|
end
|
||||||
|
if @options[:update_svn]
|
||||||
`svn add \"#{file[:path]}\"`
|
`svn add \"#{file[:path]}\"`
|
||||||
if $?.exitstatus == 0
|
if $!.exitstatus.zero?
|
||||||
puts "File #{file[:path]} created and added to source control"
|
puts "File #{file[:path]} created and added to source control"
|
||||||
else
|
else
|
||||||
puts "File #{file[:path]} created but FAILED adding to source control!"
|
puts "File #{file[:path]} created but FAILED adding to source control!"
|
||||||
@@ -179,8 +225,7 @@ class UnityModuleGenerator
|
|||||||
end
|
end
|
||||||
|
|
||||||
############################
|
############################
|
||||||
def destroy(module_name, pattern=nil)
|
def destroy(module_name, pattern = nil)
|
||||||
|
|
||||||
files_to_operate_on(module_name, pattern).each do |filespec|
|
files_to_operate_on(module_name, pattern).each do |filespec|
|
||||||
file = filespec[:path]
|
file = filespec[:path]
|
||||||
if File.exist?(file)
|
if File.exist?(file)
|
||||||
@@ -195,64 +240,70 @@ class UnityModuleGenerator
|
|||||||
puts "File #{file} does not exist so cannot be removed."
|
puts "File #{file} does not exist so cannot be removed."
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
puts "Destroy Complete"
|
puts 'Destroy Complete'
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
############################
|
############################
|
||||||
#Handle As Command Line If Called That Way
|
# Handle As Command Line If Called That Way
|
||||||
if ($0 == __FILE__)
|
if $0 == __FILE__
|
||||||
destroy = false
|
destroy = false
|
||||||
options = { }
|
options = {}
|
||||||
module_name = nil
|
module_name = nil
|
||||||
|
|
||||||
# Parse the command line parameters.
|
# Parse the command line parameters.
|
||||||
ARGV.each do |arg|
|
ARGV.each do |arg|
|
||||||
case(arg)
|
case arg
|
||||||
when /^-d/ then destroy = true
|
when /^-d/ then destroy = true
|
||||||
when /^-u/ then options[:update_svn] = true
|
when /^-u/ then options[:update_svn] = true
|
||||||
when /^-p(\w+)/ then options[:pattern] = $1
|
when /^-p\"?(\w+)\"?/ then options[:pattern] = Regexp.last_match(1)
|
||||||
when /^-s(.+)/ then options[:path_src] = $1
|
when /^-s\"?(.+)\"?/ then options[:path_src] = Regexp.last_match(1)
|
||||||
when /^-i(.+)/ then options[:path_inc] = $1
|
when /^-i\"?(.+)\"?/ then options[:path_inc] = Regexp.last_match(1)
|
||||||
when /^-t(.+)/ then options[:path_tst] = $1
|
when /^-t\"?(.+)\"?/ then options[:path_tst] = Regexp.last_match(1)
|
||||||
when /^-y(.+)/ then options = UnityModuleGenerator.grab_config($1)
|
when /^-n\"?(.+)\"?/ then options[:naming] = Regexp.last_match(1)
|
||||||
when /^(\w+)/
|
when /^-y\"?(.+)\"?/ then options = UnityModuleGenerator.grab_config(Regexp.last_match(1))
|
||||||
raise "ERROR: You can't have more than one Module name specified!" unless module_name.nil?
|
when /^(\w+)/
|
||||||
module_name = arg
|
raise "ERROR: You can't have more than one Module name specified!" unless module_name.nil?
|
||||||
when /^-(h|-help)/
|
|
||||||
ARGV = []
|
module_name = arg
|
||||||
else
|
when /^-(h|-help)/
|
||||||
raise "ERROR: Unknown option specified '#{arg}'"
|
ARGV = [].freeze
|
||||||
|
else
|
||||||
|
raise "ERROR: Unknown option specified '#{arg}'"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
if (!ARGV[0])
|
unless ARGV[0]
|
||||||
puts [ "\nGENERATE MODULE\n-------- ------",
|
puts ["\nGENERATE MODULE\n-------- ------",
|
||||||
"\nUsage: ruby generate_module [options] module_name",
|
"\nUsage: ruby generate_module [options] module_name",
|
||||||
" -i\"include\" sets the path to output headers to 'include' (DEFAULT ../src)",
|
" -i\"include\" sets the path to output headers to 'include' (DEFAULT ../src)",
|
||||||
" -s\"../src\" sets the path to output source to '../src' (DEFAULT ../src)",
|
" -s\"../src\" sets the path to output source to '../src' (DEFAULT ../src)",
|
||||||
" -t\"C:/test\" sets the path to output source to 'C:/test' (DEFAULT ../test)",
|
" -t\"C:/test\" sets the path to output source to 'C:/test' (DEFAULT ../test)",
|
||||||
" -p\"MCH\" sets the output pattern to MCH.",
|
' -p"MCH" sets the output pattern to MCH.',
|
||||||
" dh - driver hardware.",
|
' dh - driver hardware.',
|
||||||
" dih - driver interrupt hardware.",
|
' dih - driver interrupt hardware.',
|
||||||
" mch - model conductor hardware.",
|
' mch - model conductor hardware.',
|
||||||
" mvp - model view presenter.",
|
' mvp - model view presenter.',
|
||||||
" src - just a single source module. (DEFAULT)",
|
' src - just a source module, header and test. (DEFAULT)',
|
||||||
" -d destroy module instead of creating it.",
|
' test - just a test file.',
|
||||||
" -u update subversion too (requires subversion command line)",
|
' -d destroy module instead of creating it.',
|
||||||
" -y\"my.yml\" selects a different yaml config file for module generation",
|
' -n"camel" sets the file naming convention.',
|
||||||
"" ].join("\n")
|
' bumpy - BumpyCaseFilenames.',
|
||||||
|
' camel - camelCaseFilenames.',
|
||||||
|
' snake - snake_case_filenames.',
|
||||||
|
' caps - CAPS_CASE_FILENAMES.',
|
||||||
|
' -u update subversion too (requires subversion command line)',
|
||||||
|
' -y"my.yml" selects a different yaml config file for module generation',
|
||||||
|
''].join("\n")
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
|
|
||||||
raise "ERROR: You must have a Module name specified! (use option -h for help)" if module_name.nil?
|
raise 'ERROR: You must have a Module name specified! (use option -h for help)' if module_name.nil?
|
||||||
if (destroy)
|
|
||||||
|
if destroy
|
||||||
UnityModuleGenerator.new(options).destroy(module_name)
|
UnityModuleGenerator.new(options).destroy(module_name)
|
||||||
else
|
else
|
||||||
UnityModuleGenerator.new(options).generate(module_name)
|
UnityModuleGenerator.new(options).generate(module_name)
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,74 +4,82 @@
|
|||||||
# [Released under MIT License. Please refer to license.txt for details]
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
$QUICK_RUBY_VERSION = RUBY_VERSION.split('.').inject(0){|vv,v| vv * 100 + v.to_i }
|
|
||||||
File.expand_path(File.join(File.dirname(__FILE__),'colour_prompt'))
|
|
||||||
|
|
||||||
class UnityTestRunnerGenerator
|
class UnityTestRunnerGenerator
|
||||||
|
|
||||||
def initialize(options = nil)
|
def initialize(options = nil)
|
||||||
@options = UnityTestRunnerGenerator.default_options
|
@options = UnityTestRunnerGenerator.default_options
|
||||||
case(options)
|
case options
|
||||||
when NilClass then @options
|
when NilClass
|
||||||
when String then @options.merge!(UnityTestRunnerGenerator.grab_config(options))
|
@options
|
||||||
when Hash then @options.merge!(options)
|
when String
|
||||||
else raise "If you specify arguments, it should be a filename or a hash of options"
|
@options.merge!(UnityTestRunnerGenerator.grab_config(options))
|
||||||
|
when Hash
|
||||||
|
# Check if some of these have been specified
|
||||||
|
@options[:has_setup] = !options[:setup_name].nil?
|
||||||
|
@options[:has_teardown] = !options[:teardown_name].nil?
|
||||||
|
@options[:has_suite_setup] = !options[:suite_setup].nil?
|
||||||
|
@options[:has_suite_teardown] = !options[:suite_teardown].nil?
|
||||||
|
@options.merge!(options)
|
||||||
|
else
|
||||||
|
raise 'If you specify arguments, it should be a filename or a hash of options'
|
||||||
end
|
end
|
||||||
require "#{File.expand_path(File.dirname(__FILE__))}/type_sanitizer"
|
require_relative 'type_sanitizer'
|
||||||
end
|
end
|
||||||
|
|
||||||
def self.default_options
|
def self.default_options
|
||||||
{
|
{
|
||||||
:includes => [],
|
includes: [],
|
||||||
:plugins => [],
|
defines: [],
|
||||||
:framework => :unity,
|
plugins: [],
|
||||||
:test_prefix => "test|spec|should",
|
framework: :unity,
|
||||||
:setup_name => "setUp",
|
test_prefix: 'test|spec|should',
|
||||||
:teardown_name => "tearDown",
|
mock_prefix: 'Mock',
|
||||||
:main_name => "main", #set to :auto to automatically generate each time
|
mock_suffix: '',
|
||||||
:main_export_decl => "",
|
setup_name: 'setUp',
|
||||||
:cmdline_args => false,
|
teardown_name: 'tearDown',
|
||||||
:use_param_tests => false,
|
test_reset_name: 'resetTest',
|
||||||
|
test_verify_name: 'verifyTest',
|
||||||
|
main_name: 'main', # set to :auto to automatically generate each time
|
||||||
|
main_export_decl: '',
|
||||||
|
cmdline_args: false,
|
||||||
|
omit_begin_end: false,
|
||||||
|
use_param_tests: false
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
def self.grab_config(config_file)
|
def self.grab_config(config_file)
|
||||||
options = self.default_options
|
options = default_options
|
||||||
unless (config_file.nil? or config_file.empty?)
|
unless config_file.nil? || config_file.empty?
|
||||||
require 'yaml'
|
require 'yaml'
|
||||||
yaml_guts = YAML.load_file(config_file)
|
yaml_guts = YAML.load_file(config_file)
|
||||||
options.merge!(yaml_guts[:unity] || yaml_guts[:cmock])
|
options.merge!(yaml_guts[:unity] || yaml_guts[:cmock])
|
||||||
raise "No :unity or :cmock section found in #{config_file}" unless options
|
raise "No :unity or :cmock section found in #{config_file}" unless options
|
||||||
end
|
end
|
||||||
return(options)
|
options
|
||||||
end
|
end
|
||||||
|
|
||||||
def run(input_file, output_file, options=nil)
|
def run(input_file, output_file, options = nil)
|
||||||
tests = []
|
|
||||||
testfile_includes = []
|
|
||||||
used_mocks = []
|
|
||||||
|
|
||||||
@options.merge!(options) unless options.nil?
|
@options.merge!(options) unless options.nil?
|
||||||
module_name = File.basename(input_file)
|
|
||||||
|
|
||||||
#pull required data from source file
|
# pull required data from source file
|
||||||
source = File.read(input_file)
|
source = File.read(input_file)
|
||||||
source = source.force_encoding("ISO-8859-1").encode("utf-8", :replace => nil) if ($QUICK_RUBY_VERSION > 10900)
|
source = source.force_encoding('ISO-8859-1').encode('utf-8', replace: nil)
|
||||||
tests = find_tests(source)
|
tests = find_tests(source)
|
||||||
headers = find_includes(source)
|
headers = find_includes(source)
|
||||||
testfile_includes = (headers[:local] + headers[:system])
|
testfile_includes = (headers[:local] + headers[:system])
|
||||||
used_mocks = find_mocks(testfile_includes)
|
used_mocks = find_mocks(testfile_includes)
|
||||||
testfile_includes = (testfile_includes - used_mocks)
|
testfile_includes = (testfile_includes - used_mocks)
|
||||||
testfile_includes.delete_if{|inc| inc =~ /(unity|cmock)/}
|
testfile_includes.delete_if { |inc| inc =~ /(unity|cmock)/ }
|
||||||
|
find_setup_and_teardown(source)
|
||||||
|
|
||||||
#build runner file
|
# build runner file
|
||||||
generate(input_file, output_file, tests, used_mocks, testfile_includes)
|
generate(input_file, output_file, tests, used_mocks, testfile_includes)
|
||||||
|
|
||||||
#determine which files were used to return them
|
# determine which files were used to return them
|
||||||
all_files_used = [input_file, output_file]
|
all_files_used = [input_file, output_file]
|
||||||
all_files_used += testfile_includes.map {|filename| filename + '.c'} unless testfile_includes.empty?
|
all_files_used += testfile_includes.map { |filename| filename + '.c' } unless testfile_includes.empty?
|
||||||
all_files_used += @options[:includes] unless @options[:includes].empty?
|
all_files_used += @options[:includes] unless @options[:includes].empty?
|
||||||
return all_files_used.uniq
|
all_files_used += headers[:linkonly] unless headers[:linkonly].empty?
|
||||||
|
all_files_used.uniq
|
||||||
end
|
end
|
||||||
|
|
||||||
def generate(input_file, output_file, tests, used_mocks, testfile_includes)
|
def generate(input_file, output_file, tests, used_mocks, testfile_includes)
|
||||||
@@ -79,300 +87,350 @@ class UnityTestRunnerGenerator
|
|||||||
create_header(output, used_mocks, testfile_includes)
|
create_header(output, used_mocks, testfile_includes)
|
||||||
create_externs(output, tests, used_mocks)
|
create_externs(output, tests, used_mocks)
|
||||||
create_mock_management(output, used_mocks)
|
create_mock_management(output, used_mocks)
|
||||||
create_suite_setup_and_teardown(output)
|
create_setup(output)
|
||||||
create_reset(output, used_mocks)
|
create_teardown(output)
|
||||||
|
create_suite_setup(output)
|
||||||
|
create_suite_teardown(output)
|
||||||
|
create_reset(output)
|
||||||
|
create_run_test(output)
|
||||||
|
create_args_wrappers(output, tests)
|
||||||
create_main(output, input_file, tests, used_mocks)
|
create_main(output, input_file, tests, used_mocks)
|
||||||
end
|
end
|
||||||
|
|
||||||
if (@options[:header_file] && !@options[:header_file].empty?)
|
return unless @options[:header_file] && !@options[:header_file].empty?
|
||||||
File.open(@options[:header_file], 'w') do |output|
|
|
||||||
create_h_file(output, @options[:header_file], tests, testfile_includes, used_mocks)
|
File.open(@options[:header_file], 'w') do |output|
|
||||||
end
|
create_h_file(output, @options[:header_file], tests, testfile_includes, used_mocks)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def find_tests(source)
|
def find_tests(source)
|
||||||
tests_and_line_numbers = []
|
tests_and_line_numbers = []
|
||||||
|
|
||||||
|
# contains characters which will be substituted from within strings, doing
|
||||||
|
# this prevents these characters from interferring with scrubbers
|
||||||
|
# @ is not a valid C character, so there should be no clashes with files genuinely containing these markers
|
||||||
|
substring_subs = { '{' => '@co@', '}' => '@cc@', ';' => '@ss@', '/' => '@fs@' }
|
||||||
|
substring_re = Regexp.union(substring_subs.keys)
|
||||||
|
substring_unsubs = substring_subs.invert # the inverse map will be used to fix the strings afterwords
|
||||||
|
substring_unsubs['@quote@'] = '\\"'
|
||||||
|
substring_unsubs['@apos@'] = '\\\''
|
||||||
|
substring_unre = Regexp.union(substring_unsubs.keys)
|
||||||
source_scrubbed = source.clone
|
source_scrubbed = source.clone
|
||||||
source_scrubbed = source_scrubbed.gsub(/"[^"\n]*"/, '') # remove things in strings
|
source_scrubbed = source_scrubbed.gsub(/\\"/, '@quote@') # hide escaped quotes to allow capture of the full string/char
|
||||||
source_scrubbed = source_scrubbed.gsub(/\/\/.*$/, '') # remove line comments
|
source_scrubbed = source_scrubbed.gsub(/\\'/, '@apos@') # hide escaped apostrophes to allow capture of the full string/char
|
||||||
source_scrubbed = source_scrubbed.gsub(/\/\*.*?\*\//m, '') # remove block comments
|
source_scrubbed = source_scrubbed.gsub(/("[^"\n]*")|('[^'\n]*')/) { |s| s.gsub(substring_re, substring_subs) } # temporarily hide problematic characters within strings
|
||||||
lines = source_scrubbed.split(/(^\s*\#.*$) # Treat preprocessor directives as a logical line
|
source_scrubbed = source_scrubbed.gsub(/\/\/(?:.+\/\*|\*(?:$|[^\/])).*$/, '') # remove line comments that comment out the start of blocks
|
||||||
| (;|\{|\}) /x) # Match ;, {, and } as end of lines
|
source_scrubbed = source_scrubbed.gsub(/\/\*.*?\*\//m, '') # remove block comments
|
||||||
|
source_scrubbed = source_scrubbed.gsub(/\/\/.*$/, '') # remove line comments (all that remain)
|
||||||
|
lines = source_scrubbed.split(/(^\s*\#.*$) | (;|\{|\}) /x) # Treat preprocessor directives as a logical line. Match ;, {, and } as end of lines
|
||||||
|
.map { |line| line.gsub(substring_unre, substring_unsubs) } # unhide the problematic characters previously removed
|
||||||
|
|
||||||
lines.each_with_index do |line, index|
|
lines.each_with_index do |line, _index|
|
||||||
#find tests
|
# find tests
|
||||||
if line =~ /^((?:\s*TEST_CASE\s*\(.*?\)\s*)*)\s*void\s+((?:#{@options[:test_prefix]}).*)\s*\(\s*(.*)\s*\)/
|
next unless line =~ /^((?:\s*TEST_CASE\s*\(.*?\)\s*)*)\s*void\s+((?:#{@options[:test_prefix]}).*)\s*\(\s*(.*)\s*\)/m
|
||||||
arguments = $1
|
|
||||||
name = $2
|
arguments = Regexp.last_match(1)
|
||||||
call = $3
|
name = Regexp.last_match(2)
|
||||||
params = $4
|
call = Regexp.last_match(3)
|
||||||
args = nil
|
params = Regexp.last_match(4)
|
||||||
if (@options[:use_param_tests] and !arguments.empty?)
|
args = nil
|
||||||
args = []
|
|
||||||
arguments.scan(/\s*TEST_CASE\s*\((.*)\)\s*$/) {|a| args << a[0]}
|
if @options[:use_param_tests] && !arguments.empty?
|
||||||
end
|
args = []
|
||||||
tests_and_line_numbers << { :test => name, :args => args, :call => call, :params => params, :line_number => 0 }
|
arguments.scan(/\s*TEST_CASE\s*\((.*)\)\s*$/) { |a| args << a[0] }
|
||||||
end
|
end
|
||||||
end
|
|
||||||
tests_and_line_numbers.uniq! {|v| v[:test] }
|
|
||||||
|
|
||||||
#determine line numbers and create tests to run
|
tests_and_line_numbers << { test: name, args: args, call: call, params: params, line_number: 0 }
|
||||||
|
end
|
||||||
|
|
||||||
|
tests_and_line_numbers.uniq! { |v| v[:test] }
|
||||||
|
|
||||||
|
# determine line numbers and create tests to run
|
||||||
source_lines = source.split("\n")
|
source_lines = source.split("\n")
|
||||||
source_index = 0;
|
source_index = 0
|
||||||
tests_and_line_numbers.size.times do |i|
|
tests_and_line_numbers.size.times do |i|
|
||||||
source_lines[source_index..-1].each_with_index do |line, index|
|
source_lines[source_index..-1].each_with_index do |line, index|
|
||||||
if (line =~ /#{tests_and_line_numbers[i][:test]}/)
|
next unless line =~ /\s+#{tests_and_line_numbers[i][:test]}(?:\s|\()/
|
||||||
source_index += index
|
|
||||||
tests_and_line_numbers[i][:line_number] = source_index + 1
|
source_index += index
|
||||||
break
|
tests_and_line_numbers[i][:line_number] = source_index + 1
|
||||||
end
|
break
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
return tests_and_line_numbers
|
tests_and_line_numbers
|
||||||
end
|
end
|
||||||
|
|
||||||
def find_includes(source)
|
def find_includes(source)
|
||||||
|
# remove comments (block and line, in three steps to ensure correct precedence)
|
||||||
#remove comments (block and line, in three steps to ensure correct precedence)
|
|
||||||
source.gsub!(/\/\/(?:.+\/\*|\*(?:$|[^\/])).*$/, '') # remove line comments that comment out the start of blocks
|
source.gsub!(/\/\/(?:.+\/\*|\*(?:$|[^\/])).*$/, '') # remove line comments that comment out the start of blocks
|
||||||
source.gsub!(/\/\*.*?\*\//m, '') # remove block comments
|
source.gsub!(/\/\*.*?\*\//m, '') # remove block comments
|
||||||
source.gsub!(/\/\/.*$/, '') # remove line comments (all that remain)
|
source.gsub!(/\/\/.*$/, '') # remove line comments (all that remain)
|
||||||
|
|
||||||
#parse out includes
|
# parse out includes
|
||||||
includes = {
|
includes = {
|
||||||
:local => source.scan(/^\s*#include\s+\"\s*(.+)\.[hH]\s*\"/).flatten,
|
local: source.scan(/^\s*#include\s+\"\s*(.+)\.[hH]\s*\"/).flatten,
|
||||||
:system => source.scan(/^\s*#include\s+<\s*(.+)\s*>/).flatten.map { |inc| "<#{inc}>" }
|
system: source.scan(/^\s*#include\s+<\s*(.+)\s*>/).flatten.map { |inc| "<#{inc}>" },
|
||||||
|
linkonly: source.scan(/^TEST_FILE\(\s*\"\s*(.+)\.[cC]\w*\s*\"/).flatten
|
||||||
}
|
}
|
||||||
return includes
|
includes
|
||||||
end
|
end
|
||||||
|
|
||||||
def find_mocks(includes)
|
def find_mocks(includes)
|
||||||
mock_headers = []
|
mock_headers = []
|
||||||
includes.each do |include_path|
|
includes.each do |include_path|
|
||||||
include_file = File.basename(include_path)
|
include_file = File.basename(include_path)
|
||||||
mock_headers << include_path if (include_file =~ /^mock/i)
|
mock_headers << include_path if include_file =~ /^#{@options[:mock_prefix]}.*#{@options[:mock_suffix]}$/i
|
||||||
end
|
end
|
||||||
return mock_headers
|
mock_headers
|
||||||
end
|
end
|
||||||
|
|
||||||
def create_header(output, mocks, testfile_includes=[])
|
def find_setup_and_teardown(source)
|
||||||
|
@options[:has_setup] = source =~ /void\s+#{@options[:setup_name]}\s*\(/
|
||||||
|
@options[:has_teardown] = source =~ /void\s+#{@options[:teardown_name]}\s*\(/
|
||||||
|
@options[:has_suite_setup] ||= (source =~ /void\s+suiteSetUp\s*\(/)
|
||||||
|
@options[:has_suite_teardown] ||= (source =~ /void\s+suiteTearDown\s*\(/)
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_header(output, mocks, testfile_includes = [])
|
||||||
output.puts('/* AUTOGENERATED FILE. DO NOT EDIT. */')
|
output.puts('/* AUTOGENERATED FILE. DO NOT EDIT. */')
|
||||||
create_runtest(output, mocks)
|
|
||||||
output.puts("\n/*=======Automagically Detected Files To Include=====*/")
|
output.puts("\n/*=======Automagically Detected Files To Include=====*/")
|
||||||
output.puts("#include \"#{@options[:framework].to_s}.h\"")
|
output.puts("#include \"#{@options[:framework]}.h\"")
|
||||||
output.puts('#include "cmock.h"') unless (mocks.empty?)
|
output.puts('#include "cmock.h"') unless mocks.empty?
|
||||||
output.puts('#include <setjmp.h>')
|
if @options[:defines] && !@options[:defines].empty?
|
||||||
output.puts('#include <stdio.h>')
|
@options[:defines].each { |d| output.puts("#ifndef #{d}\n#define #{d}\n#endif /* #{d} */") }
|
||||||
output.puts('#include "CException.h"') if @options[:plugins].include?(:cexception)
|
end
|
||||||
if (@options[:header_file] && !@options[:header_file].empty?)
|
if @options[:header_file] && !@options[:header_file].empty?
|
||||||
output.puts("#include \"#{File.basename(@options[:header_file])}\"")
|
output.puts("#include \"#{File.basename(@options[:header_file])}\"")
|
||||||
else
|
else
|
||||||
@options[:includes].flatten.uniq.compact.each do |inc|
|
@options[:includes].flatten.uniq.compact.each do |inc|
|
||||||
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h','')}.h\""}")
|
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h', '')}.h\""}")
|
||||||
end
|
end
|
||||||
testfile_includes.each do |inc|
|
testfile_includes.each do |inc|
|
||||||
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h','')}.h\""}")
|
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h', '')}.h\""}")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
mocks.each do |mock|
|
mocks.each do |mock|
|
||||||
output.puts("#include \"#{mock.gsub('.h','')}.h\"")
|
output.puts("#include \"#{mock.gsub('.h', '')}.h\"")
|
||||||
end
|
|
||||||
if @options[:enforce_strict_ordering]
|
|
||||||
output.puts('')
|
|
||||||
output.puts('int GlobalExpectCount;')
|
|
||||||
output.puts('int GlobalVerifyOrder;')
|
|
||||||
output.puts('char* GlobalOrderError;')
|
|
||||||
end
|
end
|
||||||
|
output.puts('#include "CException.h"') if @options[:plugins].include?(:cexception)
|
||||||
|
|
||||||
|
return unless @options[:enforce_strict_ordering]
|
||||||
|
|
||||||
|
output.puts('')
|
||||||
|
output.puts('int GlobalExpectCount;')
|
||||||
|
output.puts('int GlobalVerifyOrder;')
|
||||||
|
output.puts('char* GlobalOrderError;')
|
||||||
end
|
end
|
||||||
|
|
||||||
def create_externs(output, tests, mocks)
|
def create_externs(output, tests, _mocks)
|
||||||
output.puts("\n/*=======External Functions This Runner Calls=====*/")
|
output.puts("\n/*=======External Functions This Runner Calls=====*/")
|
||||||
output.puts("extern void #{@options[:setup_name]}(void);")
|
output.puts("extern void #{@options[:setup_name]}(void);")
|
||||||
output.puts("extern void #{@options[:teardown_name]}(void);")
|
output.puts("extern void #{@options[:teardown_name]}(void);")
|
||||||
|
output.puts("\n#ifdef __cplusplus\nextern \"C\"\n{\n#endif") if @options[:externc]
|
||||||
tests.each do |test|
|
tests.each do |test|
|
||||||
output.puts("extern void #{test[:test]}(#{test[:call] || 'void'});")
|
output.puts("extern void #{test[:test]}(#{test[:call] || 'void'});")
|
||||||
end
|
end
|
||||||
|
output.puts("#ifdef __cplusplus\n}\n#endif") if @options[:externc]
|
||||||
output.puts('')
|
output.puts('')
|
||||||
end
|
end
|
||||||
|
|
||||||
def create_mock_management(output, mock_headers)
|
def create_mock_management(output, mock_headers)
|
||||||
unless (mock_headers.empty?)
|
output.puts("\n/*=======Mock Management=====*/")
|
||||||
output.puts("\n/*=======Mock Management=====*/")
|
output.puts('static void CMock_Init(void)')
|
||||||
output.puts("static void CMock_Init(void)")
|
output.puts('{')
|
||||||
output.puts("{")
|
|
||||||
if @options[:enforce_strict_ordering]
|
|
||||||
output.puts(" GlobalExpectCount = 0;")
|
|
||||||
output.puts(" GlobalVerifyOrder = 0;")
|
|
||||||
output.puts(" GlobalOrderError = NULL;")
|
|
||||||
end
|
|
||||||
mocks = mock_headers.map {|mock| File.basename(mock)}
|
|
||||||
mocks.each do |mock|
|
|
||||||
mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
|
|
||||||
output.puts(" #{mock_clean}_Init();")
|
|
||||||
end
|
|
||||||
output.puts("}\n")
|
|
||||||
|
|
||||||
output.puts("static void CMock_Verify(void)")
|
if @options[:enforce_strict_ordering]
|
||||||
output.puts("{")
|
output.puts(' GlobalExpectCount = 0;')
|
||||||
mocks.each do |mock|
|
output.puts(' GlobalVerifyOrder = 0;')
|
||||||
mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
|
output.puts(' GlobalOrderError = NULL;')
|
||||||
output.puts(" #{mock_clean}_Verify();")
|
|
||||||
end
|
|
||||||
output.puts("}\n")
|
|
||||||
|
|
||||||
output.puts("static void CMock_Destroy(void)")
|
|
||||||
output.puts("{")
|
|
||||||
mocks.each do |mock|
|
|
||||||
mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
|
|
||||||
output.puts(" #{mock_clean}_Destroy();")
|
|
||||||
end
|
|
||||||
output.puts("}\n")
|
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
def create_suite_setup_and_teardown(output)
|
mocks = mock_headers.map { |mock| File.basename(mock) }
|
||||||
unless (@options[:suite_setup].nil?)
|
mocks.each do |mock|
|
||||||
output.puts("\n/*=======Suite Setup=====*/")
|
mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
|
||||||
output.puts("static void suite_setup(void)")
|
output.puts(" #{mock_clean}_Init();")
|
||||||
output.puts("{")
|
|
||||||
output.puts(@options[:suite_setup])
|
|
||||||
output.puts("}")
|
|
||||||
end
|
end
|
||||||
unless (@options[:suite_teardown].nil?)
|
output.puts("}\n")
|
||||||
output.puts("\n/*=======Suite Teardown=====*/")
|
|
||||||
output.puts("static int suite_teardown(int num_failures)")
|
|
||||||
output.puts("{")
|
|
||||||
output.puts(@options[:suite_teardown])
|
|
||||||
output.puts("}")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def create_runtest(output, used_mocks)
|
output.puts('static void CMock_Verify(void)')
|
||||||
cexception = @options[:plugins].include? :cexception
|
output.puts('{')
|
||||||
va_args1 = @options[:use_param_tests] ? ', ...' : ''
|
mocks.each do |mock|
|
||||||
va_args2 = @options[:use_param_tests] ? '__VA_ARGS__' : ''
|
mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
|
||||||
output.puts("\n/*=======Test Runner Used To Run Each Test Below=====*/")
|
output.puts(" #{mock_clean}_Verify();")
|
||||||
output.puts("#define RUN_TEST_NO_ARGS") if @options[:use_param_tests]
|
end
|
||||||
output.puts("#define RUN_TEST(TestFunc, TestLineNum#{va_args1}) \\")
|
output.puts("}\n")
|
||||||
output.puts("{ \\")
|
|
||||||
output.puts(" Unity.CurrentTestName = #TestFunc#{va_args2.empty? ? '' : " \"(\" ##{va_args2} \")\""}; \\")
|
output.puts('static void CMock_Destroy(void)')
|
||||||
output.puts(" Unity.CurrentTestLineNumber = TestLineNum; \\")
|
output.puts('{')
|
||||||
output.puts(" if (UnityTestMatches()) { \\") if (@options[:cmdline_args])
|
mocks.each do |mock|
|
||||||
output.puts(" Unity.NumberOfTests++; \\")
|
mock_clean = TypeSanitizer.sanitize_c_identifier(mock)
|
||||||
output.puts(" CMock_Init(); \\") unless (used_mocks.empty?)
|
output.puts(" #{mock_clean}_Destroy();")
|
||||||
output.puts(" UNITY_CLR_DETAILS(); \\") unless (used_mocks.empty?)
|
end
|
||||||
output.puts(" if (TEST_PROTECT()) \\")
|
|
||||||
output.puts(" { \\")
|
|
||||||
output.puts(" CEXCEPTION_T e; \\") if cexception
|
|
||||||
output.puts(" Try { \\") if cexception
|
|
||||||
output.puts(" #{@options[:setup_name]}(); \\")
|
|
||||||
output.puts(" TestFunc(#{va_args2}); \\")
|
|
||||||
output.puts(" } Catch(e) { TEST_ASSERT_EQUAL_HEX32_MESSAGE(CEXCEPTION_NONE, e, \"Unhandled Exception!\"); } \\") if cexception
|
|
||||||
output.puts(" } \\")
|
|
||||||
output.puts(" if (TEST_PROTECT() && !TEST_IS_IGNORED) \\")
|
|
||||||
output.puts(" { \\")
|
|
||||||
output.puts(" #{@options[:teardown_name]}(); \\")
|
|
||||||
output.puts(" CMock_Verify(); \\") unless (used_mocks.empty?)
|
|
||||||
output.puts(" } \\")
|
|
||||||
output.puts(" CMock_Destroy(); \\") unless (used_mocks.empty?)
|
|
||||||
output.puts(" UnityConcludeTest(); \\")
|
|
||||||
output.puts(" } \\") if (@options[:cmdline_args])
|
|
||||||
output.puts("}\n")
|
output.puts("}\n")
|
||||||
end
|
end
|
||||||
|
|
||||||
def create_reset(output, used_mocks)
|
def create_setup(output)
|
||||||
output.puts("\n/*=======Test Reset Option=====*/")
|
return if @options[:has_setup]
|
||||||
output.puts("void resetTest(void);")
|
|
||||||
output.puts("void resetTest(void)")
|
output.puts("\n/*=======Setup (stub)=====*/")
|
||||||
output.puts("{")
|
output.puts("void #{@options[:setup_name]}(void) {}")
|
||||||
output.puts(" CMock_Verify();") unless (used_mocks.empty?)
|
end
|
||||||
output.puts(" CMock_Destroy();") unless (used_mocks.empty?)
|
|
||||||
|
def create_teardown(output)
|
||||||
|
return if @options[:has_teardown]
|
||||||
|
|
||||||
|
output.puts("\n/*=======Teardown (stub)=====*/")
|
||||||
|
output.puts("void #{@options[:teardown_name]}(void) {}")
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_suite_setup(output)
|
||||||
|
return if @options[:suite_setup].nil?
|
||||||
|
|
||||||
|
output.puts("\n/*=======Suite Setup=====*/")
|
||||||
|
output.puts('void suiteSetUp(void)')
|
||||||
|
output.puts('{')
|
||||||
|
output.puts(@options[:suite_setup])
|
||||||
|
output.puts('}')
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_suite_teardown(output)
|
||||||
|
return if @options[:suite_teardown].nil?
|
||||||
|
|
||||||
|
output.puts("\n/*=======Suite Teardown=====*/")
|
||||||
|
output.puts('int suiteTearDown(int num_failures)')
|
||||||
|
output.puts('{')
|
||||||
|
output.puts(@options[:suite_teardown])
|
||||||
|
output.puts('}')
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_reset(output)
|
||||||
|
output.puts("\n/*=======Test Reset Options=====*/")
|
||||||
|
output.puts("void #{@options[:test_reset_name]}(void);")
|
||||||
|
output.puts("void #{@options[:test_reset_name]}(void)")
|
||||||
|
output.puts('{')
|
||||||
output.puts(" #{@options[:teardown_name]}();")
|
output.puts(" #{@options[:teardown_name]}();")
|
||||||
output.puts(" CMock_Init();") unless (used_mocks.empty?)
|
output.puts(' CMock_Verify();')
|
||||||
|
output.puts(' CMock_Destroy();')
|
||||||
|
output.puts(' CMock_Init();')
|
||||||
output.puts(" #{@options[:setup_name]}();")
|
output.puts(" #{@options[:setup_name]}();")
|
||||||
output.puts("}")
|
output.puts('}')
|
||||||
|
output.puts("void #{@options[:test_verify_name]}(void);")
|
||||||
|
output.puts("void #{@options[:test_verify_name]}(void)")
|
||||||
|
output.puts('{')
|
||||||
|
output.puts(' CMock_Verify();')
|
||||||
|
output.puts('}')
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_run_test(output)
|
||||||
|
require 'erb'
|
||||||
|
template = ERB.new(File.read(File.join(__dir__, 'run_test.erb')))
|
||||||
|
output.puts(template.result(binding))
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_args_wrappers(output, tests)
|
||||||
|
return unless @options[:use_param_tests]
|
||||||
|
|
||||||
|
output.puts("\n/*=======Parameterized Test Wrappers=====*/")
|
||||||
|
tests.each do |test|
|
||||||
|
next if test[:args].nil? || test[:args].empty?
|
||||||
|
|
||||||
|
test[:args].each.with_index(1) do |args, idx|
|
||||||
|
output.puts("static void runner_args#{idx}_#{test[:test]}(void)")
|
||||||
|
output.puts('{')
|
||||||
|
output.puts(" #{test[:test]}(#{args});")
|
||||||
|
output.puts("}\n")
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def create_main(output, filename, tests, used_mocks)
|
def create_main(output, filename, tests, used_mocks)
|
||||||
output.puts("\n\n/*=======MAIN=====*/")
|
output.puts("\n\n/*=======MAIN=====*/")
|
||||||
main_name = (@options[:main_name].to_sym == :auto) ? "main_#{filename.gsub('.c','')}" : "#{@options[:main_name]}"
|
main_name = @options[:main_name].to_sym == :auto ? "main_#{filename.gsub('.c', '')}" : (@options[:main_name]).to_s
|
||||||
if (@options[:cmdline_args])
|
if @options[:cmdline_args]
|
||||||
if (main_name != "main")
|
if main_name != 'main'
|
||||||
output.puts("#{@options[:main_export_decl]} int #{main_name}(int argc, char** argv);")
|
output.puts("#{@options[:main_export_decl]} int #{main_name}(int argc, char** argv);")
|
||||||
end
|
end
|
||||||
output.puts("#{@options[:main_export_decl]} int #{main_name}(int argc, char** argv)")
|
output.puts("#{@options[:main_export_decl]} int #{main_name}(int argc, char** argv)")
|
||||||
output.puts("{")
|
output.puts('{')
|
||||||
output.puts(" int parse_status = UnityParseOptions(argc, argv);")
|
output.puts(' int parse_status = UnityParseOptions(argc, argv);')
|
||||||
output.puts(" if (parse_status != 0)")
|
output.puts(' if (parse_status != 0)')
|
||||||
output.puts(" {")
|
output.puts(' {')
|
||||||
output.puts(" if (parse_status < 0)")
|
output.puts(' if (parse_status < 0)')
|
||||||
output.puts(" {")
|
output.puts(' {')
|
||||||
output.puts(" UnityPrint(\"#{filename.gsub('.c','')}.\");")
|
output.puts(" UnityPrint(\"#{filename.gsub('.c', '')}.\");")
|
||||||
output.puts(" UNITY_PRINT_EOL();")
|
output.puts(' UNITY_PRINT_EOL();')
|
||||||
if (@options[:use_param_tests])
|
tests.each do |test|
|
||||||
tests.each do |test|
|
if (!@options[:use_param_tests]) || test[:args].nil? || test[:args].empty?
|
||||||
if ((test[:args].nil?) or (test[:args].empty?))
|
output.puts(" UnityPrint(\" #{test[:test]}\");")
|
||||||
output.puts(" UnityPrint(\" #{test[:test]}(RUN_TEST_NO_ARGS)\");")
|
output.puts(' UNITY_PRINT_EOL();')
|
||||||
output.puts(" UNITY_PRINT_EOL();")
|
else
|
||||||
else
|
test[:args].each do |args|
|
||||||
test[:args].each do |args|
|
output.puts(" UnityPrint(\" #{test[:test]}(#{args})\");")
|
||||||
output.puts(" UnityPrint(\" #{test[:test]}(#{args})\");")
|
output.puts(' UNITY_PRINT_EOL();')
|
||||||
output.puts(" UNITY_PRINT_EOL();")
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
else
|
|
||||||
tests.each { |test| output.puts(" UnityPrint(\" #{test[:test]}\");\n UNITY_PRINT_EOL();")}
|
|
||||||
end
|
end
|
||||||
output.puts(" return 0;")
|
output.puts(' return 0;')
|
||||||
output.puts(" }")
|
output.puts(' }')
|
||||||
output.puts(" return parse_status;")
|
output.puts(' return parse_status;')
|
||||||
output.puts(" }")
|
output.puts(' }')
|
||||||
else
|
else
|
||||||
if (main_name != "main")
|
main_return = @options[:omit_begin_end] ? 'void' : 'int'
|
||||||
output.puts("#{@options[:main_export_decl]} int #{main_name}(void);")
|
if main_name != 'main'
|
||||||
|
output.puts("#{@options[:main_export_decl]} #{main_return} #{main_name}(void);")
|
||||||
end
|
end
|
||||||
output.puts("int #{main_name}(void)")
|
output.puts("#{main_return} #{main_name}(void)")
|
||||||
output.puts("{")
|
output.puts('{')
|
||||||
end
|
end
|
||||||
output.puts(" suite_setup();") unless @options[:suite_setup].nil?
|
output.puts(' suiteSetUp();') if @options[:has_suite_setup]
|
||||||
output.puts(" UnityBegin(\"#{filename.gsub(/\\/,'\\\\\\')}\");")
|
if @options[:omit_begin_end]
|
||||||
if (@options[:use_param_tests])
|
output.puts(" UnitySetTestFile(\"#{filename.gsub(/\\/, '\\\\\\')}\");")
|
||||||
tests.each do |test|
|
else
|
||||||
if ((test[:args].nil?) or (test[:args].empty?))
|
output.puts(" UnityBegin(\"#{filename.gsub(/\\/, '\\\\\\')}\");")
|
||||||
output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]}, RUN_TEST_NO_ARGS);")
|
end
|
||||||
else
|
tests.each do |test|
|
||||||
test[:args].each {|args| output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]}, #{args});")}
|
if (!@options[:use_param_tests]) || test[:args].nil? || test[:args].empty?
|
||||||
|
output.puts(" run_test(#{test[:test]}, \"#{test[:test]}\", #{test[:line_number]});")
|
||||||
|
else
|
||||||
|
test[:args].each.with_index(1) do |args, idx|
|
||||||
|
wrapper = "runner_args#{idx}_#{test[:test]}"
|
||||||
|
testname = "#{test[:test]}(#{args})".dump
|
||||||
|
output.puts(" run_test(#{wrapper}, #{testname}, #{test[:line_number]});")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
else
|
|
||||||
tests.each { |test| output.puts(" RUN_TEST(#{test[:test]}, #{test[:line_number]});") }
|
|
||||||
end
|
end
|
||||||
output.puts()
|
output.puts
|
||||||
output.puts(" CMock_Guts_MemFreeFinal();") unless used_mocks.empty?
|
output.puts(' CMock_Guts_MemFreeFinal();') unless used_mocks.empty?
|
||||||
output.puts(" return #{@options[:suite_teardown].nil? ? "" : "suite_teardown"}(UnityEnd());")
|
if @options[:has_suite_teardown]
|
||||||
output.puts("}")
|
if @options[:omit_begin_end]
|
||||||
|
output.puts(' (void) suite_teardown(0);')
|
||||||
|
else
|
||||||
|
output.puts(' return suiteTearDown(UnityEnd());')
|
||||||
|
end
|
||||||
|
else
|
||||||
|
output.puts(' return UnityEnd();') if not @options[:omit_begin_end]
|
||||||
|
end
|
||||||
|
output.puts('}')
|
||||||
end
|
end
|
||||||
|
|
||||||
def create_h_file(output, filename, tests, testfile_includes, used_mocks)
|
def create_h_file(output, filename, tests, testfile_includes, used_mocks)
|
||||||
filename = File.basename(filename).gsub(/[-\/\\\.\,\s]/, "_").upcase
|
filename = File.basename(filename).gsub(/[-\/\\\.\,\s]/, '_').upcase
|
||||||
output.puts("/* AUTOGENERATED FILE. DO NOT EDIT. */")
|
output.puts('/* AUTOGENERATED FILE. DO NOT EDIT. */')
|
||||||
output.puts("#ifndef _#{filename}")
|
output.puts("#ifndef _#{filename}")
|
||||||
output.puts("#define _#{filename}\n\n")
|
output.puts("#define _#{filename}\n\n")
|
||||||
output.puts("#include \"#{@options[:framework].to_s}.h\"")
|
output.puts("#include \"#{@options[:framework]}.h\"")
|
||||||
output.puts('#include "cmock.h"') unless (used_mocks.empty?)
|
output.puts('#include "cmock.h"') unless used_mocks.empty?
|
||||||
@options[:includes].flatten.uniq.compact.each do |inc|
|
@options[:includes].flatten.uniq.compact.each do |inc|
|
||||||
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h','')}.h\""}")
|
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h', '')}.h\""}")
|
||||||
end
|
end
|
||||||
testfile_includes.each do |inc|
|
testfile_includes.each do |inc|
|
||||||
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h','')}.h\""}")
|
output.puts("#include #{inc.include?('<') ? inc : "\"#{inc.gsub('.h', '')}.h\""}")
|
||||||
end
|
end
|
||||||
output.puts "\n"
|
output.puts "\n"
|
||||||
tests.each do |test|
|
tests.each do |test|
|
||||||
if ((test[:params].nil?) or (test[:params].empty?))
|
if test[:params].nil? || test[:params].empty?
|
||||||
output.puts("void #{test[:test]}(void);")
|
output.puts("void #{test[:test]}(void);")
|
||||||
else
|
else
|
||||||
output.puts("void #{test[:test]}(#{test[:params]});")
|
output.puts("void #{test[:test]}(#{test[:params]});")
|
||||||
@@ -382,50 +440,56 @@ class UnityTestRunnerGenerator
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
if ($0 == __FILE__)
|
if $0 == __FILE__
|
||||||
options = { :includes => [] }
|
options = { includes: [] }
|
||||||
yaml_file = nil
|
|
||||||
|
|
||||||
#parse out all the options first (these will all be removed as we go)
|
# parse out all the options first (these will all be removed as we go)
|
||||||
ARGV.reject! do |arg|
|
ARGV.reject! do |arg|
|
||||||
case(arg)
|
case arg
|
||||||
when '-cexception'
|
when '-cexception'
|
||||||
options[:plugins] = [:cexception]; true
|
options[:plugins] = [:cexception]
|
||||||
when /\.*\.ya?ml/
|
true
|
||||||
options = UnityTestRunnerGenerator.grab_config(arg); true
|
when /\.*\.ya?ml/
|
||||||
when /--(\w+)=\"?(.*)\"?/
|
options = UnityTestRunnerGenerator.grab_config(arg)
|
||||||
options[$1.to_sym] = $2; true
|
true
|
||||||
when /\.*\.h/
|
when /--(\w+)=\"?(.*)\"?/
|
||||||
options[:includes] << arg; true
|
options[Regexp.last_match(1).to_sym] = Regexp.last_match(2)
|
||||||
else false
|
true
|
||||||
|
when /\.*\.h/
|
||||||
|
options[:includes] << arg
|
||||||
|
true
|
||||||
|
else false
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
#make sure there is at least one parameter left (the input file)
|
# make sure there is at least one parameter left (the input file)
|
||||||
if !ARGV[0]
|
unless ARGV[0]
|
||||||
puts ["\nusage: ruby #{__FILE__} (files) (options) input_test_file (output)",
|
puts ["\nusage: ruby #{__FILE__} (files) (options) input_test_file (output)",
|
||||||
"\n input_test_file - this is the C file you want to create a runner for",
|
"\n input_test_file - this is the C file you want to create a runner for",
|
||||||
" output - this is the name of the runner file to generate",
|
' output - this is the name of the runner file to generate',
|
||||||
" defaults to (input_test_file)_Runner",
|
' defaults to (input_test_file)_Runner',
|
||||||
" files:",
|
' files:',
|
||||||
" *.yml / *.yaml - loads configuration from here in :unity or :cmock",
|
' *.yml / *.yaml - loads configuration from here in :unity or :cmock',
|
||||||
" *.h - header files are added as #includes in runner",
|
' *.h - header files are added as #includes in runner',
|
||||||
" options:",
|
' options:',
|
||||||
" -cexception - include cexception support",
|
' -cexception - include cexception support',
|
||||||
" --setup_name=\"\" - redefine setUp func name to something else",
|
' -externc - add extern "C" for cpp support',
|
||||||
" --teardown_name=\"\" - redefine tearDown func name to something else",
|
' --setup_name="" - redefine setUp func name to something else',
|
||||||
" --main_name=\"\" - redefine main func name to something else",
|
' --teardown_name="" - redefine tearDown func name to something else',
|
||||||
" --test_prefix=\"\" - redefine test prefix from default test|spec|should",
|
' --main_name="" - redefine main func name to something else',
|
||||||
" --suite_setup=\"\" - code to execute for setup of entire suite",
|
' --test_prefix="" - redefine test prefix from default test|spec|should',
|
||||||
" --suite_teardown=\"\" - code to execute for teardown of entire suite",
|
' --test_reset_name="" - redefine resetTest func name to something else',
|
||||||
" --use_param_tests=1 - enable parameterized tests (disabled by default)",
|
' --test_verify_name="" - redefine verifyTest func name to something else',
|
||||||
" --header_file=\"\" - path/name of test header file to generate too"
|
' --suite_setup="" - code to execute for setup of entire suite',
|
||||||
].join("\n")
|
' --suite_teardown="" - code to execute for teardown of entire suite',
|
||||||
|
' --use_param_tests=1 - enable parameterized tests (disabled by default)',
|
||||||
|
' --omit_begin_end=1 - omit calls to UnityBegin and UnityEnd (disabled by default)',
|
||||||
|
' --header_file="" - path/name of test header file to generate too'].join("\n")
|
||||||
exit 1
|
exit 1
|
||||||
end
|
end
|
||||||
|
|
||||||
#create the default test runner name if not specified
|
# create the default test runner name if not specified
|
||||||
ARGV[1] = ARGV[0].gsub(".c","_Runner.c") if (!ARGV[1])
|
ARGV[1] = ARGV[0].gsub('.c', '_Runner.c') unless ARGV[1]
|
||||||
|
|
||||||
UnityTestRunnerGenerator.new(options).run(ARGV[0], ARGV[1])
|
UnityTestRunnerGenerator.new(options).run(ARGV[0], ARGV[1])
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,191 +0,0 @@
|
|||||||
#============================================================
|
|
||||||
# Author: John Theofanopoulos
|
|
||||||
# A simple parser. Takes the output files generated during the build process and
|
|
||||||
# extracts information relating to the tests.
|
|
||||||
#
|
|
||||||
# Notes:
|
|
||||||
# To capture an output file under VS builds use the following:
|
|
||||||
# devenv [build instructions] > Output.txt & type Output.txt
|
|
||||||
#
|
|
||||||
# To capture an output file under GCC/Linux builds use the following:
|
|
||||||
# make | tee Output.txt
|
|
||||||
#
|
|
||||||
# To use this parser use the following command
|
|
||||||
# ruby parseOutput.rb [options] [file]
|
|
||||||
# options: -xml : produce a JUnit compatible XML file
|
|
||||||
# file : file to scan for results
|
|
||||||
#============================================================
|
|
||||||
|
|
||||||
|
|
||||||
class ParseOutput
|
|
||||||
# The following flag is set to true when a test is found or false otherwise.
|
|
||||||
@testFlag
|
|
||||||
@xmlOut
|
|
||||||
@arrayList
|
|
||||||
@totalTests
|
|
||||||
@classIndex
|
|
||||||
|
|
||||||
# Set the flag to indicate if there will be an XML output file or not
|
|
||||||
def setXmlOutput()
|
|
||||||
@xmlOut = true
|
|
||||||
end
|
|
||||||
|
|
||||||
# if write our output to XML
|
|
||||||
def writeXmlOuput()
|
|
||||||
output = File.open("report.xml", "w")
|
|
||||||
output << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
|
|
||||||
@arrayList.each do |item|
|
|
||||||
output << item << "\n"
|
|
||||||
end
|
|
||||||
output << "</testsuite>\n"
|
|
||||||
end
|
|
||||||
|
|
||||||
# This function will try and determine when the suite is changed. This is
|
|
||||||
# is the name that gets added to the classname parameter.
|
|
||||||
def testSuiteVerify(testSuiteName)
|
|
||||||
if @testFlag == false
|
|
||||||
@testFlag = true;
|
|
||||||
# Split the path name
|
|
||||||
testName = testSuiteName.split("/")
|
|
||||||
# Remove the extension
|
|
||||||
baseName = testName[testName.size - 1].split(".")
|
|
||||||
@testSuite = "test." + baseName[0]
|
|
||||||
printf "New Test: %s\n", @testSuite
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
# Test was flagged as having passed so format the output
|
|
||||||
def testPassed(array)
|
|
||||||
lastItem = array.length - 1
|
|
||||||
testName = array[lastItem - 1]
|
|
||||||
testSuiteVerify(array[@className])
|
|
||||||
printf "%-40s PASS\n", testName
|
|
||||||
if @xmlOut == true
|
|
||||||
@arrayList.push " <testcase classname=\"" + @testSuite + "\" name=\"" + testName + "\"/>"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Test was flagged as being ingored so format the output
|
|
||||||
def testIgnored(array)
|
|
||||||
lastItem = array.length - 1
|
|
||||||
testName = array[lastItem - 2]
|
|
||||||
reason = array[lastItem].chomp
|
|
||||||
testSuiteVerify(array[@className])
|
|
||||||
printf "%-40s IGNORED\n", testName
|
|
||||||
if @xmlOut == true
|
|
||||||
@arrayList.push " <testcase classname=\"" + @testSuite + "\" name=\"" + testName + "\">"
|
|
||||||
@arrayList.push " <skipped type=\"TEST IGNORED\"> " + reason + " </skipped>"
|
|
||||||
@arrayList.push " </testcase>"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Test was flagged as having failed so format the line
|
|
||||||
def testFailed(array)
|
|
||||||
lastItem = array.length - 1
|
|
||||||
testName = array[lastItem - 2]
|
|
||||||
reason = array[lastItem].chomp + " at line: " + array[lastItem - 3]
|
|
||||||
testSuiteVerify(array[@className])
|
|
||||||
printf "%-40s FAILED\n", testName
|
|
||||||
if @xmlOut == true
|
|
||||||
@arrayList.push " <testcase classname=\"" + @testSuite + "\" name=\"" + testName + "\">"
|
|
||||||
@arrayList.push " <failure type=\"ASSERT FAILED\"> " + reason + " </failure>"
|
|
||||||
@arrayList.push " </testcase>"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
# Figure out what OS we are running on. For now we are assuming if it's not Windows it must
|
|
||||||
# be Unix based.
|
|
||||||
def detectOS()
|
|
||||||
myOS = RUBY_PLATFORM.split("-")
|
|
||||||
if myOS.size == 2
|
|
||||||
if myOS[1] == "mingw32"
|
|
||||||
@className = 1
|
|
||||||
else
|
|
||||||
@className = 0
|
|
||||||
end
|
|
||||||
else
|
|
||||||
@className = 0
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
# Main function used to parse the file that was captured.
|
|
||||||
def process(name)
|
|
||||||
@testFlag = false
|
|
||||||
@arrayList = Array.new
|
|
||||||
|
|
||||||
detectOS()
|
|
||||||
|
|
||||||
puts "Parsing file: " + name
|
|
||||||
|
|
||||||
|
|
||||||
testPass = 0
|
|
||||||
testFail = 0
|
|
||||||
testIgnore = 0
|
|
||||||
puts ""
|
|
||||||
puts "=================== RESULTS ====================="
|
|
||||||
puts ""
|
|
||||||
File.open(name).each do |line|
|
|
||||||
# Typical test lines look like this:
|
|
||||||
# <path>/<test_file>.c:36:test_tc1000_opsys:FAIL: Expected 1 Was 0
|
|
||||||
# <path>/<test_file>.c:112:test_tc5004_initCanChannel:IGNORE: Not Yet Implemented
|
|
||||||
# <path>/<test_file>.c:115:test_tc5100_initCanVoidPtrs:PASS
|
|
||||||
#
|
|
||||||
# where path is different on Unix vs Windows devices (Windows leads with a drive letter)
|
|
||||||
lineArray = line.split(":")
|
|
||||||
lineSize = lineArray.size
|
|
||||||
# If we were able to split the line then we can look to see if any of our target words
|
|
||||||
# were found. Case is important.
|
|
||||||
if lineSize >= 4
|
|
||||||
# Determine if this test passed
|
|
||||||
if line.include? ":PASS"
|
|
||||||
testPassed(lineArray)
|
|
||||||
testPass += 1
|
|
||||||
elsif line.include? ":FAIL:"
|
|
||||||
testFailed(lineArray)
|
|
||||||
testFail += 1
|
|
||||||
elsif line.include? ":IGNORE:"
|
|
||||||
testIgnored(lineArray)
|
|
||||||
testIgnore += 1
|
|
||||||
# If none of the keywords are found there are no more tests for this suite so clear
|
|
||||||
# the test flag
|
|
||||||
else
|
|
||||||
@testFlag = false
|
|
||||||
end
|
|
||||||
else
|
|
||||||
@testFlag = false
|
|
||||||
end
|
|
||||||
end
|
|
||||||
puts ""
|
|
||||||
puts "=================== SUMMARY ====================="
|
|
||||||
puts ""
|
|
||||||
puts "Tests Passed : " + testPass.to_s
|
|
||||||
puts "Tests Failed : " + testFail.to_s
|
|
||||||
puts "Tests Ignored : " + testIgnore.to_s
|
|
||||||
@totalTests = testPass + testFail + testIgnore
|
|
||||||
if @xmlOut == true
|
|
||||||
heading = "<testsuite tests=\"" + @totalTests.to_s + "\" failures=\"" + testFail.to_s + "\"" + " skips=\"" + testIgnore.to_s + "\">"
|
|
||||||
@arrayList.insert(0, heading)
|
|
||||||
writeXmlOuput()
|
|
||||||
end
|
|
||||||
|
|
||||||
# return result
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
# If the command line has no values in, used a default value of Output.txt
|
|
||||||
parseMyFile = ParseOutput.new
|
|
||||||
|
|
||||||
if ARGV.size >= 1
|
|
||||||
ARGV.each do |a|
|
|
||||||
if a == "-xml"
|
|
||||||
parseMyFile.setXmlOutput();
|
|
||||||
else
|
|
||||||
parseMyFile.process(a)
|
|
||||||
break
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
322
auto/parse_output.rb
Normal file
322
auto/parse_output.rb
Normal file
@@ -0,0 +1,322 @@
|
|||||||
|
#============================================================
|
||||||
|
# Author: John Theofanopoulos
|
||||||
|
# A simple parser. Takes the output files generated during the
|
||||||
|
# build process and extracts information relating to the tests.
|
||||||
|
#
|
||||||
|
# Notes:
|
||||||
|
# To capture an output file under VS builds use the following:
|
||||||
|
# devenv [build instructions] > Output.txt & type Output.txt
|
||||||
|
#
|
||||||
|
# To capture an output file under Linux builds use the following:
|
||||||
|
# make | tee Output.txt
|
||||||
|
#
|
||||||
|
# This script can handle the following output formats:
|
||||||
|
# - normal output (raw unity)
|
||||||
|
# - fixture output (unity_fixture.h/.c)
|
||||||
|
# - fixture output with verbose flag set ("-v")
|
||||||
|
#
|
||||||
|
# To use this parser use the following command
|
||||||
|
# ruby parseOutput.rb [options] [file]
|
||||||
|
# options: -xml : produce a JUnit compatible XML file
|
||||||
|
# file: file to scan for results
|
||||||
|
#============================================================
|
||||||
|
|
||||||
|
# Parser class for handling the input file
|
||||||
|
class ParseOutput
|
||||||
|
def initialize
|
||||||
|
# internal data
|
||||||
|
@class_name_idx = 0
|
||||||
|
@path_delim = nil
|
||||||
|
|
||||||
|
# xml output related
|
||||||
|
@xml_out = false
|
||||||
|
@array_list = false
|
||||||
|
|
||||||
|
# current suite name and statistics
|
||||||
|
@test_suite = nil
|
||||||
|
@total_tests = 0
|
||||||
|
@test_passed = 0
|
||||||
|
@test_failed = 0
|
||||||
|
@test_ignored = 0
|
||||||
|
end
|
||||||
|
|
||||||
|
# Set the flag to indicate if there will be an XML output file or not
|
||||||
|
def set_xml_output
|
||||||
|
@xml_out = true
|
||||||
|
end
|
||||||
|
|
||||||
|
# If write our output to XML
|
||||||
|
def write_xml_output
|
||||||
|
output = File.open('report.xml', 'w')
|
||||||
|
output << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
|
||||||
|
@array_list.each do |item|
|
||||||
|
output << item << "\n"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pushes the suite info as xml to the array list, which will be written later
|
||||||
|
def push_xml_output_suite_info
|
||||||
|
# Insert opening tag at front
|
||||||
|
heading = '<testsuite name="Unity" tests="' + @total_tests.to_s + '" failures="' + @test_failed.to_s + '"' + ' skips="' + @test_ignored.to_s + '">'
|
||||||
|
@array_list.insert(0, heading)
|
||||||
|
# Push back the closing tag
|
||||||
|
@array_list.push '</testsuite>'
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pushes xml output data to the array list, which will be written later
|
||||||
|
def push_xml_output_passed(test_name)
|
||||||
|
@array_list.push ' <testcase classname="' + @test_suite + '" name="' + test_name + '"/>'
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pushes xml output data to the array list, which will be written later
|
||||||
|
def push_xml_output_failed(test_name, reason)
|
||||||
|
@array_list.push ' <testcase classname="' + @test_suite + '" name="' + test_name + '">'
|
||||||
|
@array_list.push ' <failure type="ASSERT FAILED">' + reason + '</failure>'
|
||||||
|
@array_list.push ' </testcase>'
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pushes xml output data to the array list, which will be written later
|
||||||
|
def push_xml_output_ignored(test_name, reason)
|
||||||
|
@array_list.push ' <testcase classname="' + @test_suite + '" name="' + test_name + '">'
|
||||||
|
@array_list.push ' <skipped type="TEST IGNORED">' + reason + '</skipped>'
|
||||||
|
@array_list.push ' </testcase>'
|
||||||
|
end
|
||||||
|
|
||||||
|
# This function will try and determine when the suite is changed. This is
|
||||||
|
# is the name that gets added to the classname parameter.
|
||||||
|
def test_suite_verify(test_suite_name)
|
||||||
|
# Split the path name
|
||||||
|
test_name = test_suite_name.split(@path_delim)
|
||||||
|
|
||||||
|
# Remove the extension and extract the base_name
|
||||||
|
base_name = test_name[test_name.size - 1].split('.')[0]
|
||||||
|
|
||||||
|
# Return if the test suite hasn't changed
|
||||||
|
return unless base_name.to_s != @test_suite.to_s
|
||||||
|
|
||||||
|
@test_suite = base_name
|
||||||
|
printf "New Test: %s\n", @test_suite
|
||||||
|
end
|
||||||
|
|
||||||
|
# Prepares the line for verbose fixture output ("-v")
|
||||||
|
def prepare_fixture_line(line)
|
||||||
|
line = line.sub('IGNORE_TEST(', '')
|
||||||
|
line = line.sub('TEST(', '')
|
||||||
|
line = line.sub(')', ',')
|
||||||
|
line = line.chomp
|
||||||
|
array = line.split(',')
|
||||||
|
array.map { |x| x.to_s.lstrip.chomp }
|
||||||
|
end
|
||||||
|
|
||||||
|
# Test was flagged as having passed so format the output.
|
||||||
|
# This is using the Unity fixture output and not the original Unity output.
|
||||||
|
def test_passed_unity_fixture(array)
|
||||||
|
class_name = array[0]
|
||||||
|
test_name = array[1]
|
||||||
|
test_suite_verify(class_name)
|
||||||
|
printf "%-40s PASS\n", test_name
|
||||||
|
|
||||||
|
push_xml_output_passed(test_name) if @xml_out
|
||||||
|
end
|
||||||
|
|
||||||
|
# Test was flagged as having failed so format the output.
|
||||||
|
# This is using the Unity fixture output and not the original Unity output.
|
||||||
|
def test_failed_unity_fixture(array)
|
||||||
|
class_name = array[0]
|
||||||
|
test_name = array[1]
|
||||||
|
test_suite_verify(class_name)
|
||||||
|
reason_array = array[2].split(':')
|
||||||
|
reason = reason_array[-1].lstrip.chomp + ' at line: ' + reason_array[-4]
|
||||||
|
|
||||||
|
printf "%-40s FAILED\n", test_name
|
||||||
|
|
||||||
|
push_xml_output_failed(test_name, reason) if @xml_out
|
||||||
|
end
|
||||||
|
|
||||||
|
# Test was flagged as being ignored so format the output.
|
||||||
|
# This is using the Unity fixture output and not the original Unity output.
|
||||||
|
def test_ignored_unity_fixture(array)
|
||||||
|
class_name = array[0]
|
||||||
|
test_name = array[1]
|
||||||
|
reason = 'No reason given'
|
||||||
|
if array.size > 2
|
||||||
|
reason_array = array[2].split(':')
|
||||||
|
tmp_reason = reason_array[-1].lstrip.chomp
|
||||||
|
reason = tmp_reason == 'IGNORE' ? 'No reason given' : tmp_reason
|
||||||
|
end
|
||||||
|
test_suite_verify(class_name)
|
||||||
|
printf "%-40s IGNORED\n", test_name
|
||||||
|
|
||||||
|
push_xml_output_ignored(test_name, reason) if @xml_out
|
||||||
|
end
|
||||||
|
|
||||||
|
# Test was flagged as having passed so format the output
|
||||||
|
def test_passed(array)
|
||||||
|
last_item = array.length - 1
|
||||||
|
test_name = array[last_item - 1]
|
||||||
|
test_suite_verify(array[@class_name_idx])
|
||||||
|
printf "%-40s PASS\n", test_name
|
||||||
|
|
||||||
|
return unless @xml_out
|
||||||
|
|
||||||
|
push_xml_output_passed(test_name) if @xml_out
|
||||||
|
end
|
||||||
|
|
||||||
|
# Test was flagged as having failed so format the line
|
||||||
|
def test_failed(array)
|
||||||
|
last_item = array.length - 1
|
||||||
|
test_name = array[last_item - 2]
|
||||||
|
reason = array[last_item].chomp.lstrip + ' at line: ' + array[last_item - 3]
|
||||||
|
class_name = array[@class_name_idx]
|
||||||
|
|
||||||
|
if test_name.start_with? 'TEST('
|
||||||
|
array2 = test_name.split(' ')
|
||||||
|
|
||||||
|
test_suite = array2[0].sub('TEST(', '')
|
||||||
|
test_suite = test_suite.sub(',', '')
|
||||||
|
class_name = test_suite
|
||||||
|
|
||||||
|
test_name = array2[1].sub(')', '')
|
||||||
|
end
|
||||||
|
|
||||||
|
test_suite_verify(class_name)
|
||||||
|
printf "%-40s FAILED\n", test_name
|
||||||
|
|
||||||
|
push_xml_output_failed(test_name, reason) if @xml_out
|
||||||
|
end
|
||||||
|
|
||||||
|
# Test was flagged as being ignored so format the output
|
||||||
|
def test_ignored(array)
|
||||||
|
last_item = array.length - 1
|
||||||
|
test_name = array[last_item - 2]
|
||||||
|
reason = array[last_item].chomp.lstrip
|
||||||
|
class_name = array[@class_name_idx]
|
||||||
|
|
||||||
|
if test_name.start_with? 'TEST('
|
||||||
|
array2 = test_name.split(' ')
|
||||||
|
|
||||||
|
test_suite = array2[0].sub('TEST(', '')
|
||||||
|
test_suite = test_suite.sub(',', '')
|
||||||
|
class_name = test_suite
|
||||||
|
|
||||||
|
test_name = array2[1].sub(')', '')
|
||||||
|
end
|
||||||
|
|
||||||
|
test_suite_verify(class_name)
|
||||||
|
printf "%-40s IGNORED\n", test_name
|
||||||
|
|
||||||
|
push_xml_output_ignored(test_name, reason) if @xml_out
|
||||||
|
end
|
||||||
|
|
||||||
|
# Adjusts the os specific members according to the current path style
|
||||||
|
# (Windows or Unix based)
|
||||||
|
def detect_os_specifics(line)
|
||||||
|
if line.include? '\\'
|
||||||
|
# Windows X:\Y\Z
|
||||||
|
@class_name_idx = 1
|
||||||
|
@path_delim = '\\'
|
||||||
|
else
|
||||||
|
# Unix Based /X/Y/Z
|
||||||
|
@class_name_idx = 0
|
||||||
|
@path_delim = '/'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Main function used to parse the file that was captured.
|
||||||
|
def process(file_name)
|
||||||
|
@array_list = []
|
||||||
|
|
||||||
|
puts 'Parsing file: ' + file_name
|
||||||
|
|
||||||
|
@test_passed = 0
|
||||||
|
@test_failed = 0
|
||||||
|
@test_ignored = 0
|
||||||
|
puts ''
|
||||||
|
puts '=================== RESULTS ====================='
|
||||||
|
puts ''
|
||||||
|
File.open(file_name).each do |line|
|
||||||
|
# Typical test lines look like these:
|
||||||
|
# ----------------------------------------------------
|
||||||
|
# 1. normal output:
|
||||||
|
# <path>/<test_file>.c:36:test_tc1000_opsys:FAIL: Expected 1 Was 0
|
||||||
|
# <path>/<test_file>.c:112:test_tc5004_initCanChannel:IGNORE: Not Yet Implemented
|
||||||
|
# <path>/<test_file>.c:115:test_tc5100_initCanVoidPtrs:PASS
|
||||||
|
#
|
||||||
|
# 2. fixture output
|
||||||
|
# <path>/<test_file>.c:63:TEST(<test_group>, <test_function>):FAIL: Expected 0x00001234 Was 0x00005A5A
|
||||||
|
# <path>/<test_file>.c:36:TEST(<test_group>, <test_function>):IGNORE
|
||||||
|
# Note: "PASS" information won't be generated in this mode
|
||||||
|
#
|
||||||
|
# 3. fixture output with verbose information ("-v")
|
||||||
|
# TEST(<test_group, <test_file>)<path>/<test_file>:168::FAIL: Expected 0x8D Was 0x8C
|
||||||
|
# TEST(<test_group>, <test_file>)<path>/<test_file>:22::IGNORE: This Test Was Ignored On Purpose
|
||||||
|
# IGNORE_TEST(<test_group, <test_file>)
|
||||||
|
# TEST(<test_group, <test_file>) PASS
|
||||||
|
#
|
||||||
|
# Note: Where path is different on Unix vs Windows devices (Windows leads with a drive letter)!
|
||||||
|
detect_os_specifics(line)
|
||||||
|
line_array = line.split(':')
|
||||||
|
|
||||||
|
# If we were able to split the line then we can look to see if any of our target words
|
||||||
|
# were found. Case is important.
|
||||||
|
next unless (line_array.size >= 4) || (line.start_with? 'TEST(') || (line.start_with? 'IGNORE_TEST(')
|
||||||
|
|
||||||
|
# check if the output is fixture output (with verbose flag "-v")
|
||||||
|
if (line.start_with? 'TEST(') || (line.start_with? 'IGNORE_TEST(')
|
||||||
|
line_array = prepare_fixture_line(line)
|
||||||
|
if line.include? ' PASS'
|
||||||
|
test_passed_unity_fixture(line_array)
|
||||||
|
@test_passed += 1
|
||||||
|
elsif line.include? 'FAIL'
|
||||||
|
test_failed_unity_fixture(line_array)
|
||||||
|
@test_failed += 1
|
||||||
|
elsif line.include? 'IGNORE'
|
||||||
|
test_ignored_unity_fixture(line_array)
|
||||||
|
@test_ignored += 1
|
||||||
|
end
|
||||||
|
# normal output / fixture output (without verbose "-v")
|
||||||
|
elsif line.include? ':PASS'
|
||||||
|
test_passed(line_array)
|
||||||
|
@test_passed += 1
|
||||||
|
elsif line.include? ':FAIL'
|
||||||
|
test_failed(line_array)
|
||||||
|
@test_failed += 1
|
||||||
|
elsif line.include? ':IGNORE:'
|
||||||
|
test_ignored(line_array)
|
||||||
|
@test_ignored += 1
|
||||||
|
elsif line.include? ':IGNORE'
|
||||||
|
line_array.push('No reason given')
|
||||||
|
test_ignored(line_array)
|
||||||
|
@test_ignored += 1
|
||||||
|
end
|
||||||
|
@total_tests = @test_passed + @test_failed + @test_ignored
|
||||||
|
end
|
||||||
|
puts ''
|
||||||
|
puts '=================== SUMMARY ====================='
|
||||||
|
puts ''
|
||||||
|
puts 'Tests Passed : ' + @test_passed.to_s
|
||||||
|
puts 'Tests Failed : ' + @test_failed.to_s
|
||||||
|
puts 'Tests Ignored : ' + @test_ignored.to_s
|
||||||
|
|
||||||
|
return unless @xml_out
|
||||||
|
|
||||||
|
# push information about the suite
|
||||||
|
push_xml_output_suite_info
|
||||||
|
# write xml output file
|
||||||
|
write_xml_output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# If the command line has no values in, used a default value of Output.txt
|
||||||
|
parse_my_file = ParseOutput.new
|
||||||
|
|
||||||
|
if ARGV.size >= 1
|
||||||
|
ARGV.each do |arg|
|
||||||
|
if arg == '-xml'
|
||||||
|
parse_my_file.set_xml_output
|
||||||
|
else
|
||||||
|
parse_my_file.process(arg)
|
||||||
|
break
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
36
auto/run_test.erb
Normal file
36
auto/run_test.erb
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
/*=======Test Runner Used To Run Each Test=====*/
|
||||||
|
static void run_test(UnityTestFunction func, const char* name, int line_num)
|
||||||
|
{
|
||||||
|
Unity.CurrentTestName = name;
|
||||||
|
Unity.CurrentTestLineNumber = line_num;
|
||||||
|
#ifdef UNITY_USE_COMMAND_LINE_ARGS
|
||||||
|
if (!UnityTestMatches())
|
||||||
|
return;
|
||||||
|
#endif
|
||||||
|
Unity.NumberOfTests++;
|
||||||
|
UNITY_CLR_DETAILS();
|
||||||
|
UNITY_EXEC_TIME_START();
|
||||||
|
CMock_Init();
|
||||||
|
if (TEST_PROTECT())
|
||||||
|
{
|
||||||
|
<% if @options[:plugins].include?(:cexception) %>
|
||||||
|
CEXCEPTION_T e;
|
||||||
|
Try {
|
||||||
|
<% end %>
|
||||||
|
<%= @options[:setup_name] %>();
|
||||||
|
func();
|
||||||
|
<% if @options[:plugins].include?(:cexception) %>
|
||||||
|
} Catch(e) {
|
||||||
|
TEST_ASSERT_EQUAL_HEX32_MESSAGE(CEXCEPTION_NONE, e, "Unhandled Exception!");
|
||||||
|
}
|
||||||
|
<% end %>
|
||||||
|
}
|
||||||
|
if (TEST_PROTECT())
|
||||||
|
{
|
||||||
|
<%= @options[:teardown_name] %>();
|
||||||
|
CMock_Verify();
|
||||||
|
}
|
||||||
|
CMock_Destroy();
|
||||||
|
UNITY_EXEC_TIME_STOP();
|
||||||
|
UnityConcludeTest();
|
||||||
|
}
|
||||||
229
auto/stylize_as_junit.rb
Normal file → Executable file
229
auto/stylize_as_junit.rb
Normal file → Executable file
@@ -12,7 +12,6 @@ require 'pp'
|
|||||||
VERSION = 1.0
|
VERSION = 1.0
|
||||||
|
|
||||||
class ArgvParser
|
class ArgvParser
|
||||||
|
|
||||||
#
|
#
|
||||||
# Return a structure describing the options.
|
# Return a structure describing the options.
|
||||||
#
|
#
|
||||||
@@ -20,41 +19,41 @@ class ArgvParser
|
|||||||
# The options specified on the command line will be collected in *options*.
|
# The options specified on the command line will be collected in *options*.
|
||||||
# We set default values here.
|
# We set default values here.
|
||||||
options = OpenStruct.new
|
options = OpenStruct.new
|
||||||
options.results_dir = "."
|
options.results_dir = '.'
|
||||||
options.root_path = "."
|
options.root_path = '.'
|
||||||
options.out_file = "results.xml"
|
options.out_file = 'results.xml'
|
||||||
|
|
||||||
opts = OptionParser.new do |opts|
|
opts = OptionParser.new do |o|
|
||||||
opts.banner = "Usage: unity_to_junit.rb [options]"
|
o.banner = 'Usage: unity_to_junit.rb [options]'
|
||||||
|
|
||||||
opts.separator ""
|
o.separator ''
|
||||||
opts.separator "Specific options:"
|
o.separator 'Specific options:'
|
||||||
|
|
||||||
opts.on("-r", "--results <dir>", "Look for Unity Results files here.") do |results|
|
o.on('-r', '--results <dir>', 'Look for Unity Results files here.') do |results|
|
||||||
#puts "results #{results}"
|
# puts "results #{results}"
|
||||||
options.results_dir = results
|
options.results_dir = results
|
||||||
end
|
end
|
||||||
|
|
||||||
opts.on("-p", "--root_path <path>", "Prepend this path to files in results.") do |root_path|
|
o.on('-p', '--root_path <path>', 'Prepend this path to files in results.') do |root_path|
|
||||||
options.root_path = root_path
|
options.root_path = root_path
|
||||||
end
|
end
|
||||||
|
|
||||||
opts.on("-o", "--output <filename>", "XML file to generate.") do |out_file|
|
o.on('-o', '--output <filename>', 'XML file to generate.') do |out_file|
|
||||||
#puts "out_file: #{out_file}"
|
# puts "out_file: #{out_file}"
|
||||||
options.out_file = out_file
|
options.out_file = out_file
|
||||||
end
|
end
|
||||||
|
|
||||||
opts.separator ""
|
o.separator ''
|
||||||
opts.separator "Common options:"
|
o.separator 'Common options:'
|
||||||
|
|
||||||
# No argument, shows at tail. This will print an options summary.
|
# No argument, shows at tail. This will print an options summary.
|
||||||
opts.on_tail("-h", "--help", "Show this message") do
|
o.on_tail('-h', '--help', 'Show this message') do
|
||||||
puts opts
|
puts o
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
|
|
||||||
# Another typical switch to print the version.
|
# Another typical switch to print the version.
|
||||||
opts.on_tail("--version", "Show version") do
|
o.on_tail('--version', 'Show version') do
|
||||||
puts "unity_to_junit.rb version #{VERSION}"
|
puts "unity_to_junit.rb version #{VERSION}"
|
||||||
exit
|
exit
|
||||||
end
|
end
|
||||||
@@ -62,13 +61,13 @@ class ArgvParser
|
|||||||
|
|
||||||
opts.parse!(args)
|
opts.parse!(args)
|
||||||
options
|
options
|
||||||
end # parse()
|
end
|
||||||
|
end
|
||||||
end # class OptparseExample
|
|
||||||
|
|
||||||
class UnityToJUnit
|
class UnityToJUnit
|
||||||
include FileUtils::Verbose
|
include FileUtils::Verbose
|
||||||
attr_reader :report, :total_tests, :failures, :ignored
|
attr_reader :report, :total_tests, :failures, :ignored
|
||||||
|
attr_writer :targets, :root, :out_file
|
||||||
|
|
||||||
def initialize
|
def initialize
|
||||||
@report = ''
|
@report = ''
|
||||||
@@ -77,125 +76,112 @@ class UnityToJUnit
|
|||||||
|
|
||||||
def run
|
def run
|
||||||
# Clean up result file names
|
# Clean up result file names
|
||||||
results = @targets.map {|target| target.gsub(/\\/,"/")}
|
results = @targets.map { |target| target.tr('\\', '/') }
|
||||||
#puts "Output File: #{@out_file}"
|
# puts "Output File: #{@out_file}"
|
||||||
f = File.new(@out_file, "w")
|
f = File.new(@out_file, 'w')
|
||||||
write_xml_header(f)
|
write_xml_header(f)
|
||||||
write_suites_header( f )
|
write_suites_header(f)
|
||||||
results.each do |result_file|
|
results.each do |result_file|
|
||||||
lines = File.readlines(result_file).map { |line| line.chomp }
|
lines = File.readlines(result_file).map(&:chomp)
|
||||||
if lines.length == 0
|
|
||||||
raise "Empty test result file: #{result_file}"
|
raise "Empty test result file: #{result_file}" if lines.empty?
|
||||||
else
|
|
||||||
result_output = get_details(result_file, lines)
|
result_output = get_details(result_file, lines)
|
||||||
tests,failures,ignored = parse_test_summary(lines)
|
tests, failures, ignored = parse_test_summary(lines)
|
||||||
result_output[:counts][:total] = tests
|
result_output[:counts][:total] = tests
|
||||||
result_output[:counts][:failed] = failures
|
result_output[:counts][:failed] = failures
|
||||||
result_output[:counts][:ignored] = ignored
|
result_output[:counts][:ignored] = ignored
|
||||||
result_output[:counts][:passed] = (result_output[:counts][:total] - result_output[:counts][:failed] - result_output[:counts][:ignored])
|
result_output[:counts][:passed] = (result_output[:counts][:total] - result_output[:counts][:failed] - result_output[:counts][:ignored])
|
||||||
end
|
|
||||||
#use line[0] from the test output to get the test_file path and name
|
# use line[0] from the test output to get the test_file path and name
|
||||||
test_file_str = lines[0].gsub("\\","/")
|
test_file_str = lines[0].tr('\\', '/')
|
||||||
test_file_str = test_file_str.split(":")
|
test_file_str = test_file_str.split(':')
|
||||||
test_file = if (test_file_str.length < 2)
|
test_file = if test_file_str.length < 2
|
||||||
result_file
|
result_file
|
||||||
else
|
else
|
||||||
test_file_str[0] + ':' + test_file_str[1]
|
test_file_str[0] + ':' + test_file_str[1]
|
||||||
end
|
end
|
||||||
result_output[:source][:path] = File.dirname(test_file)
|
result_output[:source][:path] = File.dirname(test_file)
|
||||||
result_output[:source][:file] = File.basename(test_file)
|
result_output[:source][:file] = File.basename(test_file)
|
||||||
|
|
||||||
# save result_output
|
# save result_output
|
||||||
@unit_name = File.basename(test_file, ".*")
|
@unit_name = File.basename(test_file, '.*')
|
||||||
|
|
||||||
write_suite_header( result_output[:counts], f)
|
write_suite_header(result_output[:counts], f)
|
||||||
write_failures( result_output, f )
|
write_failures(result_output, f)
|
||||||
write_tests( result_output, f )
|
write_tests(result_output, f)
|
||||||
write_ignored( result_output, f )
|
write_ignored(result_output, f)
|
||||||
write_suite_footer( f )
|
write_suite_footer(f)
|
||||||
end
|
end
|
||||||
write_suites_footer( f )
|
write_suites_footer(f)
|
||||||
f.close
|
f.close
|
||||||
end
|
end
|
||||||
|
|
||||||
def set_targets(target_array)
|
def usage(err_msg = nil)
|
||||||
@targets = target_array
|
|
||||||
end
|
|
||||||
|
|
||||||
def set_root_path(path)
|
|
||||||
@root = path
|
|
||||||
end
|
|
||||||
def set_out_file(filename)
|
|
||||||
@out_file = filename
|
|
||||||
end
|
|
||||||
def usage(err_msg=nil)
|
|
||||||
puts "\nERROR: "
|
puts "\nERROR: "
|
||||||
puts err_msg if err_msg
|
puts err_msg if err_msg
|
||||||
puts "Usage: unity_to_junit.rb [options]"
|
puts 'Usage: unity_to_junit.rb [options]'
|
||||||
puts ""
|
puts ''
|
||||||
puts "Specific options:"
|
puts 'Specific options:'
|
||||||
puts " -r, --results <dir> Look for Unity Results files here."
|
puts ' -r, --results <dir> Look for Unity Results files here.'
|
||||||
puts " -p, --root_path <path> Prepend this path to files in results."
|
puts ' -p, --root_path <path> Prepend this path to files in results.'
|
||||||
puts " -o, --output <filename> XML file to generate."
|
puts ' -o, --output <filename> XML file to generate.'
|
||||||
puts ""
|
puts ''
|
||||||
puts "Common options:"
|
puts 'Common options:'
|
||||||
puts " -h, --help Show this message"
|
puts ' -h, --help Show this message'
|
||||||
puts " --version Show version"
|
puts ' --version Show version'
|
||||||
|
|
||||||
exit 1
|
exit 1
|
||||||
end
|
end
|
||||||
|
|
||||||
protected
|
protected
|
||||||
def get_details(result_file, lines)
|
|
||||||
results = get_results_structure
|
def get_details(_result_file, lines)
|
||||||
|
results = results_structure
|
||||||
lines.each do |line|
|
lines.each do |line|
|
||||||
line = line.gsub("\\","/")
|
line = line.tr('\\', '/')
|
||||||
src_file,src_line,test_name,status,msg = line.split(/:/)
|
_src_file, src_line, test_name, status, msg = line.split(/:/)
|
||||||
line_out = ((@root and (@root != 0)) ? "#{@root}#{line}" : line ).gsub(/\//, "\\")
|
case status
|
||||||
case(status)
|
when 'IGNORE' then results[:ignores] << { test: test_name, line: src_line, message: msg }
|
||||||
when 'IGNORE' then results[:ignores] << {:test => test_name, :line => src_line, :message => msg}
|
when 'FAIL' then results[:failures] << { test: test_name, line: src_line, message: msg }
|
||||||
when 'FAIL' then results[:failures] << {:test => test_name, :line => src_line, :message => msg}
|
when 'PASS' then results[:successes] << { test: test_name, line: src_line, message: msg }
|
||||||
when 'PASS' then results[:successes] << {:test => test_name, :line => src_line, :message => msg}
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
return results
|
results
|
||||||
end
|
end
|
||||||
|
|
||||||
def parse_test_summary(summary)
|
def parse_test_summary(summary)
|
||||||
if summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ }
|
raise "Couldn't parse test results: #{summary}" unless summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ }
|
||||||
[$1.to_i,$2.to_i,$3.to_i]
|
|
||||||
else
|
[Regexp.last_match(1).to_i, Regexp.last_match(2).to_i, Regexp.last_match(3).to_i]
|
||||||
raise "Couldn't parse test results: #{summary}"
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
def here; File.expand_path(File.dirname(__FILE__)); end
|
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
def get_results_structure
|
def results_structure
|
||||||
return {
|
{
|
||||||
:source => {:path => '', :file => ''},
|
source: { path: '', file: '' },
|
||||||
:successes => [],
|
successes: [],
|
||||||
:failures => [],
|
failures: [],
|
||||||
:ignores => [],
|
ignores: [],
|
||||||
:counts => {:total => 0, :passed => 0, :failed => 0, :ignored => 0},
|
counts: { total: 0, passed: 0, failed: 0, ignored: 0 },
|
||||||
:stdout => [],
|
stdout: []
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
def write_xml_header( stream )
|
def write_xml_header(stream)
|
||||||
stream.puts "<?xml version='1.0' encoding='utf-8' ?>"
|
stream.puts "<?xml version='1.0' encoding='utf-8' ?>"
|
||||||
end
|
end
|
||||||
|
|
||||||
def write_suites_header( stream )
|
def write_suites_header(stream)
|
||||||
stream.puts "<testsuites>"
|
stream.puts '<testsuites>'
|
||||||
end
|
end
|
||||||
|
|
||||||
def write_suite_header( counts, stream )
|
def write_suite_header(counts, stream)
|
||||||
stream.puts "\t<testsuite errors=\"0\" skipped=\"#{counts[:ignored]}\" failures=\"#{counts[:failed]}\" tests=\"#{counts[:total]}\" name=\"unity\">"
|
stream.puts "\t<testsuite errors=\"0\" skipped=\"#{counts[:ignored]}\" failures=\"#{counts[:failed]}\" tests=\"#{counts[:total]}\" name=\"unity\">"
|
||||||
end
|
end
|
||||||
|
|
||||||
def write_failures( results, stream )
|
def write_failures(results, stream)
|
||||||
result = results[:failures]
|
result = results[:failures]
|
||||||
result.each do |item|
|
result.each do |item|
|
||||||
filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*'))
|
filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*'))
|
||||||
@@ -206,15 +192,14 @@ class UnityToJUnit
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def write_tests( results, stream )
|
def write_tests(results, stream)
|
||||||
result = results[:successes]
|
result = results[:successes]
|
||||||
result.each do |item|
|
result.each do |item|
|
||||||
filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*'))
|
|
||||||
stream.puts "\t\t<testcase classname=\"#{@unit_name}\" name=\"#{item[:test]}\" time=\"0\" />"
|
stream.puts "\t\t<testcase classname=\"#{@unit_name}\" name=\"#{item[:test]}\" time=\"0\" />"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def write_ignored( results, stream )
|
def write_ignored(results, stream)
|
||||||
result = results[:ignores]
|
result = results[:ignores]
|
||||||
result.each do |item|
|
result.each do |item|
|
||||||
filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*'))
|
filename = File.join(results[:source][:path], File.basename(results[:source][:file], '.*'))
|
||||||
@@ -226,39 +211,41 @@ class UnityToJUnit
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def write_suite_footer( stream )
|
def write_suite_footer(stream)
|
||||||
stream.puts "\t</testsuite>"
|
stream.puts "\t</testsuite>"
|
||||||
end
|
end
|
||||||
|
|
||||||
def write_suites_footer( stream )
|
def write_suites_footer(stream)
|
||||||
stream.puts "</testsuites>"
|
stream.puts '</testsuites>'
|
||||||
end
|
end
|
||||||
end #UnityToJUnit
|
end
|
||||||
|
|
||||||
if __FILE__ == $0
|
if $0 == __FILE__
|
||||||
#parse out the command options
|
# parse out the command options
|
||||||
options = ArgvParser.parse(ARGV)
|
options = ArgvParser.parse(ARGV)
|
||||||
|
|
||||||
#create an instance to work with
|
# create an instance to work with
|
||||||
utj = UnityToJUnit.new
|
utj = UnityToJUnit.new
|
||||||
begin
|
begin
|
||||||
#look in the specified or current directory for result files
|
# look in the specified or current directory for result files
|
||||||
targets = "#{options.results_dir.gsub(/\\/, '/')}**/*.test*"
|
targets = "#{options.results_dir.tr('\\', '/')}**/*.test*"
|
||||||
|
|
||||||
results = Dir[targets]
|
results = Dir[targets]
|
||||||
|
|
||||||
raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty?
|
raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty?
|
||||||
utj.set_targets(results)
|
|
||||||
|
|
||||||
#set the root path
|
utj.targets = results
|
||||||
utj.set_root_path(options.root_path)
|
|
||||||
|
|
||||||
#set the output XML file name
|
# set the root path
|
||||||
#puts "Output File from options: #{options.out_file}"
|
utj.root = options.root_path
|
||||||
utj.set_out_file(options.out_file)
|
|
||||||
|
|
||||||
#run the summarizer
|
# set the output XML file name
|
||||||
|
# puts "Output File from options: #{options.out_file}"
|
||||||
|
utj.out_file = options.out_file
|
||||||
|
|
||||||
|
# run the summarizer
|
||||||
puts utj.run
|
puts utj.run
|
||||||
rescue Exception => e
|
rescue StandardError => e
|
||||||
utj.usage e.message
|
utj.usage e.message
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
# Unity Project - A Test Framework for C
|
# Unity Project - A Test Framework for C
|
||||||
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
# [Released under MIT License. Please refer to license.txt for details]
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
require'yaml'
|
require'yaml'
|
||||||
|
|
||||||
@@ -10,14 +10,16 @@ module RakefileHelpers
|
|||||||
class TestFileFilter
|
class TestFileFilter
|
||||||
def initialize(all_files = false)
|
def initialize(all_files = false)
|
||||||
@all_files = all_files
|
@all_files = all_files
|
||||||
if not @all_files == true
|
|
||||||
if File.exist?('test_file_filter.yml')
|
return unless @all_files
|
||||||
filters = YAML.load_file( 'test_file_filter.yml' )
|
return unless File.exist?('test_file_filter.yml')
|
||||||
@all_files, @only_files, @exclude_files =
|
|
||||||
filters[:all_files], filters[:only_files], filters[:exclude_files]
|
filters = YAML.load_file('test_file_filter.yml')
|
||||||
end
|
@all_files = filters[:all_files]
|
||||||
end
|
@only_files = filters[:only_files]
|
||||||
end
|
@exclude_files = filters[:exclude_files]
|
||||||
|
end
|
||||||
|
|
||||||
attr_accessor :all_files, :only_files, :exclude_files
|
attr_accessor :all_files, :only_files, :exclude_files
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,8 +1,6 @@
|
|||||||
module TypeSanitizer
|
module TypeSanitizer
|
||||||
|
|
||||||
def self.sanitize_c_identifier(unsanitized)
|
def self.sanitize_c_identifier(unsanitized)
|
||||||
# convert filename to valid C identifier by replacing invalid chars with '_'
|
# convert filename to valid C identifier by replacing invalid chars with '_'
|
||||||
return unsanitized.gsub(/[-\/\\\.\,\s]/, "_")
|
unsanitized.gsub(/[-\/\\\.\,\s]/, '_')
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -86,9 +86,13 @@ class UnityTestSummary:
|
|||||||
results = { 'failures': [], 'ignores': [], 'successes': [] }
|
results = { 'failures': [], 'ignores': [], 'successes': [] }
|
||||||
for line in lines:
|
for line in lines:
|
||||||
parts = line.split(':')
|
parts = line.split(':')
|
||||||
if len(parts) != 5:
|
if len(parts) == 5:
|
||||||
|
src_file,src_line,test_name,status,msg = parts
|
||||||
|
elif len(parts) == 4:
|
||||||
|
src_file,src_line,test_name,status = parts
|
||||||
|
msg = ''
|
||||||
|
else:
|
||||||
continue
|
continue
|
||||||
src_file,src_line,test_name,status,msg = parts
|
|
||||||
if len(self.root) > 0:
|
if len(self.root) > 0:
|
||||||
line_out = "%s%s" % (self.root, line)
|
line_out = "%s%s" % (self.root, line)
|
||||||
else:
|
else:
|
||||||
@@ -117,7 +121,7 @@ if __name__ == '__main__':
|
|||||||
targets_dir = sys.argv[1]
|
targets_dir = sys.argv[1]
|
||||||
else:
|
else:
|
||||||
targets_dir = './'
|
targets_dir = './'
|
||||||
targets = list(map(lambda x: x.replace('\\', '/'), glob(targets_dir + '*.test*')))
|
targets = list(map(lambda x: x.replace('\\', '/'), glob(targets_dir + '**/*.test*', recursive=True)))
|
||||||
if len(targets) == 0:
|
if len(targets) == 0:
|
||||||
raise Exception("No *.testpass or *.testfail files found in '%s'" % targets_dir)
|
raise Exception("No *.testpass or *.testfail files found in '%s'" % targets_dir)
|
||||||
uts.set_targets(targets)
|
uts.set_targets(targets)
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
# [Released under MIT License. Please refer to license.txt for details]
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
#!/usr/bin/ruby
|
# !/usr/bin/ruby
|
||||||
#
|
#
|
||||||
# unity_test_summary.rb
|
# unity_test_summary.rb
|
||||||
#
|
#
|
||||||
@@ -15,37 +15,35 @@ class UnityTestSummary
|
|||||||
include FileUtils::Verbose
|
include FileUtils::Verbose
|
||||||
|
|
||||||
attr_reader :report, :total_tests, :failures, :ignored
|
attr_reader :report, :total_tests, :failures, :ignored
|
||||||
|
attr_writer :targets, :root
|
||||||
|
|
||||||
def initialize(opts = {})
|
def initialize(_opts = {})
|
||||||
@report = ''
|
@report = ''
|
||||||
@total_tests = 0
|
@total_tests = 0
|
||||||
@failures = 0
|
@failures = 0
|
||||||
@ignored = 0
|
@ignored = 0
|
||||||
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def run
|
def run
|
||||||
# Clean up result file names
|
# Clean up result file names
|
||||||
results = @targets.map {|target| target.gsub(/\\/,'/')}
|
results = @targets.map { |target| target.tr('\\', '/') }
|
||||||
|
|
||||||
# Dig through each result file, looking for details on pass/fail:
|
# Dig through each result file, looking for details on pass/fail:
|
||||||
failure_output = []
|
failure_output = []
|
||||||
ignore_output = []
|
ignore_output = []
|
||||||
|
|
||||||
results.each do |result_file|
|
results.each do |result_file|
|
||||||
lines = File.readlines(result_file).map { |line| line.chomp }
|
lines = File.readlines(result_file).map(&:chomp)
|
||||||
if lines.length == 0
|
|
||||||
raise "Empty test result file: #{result_file}"
|
raise "Empty test result file: #{result_file}" if lines.empty?
|
||||||
else
|
|
||||||
output = get_details(result_file, lines)
|
output = get_details(result_file, lines)
|
||||||
failure_output << output[:failures] unless output[:failures].empty?
|
failure_output << output[:failures] unless output[:failures].empty?
|
||||||
ignore_output << output[:ignores] unless output[:ignores].empty?
|
ignore_output << output[:ignores] unless output[:ignores].empty?
|
||||||
tests,failures,ignored = parse_test_summary(lines)
|
tests, failures, ignored = parse_test_summary(lines)
|
||||||
@total_tests += tests
|
@total_tests += tests
|
||||||
@failures += failures
|
@failures += failures
|
||||||
@ignored += ignored
|
@ignored += ignored
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if @ignored > 0
|
if @ignored > 0
|
||||||
@@ -72,77 +70,66 @@ class UnityTestSummary
|
|||||||
@report += "\n"
|
@report += "\n"
|
||||||
end
|
end
|
||||||
|
|
||||||
def set_targets(target_array)
|
def usage(err_msg = nil)
|
||||||
@targets = target_array
|
|
||||||
end
|
|
||||||
|
|
||||||
def set_root_path(path)
|
|
||||||
@root = path
|
|
||||||
end
|
|
||||||
|
|
||||||
def usage(err_msg=nil)
|
|
||||||
puts "\nERROR: "
|
puts "\nERROR: "
|
||||||
puts err_msg if err_msg
|
puts err_msg if err_msg
|
||||||
puts "\nUsage: unity_test_summary.rb result_file_directory/ root_path/"
|
puts "\nUsage: unity_test_summary.rb result_file_directory/ root_path/"
|
||||||
puts " result_file_directory - The location of your results files."
|
puts ' result_file_directory - The location of your results files.'
|
||||||
puts " Defaults to current directory if not specified."
|
puts ' Defaults to current directory if not specified.'
|
||||||
puts " Should end in / if specified."
|
puts ' Should end in / if specified.'
|
||||||
puts " root_path - Helpful for producing more verbose output if using relative paths."
|
puts ' root_path - Helpful for producing more verbose output if using relative paths.'
|
||||||
exit 1
|
exit 1
|
||||||
end
|
end
|
||||||
|
|
||||||
protected
|
protected
|
||||||
|
|
||||||
def get_details(result_file, lines)
|
def get_details(_result_file, lines)
|
||||||
results = { :failures => [], :ignores => [], :successes => [] }
|
results = { failures: [], ignores: [], successes: [] }
|
||||||
lines.each do |line|
|
lines.each do |line|
|
||||||
src_file,src_line,test_name,status,msg = line.split(/:/)
|
_src_file, _src_line, _test_name, status, _msg = line.split(/:/)
|
||||||
line_out = ((@root && (@root != 0)) ? "#{@root}#{line}" : line ).gsub(/\//, "\\")
|
line_out = (@root && (@root != 0) ? "#{@root}#{line}" : line).gsub(/\//, '\\')
|
||||||
case(status)
|
case status
|
||||||
when 'IGNORE' then results[:ignores] << line_out
|
when 'IGNORE' then results[:ignores] << line_out
|
||||||
when 'FAIL' then results[:failures] << line_out
|
when 'FAIL' then results[:failures] << line_out
|
||||||
when 'PASS' then results[:successes] << line_out
|
when 'PASS' then results[:successes] << line_out
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
return results
|
results
|
||||||
end
|
end
|
||||||
|
|
||||||
def parse_test_summary(summary)
|
def parse_test_summary(summary)
|
||||||
if summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ }
|
raise "Couldn't parse test results: #{summary}" unless summary.find { |v| v =~ /(\d+) Tests (\d+) Failures (\d+) Ignored/ }
|
||||||
[$1.to_i,$2.to_i,$3.to_i]
|
|
||||||
else
|
[Regexp.last_match(1).to_i, Regexp.last_match(2).to_i, Regexp.last_match(3).to_i]
|
||||||
raise "Couldn't parse test results: #{summary}"
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def here; File.expand_path(File.dirname(__FILE__)); end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if $0 == __FILE__
|
if $0 == __FILE__
|
||||||
|
|
||||||
#parse out the command options
|
# parse out the command options
|
||||||
opts, args = ARGV.partition {|v| v =~ /^--\w+/}
|
opts, args = ARGV.partition { |v| v =~ /^--\w+/ }
|
||||||
opts.map! {|v| v[2..-1].to_sym }
|
opts.map! { |v| v[2..-1].to_sym }
|
||||||
|
|
||||||
#create an instance to work with
|
# create an instance to work with
|
||||||
uts = UnityTestSummary.new(opts)
|
uts = UnityTestSummary.new(opts)
|
||||||
|
|
||||||
begin
|
begin
|
||||||
#look in the specified or current directory for result files
|
# look in the specified or current directory for result files
|
||||||
args[0] ||= './'
|
args[0] ||= './'
|
||||||
targets = "#{ARGV[0].gsub(/\\/, '/')}**/*.test*"
|
targets = "#{ARGV[0].tr('\\', '/')}**/*.test*"
|
||||||
results = Dir[targets]
|
results = Dir[targets]
|
||||||
|
|
||||||
raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty?
|
raise "No *.testpass, *.testfail, or *.testresults files found in '#{targets}'" if results.empty?
|
||||||
uts.set_targets(results)
|
|
||||||
|
|
||||||
#set the root path
|
uts.targets = results
|
||||||
|
|
||||||
|
# set the root path
|
||||||
args[1] ||= Dir.pwd + '/'
|
args[1] ||= Dir.pwd + '/'
|
||||||
uts.set_root_path(ARGV[1])
|
uts.root = ARGV[1]
|
||||||
|
|
||||||
#run the summarizer
|
# run the summarizer
|
||||||
puts uts.run
|
puts uts.run
|
||||||
rescue Exception => e
|
rescue StandardError => e
|
||||||
uts.usage e.message
|
uts.usage e.message
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
206
docs/ThrowTheSwitchCodingStandard.md
Normal file
206
docs/ThrowTheSwitchCodingStandard.md
Normal file
@@ -0,0 +1,206 @@
|
|||||||
|
# ThrowTheSwitch.org Coding Standard
|
||||||
|
|
||||||
|
Hi. Welcome to the coding standard for ThrowTheSwitch.org. For the most part,
|
||||||
|
we try to follow these standards to unify our contributors' code into a cohesive
|
||||||
|
unit (puns intended). You might find places where these standards aren't
|
||||||
|
followed. We're not perfect. Please be polite where you notice these discrepancies
|
||||||
|
and we'll try to be polite when we notice yours.
|
||||||
|
|
||||||
|
;)
|
||||||
|
|
||||||
|
|
||||||
|
## Why Have A Coding Standard?
|
||||||
|
|
||||||
|
Being consistent makes code easier to understand. We've tried to keep
|
||||||
|
our standard simple because we also believe that we can only expect someone to
|
||||||
|
follow something that is understandable. Please do your best.
|
||||||
|
|
||||||
|
|
||||||
|
## Our Philosophy
|
||||||
|
|
||||||
|
Before we get into details on syntax, let's take a moment to talk about our
|
||||||
|
vision for these tools. We're C developers and embedded software developers.
|
||||||
|
These tools are great to test any C code, but catering to embedded software has
|
||||||
|
made us more tolerant of compiler quirks. There are a LOT of quirky compilers
|
||||||
|
out there. By quirky I mean "doesn't follow standards because they feel like
|
||||||
|
they have a license to do as they wish."
|
||||||
|
|
||||||
|
Our philosophy is "support every compiler we can". Most often, this means that
|
||||||
|
we aim for writing C code that is standards compliant (often C89... that seems
|
||||||
|
to be a sweet spot that is almost always compatible). But it also means these
|
||||||
|
tools are tolerant of things that aren't common. Some that aren't even
|
||||||
|
compliant. There are configuration options to override the size of standard
|
||||||
|
types. There are configuration options to force Unity to not use certain
|
||||||
|
standard library functions. A lot of Unity is configurable and we have worked
|
||||||
|
hard to make it not TOO ugly in the process.
|
||||||
|
|
||||||
|
Similarly, our tools that parse C do their best. They aren't full C parsers
|
||||||
|
(yet) and, even if they were, they would still have to accept non-standard
|
||||||
|
additions like gcc extensions or specifying `@0x1000` to force a variable to
|
||||||
|
compile to a particular location. It's just what we do, because we like
|
||||||
|
everything to Just Work™.
|
||||||
|
|
||||||
|
Speaking of having things Just Work™, that's our second philosophy. By that, we
|
||||||
|
mean that we do our best to have EVERY configuration option have a logical
|
||||||
|
default. We believe that if you're working with a simple compiler and target,
|
||||||
|
you shouldn't need to configure very much... we try to make the tools guess as
|
||||||
|
much as they can, but give the user the power to override it when it's wrong.
|
||||||
|
|
||||||
|
|
||||||
|
## Naming Things
|
||||||
|
|
||||||
|
Let's talk about naming things. Programming is all about naming things. We name
|
||||||
|
files, functions, variables, and so much more. While we're not always going to
|
||||||
|
find the best name for something, we actually put a bit of effort into
|
||||||
|
finding *What Something WANTS to be Called*™.
|
||||||
|
|
||||||
|
When naming things, we follow this hierarchy, the first being the
|
||||||
|
most important to us (but we do all four when possible):
|
||||||
|
1. Readable
|
||||||
|
2. Descriptive
|
||||||
|
3. Consistent
|
||||||
|
4. Memorable
|
||||||
|
|
||||||
|
|
||||||
|
#### Readable
|
||||||
|
|
||||||
|
We want to read our code. This means we like names and flow that are more
|
||||||
|
naturally read. We try to avoid double negatives. We try to avoid cryptic
|
||||||
|
abbreviations (sticking to ones we feel are common).
|
||||||
|
|
||||||
|
|
||||||
|
#### Descriptive
|
||||||
|
|
||||||
|
We like descriptive names for things, especially functions and variables.
|
||||||
|
Finding the right name for something is an important endeavor. You might notice
|
||||||
|
from poking around our code that this often results in names that are a little
|
||||||
|
longer than the average. Guilty. We're okay with a bit more typing if it
|
||||||
|
means our code is easier to understand.
|
||||||
|
|
||||||
|
There are two exceptions to this rule that we also stick to as religiously as
|
||||||
|
possible:
|
||||||
|
|
||||||
|
First, while we realize hungarian notation (and similar systems for encoding
|
||||||
|
type information into variable names) is providing a more descriptive name, we
|
||||||
|
feel that (for the average developer) it takes away from readability and is to be avoided.
|
||||||
|
|
||||||
|
Second, loop counters and other local throw-away variables often have a purpose
|
||||||
|
which is obvious. There's no need, therefore, to get carried away with complex
|
||||||
|
naming. We find i, j, and k are better loop counters than loopCounterVar or
|
||||||
|
whatnot. We only break this rule when we see that more description could improve
|
||||||
|
understanding of an algorithm.
|
||||||
|
|
||||||
|
|
||||||
|
#### Consistent
|
||||||
|
|
||||||
|
We like consistency, but we're not really obsessed with it. We try to name our
|
||||||
|
configuration macros in a consistent fashion... you'll notice a repeated use of
|
||||||
|
UNITY_EXCLUDE_BLAH or UNITY_USES_BLAH macros. This helps users avoid having to
|
||||||
|
remember each macro's details.
|
||||||
|
|
||||||
|
|
||||||
|
#### Memorable
|
||||||
|
|
||||||
|
Where ever it doesn't violate the above principles, we try to apply memorable
|
||||||
|
names. Sometimes this means using something that is simply descriptive, but
|
||||||
|
often we strive for descriptive AND unique... we like quirky names that stand
|
||||||
|
out in our memory and are easier to search for. Take a look through the file
|
||||||
|
names in Ceedling and you'll get a good idea of what we are talking about here.
|
||||||
|
Why use preprocess when you can use preprocessinator? Or what better describes a
|
||||||
|
module in charge of invoking tasks during releases than release_invoker? Don't
|
||||||
|
get carried away. The names are still descriptive and fulfill the above
|
||||||
|
requirements, but they don't feel stale.
|
||||||
|
|
||||||
|
|
||||||
|
## C and C++ Details
|
||||||
|
|
||||||
|
We don't really want to add to the style battles out there. Tabs or spaces?
|
||||||
|
How many spaces? Where do the braces go? These are age-old questions that will
|
||||||
|
never be answered... or at least not answered in a way that will make everyone
|
||||||
|
happy.
|
||||||
|
|
||||||
|
We've decided on our own style preferences. If you'd like to contribute to these
|
||||||
|
projects (and we hope that you do), then we ask if you do your best to follow
|
||||||
|
the same. It will only hurt a little. We promise.
|
||||||
|
|
||||||
|
|
||||||
|
#### Whitespace
|
||||||
|
|
||||||
|
Our C-style is to use spaces and to use 4 of them per indent level. It's a nice
|
||||||
|
power-of-2 number that looks decent on a wide-screen. We have no more reason
|
||||||
|
than that. We break that rule when we have lines that wrap (macros or function
|
||||||
|
arguments or whatnot). When that happens, we like to indent further to line
|
||||||
|
things up in nice tidy columns.
|
||||||
|
|
||||||
|
```C
|
||||||
|
if (stuff_happened)
|
||||||
|
{
|
||||||
|
do_something();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Case
|
||||||
|
|
||||||
|
- Files - all lower case with underscores.
|
||||||
|
- Variables - all lower case with underscores
|
||||||
|
- Macros - all caps with underscores.
|
||||||
|
- Typedefs - all caps with underscores. (also ends with _T).
|
||||||
|
- Functions - camel cased. Usually named ModuleName_FuncName
|
||||||
|
- Constants and Globals - camel cased.
|
||||||
|
|
||||||
|
|
||||||
|
#### Braces
|
||||||
|
|
||||||
|
The left brace is on the next line after the declaration. The right brace is
|
||||||
|
directly below that. Everything in between in indented one level. If you're
|
||||||
|
catching an error and you have a one-line, go ahead and to it on the same line.
|
||||||
|
|
||||||
|
```C
|
||||||
|
while (blah)
|
||||||
|
{
|
||||||
|
//Like so. Even if only one line, we use braces.
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Comments
|
||||||
|
|
||||||
|
Do you know what we hate? Old-school C block comments. BUT, we're using them
|
||||||
|
anyway. As we mentioned, our goal is to support every compiler we can,
|
||||||
|
especially embedded compilers. There are STILL C compilers out there that only
|
||||||
|
support old-school block comments. So that is what we're using. We apologize. We
|
||||||
|
think they are ugly too.
|
||||||
|
|
||||||
|
|
||||||
|
## Ruby Details
|
||||||
|
|
||||||
|
Is there really such thing as a Ruby coding standard? Ruby is such a free form
|
||||||
|
language, it seems almost sacrilegious to suggest that people should comply to
|
||||||
|
one method! We'll keep it really brief!
|
||||||
|
|
||||||
|
|
||||||
|
#### Whitespace
|
||||||
|
|
||||||
|
Our Ruby style is to use spaces and to use 2 of them per indent level. It's a
|
||||||
|
nice power-of-2 number that really grooves with Ruby's compact style. We have no
|
||||||
|
more reason than that. We break that rule when we have lines that wrap. When
|
||||||
|
that happens, we like to indent further to line things up in nice tidy columns.
|
||||||
|
|
||||||
|
|
||||||
|
#### Case
|
||||||
|
|
||||||
|
- Files - all lower case with underscores.
|
||||||
|
- Variables - all lower case with underscores
|
||||||
|
- Classes, Modules, etc - Camel cased.
|
||||||
|
- Functions - all lower case with underscores
|
||||||
|
- Constants - all upper case with underscores
|
||||||
|
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
Egad. Really? We use mark down and we like pdf files because they can be made to
|
||||||
|
look nice while still being portable. Good enough?
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
Binary file not shown.
850
docs/UnityAssertionsReference.md
Normal file
850
docs/UnityAssertionsReference.md
Normal file
@@ -0,0 +1,850 @@
|
|||||||
|
# Unity Assertions Reference
|
||||||
|
|
||||||
|
## Background and Overview
|
||||||
|
|
||||||
|
### Super Condensed Version
|
||||||
|
|
||||||
|
- An assertion establishes truth (i.e. boolean True) for a single condition.
|
||||||
|
Upon boolean False, an assertion stops execution and reports the failure.
|
||||||
|
- Unity is mainly a rich collection of assertions and the support to gather up
|
||||||
|
and easily execute those assertions.
|
||||||
|
- The structure of Unity allows you to easily separate test assertions from
|
||||||
|
source code in, well, test code.
|
||||||
|
- Unity's assertions:
|
||||||
|
- Come in many, many flavors to handle different C types and assertion cases.
|
||||||
|
- Use context to provide detailed and helpful failure messages.
|
||||||
|
- Document types, expected values, and basic behavior in your source code for
|
||||||
|
free.
|
||||||
|
|
||||||
|
|
||||||
|
### Unity Is Several Things But Mainly It's Assertions
|
||||||
|
|
||||||
|
One way to think of Unity is simply as a rich collection of assertions you can
|
||||||
|
use to establish whether your source code behaves the way you think it does.
|
||||||
|
Unity provides a framework to easily organize and execute those assertions in
|
||||||
|
test code separate from your source code.
|
||||||
|
|
||||||
|
|
||||||
|
### What's an Assertion?
|
||||||
|
|
||||||
|
At their core, assertions are an establishment of truth - boolean truth. Was this
|
||||||
|
thing equal to that thing? Does that code doohickey have such-and-such property
|
||||||
|
or not? You get the idea. Assertions are executable code (to appreciate the big
|
||||||
|
picture on this read up on the difference between
|
||||||
|
[link:Dynamic Verification and Static Analysis]). A failing assertion stops
|
||||||
|
execution and reports an error through some appropriate I/O channel (e.g.
|
||||||
|
stdout, GUI, file, blinky light).
|
||||||
|
|
||||||
|
Fundamentally, for dynamic verification all you need is a single assertion
|
||||||
|
mechanism. In fact, that's what the [assert() macro in C's standard library](http://en.wikipedia.org/en/wiki/Assert.h)
|
||||||
|
is for. So why not just use it? Well, we can do far better in the reporting
|
||||||
|
department. C's `assert()` is pretty dumb as-is and is particularly poor for
|
||||||
|
handling common data types like arrays, structs, etc. And, without some other
|
||||||
|
support, it's far too tempting to litter source code with C's `assert()`'s. It's
|
||||||
|
generally much cleaner, manageable, and more useful to separate test and source
|
||||||
|
code in the way Unity facilitates.
|
||||||
|
|
||||||
|
|
||||||
|
### Unity's Assertions: Helpful Messages _and_ Free Source Code Documentation
|
||||||
|
|
||||||
|
Asserting a simple truth condition is valuable, but using the context of the
|
||||||
|
assertion is even more valuable. For instance, if you know you're comparing bit
|
||||||
|
flags and not just integers, then why not use that context to give explicit,
|
||||||
|
readable, bit-level feedback when an assertion fails?
|
||||||
|
|
||||||
|
That's what Unity's collection of assertions do - capture context to give you
|
||||||
|
helpful, meaningful assertion failure messages. In fact, the assertions
|
||||||
|
themselves also serve as executable documentation about types and values in your
|
||||||
|
source code. So long as your tests remain current with your source and all those
|
||||||
|
tests pass, you have a detailed, up-to-date view of the intent and mechanisms in
|
||||||
|
your source code. And due to a wondrous mystery, well-tested code usually tends
|
||||||
|
to be well designed code.
|
||||||
|
|
||||||
|
|
||||||
|
## Assertion Conventions and Configurations
|
||||||
|
|
||||||
|
### Naming and Parameter Conventions
|
||||||
|
|
||||||
|
The convention of assertion parameters generally follows this order:
|
||||||
|
|
||||||
|
TEST_ASSERT_X( {modifiers}, {expected}, actual, {size/count} )
|
||||||
|
|
||||||
|
The very simplest assertion possible uses only a single "actual" parameter (e.g.
|
||||||
|
a simple null check).
|
||||||
|
|
||||||
|
"Actual" is the value being tested and unlike the other parameters in an
|
||||||
|
assertion construction is the only parameter present in all assertion variants.
|
||||||
|
"Modifiers" are masks, ranges, bit flag specifiers, floating point deltas.
|
||||||
|
"Expected" is your expected value (duh) to compare to an "actual" value; it's
|
||||||
|
marked as an optional parameter because some assertions only need a single
|
||||||
|
"actual" parameter (e.g. null check).
|
||||||
|
"Size/count" refers to string lengths, number of array elements, etc.
|
||||||
|
|
||||||
|
Many of Unity's assertions are clear duplications in that the same data type
|
||||||
|
is handled by several assertions. The differences among these are in how failure
|
||||||
|
messages are presented. For instance, a `_HEX` variant of an assertion prints
|
||||||
|
the expected and actual values of that assertion formatted as hexadecimal.
|
||||||
|
|
||||||
|
|
||||||
|
#### TEST_ASSERT_X_MESSAGE Variants
|
||||||
|
|
||||||
|
_All_ assertions are complemented with a variant that includes a simple string
|
||||||
|
message as a final parameter. The string you specify is appended to an assertion
|
||||||
|
failure message in Unity output.
|
||||||
|
|
||||||
|
For brevity, the assertion variants with a message parameter are not listed
|
||||||
|
below. Just tack on `_MESSAGE` as the final component to any assertion name in
|
||||||
|
the reference list below and add a string as the final parameter.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
|
||||||
|
TEST_ASSERT_X( {modifiers}, {expected}, actual, {size/count} )
|
||||||
|
|
||||||
|
becomes messageified like thus...
|
||||||
|
|
||||||
|
TEST_ASSERT_X_MESSAGE( {modifiers}, {expected}, actual, {size/count}, message )
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- The `_MESSAGE` variants intentionally do not support `printf` style formatting
|
||||||
|
since many embedded projects don't support or avoid `printf` for various reasons.
|
||||||
|
It is possible to use `sprintf` before the assertion to assemble a complex fail
|
||||||
|
message, if necessary.
|
||||||
|
- If you want to output a counter value within an assertion fail message (e.g. from
|
||||||
|
a loop) , building up an array of results and then using one of the `_ARRAY`
|
||||||
|
assertions (see below) might be a handy alternative to `sprintf`.
|
||||||
|
|
||||||
|
|
||||||
|
#### TEST_ASSERT_X_ARRAY Variants
|
||||||
|
|
||||||
|
Unity provides a collection of assertions for arrays containing a variety of
|
||||||
|
types. These are documented in the Array section below. These are almost on par
|
||||||
|
with the `_MESSAGE`variants of Unity's Asserts in that for pretty much any Unity
|
||||||
|
type assertion you can tack on `_ARRAY` and run assertions on an entire block of
|
||||||
|
memory.
|
||||||
|
|
||||||
|
TEST_ASSERT_EQUAL_TYPEX_ARRAY( expected, actual, {size/count} )
|
||||||
|
|
||||||
|
"Expected" is an array itself.
|
||||||
|
"Size/count" is one or two parameters necessary to establish the number of array
|
||||||
|
elements and perhaps the length of elements within the array.
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- The `_MESSAGE` variant convention still applies here to array assertions. The
|
||||||
|
`_MESSAGE` variants of the `_ARRAY` assertions have names ending with
|
||||||
|
`_ARRAY_MESSAGE`.
|
||||||
|
- Assertions for handling arrays of floating point values are grouped with float
|
||||||
|
and double assertions (see immediately following section).
|
||||||
|
|
||||||
|
|
||||||
|
### TEST_ASSERT_EACH_EQUAL_X Variants
|
||||||
|
|
||||||
|
Unity provides a collection of assertions for arrays containing a variety of
|
||||||
|
types which can be compared to a single value as well. These are documented in
|
||||||
|
the Each Equal section below. these are almost on par with the `_MESSAGE`
|
||||||
|
variants of Unity's Asserts in that for pretty much any Unity type assertion you
|
||||||
|
can inject _EACH_EQUAL and run assertions on an entire block of memory.
|
||||||
|
|
||||||
|
TEST_ASSERT_EACH_EQUAL_TYPEX( expected, actual, {size/count} )
|
||||||
|
|
||||||
|
"Expected" is a single value to compare to.
|
||||||
|
"Actual" is an array where each element will be compared to the expected value.
|
||||||
|
"Size/count" is one of two parameters necessary to establish the number of array
|
||||||
|
elements and perhaps the length of elements within the array.
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- The `_MESSAGE` variant convention still applies here to Each Equal assertions.
|
||||||
|
- Assertions for handling Each Equal of floating point values are grouped with
|
||||||
|
float and double assertions (see immediately following section).
|
||||||
|
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
#### Floating Point Support Is Optional
|
||||||
|
|
||||||
|
Support for floating point types is configurable. That is, by defining the
|
||||||
|
appropriate preprocessor symbols, floats and doubles can be individually enabled
|
||||||
|
or disabled in Unity code. This is useful for embedded targets with no floating
|
||||||
|
point math support (i.e. Unity compiles free of errors for fixed point only
|
||||||
|
platforms). See Unity documentation for specifics.
|
||||||
|
|
||||||
|
|
||||||
|
#### Maximum Data Type Width Is Configurable
|
||||||
|
|
||||||
|
Not all targets support 64 bit wide types or even 32 bit wide types. Define the
|
||||||
|
appropriate preprocessor symbols and Unity will omit all operations from
|
||||||
|
compilation that exceed the maximum width of your target. See Unity
|
||||||
|
documentation for specifics.
|
||||||
|
|
||||||
|
|
||||||
|
## The Assertions in All Their Blessed Glory
|
||||||
|
|
||||||
|
### Basic Fail, Pass and Ignore
|
||||||
|
|
||||||
|
##### `TEST_FAIL()`
|
||||||
|
|
||||||
|
##### `TEST_FAIL_MESSAGE("message")`
|
||||||
|
|
||||||
|
This fella is most often used in special conditions where your test code is
|
||||||
|
performing logic beyond a simple assertion. That is, in practice, `TEST_FAIL()`
|
||||||
|
will always be found inside a conditional code block.
|
||||||
|
|
||||||
|
_Examples:_
|
||||||
|
- Executing a state machine multiple times that increments a counter your test
|
||||||
|
code then verifies as a final step.
|
||||||
|
- Triggering an exception and verifying it (as in Try / Catch / Throw - see the
|
||||||
|
[CException](https://github.com/ThrowTheSwitch/CException) project).
|
||||||
|
|
||||||
|
##### `TEST_PASS()`
|
||||||
|
|
||||||
|
##### `TEST_PASS_MESSAGE("message")`
|
||||||
|
|
||||||
|
This will abort the remainder of the test, but count the test as a pass. Under
|
||||||
|
normal circumstances, it is not necessary to include this macro in your tests...
|
||||||
|
a lack of failure will automatically be counted as a `PASS`. It is occasionally
|
||||||
|
useful for tests with `#ifdef`s and such.
|
||||||
|
|
||||||
|
##### `TEST_IGNORE()`
|
||||||
|
|
||||||
|
##### `TEST_IGNORE_MESSAGE("message")`
|
||||||
|
|
||||||
|
Marks a test case (i.e. function meant to contain test assertions) as ignored.
|
||||||
|
Usually this is employed as a breadcrumb to come back and implement a test case.
|
||||||
|
An ignored test case has effects if other assertions are in the enclosing test
|
||||||
|
case (see Unity documentation for more).
|
||||||
|
|
||||||
|
##### `TEST_MESSAGE(message)`
|
||||||
|
|
||||||
|
This can be useful for outputting `INFO` messages into the Unity output stream
|
||||||
|
without actually ending the test. Like pass and fail messages, it will be output
|
||||||
|
with the filename and line number.
|
||||||
|
|
||||||
|
### Boolean
|
||||||
|
|
||||||
|
##### `TEST_ASSERT (condition)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_TRUE (condition)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FALSE (condition)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UNLESS (condition)`
|
||||||
|
|
||||||
|
A simple wording variation on `TEST_ASSERT_FALSE`.The semantics of
|
||||||
|
`TEST_ASSERT_UNLESS` aid readability in certain test constructions or
|
||||||
|
conditional statements.
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_NULL (pointer)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_NOT_NULL (pointer)`
|
||||||
|
|
||||||
|
|
||||||
|
### Signed and Unsigned Integers (of all sizes)
|
||||||
|
|
||||||
|
Large integer sizes can be disabled for build targets that do not support them.
|
||||||
|
For example, if your target only supports up to 16 bit types, by defining the
|
||||||
|
appropriate symbols Unity can be configured to omit 32 and 64 bit operations
|
||||||
|
that would break compilation (see Unity documentation for more). Refer to
|
||||||
|
Advanced Asserting later in this document for advice on dealing with other word
|
||||||
|
sizes.
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT8 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT16 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT32 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT64 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT8 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT16 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT32 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT64 (expected, actual)`
|
||||||
|
|
||||||
|
|
||||||
|
### Unsigned Integers (of all sizes) in Hexadecimal
|
||||||
|
|
||||||
|
All `_HEX` assertions are identical in function to unsigned integer assertions
|
||||||
|
but produce failure messages with the `expected` and `actual` values formatted
|
||||||
|
in hexadecimal. Unity output is big endian.
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX8 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX16 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX32 (expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX64 (expected, actual)`
|
||||||
|
|
||||||
|
|
||||||
|
### Characters
|
||||||
|
|
||||||
|
While you can use the 8-bit integer assertions to compare `char`, another option is
|
||||||
|
to use this specialized assertion which will show printable characters as printables,
|
||||||
|
otherwise showing the HEX escape code for the characters.
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_CHAR (expected, actual)`
|
||||||
|
|
||||||
|
|
||||||
|
### Masked and Bit-level Assertions
|
||||||
|
|
||||||
|
Masked and bit-level assertions produce output formatted in hexadecimal. Unity
|
||||||
|
output is big endian.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_BITS (mask, expected, actual)`
|
||||||
|
|
||||||
|
Only compares the masked (i.e. high) bits of `expected` and `actual` parameters.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_BITS_HIGH (mask, actual)`
|
||||||
|
|
||||||
|
Asserts the masked bits of the `actual` parameter are high.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_BITS_LOW (mask, actual)`
|
||||||
|
|
||||||
|
Asserts the masked bits of the `actual` parameter are low.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_BIT_HIGH (bit, actual)`
|
||||||
|
|
||||||
|
Asserts the specified bit of the `actual` parameter is high.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_BIT_LOW (bit, actual)`
|
||||||
|
|
||||||
|
Asserts the specified bit of the `actual` parameter is low.
|
||||||
|
|
||||||
|
### Integer Less Than / Greater Than
|
||||||
|
|
||||||
|
These assertions verify that the `actual` parameter is less than or greater
|
||||||
|
than `threshold` (exclusive). For example, if the threshold value is 0 for the
|
||||||
|
greater than assertion will fail if it is 0 or less.
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_INT (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_INT8 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_INT16 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_INT32 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_UINT (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_UINT8 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_UINT16 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_UINT32 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_HEX8 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_HEX16 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_HEX32 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_GREATER_THAN_CHAR (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_INT (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_INT8 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_INT16 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_INT32 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_UINT (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_UINT8 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_UINT16 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_UINT32 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_HEX8 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_HEX16 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_HEX32 (threshold, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_LESS_THAN_CHAR (threshold, actual)`
|
||||||
|
|
||||||
|
|
||||||
|
### Integer Ranges (of all sizes)
|
||||||
|
|
||||||
|
These assertions verify that the `expected` parameter is within +/- `delta`
|
||||||
|
(inclusive) of the `actual` parameter. For example, if the expected value is 10
|
||||||
|
and the delta is 3 then the assertion will fail for any value outside the range
|
||||||
|
of 7 - 13.
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT8_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT16_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT32_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT64_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT8_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT16_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT32_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT64_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX8_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX16_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX32_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX64_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_CHAR_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
### Structs and Strings
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_PTR (expected, actual)`
|
||||||
|
|
||||||
|
Asserts that the pointers point to the same memory location.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_STRING (expected, actual)`
|
||||||
|
|
||||||
|
Asserts that the null terminated (`'\0'`)strings are identical. If strings are
|
||||||
|
of different lengths or any portion of the strings before their terminators
|
||||||
|
differ, the assertion fails. Two NULL strings (i.e. zero length) are considered
|
||||||
|
equivalent.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_MEMORY (expected, actual, len)`
|
||||||
|
|
||||||
|
Asserts that the contents of the memory specified by the `expected` and `actual`
|
||||||
|
pointers is identical. The size of the memory blocks in bytes is specified by
|
||||||
|
the `len` parameter.
|
||||||
|
|
||||||
|
|
||||||
|
### Arrays
|
||||||
|
|
||||||
|
`expected` and `actual` parameters are both arrays. `num_elements` specifies the
|
||||||
|
number of elements in the arrays to compare.
|
||||||
|
|
||||||
|
`_HEX` assertions produce failure messages with expected and actual array
|
||||||
|
contents formatted in hexadecimal.
|
||||||
|
|
||||||
|
For array of strings comparison behavior, see comments for
|
||||||
|
`TEST_ASSERT_EQUAL_STRING` in the preceding section.
|
||||||
|
|
||||||
|
Assertions fail upon the first element in the compared arrays found not to
|
||||||
|
match. Failure messages specify the array index of the failed comparison.
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT8_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT16_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT32_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_INT64_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT8_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT16_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT32_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_UINT64_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX8_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX16_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX32_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_HEX64_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_CHAR_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_PTR_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_STRING_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_MEMORY_ARRAY (expected, actual, len, num_elements)`
|
||||||
|
|
||||||
|
`len` is the memory in bytes to be compared at each array element.
|
||||||
|
|
||||||
|
### Integer Array Ranges (of all sizes)
|
||||||
|
|
||||||
|
These assertions verify that the `expected` array parameter is within +/- `delta`
|
||||||
|
(inclusive) of the `actual` array parameter. For example, if the expected value is
|
||||||
|
\[10, 12\] and the delta is 3 then the assertion will fail for any value
|
||||||
|
outside the range of \[7 - 13, 9 - 15\].
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT8_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT16_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT32_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_INT64_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT8_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT16_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT32_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_UINT64_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX8_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX16_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX32_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_HEX64_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_CHAR_ARRAY_WITHIN (delta, expected, actual, num_elements)`
|
||||||
|
|
||||||
|
### Each Equal (Arrays to Single Value)
|
||||||
|
|
||||||
|
`expected` are single values and `actual` are arrays. `num_elements` specifies
|
||||||
|
the number of elements in the arrays to compare.
|
||||||
|
|
||||||
|
`_HEX` assertions produce failure messages with expected and actual array
|
||||||
|
contents formatted in hexadecimal.
|
||||||
|
|
||||||
|
Assertions fail upon the first element in the compared arrays found not to
|
||||||
|
match. Failure messages specify the array index of the failed comparison.
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_INT (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_INT8 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_INT16 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_INT32 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_INT64 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_UINT (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_UINT8 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_UINT16 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_UINT32 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_UINT64 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_HEX (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_HEX8 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_HEX16 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_HEX32 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_HEX64 (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_CHAR (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_PTR (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_STRING (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
#### `TEST_ASSERT_EACH_EQUAL_MEMORY (expected, actual, len, num_elements)`
|
||||||
|
|
||||||
|
`len` is the memory in bytes to be compared at each array element.
|
||||||
|
|
||||||
|
|
||||||
|
### Floating Point (If enabled)
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
Asserts that the `actual` value is within +/- `delta` of the `expected` value.
|
||||||
|
The nature of floating point representation is such that exact evaluations of
|
||||||
|
equality are not guaranteed.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_FLOAT (expected, actual)`
|
||||||
|
|
||||||
|
Asserts that the ?actual?value is "close enough to be considered equal" to the
|
||||||
|
`expected` value. If you are curious about the details, refer to the Advanced
|
||||||
|
Asserting section for more details on this. Omitting a user-specified delta in a
|
||||||
|
floating point assertion is both a shorthand convenience and a requirement of
|
||||||
|
code generation conventions for CMock.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_FLOAT_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
See Array assertion section for details. Note that individual array element
|
||||||
|
float comparisons are executed using T?EST_ASSERT_EQUAL_FLOAT?.That is, user
|
||||||
|
specified delta comparison values requires a custom-implemented floating point
|
||||||
|
array assertion.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_IS_INF (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is equivalent to positive infinity floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_IS_NEG_INF (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is equivalent to negative infinity floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_IS_NAN (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a Not A Number floating point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_IS_DETERMINATE (actual)`
|
||||||
|
|
||||||
|
Asserts that ?actual?parameter is a floating point representation usable for
|
||||||
|
mathematical operations. That is, the `actual` parameter is neither positive
|
||||||
|
infinity nor negative infinity nor Not A Number floating point representations.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_IS_NOT_INF (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a value other than positive infinity floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_IS_NOT_NEG_INF (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a value other than negative infinity floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_IS_NOT_NAN (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a value other than Not A Number floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_FLOAT_IS_NOT_DETERMINATE (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is not usable for mathematical operations. That
|
||||||
|
is, the `actual` parameter is either positive infinity or negative infinity or
|
||||||
|
Not A Number floating point representations.
|
||||||
|
|
||||||
|
|
||||||
|
### Double (If enabled)
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_WITHIN (delta, expected, actual)`
|
||||||
|
|
||||||
|
Asserts that the `actual` value is within +/- `delta` of the `expected` value.
|
||||||
|
The nature of floating point representation is such that exact evaluations of
|
||||||
|
equality are not guaranteed.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_DOUBLE (expected, actual)`
|
||||||
|
|
||||||
|
Asserts that the `actual` value is "close enough to be considered equal" to the
|
||||||
|
`expected` value. If you are curious about the details, refer to the Advanced
|
||||||
|
Asserting section for more details. Omitting a user-specified delta in a
|
||||||
|
floating point assertion is both a shorthand convenience and a requirement of
|
||||||
|
code generation conventions for CMock.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_EQUAL_DOUBLE_ARRAY (expected, actual, num_elements)`
|
||||||
|
|
||||||
|
See Array assertion section for details. Note that individual array element
|
||||||
|
double comparisons are executed using `TEST_ASSERT_EQUAL_DOUBLE`.That is, user
|
||||||
|
specified delta comparison values requires a custom implemented double array
|
||||||
|
assertion.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_IS_INF (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is equivalent to positive infinity floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_IS_NEG_INF (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is equivalent to negative infinity floating point
|
||||||
|
representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_IS_NAN (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a Not A Number floating point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_IS_DETERMINATE (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a floating point representation usable for
|
||||||
|
mathematical operations. That is, the ?actual?parameter is neither positive
|
||||||
|
infinity nor negative infinity nor Not A Number floating point representations.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_IS_NOT_INF (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a value other than positive infinity floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_IS_NOT_NEG_INF (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a value other than negative infinity floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_IS_NOT_NAN (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is a value other than Not A Number floating
|
||||||
|
point representation.
|
||||||
|
|
||||||
|
|
||||||
|
##### `TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE (actual)`
|
||||||
|
|
||||||
|
Asserts that `actual` parameter is not usable for mathematical operations. That
|
||||||
|
is, the `actual` parameter is either positive infinity or negative infinity or
|
||||||
|
Not A Number floating point representations.
|
||||||
|
|
||||||
|
|
||||||
|
## Advanced Asserting: Details On Tricky Assertions
|
||||||
|
|
||||||
|
This section helps you understand how to deal with some of the trickier
|
||||||
|
assertion situations you may run into. It will give you a glimpse into some of
|
||||||
|
the under-the-hood details of Unity's assertion mechanisms. If you're one of
|
||||||
|
those people who likes to know what is going on in the background, read on. If
|
||||||
|
not, feel free to ignore the rest of this document until you need it.
|
||||||
|
|
||||||
|
|
||||||
|
### How do the EQUAL assertions work for FLOAT and DOUBLE?
|
||||||
|
|
||||||
|
As you may know, directly checking for equality between a pair of floats or a
|
||||||
|
pair of doubles is sloppy at best and an outright no-no at worst. Floating point
|
||||||
|
values can often be represented in multiple ways, particularly after a series of
|
||||||
|
operations on a value. Initializing a variable to the value of 2.0 is likely to
|
||||||
|
result in a floating point representation of 2 x 20,but a series of
|
||||||
|
mathematical operations might result in a representation of 8 x 2-2
|
||||||
|
that also evaluates to a value of 2. At some point repeated operations cause
|
||||||
|
equality checks to fail.
|
||||||
|
|
||||||
|
So Unity doesn't do direct floating point comparisons for equality. Instead, it
|
||||||
|
checks if two floating point values are "really close." If you leave Unity
|
||||||
|
running with defaults, "really close" means "within a significant bit or two."
|
||||||
|
Under the hood, `TEST_ASSERT_EQUAL_FLOAT` is really `TEST_ASSERT_FLOAT_WITHIN`
|
||||||
|
with the `delta` parameter calculated on the fly. For single precision, delta is
|
||||||
|
the expected value multiplied by 0.00001, producing a very small proportional
|
||||||
|
range around the expected value.
|
||||||
|
|
||||||
|
If you are expecting a value of 20,000.0 the delta is calculated to be 0.2. So
|
||||||
|
any value between 19,999.8 and 20,000.2 will satisfy the equality check. This
|
||||||
|
works out to be roughly a single bit of range for a single-precision number, and
|
||||||
|
that's just about as tight a tolerance as you can reasonably get from a floating
|
||||||
|
point value.
|
||||||
|
|
||||||
|
So what happens when it's zero? Zero - even more than other floating point
|
||||||
|
values - can be represented many different ways. It doesn't matter if you have
|
||||||
|
0 x 20 or 0 x 263.It's still zero, right? Luckily, if you
|
||||||
|
subtract these values from each other, they will always produce a difference of
|
||||||
|
zero, which will still fall between 0 plus or minus a delta of 0. So it still
|
||||||
|
works!
|
||||||
|
|
||||||
|
Double precision floating point numbers use a much smaller multiplier, again
|
||||||
|
approximating a single bit of error.
|
||||||
|
|
||||||
|
If you don't like these ranges and you want to make your floating point equality
|
||||||
|
assertions less strict, you can change these multipliers to whatever you like by
|
||||||
|
defining UNITY_FLOAT_PRECISION and UNITY_DOUBLE_PRECISION. See Unity
|
||||||
|
documentation for more.
|
||||||
|
|
||||||
|
|
||||||
|
### How do we deal with targets with non-standard int sizes?
|
||||||
|
|
||||||
|
It's "fun" that C is a standard where something as fundamental as an integer
|
||||||
|
varies by target. According to the C standard, an `int` is to be the target's
|
||||||
|
natural register size, and it should be at least 16-bits and a multiple of a
|
||||||
|
byte. It also guarantees an order of sizes:
|
||||||
|
|
||||||
|
```C
|
||||||
|
char <= short <= int <= long <= long long
|
||||||
|
```
|
||||||
|
|
||||||
|
Most often, `int` is 32-bits. In many cases in the embedded world, `int` is
|
||||||
|
16-bits. There are rare microcontrollers out there that have 24-bit integers,
|
||||||
|
and this remains perfectly standard C.
|
||||||
|
|
||||||
|
To make things even more interesting, there are compilers and targets out there
|
||||||
|
that have a hard choice to make. What if their natural register size is 10-bits
|
||||||
|
or 12-bits? Clearly they can't fulfill _both_ the requirement to be at least
|
||||||
|
16-bits AND the requirement to match the natural register size. In these
|
||||||
|
situations, they often choose the natural register size, leaving us with
|
||||||
|
something like this:
|
||||||
|
|
||||||
|
```C
|
||||||
|
char (8 bit) <= short (12 bit) <= int (12 bit) <= long (16 bit)
|
||||||
|
```
|
||||||
|
|
||||||
|
Um... yikes. It's obviously breaking a rule or two... but they had to break SOME
|
||||||
|
rules, so they made a choice.
|
||||||
|
|
||||||
|
When the C99 standard rolled around, it introduced alternate standard-size types.
|
||||||
|
It also introduced macros for pulling in MIN/MAX values for your integer types.
|
||||||
|
It's glorious! Unfortunately, many embedded compilers can't be relied upon to
|
||||||
|
use the C99 types (Sometimes because they have weird register sizes as described
|
||||||
|
above. Sometimes because they don't feel like it?).
|
||||||
|
|
||||||
|
A goal of Unity from the beginning was to support every combination of
|
||||||
|
microcontroller or microprocessor and C compiler. Over time, we've gotten really
|
||||||
|
close to this. There are a few tricks that you should be aware of, though, if
|
||||||
|
you're going to do this effectively on some of these more idiosyncratic targets.
|
||||||
|
|
||||||
|
First, when setting up Unity for a new target, you're going to want to pay
|
||||||
|
special attention to the macros for automatically detecting types
|
||||||
|
(where available) or manually configuring them yourself. You can get information
|
||||||
|
on both of these in Unity's documentation.
|
||||||
|
|
||||||
|
What about the times where you suddenly need to deal with something odd, like a
|
||||||
|
24-bit `int`? The simplest solution is to use the next size up. If you have a
|
||||||
|
24-bit `int`, configure Unity to use 32-bit integers. If you have a 12-bit
|
||||||
|
`int`, configure Unity to use 16 bits. There are two ways this is going to
|
||||||
|
affect you:
|
||||||
|
|
||||||
|
1. When Unity displays errors for you, it's going to pad the upper unused bits
|
||||||
|
with zeros.
|
||||||
|
2. You're going to have to be careful of assertions that perform signed
|
||||||
|
operations, particularly `TEST_ASSERT_INT_WITHIN`.Such assertions might wrap
|
||||||
|
your `int` in the wrong place, and you could experience false failures. You can
|
||||||
|
always back down to a simple `TEST_ASSERT` and do the operations yourself.
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
Binary file not shown.
541
docs/UnityConfigurationGuide.md
Normal file
541
docs/UnityConfigurationGuide.md
Normal file
@@ -0,0 +1,541 @@
|
|||||||
|
# Unity Configuration Guide
|
||||||
|
|
||||||
|
## C Standards, Compilers and Microcontrollers
|
||||||
|
|
||||||
|
The embedded software world contains its challenges. Compilers support different
|
||||||
|
revisions of the C Standard. They ignore requirements in places, sometimes to
|
||||||
|
make the language more usable in some special regard. Sometimes it's to simplify
|
||||||
|
their support. Sometimes it's due to specific quirks of the microcontroller they
|
||||||
|
are targeting. Simulators add another dimension to this menagerie.
|
||||||
|
|
||||||
|
Unity is designed to run on almost anything that is targeted by a C compiler. It
|
||||||
|
would be awesome if this could be done with zero configuration. While there are
|
||||||
|
some targets that come close to this dream, it is sadly not universal. It is
|
||||||
|
likely that you are going to need at least a couple of the configuration options
|
||||||
|
described in this document.
|
||||||
|
|
||||||
|
All of Unity's configuration options are `#defines`. Most of these are simple
|
||||||
|
definitions. A couple are macros with arguments. They live inside the
|
||||||
|
unity_internals.h header file. We don't necessarily recommend opening that file
|
||||||
|
unless you really need to. That file is proof that a cross-platform library is
|
||||||
|
challenging to build. From a more positive perspective, it is also proof that a
|
||||||
|
great deal of complexity can be centralized primarily to one place to
|
||||||
|
provide a more consistent and simple experience elsewhere.
|
||||||
|
|
||||||
|
|
||||||
|
### Using These Options
|
||||||
|
|
||||||
|
It doesn't matter if you're using a target-specific compiler and a simulator or
|
||||||
|
a native compiler. In either case, you've got a couple choices for configuring
|
||||||
|
these options:
|
||||||
|
|
||||||
|
1. Because these options are specified via C defines, you can pass most of these
|
||||||
|
options to your compiler through command line compiler flags. Even if you're
|
||||||
|
using an embedded target that forces you to use their overbearing IDE for all
|
||||||
|
configuration, there will be a place somewhere in your project to configure
|
||||||
|
defines for your compiler.
|
||||||
|
2. You can create a custom `unity_config.h` configuration file (present in your
|
||||||
|
toolchain's search paths). In this file, you will list definitions and macros
|
||||||
|
specific to your target. All you must do is define `UNITY_INCLUDE_CONFIG_H` and
|
||||||
|
Unity will rely on `unity_config.h` for any further definitions it may need.
|
||||||
|
|
||||||
|
|
||||||
|
## The Options
|
||||||
|
|
||||||
|
### Integer Types
|
||||||
|
|
||||||
|
If you've been a C developer for long, you probably already know that C's
|
||||||
|
concept of an integer varies from target to target. The C Standard has rules
|
||||||
|
about the `int` matching the register size of the target microprocessor. It has
|
||||||
|
rules about the `int` and how its size relates to other integer types. An `int`
|
||||||
|
on one target might be 16 bits while on another target it might be 64. There are
|
||||||
|
more specific types in compilers compliant with C99 or later, but that's
|
||||||
|
certainly not every compiler you are likely to encounter. Therefore, Unity has a
|
||||||
|
number of features for helping to adjust itself to match your required integer
|
||||||
|
sizes. It starts off by trying to do it automatically.
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_EXCLUDE_STDINT_H`
|
||||||
|
|
||||||
|
The first thing that Unity does to guess your types is check `stdint.h`.
|
||||||
|
This file includes defines like `UINT_MAX` that Unity can use to
|
||||||
|
learn a lot about your system. It's possible you don't want it to do this
|
||||||
|
(um. why not?) or (more likely) it's possible that your system doesn't
|
||||||
|
support `stdint.h`. If that's the case, you're going to want to define this.
|
||||||
|
That way, Unity will know to skip the inclusion of this file and you won't
|
||||||
|
be left with a compiler error.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_EXCLUDE_STDINT_H
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_EXCLUDE_LIMITS_H`
|
||||||
|
|
||||||
|
The second attempt to guess your types is to check `limits.h`. Some compilers
|
||||||
|
that don't support `stdint.h` could include `limits.h` instead. If you don't
|
||||||
|
want Unity to check this file either, define this to make it skip the inclusion.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_EXCLUDE_LIMITS_H
|
||||||
|
```
|
||||||
|
|
||||||
|
If you've disabled both of the automatic options above, you're going to have to
|
||||||
|
do the configuration yourself. Don't worry. Even this isn't too bad... there are
|
||||||
|
just a handful of defines that you are going to specify if you don't like the
|
||||||
|
defaults.
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_INT_WIDTH`
|
||||||
|
|
||||||
|
Define this to be the number of bits an `int` takes up on your system. The
|
||||||
|
default, if not autodetected, is 32 bits.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_INT_WIDTH 16
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_LONG_WIDTH`
|
||||||
|
|
||||||
|
Define this to be the number of bits a `long` takes up on your system. The
|
||||||
|
default, if not autodetected, is 32 bits. This is used to figure out what kind
|
||||||
|
of 64-bit support your system can handle. Does it need to specify a `long` or a
|
||||||
|
`long long` to get a 64-bit value. On 16-bit systems, this option is going to be
|
||||||
|
ignored.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_LONG_WIDTH 16
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_POINTER_WIDTH`
|
||||||
|
|
||||||
|
Define this to be the number of bits a pointer takes up on your system. The
|
||||||
|
default, if not autodetected, is 32-bits. If you're getting ugly compiler
|
||||||
|
warnings about casting from pointers, this is the one to look at.
|
||||||
|
|
||||||
|
_Hint:_ In order to support exotic processors (for example TI C55x with a pointer
|
||||||
|
width of 23-bit), choose the next power of two (in this case 32-bit).
|
||||||
|
|
||||||
|
_Supported values:_ 16, 32 and 64
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
// Choose on of these #defines to set your pointer width (if not autodetected)
|
||||||
|
//#define UNITY_POINTER_WIDTH 16
|
||||||
|
//#define UNITY_POINTER_WIDTH 32
|
||||||
|
#define UNITY_POINTER_WIDTH 64 // Set UNITY_POINTER_WIDTH to 64-bit
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_SUPPORT_64`
|
||||||
|
|
||||||
|
Unity will automatically include 64-bit support if it auto-detects it, or if
|
||||||
|
your `int`, `long`, or pointer widths are greater than 32-bits. Define this to
|
||||||
|
enable 64-bit support if none of the other options already did it for you. There
|
||||||
|
can be a significant size and speed impact to enabling 64-bit support on small
|
||||||
|
targets, so don't define it if you don't need it.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_SUPPORT_64
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Floating Point Types
|
||||||
|
|
||||||
|
In the embedded world, it's not uncommon for targets to have no support for
|
||||||
|
floating point operations at all or to have support that is limited to only
|
||||||
|
single precision. We are able to guess integer sizes on the fly because integers
|
||||||
|
are always available in at least one size. Floating point, on the other hand, is
|
||||||
|
sometimes not available at all. Trying to include `float.h` on these platforms
|
||||||
|
would result in an error. This leaves manual configuration as the only option.
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_INCLUDE_FLOAT`
|
||||||
|
|
||||||
|
##### `UNITY_EXCLUDE_FLOAT`
|
||||||
|
|
||||||
|
##### `UNITY_INCLUDE_DOUBLE`
|
||||||
|
|
||||||
|
##### `UNITY_EXCLUDE_DOUBLE`
|
||||||
|
|
||||||
|
By default, Unity guesses that you will want single precision floating point
|
||||||
|
support, but not double precision. It's easy to change either of these using the
|
||||||
|
include and exclude options here. You may include neither, either, or both, as
|
||||||
|
suits your needs. For features that are enabled, the following floating point
|
||||||
|
options also become available.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
//what manner of strange processor is this?
|
||||||
|
#define UNITY_EXCLUDE_FLOAT
|
||||||
|
#define UNITY_INCLUDE_DOUBLE
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_EXCLUDE_FLOAT_PRINT`
|
||||||
|
|
||||||
|
Unity aims for as small of a footprint as possible and avoids most standard
|
||||||
|
library calls (some embedded platforms don’t have a standard library!). Because
|
||||||
|
of this, its routines for printing integer values are minimalist and hand-coded.
|
||||||
|
Therefore, the display of floating point values during a failure are optional.
|
||||||
|
By default, Unity will print the actual results of floating point assertion
|
||||||
|
failure (e.g. ”Expected 4.56 Was 4.68”). To not include this extra support, you
|
||||||
|
can use this define to instead respond to a failed assertion with a message like
|
||||||
|
”Values Not Within Delta”. If you would like verbose failure messages for floating
|
||||||
|
point assertions, use these options to give more explicit failure messages.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_EXCLUDE_FLOAT_PRINT
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_FLOAT_TYPE`
|
||||||
|
|
||||||
|
If enabled, Unity assumes you want your `FLOAT` asserts to compare standard C
|
||||||
|
floats. If your compiler supports a specialty floating point type, you can
|
||||||
|
always override this behavior by using this definition.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_FLOAT_TYPE float16_t
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_DOUBLE_TYPE`
|
||||||
|
|
||||||
|
If enabled, Unity assumes you want your `DOUBLE` asserts to compare standard C
|
||||||
|
doubles. If you would like to change this, you can specify something else by
|
||||||
|
using this option. For example, defining `UNITY_DOUBLE_TYPE` to `long double`
|
||||||
|
could enable gargantuan floating point types on your 64-bit processor instead of
|
||||||
|
the standard `double`.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_DOUBLE_TYPE long double
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_FLOAT_PRECISION`
|
||||||
|
|
||||||
|
##### `UNITY_DOUBLE_PRECISION`
|
||||||
|
|
||||||
|
If you look up `UNITY_ASSERT_EQUAL_FLOAT` and `UNITY_ASSERT_EQUAL_DOUBLE` as
|
||||||
|
documented in the big daddy Unity Assertion Guide, you will learn that they are
|
||||||
|
not really asserting that two values are equal but rather that two values are
|
||||||
|
"close enough" to equal. "Close enough" is controlled by these precision
|
||||||
|
configuration options. If you are working with 32-bit floats and/or 64-bit
|
||||||
|
doubles (the normal on most processors), you should have no need to change these
|
||||||
|
options. They are both set to give you approximately 1 significant bit in either
|
||||||
|
direction. The float precision is 0.00001 while the double is 10-12.
|
||||||
|
For further details on how this works, see the appendix of the Unity Assertion
|
||||||
|
Guide.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_FLOAT_PRECISION 0.001f
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Miscellaneous
|
||||||
|
|
||||||
|
##### `UNITY_EXCLUDE_STDDEF_H`
|
||||||
|
|
||||||
|
Unity uses the `NULL` macro, which defines the value of a null pointer constant,
|
||||||
|
defined in `stddef.h` by default. If you want to provide
|
||||||
|
your own macro for this, you should exclude the `stddef.h` header file by adding this
|
||||||
|
define to your configuration.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_EXCLUDE_STDDEF_H
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### `UNITY_INCLUDE_PRINT_FORMATTED`
|
||||||
|
|
||||||
|
Unity provides a simple (and very basic) printf-like string output implementation,
|
||||||
|
which is able to print a string modified by the following format string modifiers:
|
||||||
|
|
||||||
|
- __%d__ - signed value (decimal)
|
||||||
|
- __%i__ - same as __%i__
|
||||||
|
- __%u__ - unsigned value (decimal)
|
||||||
|
- __%f__ - float/Double (if float support is activated)
|
||||||
|
- __%g__ - same as __%f__
|
||||||
|
- __%b__ - binary prefixed with "0b"
|
||||||
|
- __%x__ - hexadecimal (upper case) prefixed with "0x"
|
||||||
|
- __%X__ - same as __%x__
|
||||||
|
- __%p__ - pointer (same as __%x__ or __%X__)
|
||||||
|
- __%c__ - a single character
|
||||||
|
- __%s__ - a string (e.g. "string")
|
||||||
|
- __%%__ - The "%" symbol (escaped)
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_INCLUDE_PRINT_FORMATTED
|
||||||
|
|
||||||
|
int a = 0xfab1;
|
||||||
|
UnityPrintFormatted("Decimal %d\n", -7);
|
||||||
|
UnityPrintFormatted("Unsigned %u\n", 987);
|
||||||
|
UnityPrintFormatted("Float %f\n", 3.1415926535897932384);
|
||||||
|
UnityPrintFormatted("Binary %b\n", 0xA);
|
||||||
|
UnityPrintFormatted("Hex %X\n", 0xFAB);
|
||||||
|
UnityPrintFormatted("Pointer %p\n", &a);
|
||||||
|
UnityPrintFormatted("Character %c\n", 'F');
|
||||||
|
UnityPrintFormatted("String %s\n", "My string");
|
||||||
|
UnityPrintFormatted("Percent %%\n");
|
||||||
|
UnityPrintFormatted("Color Red \033[41mFAIL\033[00m\n");
|
||||||
|
UnityPrintFormatted("\n");
|
||||||
|
UnityPrintFormatted("Multiple (%d) (%i) (%u) (%x)\n", -100, 0, 200, 0x12345);
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Toolset Customization
|
||||||
|
|
||||||
|
In addition to the options listed above, there are a number of other options
|
||||||
|
which will come in handy to customize Unity's behavior for your specific
|
||||||
|
toolchain. It is possible that you may not need to touch any of these... but
|
||||||
|
certain platforms, particularly those running in simulators, may need to jump
|
||||||
|
through extra hoops to run properly. These macros will help in those
|
||||||
|
situations.
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_OUTPUT_CHAR(a)`
|
||||||
|
|
||||||
|
##### `UNITY_OUTPUT_FLUSH()`
|
||||||
|
|
||||||
|
##### `UNITY_OUTPUT_START()`
|
||||||
|
|
||||||
|
##### `UNITY_OUTPUT_COMPLETE()`
|
||||||
|
|
||||||
|
By default, Unity prints its results to `stdout` as it runs. This works
|
||||||
|
perfectly fine in most situations where you are using a native compiler for
|
||||||
|
testing. It works on some simulators as well so long as they have `stdout`
|
||||||
|
routed back to the command line. There are times, however, where the simulator
|
||||||
|
will lack support for dumping results or you will want to route results
|
||||||
|
elsewhere for other reasons. In these cases, you should define the
|
||||||
|
`UNITY_OUTPUT_CHAR` macro. This macro accepts a single character at a time (as
|
||||||
|
an `int`, since this is the parameter type of the standard C `putchar` function
|
||||||
|
most commonly used). You may replace this with whatever function call you like.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
Say you are forced to run your test suite on an embedded processor with no
|
||||||
|
`stdout` option. You decide to route your test result output to a custom serial
|
||||||
|
`RS232_putc()` function you wrote like thus:
|
||||||
|
```C
|
||||||
|
#include "RS232_header.h"
|
||||||
|
...
|
||||||
|
#define UNITY_OUTPUT_CHAR(a) RS232_putc(a)
|
||||||
|
#define UNITY_OUTPUT_START() RS232_config(115200,1,8,0)
|
||||||
|
#define UNITY_OUTPUT_FLUSH() RS232_flush()
|
||||||
|
#define UNITY_OUTPUT_COMPLETE() RS232_close()
|
||||||
|
```
|
||||||
|
|
||||||
|
_Note:_
|
||||||
|
`UNITY_OUTPUT_FLUSH()` can be set to the standard out flush function simply by
|
||||||
|
specifying `UNITY_USE_FLUSH_STDOUT`. No other defines are required.
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_OUTPUT_FOR_ECLIPSE`
|
||||||
|
|
||||||
|
##### `UNITY_OUTPUT_FOR_IAR_WORKBENCH`
|
||||||
|
|
||||||
|
##### `UNITY_OUTPUT_FOR_QT_CREATOR`
|
||||||
|
|
||||||
|
When managing your own builds, it is often handy to have messages output in a format which is
|
||||||
|
recognized by your IDE. These are some standard formats which can be supported. If you're using
|
||||||
|
Ceedling to manage your builds, it is better to stick with the standard format (leaving these
|
||||||
|
all undefined) and allow Ceedling to use its own decorators.
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_PTR_ATTRIBUTE`
|
||||||
|
|
||||||
|
Some compilers require a custom attribute to be assigned to pointers, like
|
||||||
|
`near` or `far`. In these cases, you can give Unity a safe default for these by
|
||||||
|
defining this option with the attribute you would like.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_PTR_ATTRIBUTE __attribute__((far))
|
||||||
|
#define UNITY_PTR_ATTRIBUTE near
|
||||||
|
```
|
||||||
|
|
||||||
|
##### `UNITY_PRINT_EOL`
|
||||||
|
|
||||||
|
By default, Unity outputs \n at the end of each line of output. This is easy
|
||||||
|
to parse by the scripts, by Ceedling, etc, but it might not be ideal for YOUR
|
||||||
|
system. Feel free to override this and to make it whatever you wish.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_PRINT_EOL { UNITY_OUTPUT_CHAR('\r'); UNITY_OUTPUT_CHAR('\n') }
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_EXCLUDE_DETAILS`
|
||||||
|
|
||||||
|
This is an option for if you absolutely must squeeze every byte of memory out of
|
||||||
|
your system. Unity stores a set of internal scratchpads which are used to pass
|
||||||
|
extra detail information around. It's used by systems like CMock in order to
|
||||||
|
report which function or argument flagged an error. If you're not using CMock and
|
||||||
|
you're not using these details for other things, then you can exclude them.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_EXCLUDE_DETAILS
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
##### `UNITY_EXCLUDE_SETJMP`
|
||||||
|
|
||||||
|
If your embedded system doesn't support the standard library setjmp, you can
|
||||||
|
exclude Unity's reliance on this by using this define. This dropped dependence
|
||||||
|
comes at a price, though. You will be unable to use custom helper functions for
|
||||||
|
your tests, and you will be unable to use tools like CMock. Very likely, if your
|
||||||
|
compiler doesn't support setjmp, you wouldn't have had the memory space for those
|
||||||
|
things anyway, though... so this option exists for those situations.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_EXCLUDE_SETJMP
|
||||||
|
```
|
||||||
|
|
||||||
|
##### `UNITY_OUTPUT_COLOR`
|
||||||
|
|
||||||
|
If you want to add color using ANSI escape codes you can use this define.
|
||||||
|
|
||||||
|
_Example:_
|
||||||
|
```C
|
||||||
|
#define UNITY_OUTPUT_COLOR
|
||||||
|
```
|
||||||
|
|
||||||
|
##### `UNITY_SHORTHAND_AS_INT`
|
||||||
|
##### `UNITY_SHORTHAND_AS_MEM`
|
||||||
|
##### `UNITY_SHORTHAND_AS_RAW`
|
||||||
|
##### `UNITY_SHORTHAND_AS_NONE`
|
||||||
|
|
||||||
|
These options give you control of the `TEST_ASSERT_EQUAL` and the
|
||||||
|
`TEST_ASSERT_NOT_EQUAL` shorthand assertions. Historically, Unity treated the
|
||||||
|
former as an alias for an integer comparison. It treated the latter as a direct
|
||||||
|
comparison using `!=`. This assymetry was confusing, but there was much
|
||||||
|
disagreement as to how best to treat this pair of assertions. These four options
|
||||||
|
will allow you to specify how Unity will treat these assertions.
|
||||||
|
|
||||||
|
- AS INT - the values will be cast to integers and directly compared. Arguments
|
||||||
|
that don't cast easily to integers will cause compiler errors.
|
||||||
|
- AS MEM - the address of both values will be taken and the entire object's
|
||||||
|
memory footprint will be compared byte by byte. Directly placing
|
||||||
|
constant numbers like `456` as expected values will cause errors.
|
||||||
|
- AS_RAW - Unity assumes that you can compare the two values using `==` and `!=`
|
||||||
|
and will do so. No details are given about mismatches, because it
|
||||||
|
doesn't really know what type it's dealing with.
|
||||||
|
- AS_NONE - Unity will disallow the use of these shorthand macros altogether,
|
||||||
|
insisting that developers choose a more descriptive option.
|
||||||
|
|
||||||
|
#### `UNITY_SUPPORT_VARIADIC_MACROS`
|
||||||
|
|
||||||
|
This will force Unity to support variadic macros when using its own built-in
|
||||||
|
RUN_TEST macro. This will rarely be necessary. Most often, Unity will automatically
|
||||||
|
detect if the compiler supports variadic macros by checking to see if it's C99+
|
||||||
|
compatible. In the event that the compiler supports variadic macros, but is primarily
|
||||||
|
C89 (ANSI), defining this option will allow you to use them. This option is also not
|
||||||
|
necessary when using Ceedling or the test runner generator script.
|
||||||
|
|
||||||
|
## Getting Into The Guts
|
||||||
|
|
||||||
|
There will be cases where the options above aren't quite going to get everything
|
||||||
|
perfect. They are likely sufficient for any situation where you are compiling
|
||||||
|
and executing your tests with a native toolchain (e.g. clang on Mac). These
|
||||||
|
options may even get you through the majority of cases encountered in working
|
||||||
|
with a target simulator run from your local command line. But especially if you
|
||||||
|
must run your test suite on your target hardware, your Unity configuration will
|
||||||
|
require special help. This special help will usually reside in one of two
|
||||||
|
places: the `main()` function or the `RUN_TEST` macro. Let's look at how these
|
||||||
|
work.
|
||||||
|
|
||||||
|
|
||||||
|
##### `main()`
|
||||||
|
|
||||||
|
Each test module is compiled and run on its own, separate from the other test
|
||||||
|
files in your project. Each test file, therefore, has a `main` function. This
|
||||||
|
`main` function will need to contain whatever code is necessary to initialize
|
||||||
|
your system to a workable state. This is particularly true for situations where
|
||||||
|
you must set up a memory map or initialize a communication channel for the
|
||||||
|
output of your test results.
|
||||||
|
|
||||||
|
A simple main function looks something like this:
|
||||||
|
|
||||||
|
```C
|
||||||
|
int main(void) {
|
||||||
|
UNITY_BEGIN();
|
||||||
|
RUN_TEST(test_TheFirst);
|
||||||
|
RUN_TEST(test_TheSecond);
|
||||||
|
RUN_TEST(test_TheThird);
|
||||||
|
return UNITY_END();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
You can see that our main function doesn't bother taking any arguments. For our
|
||||||
|
most barebones case, we'll never have arguments because we just run all the
|
||||||
|
tests each time. Instead, we start by calling `UNITY_BEGIN`. We run each test
|
||||||
|
(in whatever order we wish). Finally, we call `UNITY_END`, returning its return
|
||||||
|
value (which is the total number of failures).
|
||||||
|
|
||||||
|
It should be easy to see that you can add code before any test cases are run or
|
||||||
|
after all the test cases have completed. This allows you to do any needed
|
||||||
|
system-wide setup or teardown that might be required for your special
|
||||||
|
circumstances.
|
||||||
|
|
||||||
|
|
||||||
|
##### `RUN_TEST`
|
||||||
|
|
||||||
|
The `RUN_TEST` macro is called with each test case function. Its job is to
|
||||||
|
perform whatever setup and teardown is necessary for executing a single test
|
||||||
|
case function. This includes catching failures, calling the test module's
|
||||||
|
`setUp()` and `tearDown()` functions, and calling `UnityConcludeTest()`. If
|
||||||
|
using CMock or test coverage, there will be additional stubs in use here. A
|
||||||
|
simple minimalist RUN_TEST macro looks something like this:
|
||||||
|
|
||||||
|
```C
|
||||||
|
#define RUN_TEST(testfunc) \
|
||||||
|
UNITY_NEW_TEST(#testfunc) \
|
||||||
|
if (TEST_PROTECT()) { \
|
||||||
|
setUp(); \
|
||||||
|
testfunc(); \
|
||||||
|
} \
|
||||||
|
if (TEST_PROTECT() && (!TEST_IS_IGNORED)) \
|
||||||
|
tearDown(); \
|
||||||
|
UnityConcludeTest();
|
||||||
|
```
|
||||||
|
|
||||||
|
So that's quite a macro, huh? It gives you a glimpse of what kind of stuff Unity
|
||||||
|
has to deal with for every single test case. For each test case, we declare that
|
||||||
|
it is a new test. Then we run `setUp` and our test function. These are run
|
||||||
|
within a `TEST_PROTECT` block, the function of which is to handle failures that
|
||||||
|
occur during the test. Then, assuming our test is still running and hasn't been
|
||||||
|
ignored, we run `tearDown`. No matter what, our last step is to conclude this
|
||||||
|
test before moving on to the next.
|
||||||
|
|
||||||
|
Let's say you need to add a call to `fsync` to force all of your output data to
|
||||||
|
flush to a file after each test. You could easily insert this after your
|
||||||
|
`UnityConcludeTest` call. Maybe you want to write an xml tag before and after
|
||||||
|
each result set. Again, you could do this by adding lines to this macro. Updates
|
||||||
|
to this macro are for the occasions when you need an action before or after
|
||||||
|
every single test case throughout your entire suite of tests.
|
||||||
|
|
||||||
|
|
||||||
|
## Happy Porting
|
||||||
|
|
||||||
|
The defines and macros in this guide should help you port Unity to just about
|
||||||
|
any C target we can imagine. If you run into a snag or two, don't be afraid of
|
||||||
|
asking for help on the forums. We love a good challenge!
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
Binary file not shown.
251
docs/UnityGettingStartedGuide.md
Normal file
251
docs/UnityGettingStartedGuide.md
Normal file
@@ -0,0 +1,251 @@
|
|||||||
|
# Unity - Getting Started
|
||||||
|
|
||||||
|
## Welcome
|
||||||
|
|
||||||
|
Congratulations. You're now the proud owner of your very own pile of bits! What
|
||||||
|
are you going to do with all these ones and zeros? This document should be able
|
||||||
|
to help you decide just that.
|
||||||
|
|
||||||
|
Unity is a unit test framework. The goal has been to keep it small and
|
||||||
|
functional. The core Unity test framework is three files: a single C file and a
|
||||||
|
couple header files. These team up to provide functions and macros to make
|
||||||
|
testing easier.
|
||||||
|
|
||||||
|
Unity was designed to be cross-platform. It works hard to stick with C standards
|
||||||
|
while still providing support for the many embedded C compilers that bend the
|
||||||
|
rules. Unity has been used with many compilers, including GCC, IAR, Clang,
|
||||||
|
Green Hills, Microchip, and MS Visual Studio. It's not much work to get it to
|
||||||
|
work with a new target.
|
||||||
|
|
||||||
|
|
||||||
|
### Overview of the Documents
|
||||||
|
|
||||||
|
#### Unity Assertions reference
|
||||||
|
|
||||||
|
This document will guide you through all the assertion options provided by
|
||||||
|
Unity. This is going to be your unit testing bread and butter. You'll spend more
|
||||||
|
time with assertions than any other part of Unity.
|
||||||
|
|
||||||
|
|
||||||
|
#### Unity Assertions Cheat Sheet
|
||||||
|
|
||||||
|
This document contains an abridged summary of the assertions described in the
|
||||||
|
previous document. It's perfect for printing and referencing while you
|
||||||
|
familiarize yourself with Unity's options.
|
||||||
|
|
||||||
|
|
||||||
|
#### Unity Configuration Guide
|
||||||
|
|
||||||
|
This document is the one to reference when you are going to use Unity with a new
|
||||||
|
target or compiler. It'll guide you through the configuration options and will
|
||||||
|
help you customize your testing experience to meet your needs.
|
||||||
|
|
||||||
|
|
||||||
|
#### Unity Helper Scripts
|
||||||
|
|
||||||
|
This document describes the helper scripts that are available for simplifying
|
||||||
|
your testing workflow. It describes the collection of optional Ruby scripts
|
||||||
|
included in the auto directory of your Unity installation. Neither Ruby nor
|
||||||
|
these scripts are necessary for using Unity. They are provided as a convenience
|
||||||
|
for those who wish to use them.
|
||||||
|
|
||||||
|
|
||||||
|
#### Unity License
|
||||||
|
|
||||||
|
What's an open source project without a license file? This brief document
|
||||||
|
describes the terms you're agreeing to when you use this software. Basically, we
|
||||||
|
want it to be useful to you in whatever context you want to use it, but please
|
||||||
|
don't blame us if you run into problems.
|
||||||
|
|
||||||
|
|
||||||
|
### Overview of the Folders
|
||||||
|
|
||||||
|
If you have obtained Unity through Github or something similar, you might be
|
||||||
|
surprised by just how much stuff you suddenly have staring you in the face.
|
||||||
|
Don't worry, Unity itself is very small. The rest of it is just there to make
|
||||||
|
your life easier. You can ignore it or use it at your convenience. Here's an
|
||||||
|
overview of everything in the project.
|
||||||
|
|
||||||
|
- `src` - This is the code you care about! This folder contains a C file and two
|
||||||
|
header files. These three files _are_ Unity.
|
||||||
|
- `docs` - You're reading this document, so it's possible you have found your way
|
||||||
|
into this folder already. This is where all the handy documentation can be
|
||||||
|
found.
|
||||||
|
- `examples` - This contains a few examples of using Unity.
|
||||||
|
- `extras` - These are optional add ons to Unity that are not part of the core
|
||||||
|
project. If you've reached us through James Grenning's book, you're going to
|
||||||
|
want to look here.
|
||||||
|
- `test` - This is how Unity and its scripts are all tested. If you're just using
|
||||||
|
Unity, you'll likely never need to go in here. If you are the lucky team member
|
||||||
|
who gets to port Unity to a new toolchain, this is a good place to verify
|
||||||
|
everything is configured properly.
|
||||||
|
- `auto` - Here you will find helpful Ruby scripts for simplifying your test
|
||||||
|
workflow. They are purely optional and are not required to make use of Unity.
|
||||||
|
|
||||||
|
|
||||||
|
## How to Create A Test File
|
||||||
|
|
||||||
|
Test files are C files. Most often you will create a single test file for each C
|
||||||
|
module that you want to test. The test file should include unity.h and the
|
||||||
|
header for your C module to be tested.
|
||||||
|
|
||||||
|
Next, a test file will include a `setUp()` and `tearDown()` function. The setUp
|
||||||
|
function can contain anything you would like to run before each test. The
|
||||||
|
tearDown function can contain anything you would like to run after each test.
|
||||||
|
Both functions accept no arguments and return nothing. You may leave either or
|
||||||
|
both of these blank if you have no need for them.
|
||||||
|
|
||||||
|
If you're using Ceedling or the test runner generator script, you may leave these off
|
||||||
|
completely. Not sure? Give it a try. If you compiler complains that it can't
|
||||||
|
find setUp or tearDown when it links, you'll know you need to at least include
|
||||||
|
an empty function for these.
|
||||||
|
|
||||||
|
The majority of the file will be a series of test functions. Test functions
|
||||||
|
follow the convention of starting with the word "test_" or "spec_". You don't HAVE
|
||||||
|
to name them this way, but it makes it clear what functions are tests for other
|
||||||
|
developers. Also, the automated scripts that come with Unity or Ceedling will default
|
||||||
|
to looking for test functions to be prefixed this way. Test functions take no arguments
|
||||||
|
and return nothing. All test accounting is handled internally in Unity.
|
||||||
|
|
||||||
|
Finally, at the bottom of your test file, you will write a `main()` function.
|
||||||
|
This function will call `UNITY_BEGIN()`, then `RUN_TEST` for each test, and
|
||||||
|
finally `UNITY_END()`.This is what will actually trigger each of those test
|
||||||
|
functions to run, so it is important that each function gets its own `RUN_TEST`
|
||||||
|
call.
|
||||||
|
|
||||||
|
Remembering to add each test to the main function can get to be tedious. If you
|
||||||
|
enjoy using helper scripts in your build process, you might consider making use
|
||||||
|
of our handy [generate_test_runner.rb](../auto/generate_test_runner.rb) script.
|
||||||
|
This will create the main function and all the calls for you, assuming that you
|
||||||
|
have followed the suggested naming conventions. In this case, there is no need
|
||||||
|
for you to include the main function in your test file at all.
|
||||||
|
|
||||||
|
When you're done, your test file will look something like this:
|
||||||
|
|
||||||
|
```C
|
||||||
|
#include "unity.h"
|
||||||
|
#include "file_to_test.h"
|
||||||
|
|
||||||
|
void setUp(void) {
|
||||||
|
// set stuff up here
|
||||||
|
}
|
||||||
|
|
||||||
|
void tearDown(void) {
|
||||||
|
// clean stuff up here
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_function_should_doBlahAndBlah(void) {
|
||||||
|
//test stuff
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_function_should_doAlsoDoBlah(void) {
|
||||||
|
//more test stuff
|
||||||
|
}
|
||||||
|
|
||||||
|
// not needed when using generate_test_runner.rb
|
||||||
|
int main(void) {
|
||||||
|
UNITY_BEGIN();
|
||||||
|
RUN_TEST(test_function_should_doBlahAndBlah);
|
||||||
|
RUN_TEST(test_function_should_doAlsoDoBlah);
|
||||||
|
return UNITY_END();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
It's possible that you will need more customization than this, eventually.
|
||||||
|
For that sort of thing, you're going to want to look at the configuration guide.
|
||||||
|
This should be enough to get you going, though.
|
||||||
|
|
||||||
|
### Running Test Functions
|
||||||
|
When writing your own `main()` functions, for a test-runner. There are two ways
|
||||||
|
to execute the test.
|
||||||
|
|
||||||
|
The classic variant
|
||||||
|
``` c
|
||||||
|
RUN_TEST(func, linenum)
|
||||||
|
```
|
||||||
|
or its simpler replacement that starts at the beginning of the function.
|
||||||
|
``` c
|
||||||
|
RUN_TEST(func)
|
||||||
|
```
|
||||||
|
These macros perform the necessary setup before the test is called and
|
||||||
|
handles cleanup and result tabulation afterwards.
|
||||||
|
|
||||||
|
### Ignoring Test Functions
|
||||||
|
There are times when a test is incomplete or not valid for some reason.
|
||||||
|
At these times, TEST_IGNORE can be called. Control will immediately be
|
||||||
|
returned to the caller of the test, and no failures will be returned.
|
||||||
|
This is useful when your test runners are automatically generated.
|
||||||
|
|
||||||
|
``` c
|
||||||
|
TEST_IGNORE()
|
||||||
|
```
|
||||||
|
|
||||||
|
Ignore this test and return immediately
|
||||||
|
|
||||||
|
``` c
|
||||||
|
TEST_IGNORE_MESSAGE (message)
|
||||||
|
```
|
||||||
|
|
||||||
|
Ignore this test and return immediately. Output a message stating why the test was ignored.
|
||||||
|
|
||||||
|
### Aborting Tests
|
||||||
|
There are times when a test will contain an infinite loop on error conditions, or there may be reason to escape from the test early without executing the rest of the test. A pair of macros support this functionality in Unity. The first `TEST_PROTECT` sets up the feature, and handles emergency abort cases. `TEST_ABORT` can then be used at any time within the tests to return to the last `TEST_PROTECT` call.
|
||||||
|
|
||||||
|
TEST_PROTECT()
|
||||||
|
|
||||||
|
Setup and Catch macro
|
||||||
|
|
||||||
|
TEST_ABORT()
|
||||||
|
|
||||||
|
Abort Test macro
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
main()
|
||||||
|
{
|
||||||
|
if (TEST_PROTECT())
|
||||||
|
{
|
||||||
|
MyTest();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
If MyTest calls `TEST_ABORT`, program control will immediately return to `TEST_PROTECT` with a return value of zero.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## How to Build and Run A Test File
|
||||||
|
|
||||||
|
This is the single biggest challenge to picking up a new unit testing framework,
|
||||||
|
at least in a language like C or C++. These languages are REALLY good at getting
|
||||||
|
you "close to the metal" (why is the phrase metal? Wouldn't it be more accurate
|
||||||
|
to say "close to the silicon"?). While this feature is usually a good thing, it
|
||||||
|
can make testing more challenging.
|
||||||
|
|
||||||
|
You have two really good options for toolchains. Depending on where you're
|
||||||
|
coming from, it might surprise you that neither of these options is running the
|
||||||
|
unit tests on your hardware.
|
||||||
|
There are many reasons for this, but here's a short version:
|
||||||
|
- On hardware, you have too many constraints (processing power, memory, etc),
|
||||||
|
- On hardware, you don't have complete control over all registers,
|
||||||
|
- On hardware, unit testing is more challenging,
|
||||||
|
- Unit testing isn't System testing. Keep them separate.
|
||||||
|
|
||||||
|
Instead of running your tests on your actual hardware, most developers choose to
|
||||||
|
develop them as native applications (using gcc or MSVC for example) or as
|
||||||
|
applications running on a simulator. Either is a good option. Native apps have
|
||||||
|
the advantages of being faster and easier to set up. Simulator apps have the
|
||||||
|
advantage of working with the same compiler as your target application. The
|
||||||
|
options for configuring these are discussed in the configuration guide.
|
||||||
|
|
||||||
|
To get either to work, you might need to make a few changes to the file
|
||||||
|
containing your register set (discussed later).
|
||||||
|
|
||||||
|
In either case, a test is built by linking unity, the test file, and the C
|
||||||
|
file(s) being tested. These files create an executable which can be run as the
|
||||||
|
test set for that module. Then, this process is repeated for the next test file.
|
||||||
|
This flexibility of separating tests into individual executables allows us to
|
||||||
|
much more thoroughly unit test our system and it keeps all the test code out of
|
||||||
|
our final release!
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
Binary file not shown.
266
docs/UnityHelperScriptsGuide.md
Normal file
266
docs/UnityHelperScriptsGuide.md
Normal file
@@ -0,0 +1,266 @@
|
|||||||
|
# Unity Helper Scripts
|
||||||
|
|
||||||
|
## With a Little Help From Our Friends
|
||||||
|
|
||||||
|
Sometimes what it takes to be a really efficient C programmer is a little non-C.
|
||||||
|
The Unity project includes a couple of Ruby scripts for making your life just a tad
|
||||||
|
easier. They are completely optional. If you choose to use them, you'll need a
|
||||||
|
copy of Ruby, of course. Just install whatever the latest version is, and it is
|
||||||
|
likely to work. You can find Ruby at [ruby-lang.org](https://ruby-labg.org/).
|
||||||
|
|
||||||
|
|
||||||
|
### `generate_test_runner.rb`
|
||||||
|
|
||||||
|
Are you tired of creating your own `main` function in your test file? Do you
|
||||||
|
keep forgetting to add a `RUN_TEST` call when you add a new test case to your
|
||||||
|
suite? Do you want to use CMock or other fancy add-ons but don't want to figure
|
||||||
|
out how to create your own `RUN_TEST` macro?
|
||||||
|
|
||||||
|
Well then we have the perfect script for you!
|
||||||
|
|
||||||
|
The `generate_test_runner` script processes a given test file and automatically
|
||||||
|
creates a separate test runner file that includes ?main?to execute the test
|
||||||
|
cases within the scanned test file. All you do then is add the generated runner
|
||||||
|
to your list of files to be compiled and linked, and presto you're done!
|
||||||
|
|
||||||
|
This script searches your test file for void function signatures having a
|
||||||
|
function name beginning with "test" or "spec". It treats each of these
|
||||||
|
functions as a test case and builds up a test suite of them. For example, the
|
||||||
|
following includes three test cases:
|
||||||
|
|
||||||
|
```C
|
||||||
|
void testVerifyThatUnityIsAwesomeAndWillMakeYourLifeEasier(void)
|
||||||
|
{
|
||||||
|
ASSERT_TRUE(1);
|
||||||
|
}
|
||||||
|
void test_FunctionName_should_WorkProperlyAndReturn8(void) {
|
||||||
|
ASSERT_EQUAL_INT(8, FunctionName());
|
||||||
|
}
|
||||||
|
void spec_Function_should_DoWhatItIsSupposedToDo(void) {
|
||||||
|
ASSERT_NOT_NULL(Function(5));
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
You can run this script a couple of ways. The first is from the command line:
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
ruby generate_test_runner.rb TestFile.c NameOfRunner.c
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, if you include only the test file parameter, the script will copy
|
||||||
|
the name of the test file and automatically append "_Runner" to the name of the
|
||||||
|
generated file. The example immediately below will create TestFile_Runner.c.
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
ruby generate_test_runner.rb TestFile.c
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also add a [YAML](http://www.yaml.org/) file to configure extra options.
|
||||||
|
Conveniently, this YAML file is of the same format as that used by Unity and
|
||||||
|
CMock. So if you are using YAML files already, you can simply pass the very same
|
||||||
|
file into the generator script.
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
ruby generate_test_runner.rb TestFile.c my_config.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
The contents of the YAML file `my_config.yml` could look something like the
|
||||||
|
example below. If you're wondering what some of these options do, you're going
|
||||||
|
to love the next section of this document.
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
:unity:
|
||||||
|
:includes:
|
||||||
|
- stdio.h
|
||||||
|
- microdefs.h
|
||||||
|
:cexception: 1
|
||||||
|
:suit_setup: "blah = malloc(1024);"
|
||||||
|
:suite_teardown: "free(blah);"
|
||||||
|
```
|
||||||
|
|
||||||
|
If you would like to force your generated test runner to include one or more
|
||||||
|
header files, you can just include those at the command line too. Just make sure
|
||||||
|
these are _after_ the YAML file, if you are using one:
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
ruby generate_test_runner.rb TestFile.c my_config.yml extras.h
|
||||||
|
```
|
||||||
|
|
||||||
|
Another option, particularly if you are already using Ruby to orchestrate your
|
||||||
|
builds - or more likely the Ruby-based build tool Rake - is requiring this
|
||||||
|
script directly. Anything that you would have specified in a YAML file can be
|
||||||
|
passed to the script as part of a hash. Let's push the exact same requirement
|
||||||
|
set as we did above but this time through Ruby code directly:
|
||||||
|
|
||||||
|
```Ruby
|
||||||
|
require "generate_test_runner.rb"
|
||||||
|
options = {
|
||||||
|
:includes => ["stdio.h", "microdefs.h"],
|
||||||
|
:cexception => 1,
|
||||||
|
:suite_setup => "blah = malloc(1024);",
|
||||||
|
:suite_teardown => "free(blah);"
|
||||||
|
}
|
||||||
|
UnityTestRunnerGenerator.new.run(testfile, runner_name, options)
|
||||||
|
```
|
||||||
|
|
||||||
|
If you have multiple files to generate in a build script (such as a Rakefile),
|
||||||
|
you might want to instantiate a generator object with your options and call it
|
||||||
|
to generate each runner afterwards. Like thus:
|
||||||
|
|
||||||
|
```Ruby
|
||||||
|
gen = UnityTestRunnerGenerator.new(options)
|
||||||
|
test_files.each do |f|
|
||||||
|
gen.run(f, File.basename(f,'.c')+"Runner.c"
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Options accepted by generate_test_runner.rb:
|
||||||
|
|
||||||
|
The following options are available when executing `generate_test_runner`. You
|
||||||
|
may pass these as a Ruby hash directly or specify them in a YAML file, both of
|
||||||
|
which are described above. In the `examples` directory, Example 3's Rakefile
|
||||||
|
demonstrates using a Ruby hash.
|
||||||
|
|
||||||
|
|
||||||
|
##### `:includes`
|
||||||
|
|
||||||
|
This option specifies an array of file names to be `#include`'d at the top of
|
||||||
|
your runner C file. You might use it to reference custom types or anything else
|
||||||
|
universally needed in your generated runners.
|
||||||
|
|
||||||
|
|
||||||
|
##### `:suite_setup`
|
||||||
|
|
||||||
|
Define this option with C code to be executed _before any_ test cases are run.
|
||||||
|
|
||||||
|
Alternatively, if your C compiler supports weak symbols, you can leave this
|
||||||
|
option unset and instead provide a `void suiteSetUp(void)` function in your test
|
||||||
|
suite. The linker will look for this symbol and fall back to a Unity-provided
|
||||||
|
stub if it is not found.
|
||||||
|
|
||||||
|
|
||||||
|
##### `:suite_teardown`
|
||||||
|
|
||||||
|
Define this option with C code to be executed _after all_ test cases have
|
||||||
|
finished. An integer variable `num_failures` is available for diagnostics.
|
||||||
|
The code should end with a `return` statement; the value returned will become
|
||||||
|
the exit code of `main`. You can normally just return `num_failures`.
|
||||||
|
|
||||||
|
Alternatively, if your C compiler supports weak symbols, you can leave this
|
||||||
|
option unset and instead provide a `int suiteTearDown(int num_failures)`
|
||||||
|
function in your test suite. The linker will look for this symbol and fall
|
||||||
|
back to a Unity-provided stub if it is not found.
|
||||||
|
|
||||||
|
|
||||||
|
##### `:enforce_strict_ordering`
|
||||||
|
|
||||||
|
This option should be defined if you have the strict order feature enabled in
|
||||||
|
CMock (see CMock documentation). This generates extra variables required for
|
||||||
|
everything to run smoothly. If you provide the same YAML to the generator as
|
||||||
|
used in CMock's configuration, you've already configured the generator properly.
|
||||||
|
|
||||||
|
|
||||||
|
##### `:externc`
|
||||||
|
|
||||||
|
This option should be defined if you are mixing C and CPP and want your test
|
||||||
|
runners to automatically include extern "C" support when they are generated.
|
||||||
|
|
||||||
|
##### `:mock_prefix` and `:mock_suffix`
|
||||||
|
|
||||||
|
Unity automatically generates calls to Init, Verify and Destroy for every file
|
||||||
|
included in the main test file that starts with the given mock prefix and ends
|
||||||
|
with the given mock suffix, file extension not included. By default, Unity
|
||||||
|
assumes a `Mock` prefix and no suffix.
|
||||||
|
|
||||||
|
##### `:plugins`
|
||||||
|
|
||||||
|
This option specifies an array of plugins to be used (of course, the array can
|
||||||
|
contain only a single plugin). This is your opportunity to enable support for
|
||||||
|
CException support, which will add a check for unhandled exceptions in each
|
||||||
|
test, reporting a failure if one is detected. To enable this feature using Ruby:
|
||||||
|
|
||||||
|
```Ruby
|
||||||
|
:plugins => [ :cexception ]
|
||||||
|
```
|
||||||
|
|
||||||
|
Or as a yaml file:
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
:plugins:
|
||||||
|
-:cexception
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are using CMock, it is very likely that you are already passing an array
|
||||||
|
of plugins to CMock. You can just use the same array here. This script will just
|
||||||
|
ignore the plugins that don't require additional support.
|
||||||
|
|
||||||
|
|
||||||
|
### `unity_test_summary.rb`
|
||||||
|
|
||||||
|
A Unity test file contains one or more test case functions. Each test case can
|
||||||
|
pass, fail, or be ignored. Each test file is run individually producing results
|
||||||
|
for its collection of test cases. A given project will almost certainly be
|
||||||
|
composed of multiple test files. Therefore, the suite of tests is comprised of
|
||||||
|
one or more test cases spread across one or more test files. This script
|
||||||
|
aggregates individual test file results to generate a summary of all executed
|
||||||
|
test cases. The output includes how many tests were run, how many were ignored,
|
||||||
|
and how many failed. In addition, the output includes a listing of which
|
||||||
|
specific tests were ignored and failed. A good example of the breadth and
|
||||||
|
details of these results can be found in the `examples` directory. Intentionally
|
||||||
|
ignored and failing tests in this project generate corresponding entries in the
|
||||||
|
summary report.
|
||||||
|
|
||||||
|
If you're interested in other (prettier?) output formats, check into the
|
||||||
|
Ceedling build tool project (ceedling.sourceforge.net) that works with Unity and
|
||||||
|
CMock and supports xunit-style xml as well as other goodies.
|
||||||
|
|
||||||
|
This script assumes the existence of files ending with the extensions
|
||||||
|
`.testpass` and `.testfail`.The contents of these files includes the test
|
||||||
|
results summary corresponding to each test file executed with the extension set
|
||||||
|
according to the presence or absence of failures for that test file. The script
|
||||||
|
searches a specified path for these files, opens each one it finds, parses the
|
||||||
|
results, and aggregates and prints a summary. Calling it from the command line
|
||||||
|
looks like this:
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
ruby unity_test_summary.rb build/test/
|
||||||
|
```
|
||||||
|
|
||||||
|
You can optionally specify a root path as well. This is really helpful when you
|
||||||
|
are using relative paths in your tools' setup, but you want to pull the summary
|
||||||
|
into an IDE like Eclipse for clickable shortcuts.
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
ruby unity_test_summary.rb build/test/ ~/projects/myproject/
|
||||||
|
```
|
||||||
|
|
||||||
|
Or, if you're more of a Windows sort of person:
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
ruby unity_test_summary.rb build\teat\ C:\projects\myproject\
|
||||||
|
```
|
||||||
|
|
||||||
|
When configured correctly, you'll see a final summary, like so:
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
--------------------------
|
||||||
|
UNITY IGNORED TEST SUMMARY
|
||||||
|
--------------------------
|
||||||
|
blah.c:22:test_sandwiches_should_HaveBreadOnTwoSides:IGNORE
|
||||||
|
|
||||||
|
-------------------------
|
||||||
|
UNITY FAILED TEST SUMMARY
|
||||||
|
-------------------------
|
||||||
|
blah.c:87:test_sandwiches_should_HaveCondiments:FAIL:Expected 1 was 0
|
||||||
|
meh.c:38:test_soda_should_BeCalledPop:FAIL:Expected "pop" was "coke"
|
||||||
|
|
||||||
|
--------------------------
|
||||||
|
OVERALL UNITY TEST SUMMARY
|
||||||
|
--------------------------
|
||||||
|
45 TOTAL TESTS 2 TOTAL FAILURES 1 IGNORED
|
||||||
|
```
|
||||||
|
|
||||||
|
How convenient is that?
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
Binary file not shown.
@@ -5,17 +5,14 @@
|
|||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
#We try to detect the OS we are running on, and adjust commands as needed
|
#We try to detect the OS we are running on, and adjust commands as needed
|
||||||
ifeq ($(OSTYPE),cygwin)
|
ifeq ($(OS),Windows_NT)
|
||||||
CLEANUP = rm -f
|
ifeq ($(shell uname -s),) # not in a bash-like shell
|
||||||
MKDIR = mkdir -p
|
|
||||||
TARGET_EXTENSION=.out
|
|
||||||
elseifeq ($(OSTYPE),msys)
|
|
||||||
CLEANUP = rm -f
|
|
||||||
MKDIR = mkdir -p
|
|
||||||
TARGET_EXTENSION=.exe
|
|
||||||
elseifeq ($(OS),Windows_NT)
|
|
||||||
CLEANUP = del /F /Q
|
CLEANUP = del /F /Q
|
||||||
MKDIR = mkdir
|
MKDIR = mkdir
|
||||||
|
else # in a bash-like shell, like msys
|
||||||
|
CLEANUP = rm -f
|
||||||
|
MKDIR = mkdir -p
|
||||||
|
endif
|
||||||
TARGET_EXTENSION=.exe
|
TARGET_EXTENSION=.exe
|
||||||
else
|
else
|
||||||
CLEANUP = rm -f
|
CLEANUP = rm -f
|
||||||
@@ -23,13 +20,16 @@ else
|
|||||||
TARGET_EXTENSION=.out
|
TARGET_EXTENSION=.out
|
||||||
endif
|
endif
|
||||||
|
|
||||||
UNITY_ROOT=../..
|
|
||||||
C_COMPILER=gcc
|
C_COMPILER=gcc
|
||||||
|
ifeq ($(shell uname -s), Darwin)
|
||||||
|
C_COMPILER=clang
|
||||||
|
endif
|
||||||
|
|
||||||
|
UNITY_ROOT=../..
|
||||||
|
|
||||||
CFLAGS=-std=c89
|
CFLAGS=-std=c89
|
||||||
CFLAGS += -Wall
|
CFLAGS += -Wall
|
||||||
CFLAGS += -Wextra
|
CFLAGS += -Wextra
|
||||||
CFLAGS += -Werror
|
|
||||||
CFLAGS += -Wpointer-arith
|
CFLAGS += -Wpointer-arith
|
||||||
CFLAGS += -Wcast-align
|
CFLAGS += -Wcast-align
|
||||||
CFLAGS += -Wwrite-strings
|
CFLAGS += -Wwrite-strings
|
||||||
@@ -41,6 +41,7 @@ CFLAGS += -Wno-unknown-pragmas
|
|||||||
CFLAGS += -Wstrict-prototypes
|
CFLAGS += -Wstrict-prototypes
|
||||||
CFLAGS += -Wundef
|
CFLAGS += -Wundef
|
||||||
CFLAGS += -Wold-style-definition
|
CFLAGS += -Wold-style-definition
|
||||||
|
#CFLAGS += -Wno-misleading-indentation
|
||||||
|
|
||||||
TARGET_BASE1=test1
|
TARGET_BASE1=test1
|
||||||
TARGET_BASE2=test2
|
TARGET_BASE2=test2
|
||||||
@@ -49,18 +50,23 @@ TARGET2 = $(TARGET_BASE2)$(TARGET_EXTENSION)
|
|||||||
SRC_FILES1=$(UNITY_ROOT)/src/unity.c src/ProductionCode.c test/TestProductionCode.c test/test_runners/TestProductionCode_Runner.c
|
SRC_FILES1=$(UNITY_ROOT)/src/unity.c src/ProductionCode.c test/TestProductionCode.c test/test_runners/TestProductionCode_Runner.c
|
||||||
SRC_FILES2=$(UNITY_ROOT)/src/unity.c src/ProductionCode2.c test/TestProductionCode2.c test/test_runners/TestProductionCode2_Runner.c
|
SRC_FILES2=$(UNITY_ROOT)/src/unity.c src/ProductionCode2.c test/TestProductionCode2.c test/test_runners/TestProductionCode2_Runner.c
|
||||||
INC_DIRS=-Isrc -I$(UNITY_ROOT)/src
|
INC_DIRS=-Isrc -I$(UNITY_ROOT)/src
|
||||||
SYMBOLS=-DTEST
|
SYMBOLS=
|
||||||
|
|
||||||
all: clean default
|
all: clean default
|
||||||
|
|
||||||
default:
|
default: $(SRC_FILES1) $(SRC_FILES2)
|
||||||
ruby $(UNITY_ROOT)/auto/generate_test_runner.rb test/TestProductionCode.c test/test_runners/TestProductionCode_Runner.c
|
|
||||||
ruby $(UNITY_ROOT)/auto/generate_test_runner.rb test/TestProductionCode2.c test/test_runners/TestProductionCode2_Runner.c
|
|
||||||
$(C_COMPILER) $(CFLAGS) $(INC_DIRS) $(SYMBOLS) $(SRC_FILES1) -o $(TARGET1)
|
$(C_COMPILER) $(CFLAGS) $(INC_DIRS) $(SYMBOLS) $(SRC_FILES1) -o $(TARGET1)
|
||||||
$(C_COMPILER) $(CFLAGS) $(INC_DIRS) $(SYMBOLS) $(SRC_FILES2) -o $(TARGET2)
|
$(C_COMPILER) $(CFLAGS) $(INC_DIRS) $(SYMBOLS) $(SRC_FILES2) -o $(TARGET2)
|
||||||
./$(TARGET1)
|
- ./$(TARGET1)
|
||||||
./$(TARGET2)
|
- ./$(TARGET2)
|
||||||
|
|
||||||
|
test/test_runners/TestProductionCode_Runner.c: test/TestProductionCode.c
|
||||||
|
ruby $(UNITY_ROOT)/auto/generate_test_runner.rb test/TestProductionCode.c test/test_runners/TestProductionCode_Runner.c
|
||||||
|
test/test_runners/TestProductionCode2_Runner.c: test/TestProductionCode2.c
|
||||||
|
ruby $(UNITY_ROOT)/auto/generate_test_runner.rb test/TestProductionCode2.c test/test_runners/TestProductionCode2_Runner.c
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
$(CLEANUP)
|
$(CLEANUP) $(TARGET1) $(TARGET2)
|
||||||
|
|
||||||
|
ci: CFLAGS += -Werror
|
||||||
|
ci: default
|
||||||
|
|||||||
@@ -4,14 +4,14 @@
|
|||||||
int Counter = 0;
|
int Counter = 0;
|
||||||
int NumbersToFind[9] = { 0, 34, 55, 66, 32, 11, 1, 77, 888 }; /* some obnoxious array to search that is 1-based indexing instead of 0. */
|
int NumbersToFind[9] = { 0, 34, 55, 66, 32, 11, 1, 77, 888 }; /* some obnoxious array to search that is 1-based indexing instead of 0. */
|
||||||
|
|
||||||
/* This function is supposed to search through NumbersToFind and find a particular number.
|
/* This function is supposed to search through NumbersToFind and find a particular number.
|
||||||
* If it finds it, the index is returned. Otherwise 0 is returned which sorta makes sense since
|
* If it finds it, the index is returned. Otherwise 0 is returned which sorta makes sense since
|
||||||
* NumbersToFind is indexed from 1. Unfortunately it's broken
|
* NumbersToFind is indexed from 1. Unfortunately it's broken
|
||||||
* (and should therefore be caught by our tests) */
|
* (and should therefore be caught by our tests) */
|
||||||
int FindFunction_WhichIsBroken(int NumberToFind)
|
int FindFunction_WhichIsBroken(int NumberToFind)
|
||||||
{
|
{
|
||||||
int i = 0;
|
int i = 0;
|
||||||
while (i <= 8) /* Notice I should have been in braces */
|
while (i < 8) /* Notice I should have been in braces */
|
||||||
i++;
|
i++;
|
||||||
if (NumbersToFind[i] == NumberToFind) /* Yikes! I'm getting run after the loop finishes instead of during it! */
|
if (NumbersToFind[i] == NumberToFind) /* Yikes! I'm getting run after the loop finishes instead of during it! */
|
||||||
return i;
|
return i;
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
/* sometimes you may want to get at local data in a module.
|
/* sometimes you may want to get at local data in a module.
|
||||||
* for example: If you plan to pass by reference, this could be useful
|
* for example: If you plan to pass by reference, this could be useful
|
||||||
* however, it should often be avoided */
|
* however, it should often be avoided */
|
||||||
extern int Counter;
|
extern int Counter;
|
||||||
|
|
||||||
void setUp(void)
|
void setUp(void)
|
||||||
{
|
{
|
||||||
@@ -21,7 +21,7 @@ void test_FindFunction_WhichIsBroken_ShouldReturnZeroIfItemIsNotInList_WhichWork
|
|||||||
{
|
{
|
||||||
/* All of these should pass */
|
/* All of these should pass */
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(78));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(78));
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(1));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(2));
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(33));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(33));
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(999));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(999));
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(-1));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(-1));
|
||||||
@@ -31,9 +31,9 @@ void test_FindFunction_WhichIsBroken_ShouldReturnTheIndexForItemsInList_WhichWil
|
|||||||
{
|
{
|
||||||
/* You should see this line fail in your test summary */
|
/* You should see this line fail in your test summary */
|
||||||
TEST_ASSERT_EQUAL(1, FindFunction_WhichIsBroken(34));
|
TEST_ASSERT_EQUAL(1, FindFunction_WhichIsBroken(34));
|
||||||
|
|
||||||
/* Notice the rest of these didn't get a chance to run because the line above failed.
|
/* Notice the rest of these didn't get a chance to run because the line above failed.
|
||||||
* Unit tests abort each test function on the first sign of trouble.
|
* Unit tests abort each test function on the first sign of trouble.
|
||||||
* Then NEXT test function runs as normal. */
|
* Then NEXT test function runs as normal. */
|
||||||
TEST_ASSERT_EQUAL(8, FindFunction_WhichIsBroken(8888));
|
TEST_ASSERT_EQUAL(8, FindFunction_WhichIsBroken(8888));
|
||||||
}
|
}
|
||||||
@@ -42,7 +42,7 @@ void test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValue(v
|
|||||||
{
|
{
|
||||||
/* This should be true because setUp set this up for us before this test */
|
/* This should be true because setUp set this up for us before this test */
|
||||||
TEST_ASSERT_EQUAL_HEX(0x5a5a, FunctionWhichReturnsLocalVariable());
|
TEST_ASSERT_EQUAL_HEX(0x5a5a, FunctionWhichReturnsLocalVariable());
|
||||||
|
|
||||||
/* This should be true because we can still change our answer */
|
/* This should be true because we can still change our answer */
|
||||||
Counter = 0x1234;
|
Counter = 0x1234;
|
||||||
TEST_ASSERT_EQUAL_HEX(0x1234, FunctionWhichReturnsLocalVariable());
|
TEST_ASSERT_EQUAL_HEX(0x1234, FunctionWhichReturnsLocalVariable());
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
setUp(); \
|
setUp(); \
|
||||||
TestFunc(); \
|
TestFunc(); \
|
||||||
} \
|
} \
|
||||||
if (TEST_PROTECT() && !TEST_IS_IGNORED) \
|
if (TEST_PROTECT()) \
|
||||||
{ \
|
{ \
|
||||||
tearDown(); \
|
tearDown(); \
|
||||||
} \
|
} \
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
setUp(); \
|
setUp(); \
|
||||||
TestFunc(); \
|
TestFunc(); \
|
||||||
} \
|
} \
|
||||||
if (TEST_PROTECT() && !TEST_IS_IGNORED) \
|
if (TEST_PROTECT()) \
|
||||||
{ \
|
{ \
|
||||||
tearDown(); \
|
tearDown(); \
|
||||||
} \
|
} \
|
||||||
|
|||||||
@@ -5,17 +5,14 @@
|
|||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
#We try to detect the OS we are running on, and adjust commands as needed
|
#We try to detect the OS we are running on, and adjust commands as needed
|
||||||
ifeq ($(OSTYPE),cygwin)
|
ifeq ($(OS),Windows_NT)
|
||||||
CLEANUP = rm -f
|
ifeq ($(shell uname -s),) # not in a bash-like shell
|
||||||
MKDIR = mkdir -p
|
|
||||||
TARGET_EXTENSION=.out
|
|
||||||
elseifeq ($(OSTYPE),msys)
|
|
||||||
CLEANUP = rm -f
|
|
||||||
MKDIR = mkdir -p
|
|
||||||
TARGET_EXTENSION=.exe
|
|
||||||
elseifeq ($(OS),Windows_NT)
|
|
||||||
CLEANUP = del /F /Q
|
CLEANUP = del /F /Q
|
||||||
MKDIR = mkdir
|
MKDIR = mkdir
|
||||||
|
else # in a bash-like shell, like msys
|
||||||
|
CLEANUP = rm -f
|
||||||
|
MKDIR = mkdir -p
|
||||||
|
endif
|
||||||
TARGET_EXTENSION=.exe
|
TARGET_EXTENSION=.exe
|
||||||
else
|
else
|
||||||
CLEANUP = rm -f
|
CLEANUP = rm -f
|
||||||
@@ -23,13 +20,16 @@ else
|
|||||||
TARGET_EXTENSION=.out
|
TARGET_EXTENSION=.out
|
||||||
endif
|
endif
|
||||||
|
|
||||||
UNITY_ROOT=../..
|
|
||||||
C_COMPILER=gcc
|
C_COMPILER=gcc
|
||||||
|
ifeq ($(shell uname -s), Darwin)
|
||||||
|
C_COMPILER=clang
|
||||||
|
endif
|
||||||
|
|
||||||
CFLAGS = -std=c99
|
UNITY_ROOT=../..
|
||||||
|
|
||||||
|
CFLAGS=-std=c99
|
||||||
CFLAGS += -Wall
|
CFLAGS += -Wall
|
||||||
CFLAGS += -Wextra
|
CFLAGS += -Wextra
|
||||||
CFLAGS += -Werror
|
|
||||||
CFLAGS += -Wpointer-arith
|
CFLAGS += -Wpointer-arith
|
||||||
CFLAGS += -Wcast-align
|
CFLAGS += -Wcast-align
|
||||||
CFLAGS += -Wwrite-strings
|
CFLAGS += -Wwrite-strings
|
||||||
@@ -41,9 +41,7 @@ CFLAGS += -Wno-unknown-pragmas
|
|||||||
CFLAGS += -Wstrict-prototypes
|
CFLAGS += -Wstrict-prototypes
|
||||||
CFLAGS += -Wundef
|
CFLAGS += -Wundef
|
||||||
CFLAGS += -Wold-style-definition
|
CFLAGS += -Wold-style-definition
|
||||||
CFLAGS += -Wmissing-prototypes
|
#CFLAGS += -Wno-misleading-indentation
|
||||||
CFLAGS += -Wmissing-declarations
|
|
||||||
CFLAGS += -DUNITY_FIXTURES
|
|
||||||
|
|
||||||
TARGET_BASE1=all_tests
|
TARGET_BASE1=all_tests
|
||||||
TARGET1 = $(TARGET_BASE1)$(TARGET_EXTENSION)
|
TARGET1 = $(TARGET_BASE1)$(TARGET_EXTENSION)
|
||||||
@@ -58,14 +56,16 @@ SRC_FILES1=\
|
|||||||
test/test_runners/TestProductionCode2_Runner.c \
|
test/test_runners/TestProductionCode2_Runner.c \
|
||||||
test/test_runners/all_tests.c
|
test/test_runners/all_tests.c
|
||||||
INC_DIRS=-Isrc -I$(UNITY_ROOT)/src -I$(UNITY_ROOT)/extras/fixture/src
|
INC_DIRS=-Isrc -I$(UNITY_ROOT)/src -I$(UNITY_ROOT)/extras/fixture/src
|
||||||
SYMBOLS=
|
SYMBOLS=-DUNITY_FIXTURE_NO_EXTRAS
|
||||||
|
|
||||||
all: clean default
|
all: clean default
|
||||||
|
|
||||||
default:
|
default:
|
||||||
$(C_COMPILER) $(CFLAGS) $(INC_DIRS) $(SYMBOLS) $(SRC_FILES1) -o $(TARGET1)
|
$(C_COMPILER) $(CFLAGS) $(INC_DIRS) $(SYMBOLS) $(SRC_FILES1) -o $(TARGET1)
|
||||||
./$(TARGET1) -v
|
- ./$(TARGET1) -v
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
$(CLEANUP)
|
$(CLEANUP) $(TARGET1)
|
||||||
|
|
||||||
|
ci: CFLAGS += -Werror
|
||||||
|
ci: default
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ TEST(ProductionCode, FindFunction_WhichIsBroken_ShouldReturnZeroIfItemIsNotInLis
|
|||||||
{
|
{
|
||||||
//All of these should pass
|
//All of these should pass
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(78));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(78));
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(1));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(2));
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(33));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(33));
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(999));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(999));
|
||||||
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(-1));
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(-1));
|
||||||
|
|||||||
@@ -1,43 +1,38 @@
|
|||||||
HERE = File.expand_path(File.dirname(__FILE__)) + '/'
|
|
||||||
UNITY_ROOT = File.expand_path(File.dirname(__FILE__)) + '/../..'
|
|
||||||
|
|
||||||
require 'rake'
|
require 'rake'
|
||||||
require 'rake/clean'
|
require 'rake/clean'
|
||||||
require HERE+'rakefile_helper'
|
require_relative 'rakefile_helper'
|
||||||
|
|
||||||
TEMP_DIRS = [
|
TEMP_DIRS = [
|
||||||
File.join(HERE, 'build')
|
File.join(__dir__, 'build')
|
||||||
]
|
].freeze
|
||||||
|
|
||||||
TEMP_DIRS.each do |dir|
|
TEMP_DIRS.each do |dir|
|
||||||
directory(dir)
|
directory(dir)
|
||||||
CLOBBER.include(dir)
|
CLOBBER.include(dir)
|
||||||
end
|
end
|
||||||
|
|
||||||
task :prepare_for_tests => TEMP_DIRS
|
task prepare_for_tests: TEMP_DIRS
|
||||||
|
|
||||||
include RakefileHelpers
|
|
||||||
|
|
||||||
# Load default configuration, for now
|
# Load default configuration, for now
|
||||||
DEFAULT_CONFIG_FILE = 'target_gcc_32.yml'
|
DEFAULT_CONFIG_FILE = 'target_gcc_32.yml'.freeze
|
||||||
configure_toolchain(DEFAULT_CONFIG_FILE)
|
configure_toolchain(DEFAULT_CONFIG_FILE)
|
||||||
|
|
||||||
task :unit => [:prepare_for_tests] do
|
task unit: [:prepare_for_tests] do
|
||||||
run_tests get_unit_test_files
|
run_tests unit_test_files
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "Generate test summary"
|
desc 'Generate test summary'
|
||||||
task :summary do
|
task :summary do
|
||||||
report_summary
|
report_summary
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "Build and test Unity"
|
desc 'Build and test Unity'
|
||||||
task :all => [:clean, :unit, :summary]
|
task all: %i[clean unit summary]
|
||||||
task :default => [:clobber, :all]
|
task default: %i[clobber all]
|
||||||
task :ci => [:default]
|
task ci: [:default]
|
||||||
task :cruise => [:default]
|
task cruise: [:default]
|
||||||
|
|
||||||
desc "Load configuration"
|
desc 'Load configuration'
|
||||||
task :config, :config_file do |t, args|
|
task :config, :config_file do |_t, args|
|
||||||
configure_toolchain(args[:config_file])
|
configure_toolchain(args[:config_file])
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,256 +1,250 @@
|
|||||||
require 'yaml'
|
require 'yaml'
|
||||||
require 'fileutils'
|
require 'fileutils'
|
||||||
require UNITY_ROOT+'/auto/unity_test_summary'
|
require_relative '../../auto/unity_test_summary'
|
||||||
require UNITY_ROOT+'/auto/generate_test_runner'
|
require_relative '../../auto/generate_test_runner'
|
||||||
require UNITY_ROOT+'/auto/colour_reporter'
|
require_relative '../../auto/colour_reporter'
|
||||||
|
|
||||||
module RakefileHelpers
|
C_EXTENSION = '.c'.freeze
|
||||||
|
|
||||||
C_EXTENSION = '.c'
|
def load_configuration(config_file)
|
||||||
|
$cfg_file = config_file
|
||||||
|
$cfg = YAML.load(File.read($cfg_file))
|
||||||
|
end
|
||||||
|
|
||||||
def load_configuration(config_file)
|
def configure_clean
|
||||||
$cfg_file = config_file
|
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
|
||||||
$cfg = YAML.load(File.read($cfg_file))
|
end
|
||||||
|
|
||||||
|
def configure_toolchain(config_file = DEFAULT_CONFIG_FILE)
|
||||||
|
config_file += '.yml' unless config_file =~ /\.yml$/
|
||||||
|
load_configuration(config_file)
|
||||||
|
configure_clean
|
||||||
|
end
|
||||||
|
|
||||||
|
def unit_test_files
|
||||||
|
path = $cfg['compiler']['unit_tests_path'] + 'Test*' + C_EXTENSION
|
||||||
|
path.tr!('\\', '/')
|
||||||
|
FileList.new(path)
|
||||||
|
end
|
||||||
|
|
||||||
|
def local_include_dirs
|
||||||
|
include_dirs = $cfg['compiler']['includes']['items'].dup
|
||||||
|
include_dirs.delete_if { |dir| dir.is_a?(Array) }
|
||||||
|
include_dirs
|
||||||
|
end
|
||||||
|
|
||||||
|
def extract_headers(filename)
|
||||||
|
includes = []
|
||||||
|
lines = File.readlines(filename)
|
||||||
|
lines.each do |line|
|
||||||
|
m = line.match(/^\s*#include\s+\"\s*(.+\.[hH])\s*\"/)
|
||||||
|
includes << m[1] unless m.nil?
|
||||||
|
end
|
||||||
|
includes
|
||||||
|
end
|
||||||
|
|
||||||
|
def find_source_file(header, paths)
|
||||||
|
paths.each do |dir|
|
||||||
|
src_file = dir + header.ext(C_EXTENSION)
|
||||||
|
return src_file if File.exist?(src_file)
|
||||||
|
end
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def tackit(strings)
|
||||||
|
result = if strings.is_a?(Array)
|
||||||
|
"\"#{strings.join}\""
|
||||||
|
else
|
||||||
|
strings
|
||||||
|
end
|
||||||
|
result
|
||||||
|
end
|
||||||
|
|
||||||
|
def squash(prefix, items)
|
||||||
|
result = ''
|
||||||
|
items.each { |item| result += " #{prefix}#{tackit(item)}" }
|
||||||
|
result
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_compiler_fields
|
||||||
|
command = tackit($cfg['compiler']['path'])
|
||||||
|
defines = if $cfg['compiler']['defines']['items'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'])
|
||||||
|
end
|
||||||
|
options = squash('', $cfg['compiler']['options'])
|
||||||
|
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
|
||||||
|
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
||||||
|
|
||||||
|
{ command: command, defines: defines, options: options, includes: includes }
|
||||||
|
end
|
||||||
|
|
||||||
|
def compile(file, _defines = [])
|
||||||
|
compiler = build_compiler_fields
|
||||||
|
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{file} " \
|
||||||
|
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}"
|
||||||
|
obj_file = "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
|
||||||
|
execute(cmd_str + obj_file)
|
||||||
|
obj_file
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_linker_fields
|
||||||
|
command = tackit($cfg['linker']['path'])
|
||||||
|
options = if $cfg['linker']['options'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash('', $cfg['linker']['options'])
|
||||||
|
end
|
||||||
|
includes = if $cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
|
||||||
|
end.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
||||||
|
|
||||||
|
{ command: command, options: options, includes: includes }
|
||||||
|
end
|
||||||
|
|
||||||
|
def link_it(exe_name, obj_list)
|
||||||
|
linker = build_linker_fields
|
||||||
|
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
|
||||||
|
(obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join +
|
||||||
|
$cfg['linker']['bin_files']['prefix'] + ' ' +
|
||||||
|
$cfg['linker']['bin_files']['destination'] +
|
||||||
|
exe_name + $cfg['linker']['bin_files']['extension']
|
||||||
|
execute(cmd_str)
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_simulator_fields
|
||||||
|
return nil if $cfg['simulator'].nil?
|
||||||
|
|
||||||
|
command = if $cfg['simulator']['path'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
(tackit($cfg['simulator']['path']) + ' ')
|
||||||
|
end
|
||||||
|
pre_support = if $cfg['simulator']['pre_support'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash('', $cfg['simulator']['pre_support'])
|
||||||
|
end
|
||||||
|
post_support = if $cfg['simulator']['post_support'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash('', $cfg['simulator']['post_support'])
|
||||||
|
end
|
||||||
|
|
||||||
|
{ command: command, pre_support: pre_support, post_support: post_support }
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute(command_string, verbose = true, raise_on_fail = true)
|
||||||
|
report command_string
|
||||||
|
output = `#{command_string}`.chomp
|
||||||
|
report(output) if verbose && !output.nil? && !output.empty?
|
||||||
|
|
||||||
|
if !$?.nil? && !$?.exitstatus.zero? && raise_on_fail
|
||||||
|
raise "Command failed. (Returned #{$?.exitstatus})"
|
||||||
end
|
end
|
||||||
|
|
||||||
def configure_clean
|
output
|
||||||
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
|
end
|
||||||
end
|
|
||||||
|
|
||||||
def configure_toolchain(config_file=DEFAULT_CONFIG_FILE)
|
def report_summary
|
||||||
config_file += '.yml' unless config_file =~ /\.yml$/
|
summary = UnityTestSummary.new
|
||||||
load_configuration(config_file)
|
summary.root = __dir__
|
||||||
configure_clean
|
results_glob = "#{$cfg['compiler']['build_path']}*.test*"
|
||||||
end
|
results_glob.tr!('\\', '/')
|
||||||
|
results = Dir[results_glob]
|
||||||
|
summary.targets = results
|
||||||
|
summary.run
|
||||||
|
fail_out 'FAIL: There were failures' if summary.failures > 0
|
||||||
|
end
|
||||||
|
|
||||||
def get_unit_test_files
|
def run_tests(test_files)
|
||||||
path = $cfg['compiler']['unit_tests_path'] + 'Test*' + C_EXTENSION
|
report 'Running system tests...'
|
||||||
path.gsub!(/\\/, '/')
|
|
||||||
FileList.new(path)
|
|
||||||
end
|
|
||||||
|
|
||||||
def get_local_include_dirs
|
# Tack on TEST define for compiling unit tests
|
||||||
include_dirs = $cfg['compiler']['includes']['items'].dup
|
load_configuration($cfg_file)
|
||||||
include_dirs.delete_if {|dir| dir.is_a?(Array)}
|
test_defines = ['TEST']
|
||||||
return include_dirs
|
$cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil?
|
||||||
end
|
$cfg['compiler']['defines']['items'] << 'TEST'
|
||||||
|
|
||||||
def extract_headers(filename)
|
include_dirs = local_include_dirs
|
||||||
includes = []
|
|
||||||
lines = File.readlines(filename)
|
|
||||||
lines.each do |line|
|
|
||||||
m = line.match(/^\s*#include\s+\"\s*(.+\.[hH])\s*\"/)
|
|
||||||
if not m.nil?
|
|
||||||
includes << m[1]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
return includes
|
|
||||||
end
|
|
||||||
|
|
||||||
def find_source_file(header, paths)
|
|
||||||
paths.each do |dir|
|
|
||||||
src_file = dir + header.ext(C_EXTENSION)
|
|
||||||
if (File.exists?(src_file))
|
|
||||||
return src_file
|
|
||||||
end
|
|
||||||
end
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
def tackit(strings)
|
|
||||||
if strings.is_a?(Array)
|
|
||||||
result = "\"#{strings.join}\""
|
|
||||||
else
|
|
||||||
result = strings
|
|
||||||
end
|
|
||||||
return result
|
|
||||||
end
|
|
||||||
|
|
||||||
def squash(prefix, items)
|
|
||||||
result = ''
|
|
||||||
items.each { |item| result += " #{prefix}#{tackit(item)}" }
|
|
||||||
return result
|
|
||||||
end
|
|
||||||
|
|
||||||
def build_compiler_fields
|
|
||||||
command = tackit($cfg['compiler']['path'])
|
|
||||||
if $cfg['compiler']['defines']['items'].nil?
|
|
||||||
defines = ''
|
|
||||||
else
|
|
||||||
defines = squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'])
|
|
||||||
end
|
|
||||||
options = squash('', $cfg['compiler']['options'])
|
|
||||||
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
|
|
||||||
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
|
||||||
return {:command => command, :defines => defines, :options => options, :includes => includes}
|
|
||||||
end
|
|
||||||
|
|
||||||
def compile(file, defines=[])
|
|
||||||
compiler = build_compiler_fields
|
|
||||||
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{file} " +
|
|
||||||
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}"
|
|
||||||
obj_file = "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
|
|
||||||
execute(cmd_str + obj_file)
|
|
||||||
return obj_file
|
|
||||||
end
|
|
||||||
|
|
||||||
def build_linker_fields
|
|
||||||
command = tackit($cfg['linker']['path'])
|
|
||||||
if $cfg['linker']['options'].nil?
|
|
||||||
options = ''
|
|
||||||
else
|
|
||||||
options = squash('', $cfg['linker']['options'])
|
|
||||||
end
|
|
||||||
if ($cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?)
|
|
||||||
includes = ''
|
|
||||||
else
|
|
||||||
includes = squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
|
|
||||||
end
|
|
||||||
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
|
||||||
return {:command => command, :options => options, :includes => includes}
|
|
||||||
end
|
|
||||||
|
|
||||||
def link_it(exe_name, obj_list)
|
|
||||||
linker = build_linker_fields
|
|
||||||
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
|
|
||||||
(obj_list.map{|obj|"#{$cfg['linker']['object_files']['path']}#{obj} "}).join +
|
|
||||||
$cfg['linker']['bin_files']['prefix'] + ' ' +
|
|
||||||
$cfg['linker']['bin_files']['destination'] +
|
|
||||||
exe_name + $cfg['linker']['bin_files']['extension']
|
|
||||||
execute(cmd_str)
|
|
||||||
end
|
|
||||||
|
|
||||||
def build_simulator_fields
|
|
||||||
return nil if $cfg['simulator'].nil?
|
|
||||||
if $cfg['simulator']['path'].nil?
|
|
||||||
command = ''
|
|
||||||
else
|
|
||||||
command = (tackit($cfg['simulator']['path']) + ' ')
|
|
||||||
end
|
|
||||||
if $cfg['simulator']['pre_support'].nil?
|
|
||||||
pre_support = ''
|
|
||||||
else
|
|
||||||
pre_support = squash('', $cfg['simulator']['pre_support'])
|
|
||||||
end
|
|
||||||
if $cfg['simulator']['post_support'].nil?
|
|
||||||
post_support = ''
|
|
||||||
else
|
|
||||||
post_support = squash('', $cfg['simulator']['post_support'])
|
|
||||||
end
|
|
||||||
return {:command => command, :pre_support => pre_support, :post_support => post_support}
|
|
||||||
end
|
|
||||||
|
|
||||||
def execute(command_string, verbose=true, raise_on_fail=true)
|
|
||||||
report command_string
|
|
||||||
output = `#{command_string}`.chomp
|
|
||||||
report(output) if (verbose && !output.nil? && (output.length > 0))
|
|
||||||
if (($?.exitstatus != 0) and (raise_on_fail))
|
|
||||||
raise "Command failed. (Returned #{$?.exitstatus})"
|
|
||||||
end
|
|
||||||
return output
|
|
||||||
end
|
|
||||||
|
|
||||||
def report_summary
|
|
||||||
summary = UnityTestSummary.new
|
|
||||||
summary.set_root_path(HERE)
|
|
||||||
results_glob = "#{$cfg['compiler']['build_path']}*.test*"
|
|
||||||
results_glob.gsub!(/\\/, '/')
|
|
||||||
results = Dir[results_glob]
|
|
||||||
summary.set_targets(results)
|
|
||||||
summary.run
|
|
||||||
fail_out "FAIL: There were failures" if (summary.failures > 0)
|
|
||||||
end
|
|
||||||
|
|
||||||
def run_tests(test_files)
|
|
||||||
|
|
||||||
report 'Running system tests...'
|
|
||||||
|
|
||||||
# Tack on TEST define for compiling unit tests
|
|
||||||
load_configuration($cfg_file)
|
|
||||||
test_defines = ['TEST']
|
|
||||||
$cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil?
|
|
||||||
$cfg['compiler']['defines']['items'] << 'TEST'
|
|
||||||
|
|
||||||
include_dirs = get_local_include_dirs
|
|
||||||
|
|
||||||
# Build and execute each unit test
|
|
||||||
test_files.each do |test|
|
|
||||||
obj_list = []
|
|
||||||
|
|
||||||
# Detect dependencies and build required required modules
|
|
||||||
extract_headers(test).each do |header|
|
|
||||||
# Compile corresponding source file if it exists
|
|
||||||
src_file = find_source_file(header, include_dirs)
|
|
||||||
if !src_file.nil?
|
|
||||||
obj_list << compile(src_file, test_defines)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Build the test runner (generate if configured to do so)
|
|
||||||
test_base = File.basename(test, C_EXTENSION)
|
|
||||||
runner_name = test_base + '_Runner.c'
|
|
||||||
if $cfg['compiler']['runner_path'].nil?
|
|
||||||
runner_path = $cfg['compiler']['build_path'] + runner_name
|
|
||||||
test_gen = UnityTestRunnerGenerator.new($cfg_file)
|
|
||||||
test_gen.run(test, runner_path)
|
|
||||||
else
|
|
||||||
runner_path = $cfg['compiler']['runner_path'] + runner_name
|
|
||||||
end
|
|
||||||
|
|
||||||
obj_list << compile(runner_path, test_defines)
|
|
||||||
|
|
||||||
# Build the test module
|
|
||||||
obj_list << compile(test, test_defines)
|
|
||||||
|
|
||||||
# Link the test executable
|
|
||||||
link_it(test_base, obj_list)
|
|
||||||
|
|
||||||
# Execute unit test and generate results file
|
|
||||||
simulator = build_simulator_fields
|
|
||||||
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
|
|
||||||
if simulator.nil?
|
|
||||||
cmd_str = executable
|
|
||||||
else
|
|
||||||
cmd_str = "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
|
||||||
end
|
|
||||||
output = execute(cmd_str, true, false)
|
|
||||||
test_results = $cfg['compiler']['build_path'] + test_base
|
|
||||||
if output.match(/OK$/m).nil?
|
|
||||||
test_results += '.testfail'
|
|
||||||
else
|
|
||||||
test_results += '.testpass'
|
|
||||||
end
|
|
||||||
File.open(test_results, 'w') { |f| f.print output }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def build_application(main)
|
|
||||||
|
|
||||||
report "Building application..."
|
|
||||||
|
|
||||||
|
# Build and execute each unit test
|
||||||
|
test_files.each do |test|
|
||||||
obj_list = []
|
obj_list = []
|
||||||
load_configuration($cfg_file)
|
|
||||||
main_path = $cfg['compiler']['source_path'] + main + C_EXTENSION
|
|
||||||
|
|
||||||
# Detect dependencies and build required required modules
|
# Detect dependencies and build required required modules
|
||||||
include_dirs = get_local_include_dirs
|
extract_headers(test).each do |header|
|
||||||
extract_headers(main_path).each do |header|
|
# Compile corresponding source file if it exists
|
||||||
src_file = find_source_file(header, include_dirs)
|
src_file = find_source_file(header, include_dirs)
|
||||||
if !src_file.nil?
|
obj_list << compile(src_file, test_defines) unless src_file.nil?
|
||||||
obj_list << compile(src_file)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Build the main source file
|
# Build the test runner (generate if configured to do so)
|
||||||
main_base = File.basename(main_path, C_EXTENSION)
|
test_base = File.basename(test, C_EXTENSION)
|
||||||
obj_list << compile(main_path)
|
runner_name = test_base + '_Runner.c'
|
||||||
|
if $cfg['compiler']['runner_path'].nil?
|
||||||
|
runner_path = $cfg['compiler']['build_path'] + runner_name
|
||||||
|
test_gen = UnityTestRunnerGenerator.new($cfg_file)
|
||||||
|
test_gen.run(test, runner_path)
|
||||||
|
else
|
||||||
|
runner_path = $cfg['compiler']['runner_path'] + runner_name
|
||||||
|
end
|
||||||
|
|
||||||
# Create the executable
|
obj_list << compile(runner_path, test_defines)
|
||||||
link_it(main_base, obj_list)
|
|
||||||
end
|
|
||||||
|
|
||||||
def fail_out(msg)
|
# Build the test module
|
||||||
puts msg
|
obj_list << compile(test, test_defines)
|
||||||
exit(-1)
|
|
||||||
|
# Link the test executable
|
||||||
|
link_it(test_base, obj_list)
|
||||||
|
|
||||||
|
# Execute unit test and generate results file
|
||||||
|
simulator = build_simulator_fields
|
||||||
|
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
|
||||||
|
cmd_str = if simulator.nil?
|
||||||
|
executable
|
||||||
|
else
|
||||||
|
"#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
||||||
|
end
|
||||||
|
output = execute(cmd_str, true, false)
|
||||||
|
test_results = $cfg['compiler']['build_path'] + test_base
|
||||||
|
test_results += if output.match(/OK$/m).nil?
|
||||||
|
'.testfail'
|
||||||
|
else
|
||||||
|
'.testpass'
|
||||||
|
end
|
||||||
|
File.open(test_results, 'w') { |f| f.print output }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def build_application(main)
|
||||||
|
report 'Building application...'
|
||||||
|
|
||||||
|
obj_list = []
|
||||||
|
load_configuration($cfg_file)
|
||||||
|
main_path = $cfg['compiler']['source_path'] + main + C_EXTENSION
|
||||||
|
|
||||||
|
# Detect dependencies and build required required modules
|
||||||
|
include_dirs = get_local_include_dirs
|
||||||
|
extract_headers(main_path).each do |header|
|
||||||
|
src_file = find_source_file(header, include_dirs)
|
||||||
|
obj_list << compile(src_file) unless src_file.nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
# Build the main source file
|
||||||
|
main_base = File.basename(main_path, C_EXTENSION)
|
||||||
|
obj_list << compile(main_path)
|
||||||
|
|
||||||
|
# Create the executable
|
||||||
|
link_it(main_base, obj_list)
|
||||||
|
end
|
||||||
|
|
||||||
|
def fail_out(msg)
|
||||||
|
puts msg
|
||||||
|
puts 'Not returning exit code so continuous integration can pass'
|
||||||
|
# exit(-1) # Only removed to pass example_3, which has failing tests on purpose.
|
||||||
|
# Still fail if the build fails for any other reason.
|
||||||
|
end
|
||||||
|
|||||||
@@ -4,16 +4,10 @@ Example 3
|
|||||||
This example project gives an example of some passing, ignored, and failing tests.
|
This example project gives an example of some passing, ignored, and failing tests.
|
||||||
It's simple and meant for you to look over and get an idea for what all of this stuff does.
|
It's simple and meant for you to look over and get an idea for what all of this stuff does.
|
||||||
|
|
||||||
You can build and test using the makefile if you have gcc installed (you may need to tweak
|
You can build and test using rake. The rake version will let you test with gcc or a couple
|
||||||
the locations of some tools in the makefile). Otherwise, the rake version will let you
|
versions of IAR. You can tweak the yaml files to get those versions running.
|
||||||
test with gcc or a couple versions of IAR. You can tweak the yaml files to get those versions
|
|
||||||
running.
|
|
||||||
|
|
||||||
Ruby is required if you're using the rake version (obviously). This version shows off most of
|
Ruby is required if you're using the rake version (obviously). This version shows off most of
|
||||||
Unity's advanced features (automatically creating test runners, fancy summaries, etc.)
|
Unity's advanced features (automatically creating test runners, fancy summaries, etc.)
|
||||||
|
Without ruby, you have to maintain your own test runners. Do that for a while and you'll learn
|
||||||
The makefile version doesn't require anything outside of your normal build tools, but won't do the
|
why you really want to start using the Ruby tools.
|
||||||
extras for you. So that you can test right away, we've written the test runners for you and
|
|
||||||
put them in the test\no_ruby subdirectory. If you make changes to the tests or source, you might
|
|
||||||
need to update these (like when you add or remove tests). Do that for a while and you'll learn
|
|
||||||
why you really want to start using the Ruby tools.
|
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
# Copied from ~Unity/targets/gcc_32.yml
|
# Copied from ~Unity/targets/gcc_32.yml
|
||||||
unity_root: &unity_root '../..'
|
unity_root: &unity_root '../..'
|
||||||
|
unity_source: &unity_source '../../src/'
|
||||||
compiler:
|
compiler:
|
||||||
path: gcc
|
path: gcc
|
||||||
source_path: 'src/'
|
source_path: &source_path 'src/'
|
||||||
unit_tests_path: &unit_tests_path 'test/'
|
unit_tests_path: &unit_tests_path 'test/'
|
||||||
build_path: &build_path 'build/'
|
build_path: &build_path 'build/'
|
||||||
options:
|
options:
|
||||||
@@ -15,8 +16,8 @@ compiler:
|
|||||||
includes:
|
includes:
|
||||||
prefix: '-I'
|
prefix: '-I'
|
||||||
items:
|
items:
|
||||||
- 'src/'
|
- *source_path
|
||||||
- '../../src/'
|
- *unity_source
|
||||||
- *unit_tests_path
|
- *unit_tests_path
|
||||||
defines:
|
defines:
|
||||||
prefix: '-D'
|
prefix: '-D'
|
||||||
|
|||||||
17
examples/example_4/meson.build
Normal file
17
examples/example_4/meson.build
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
###################################################################################
|
||||||
|
# #
|
||||||
|
# NAME: meson.build #
|
||||||
|
# #
|
||||||
|
# AUTHOR: Mike Karlesky, Mark VanderVoord, Greg Williams. #
|
||||||
|
# WRITTEN BY: Michael Brockus. #
|
||||||
|
# #
|
||||||
|
# License: MIT #
|
||||||
|
# #
|
||||||
|
###################################################################################
|
||||||
|
|
||||||
|
project('example-4', 'c')
|
||||||
|
|
||||||
|
unity_dep = dependency('unity', fallback : ['unity', 'unity_dep'])
|
||||||
|
|
||||||
|
subdir('src')
|
||||||
|
subdir('test')
|
||||||
15
examples/example_4/readme.txt
Normal file
15
examples/example_4/readme.txt
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
Example 4
|
||||||
|
=========
|
||||||
|
|
||||||
|
Close to the simplest possible example of Unity, using only basic features.
|
||||||
|
to build this example run "meson setup <build dir name>".
|
||||||
|
|
||||||
|
Meson uses the Ninja build system to actually build the code. To start the
|
||||||
|
build, simply type the following command.
|
||||||
|
|
||||||
|
"ninja -C <build dir name>"
|
||||||
|
|
||||||
|
Meson provides native support for running tests. The command to do that is simple.
|
||||||
|
|
||||||
|
"meson test -C <build dir name>".
|
||||||
|
|
||||||
24
examples/example_4/src/ProductionCode.c
Normal file
24
examples/example_4/src/ProductionCode.c
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
|
||||||
|
#include "ProductionCode.h"
|
||||||
|
|
||||||
|
int Counter = 0;
|
||||||
|
int NumbersToFind[9] = { 0, 34, 55, 66, 32, 11, 1, 77, 888 }; /* some obnoxious array to search that is 1-based indexing instead of 0. */
|
||||||
|
|
||||||
|
/* This function is supposed to search through NumbersToFind and find a particular number.
|
||||||
|
* If it finds it, the index is returned. Otherwise 0 is returned which sorta makes sense since
|
||||||
|
* NumbersToFind is indexed from 1. Unfortunately it's broken
|
||||||
|
* (and should therefore be caught by our tests) */
|
||||||
|
int FindFunction_WhichIsBroken(int NumberToFind)
|
||||||
|
{
|
||||||
|
int i = 0;
|
||||||
|
while (i < 8) /* Notice I should have been in braces */
|
||||||
|
i++;
|
||||||
|
if (NumbersToFind[i] == NumberToFind) /* Yikes! I'm getting run after the loop finishes instead of during it! */
|
||||||
|
return i;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
int FunctionWhichReturnsLocalVariable(void)
|
||||||
|
{
|
||||||
|
return Counter;
|
||||||
|
}
|
||||||
3
examples/example_4/src/ProductionCode.h
Normal file
3
examples/example_4/src/ProductionCode.h
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
|
||||||
|
int FindFunction_WhichIsBroken(int NumberToFind);
|
||||||
|
int FunctionWhichReturnsLocalVariable(void);
|
||||||
11
examples/example_4/src/ProductionCode2.c
Normal file
11
examples/example_4/src/ProductionCode2.c
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
|
||||||
|
#include "ProductionCode2.h"
|
||||||
|
|
||||||
|
char* ThisFunctionHasNotBeenTested(int Poor, char* LittleFunction)
|
||||||
|
{
|
||||||
|
(void)Poor;
|
||||||
|
(void)LittleFunction;
|
||||||
|
/* Since There Are No Tests Yet, This Function Could Be Empty For All We Know.
|
||||||
|
* Which isn't terribly useful... but at least we put in a TEST_IGNORE so we won't forget */
|
||||||
|
return (char*)0;
|
||||||
|
}
|
||||||
2
examples/example_4/src/ProductionCode2.h
Normal file
2
examples/example_4/src/ProductionCode2.h
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
|
||||||
|
char* ThisFunctionHasNotBeenTested(int Poor, char* LittleFunction);
|
||||||
21
examples/example_4/src/meson.build
Normal file
21
examples/example_4/src/meson.build
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
###################################################################################
|
||||||
|
# #
|
||||||
|
# NAME: meson.build #
|
||||||
|
# #
|
||||||
|
# AUTHOR: Mike Karlesky, Mark VanderVoord, Greg Williams. #
|
||||||
|
# WRITTEN BY: Michael Brockus. #
|
||||||
|
# #
|
||||||
|
# License: MIT #
|
||||||
|
# #
|
||||||
|
###################################################################################
|
||||||
|
|
||||||
|
inc_dir = include_directories('.')
|
||||||
|
lib_list = {'a': ['ProductionCode.c' ], 'b': ['ProductionCode2.c']}
|
||||||
|
|
||||||
|
foreach lib, src : lib_list
|
||||||
|
set_variable(lib + '_lib',
|
||||||
|
static_library(lib + '_lib', sources: src, include_directories: inc_dir))
|
||||||
|
endforeach
|
||||||
|
|
||||||
|
a_dep = declare_dependency(link_with: a_lib, include_directories: inc_dir)
|
||||||
|
b_dep = declare_dependency(link_with: b_lib, include_directories: inc_dir)
|
||||||
4
examples/example_4/subprojects/unity.wrap
Executable file
4
examples/example_4/subprojects/unity.wrap
Executable file
@@ -0,0 +1,4 @@
|
|||||||
|
[wrap-git]
|
||||||
|
directory = unity
|
||||||
|
url = https://github.com/ThrowTheSwitch/Unity.git
|
||||||
|
revision = head
|
||||||
63
examples/example_4/test/TestProductionCode.c
Normal file
63
examples/example_4/test/TestProductionCode.c
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
|
||||||
|
#include "ProductionCode.h"
|
||||||
|
#include "unity.h"
|
||||||
|
|
||||||
|
/* sometimes you may want to get at local data in a module.
|
||||||
|
* for example: If you plan to pass by reference, this could be useful
|
||||||
|
* however, it should often be avoided */
|
||||||
|
extern int Counter;
|
||||||
|
|
||||||
|
void setUp(void)
|
||||||
|
{
|
||||||
|
/* This is run before EACH TEST */
|
||||||
|
Counter = 0x5a5a;
|
||||||
|
}
|
||||||
|
|
||||||
|
void tearDown(void)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
void test_FindFunction_WhichIsBroken_ShouldReturnZeroIfItemIsNotInList_WhichWorksEvenInOurBrokenCode(void)
|
||||||
|
{
|
||||||
|
/* All of these should pass */
|
||||||
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(78));
|
||||||
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(2));
|
||||||
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(33));
|
||||||
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(999));
|
||||||
|
TEST_ASSERT_EQUAL(0, FindFunction_WhichIsBroken(-1));
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_FindFunction_WhichIsBroken_ShouldReturnTheIndexForItemsInList_WhichWillFailBecauseOurFunctionUnderTestIsBroken(void)
|
||||||
|
{
|
||||||
|
/* You should see this line fail in your test summary */
|
||||||
|
TEST_ASSERT_EQUAL(1, FindFunction_WhichIsBroken(34));
|
||||||
|
|
||||||
|
/* Notice the rest of these didn't get a chance to run because the line above failed.
|
||||||
|
* Unit tests abort each test function on the first sign of trouble.
|
||||||
|
* Then NEXT test function runs as normal. */
|
||||||
|
TEST_ASSERT_EQUAL(8, FindFunction_WhichIsBroken(8888));
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValue(void)
|
||||||
|
{
|
||||||
|
/* This should be true because setUp set this up for us before this test */
|
||||||
|
TEST_ASSERT_EQUAL_HEX(0x5a5a, FunctionWhichReturnsLocalVariable());
|
||||||
|
|
||||||
|
/* This should be true because we can still change our answer */
|
||||||
|
Counter = 0x1234;
|
||||||
|
TEST_ASSERT_EQUAL_HEX(0x1234, FunctionWhichReturnsLocalVariable());
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValueAgain(void)
|
||||||
|
{
|
||||||
|
/* This should be true again because setup was rerun before this test (and after we changed it to 0x1234) */
|
||||||
|
TEST_ASSERT_EQUAL_HEX(0x5a5a, FunctionWhichReturnsLocalVariable());
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_FunctionWhichReturnsLocalVariable_ShouldReturnCurrentCounter_ButFailsBecauseThisTestIsActuallyFlawed(void)
|
||||||
|
{
|
||||||
|
/* Sometimes you get the test wrong. When that happens, you get a failure too... and a quick look should tell
|
||||||
|
* you what actually happened...which in this case was a failure to setup the initial condition. */
|
||||||
|
TEST_ASSERT_EQUAL_HEX(0x1234, FunctionWhichReturnsLocalVariable());
|
||||||
|
}
|
||||||
35
examples/example_4/test/TestProductionCode2.c
Normal file
35
examples/example_4/test/TestProductionCode2.c
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
|
||||||
|
#include "ProductionCode2.h"
|
||||||
|
#include "unity.h"
|
||||||
|
|
||||||
|
/* These should be ignored because they are commented out in various ways:
|
||||||
|
#include "whatever.h"
|
||||||
|
#include "somethingelse.h"
|
||||||
|
*/
|
||||||
|
|
||||||
|
void setUp(void)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void tearDown(void)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_IgnoredTest(void);
|
||||||
|
void test_AnotherIgnoredTest(void);
|
||||||
|
void test_ThisFunctionHasNotBeenTested_NeedsToBeImplemented(void);
|
||||||
|
|
||||||
|
void test_IgnoredTest(void)
|
||||||
|
{
|
||||||
|
TEST_IGNORE_MESSAGE("This Test Was Ignored On Purpose");
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_AnotherIgnoredTest(void)
|
||||||
|
{
|
||||||
|
TEST_IGNORE_MESSAGE("These Can Be Useful For Leaving Yourself Notes On What You Need To Do Yet");
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_ThisFunctionHasNotBeenTested_NeedsToBeImplemented(void)
|
||||||
|
{
|
||||||
|
TEST_IGNORE(); /* Like This */
|
||||||
|
}
|
||||||
12
examples/example_4/test/meson.build
Normal file
12
examples/example_4/test/meson.build
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
###################################################################################
|
||||||
|
# #
|
||||||
|
# NAME: meson.build #
|
||||||
|
# #
|
||||||
|
# AUTHOR: Mike Karlesky, Mark VanderVoord, Greg Williams. #
|
||||||
|
# WRITTEN BY: Michael Brockus. #
|
||||||
|
# #
|
||||||
|
# License: MIT #
|
||||||
|
# #
|
||||||
|
###################################################################################
|
||||||
|
|
||||||
|
subdir('test_runners')
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
/* AUTOGENERATED FILE. DO NOT EDIT. */
|
||||||
|
|
||||||
|
/*=======Test Runner Used To Run Each Test Below=====*/
|
||||||
|
#define RUN_TEST(TestFunc, TestLineNum) \
|
||||||
|
{ \
|
||||||
|
Unity.CurrentTestName = #TestFunc; \
|
||||||
|
Unity.CurrentTestLineNumber = TestLineNum; \
|
||||||
|
Unity.NumberOfTests++; \
|
||||||
|
if (TEST_PROTECT()) \
|
||||||
|
{ \
|
||||||
|
setUp(); \
|
||||||
|
TestFunc(); \
|
||||||
|
} \
|
||||||
|
if (TEST_PROTECT()) \
|
||||||
|
{ \
|
||||||
|
tearDown(); \
|
||||||
|
} \
|
||||||
|
UnityConcludeTest(); \
|
||||||
|
}
|
||||||
|
|
||||||
|
/*=======Automagically Detected Files To Include=====*/
|
||||||
|
#include "unity.h"
|
||||||
|
#include <setjmp.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include "ProductionCode2.h"
|
||||||
|
|
||||||
|
/*=======External Functions This Runner Calls=====*/
|
||||||
|
extern void setUp(void);
|
||||||
|
extern void tearDown(void);
|
||||||
|
extern void test_IgnoredTest(void);
|
||||||
|
extern void test_AnotherIgnoredTest(void);
|
||||||
|
extern void test_ThisFunctionHasNotBeenTested_NeedsToBeImplemented(void);
|
||||||
|
|
||||||
|
|
||||||
|
/*=======Test Reset Option=====*/
|
||||||
|
void resetTest(void);
|
||||||
|
void resetTest(void)
|
||||||
|
{
|
||||||
|
tearDown();
|
||||||
|
setUp();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/*=======MAIN=====*/
|
||||||
|
int main(void)
|
||||||
|
{
|
||||||
|
UnityBegin("test/TestProductionCode2.c");
|
||||||
|
RUN_TEST(test_IgnoredTest, 18);
|
||||||
|
RUN_TEST(test_AnotherIgnoredTest, 23);
|
||||||
|
RUN_TEST(test_ThisFunctionHasNotBeenTested_NeedsToBeImplemented, 28);
|
||||||
|
|
||||||
|
return (UnityEnd());
|
||||||
|
}
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
/* AUTOGENERATED FILE. DO NOT EDIT. */
|
||||||
|
|
||||||
|
/*=======Test Runner Used To Run Each Test Below=====*/
|
||||||
|
#define RUN_TEST(TestFunc, TestLineNum) \
|
||||||
|
{ \
|
||||||
|
Unity.CurrentTestName = #TestFunc; \
|
||||||
|
Unity.CurrentTestLineNumber = TestLineNum; \
|
||||||
|
Unity.NumberOfTests++; \
|
||||||
|
if (TEST_PROTECT()) \
|
||||||
|
{ \
|
||||||
|
setUp(); \
|
||||||
|
TestFunc(); \
|
||||||
|
} \
|
||||||
|
if (TEST_PROTECT()) \
|
||||||
|
{ \
|
||||||
|
tearDown(); \
|
||||||
|
} \
|
||||||
|
UnityConcludeTest(); \
|
||||||
|
}
|
||||||
|
|
||||||
|
/*=======Automagically Detected Files To Include=====*/
|
||||||
|
#include "unity.h"
|
||||||
|
#include <setjmp.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include "ProductionCode.h"
|
||||||
|
|
||||||
|
/*=======External Functions This Runner Calls=====*/
|
||||||
|
extern void setUp(void);
|
||||||
|
extern void tearDown(void);
|
||||||
|
extern void test_FindFunction_WhichIsBroken_ShouldReturnZeroIfItemIsNotInList_WhichWorksEvenInOurBrokenCode(void);
|
||||||
|
extern void test_FindFunction_WhichIsBroken_ShouldReturnTheIndexForItemsInList_WhichWillFailBecauseOurFunctionUnderTestIsBroken(void);
|
||||||
|
extern void test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValue(void);
|
||||||
|
extern void test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValueAgain(void);
|
||||||
|
extern void test_FunctionWhichReturnsLocalVariable_ShouldReturnCurrentCounter_ButFailsBecauseThisTestIsActuallyFlawed(void);
|
||||||
|
|
||||||
|
|
||||||
|
/*=======Test Reset Option=====*/
|
||||||
|
void resetTest(void);
|
||||||
|
void resetTest(void)
|
||||||
|
{
|
||||||
|
tearDown();
|
||||||
|
setUp();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/*=======MAIN=====*/
|
||||||
|
int main(void)
|
||||||
|
{
|
||||||
|
UnityBegin("test/TestProductionCode.c");
|
||||||
|
RUN_TEST(test_FindFunction_WhichIsBroken_ShouldReturnZeroIfItemIsNotInList_WhichWorksEvenInOurBrokenCode, 20);
|
||||||
|
RUN_TEST(test_FindFunction_WhichIsBroken_ShouldReturnTheIndexForItemsInList_WhichWillFailBecauseOurFunctionUnderTestIsBroken, 30);
|
||||||
|
RUN_TEST(test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValue, 41);
|
||||||
|
RUN_TEST(test_FunctionWhichReturnsLocalVariable_ShouldReturnTheCurrentCounterValueAgain, 51);
|
||||||
|
RUN_TEST(test_FunctionWhichReturnsLocalVariable_ShouldReturnCurrentCounter_ButFailsBecauseThisTestIsActuallyFlawed, 57);
|
||||||
|
|
||||||
|
return (UnityEnd());
|
||||||
|
}
|
||||||
16
examples/example_4/test/test_runners/meson.build
Normal file
16
examples/example_4/test/test_runners/meson.build
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
###################################################################################
|
||||||
|
# #
|
||||||
|
# NAME: meson.build #
|
||||||
|
# #
|
||||||
|
# AUTHOR: Mike Karlesky, Mark VanderVoord, Greg Williams. #
|
||||||
|
# WRITTEN BY: Michael Brockus. #
|
||||||
|
# #
|
||||||
|
# License: MIT #
|
||||||
|
# #
|
||||||
|
###################################################################################
|
||||||
|
|
||||||
|
cases = [['TestProductionCode_Runner.c', join_paths('..' ,'TestProductionCode.c')],
|
||||||
|
['TestProductionCode2_Runner.c', join_paths('..' ,'TestProductionCode2.c')]]
|
||||||
|
|
||||||
|
test('Running: 01-test-case', executable('01-test-case', cases[0], dependencies: [ a_dep, unity_dep ]))
|
||||||
|
test('Running: 02-test-case', executable('02-test-case', cases[1], dependencies: [ b_dep, unity_dep ]))
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
/* Unity Configuration
|
/* Unity Configuration
|
||||||
* As of May 11th, 2016 at ThrowTheSwitch/Unity commit 837c529
|
* As of May 11th, 2016 at ThrowTheSwitch/Unity commit 837c529
|
||||||
* Update: August 25th, 2016
|
* Update: December 29th, 2016
|
||||||
* See Also: Unity/docs/UnityConfigurationGuide.pdf
|
* See Also: Unity/docs/UnityConfigurationGuide.pdf
|
||||||
*
|
*
|
||||||
* Unity is designed to run on almost anything that is targeted by a C compiler.
|
* Unity is designed to run on almost anything that is targeted by a C compiler.
|
||||||
@@ -37,11 +37,6 @@
|
|||||||
#ifndef UNITY_CONFIG_H
|
#ifndef UNITY_CONFIG_H
|
||||||
#define UNITY_CONFIG_H
|
#define UNITY_CONFIG_H
|
||||||
|
|
||||||
#ifdef __cplusplus
|
|
||||||
extern "C"
|
|
||||||
{
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* ************************* AUTOMATIC INTEGER TYPES ***************************
|
/* ************************* AUTOMATIC INTEGER TYPES ***************************
|
||||||
* C's concept of an integer varies from target to target. The C Standard has
|
* C's concept of an integer varies from target to target. The C Standard has
|
||||||
* rules about the `int` matching the register size of the target
|
* rules about the `int` matching the register size of the target
|
||||||
@@ -122,10 +117,9 @@ extern "C"
|
|||||||
|
|
||||||
/* By default, Unity guesses that you will want single precision floating point
|
/* By default, Unity guesses that you will want single precision floating point
|
||||||
* support, but not double precision. It's easy to change either of these using
|
* support, but not double precision. It's easy to change either of these using
|
||||||
* the include and exclude options here. You may include neither, either, or
|
* the include and exclude options here. You may include neither, just float,
|
||||||
* both, as suits your needs.
|
* or both, as suits your needs.
|
||||||
*/
|
*/
|
||||||
/* #define UNITY_INCLUDE_FLOAT */
|
|
||||||
/* #define UNITY_EXCLUDE_FLOAT */
|
/* #define UNITY_EXCLUDE_FLOAT */
|
||||||
/* #define UNITY_INCLUDE_DOUBLE */
|
/* #define UNITY_INCLUDE_DOUBLE */
|
||||||
/* #define UNITY_EXCLUDE_DOUBLE */
|
/* #define UNITY_EXCLUDE_DOUBLE */
|
||||||
@@ -137,18 +131,15 @@ extern "C"
|
|||||||
/* Unity aims for as small of a footprint as possible and avoids most standard
|
/* Unity aims for as small of a footprint as possible and avoids most standard
|
||||||
* library calls (some embedded platforms don't have a standard library!).
|
* library calls (some embedded platforms don't have a standard library!).
|
||||||
* Because of this, its routines for printing integer values are minimalist and
|
* Because of this, its routines for printing integer values are minimalist and
|
||||||
* hand-coded. To keep Unity universal, though, we chose to _not_ develop our
|
* hand-coded. To keep Unity universal, though, we eventually chose to develop
|
||||||
* own floating point print routines. Instead, the display of floating point
|
* our own floating point print routines. Still, the display of floating point
|
||||||
* values during a failure are optional. By default, Unity will not print the
|
* values during a failure are optional. By default, Unity will print the
|
||||||
* actual results of floating point assertion failure. So a failed assertion
|
* actual results of floating point assertion failures. So a failed assertion
|
||||||
* will produce a message like `"Values Not Within Delta"`. If you would like
|
* will produce a message like "Expected 4.0 Was 4.25". If you would like less
|
||||||
* verbose failure messages for floating point assertions, use these options to
|
* verbose failure messages for floating point assertions, use this option to
|
||||||
* give more explicit failure messages (e.g. `"Expected 4.56 Was 4.68"`). Note
|
* give a failure message `"Values Not Within Delta"` and trim the binary size.
|
||||||
* that this feature requires the use of `sprintf` so might not be desirable in
|
|
||||||
* all cases.
|
|
||||||
*/
|
*/
|
||||||
/* #define UNITY_FLOAT_VERBOSE */
|
/* #define UNITY_EXCLUDE_FLOAT_PRINT */
|
||||||
/* #define UNITY_DOUBLE_VERBOSE */
|
|
||||||
|
|
||||||
/* If enabled, Unity assumes you want your `FLOAT` asserts to compare standard C
|
/* If enabled, Unity assumes you want your `FLOAT` asserts to compare standard C
|
||||||
* floats. If your compiler supports a specialty floating point type, you can
|
* floats. If your compiler supports a specialty floating point type, you can
|
||||||
@@ -185,6 +176,22 @@ extern "C"
|
|||||||
/* #define UNITY_DOUBLE_PRECISION 0.001f */
|
/* #define UNITY_DOUBLE_PRECISION 0.001f */
|
||||||
|
|
||||||
|
|
||||||
|
/* *************************** MISCELLANEOUS ***********************************
|
||||||
|
* Miscellaneous configuration options for Unity
|
||||||
|
**************************************************************************** */
|
||||||
|
|
||||||
|
/* Unity uses the stddef.h header included in the C standard library for the
|
||||||
|
* "NULL" macro. Define this in order to disable the include of stddef.h. If you
|
||||||
|
* do this, you have to make sure to provide your own "NULL" definition.
|
||||||
|
*/
|
||||||
|
/* #define UNITY_EXCLUDE_STDDEF_H */
|
||||||
|
|
||||||
|
/* Define this to enable the unity formatted print function:
|
||||||
|
* "UnityPrintFormatted"
|
||||||
|
*/
|
||||||
|
/* #define UNITY_INCLUDE_PRINT_FORMATTED */
|
||||||
|
|
||||||
|
|
||||||
/* *************************** TOOLSET CUSTOMIZATION ***************************
|
/* *************************** TOOLSET CUSTOMIZATION ***************************
|
||||||
* In addition to the options listed above, there are a number of other options
|
* In addition to the options listed above, there are a number of other options
|
||||||
* which will come in handy to customize Unity's behavior for your specific
|
* which will come in handy to customize Unity's behavior for your specific
|
||||||
@@ -210,10 +217,12 @@ extern "C"
|
|||||||
* `stdout` option. You decide to route your test result output to a custom
|
* `stdout` option. You decide to route your test result output to a custom
|
||||||
* serial `RS232_putc()` function you wrote like thus:
|
* serial `RS232_putc()` function you wrote like thus:
|
||||||
*/
|
*/
|
||||||
/* #define UNITY_OUTPUT_CHAR(a) RS232_putc(a) */
|
/* #define UNITY_OUTPUT_CHAR(a) RS232_putc(a) */
|
||||||
/* #define UNITY_OUTPUT_FLUSH() RS232_config(115200,1,8,0) */
|
/* #define UNITY_OUTPUT_CHAR_HEADER_DECLARATION RS232_putc(int) */
|
||||||
/* #define UNITY_OUTPUT_START() RS232_flush() */
|
/* #define UNITY_OUTPUT_FLUSH() RS232_flush() */
|
||||||
/* #define UNITY_OUTPUT_COMPLETE() RS232_close() */
|
/* #define UNITY_OUTPUT_FLUSH_HEADER_DECLARATION RS232_flush(void) */
|
||||||
|
/* #define UNITY_OUTPUT_START() RS232_config(115200,1,8,0) */
|
||||||
|
/* #define UNITY_OUTPUT_COMPLETE() RS232_close() */
|
||||||
|
|
||||||
/* For some targets, Unity can make the otherwise required `setUp()` and
|
/* For some targets, Unity can make the otherwise required `setUp()` and
|
||||||
* `tearDown()` functions optional. This is a nice convenience for test writers
|
* `tearDown()` functions optional. This is a nice convenience for test writers
|
||||||
@@ -232,6 +241,7 @@ extern "C"
|
|||||||
*/
|
*/
|
||||||
/* #define UNITY_SUPPORT_WEAK weak */
|
/* #define UNITY_SUPPORT_WEAK weak */
|
||||||
/* #define UNITY_SUPPORT_WEAK __attribute__((weak)) */
|
/* #define UNITY_SUPPORT_WEAK __attribute__((weak)) */
|
||||||
|
/* #define UNITY_NO_WEAK */
|
||||||
|
|
||||||
/* Some compilers require a custom attribute to be assigned to pointers, like
|
/* Some compilers require a custom attribute to be assigned to pointers, like
|
||||||
* `near` or `far`. In these cases, you can give Unity a safe default for these
|
* `near` or `far`. In these cases, you can give Unity a safe default for these
|
||||||
@@ -242,8 +252,12 @@ extern "C"
|
|||||||
/* #define UNITY_PTR_ATTRIBUTE __attribute__((far)) */
|
/* #define UNITY_PTR_ATTRIBUTE __attribute__((far)) */
|
||||||
/* #define UNITY_PTR_ATTRIBUTE near */
|
/* #define UNITY_PTR_ATTRIBUTE near */
|
||||||
|
|
||||||
#ifdef __cplusplus
|
/* Print execution time of each test when executed in verbose mode
|
||||||
}
|
*
|
||||||
#endif /* extern "C" */
|
* Example:
|
||||||
|
*
|
||||||
|
* TEST - PASS (10 ms)
|
||||||
|
*/
|
||||||
|
/* #define UNITY_INCLUDE_EXEC_TIME */
|
||||||
|
|
||||||
#endif /* UNITY_CONFIG_H */
|
#endif /* UNITY_CONFIG_H */
|
||||||
|
|||||||
@@ -4,42 +4,38 @@
|
|||||||
# [Released under MIT License. Please refer to license.txt for details]
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
HERE = File.expand_path(File.dirname(__FILE__)) + '/'
|
|
||||||
|
|
||||||
require 'rake'
|
require 'rake'
|
||||||
require 'rake/clean'
|
require 'rake/clean'
|
||||||
require 'rake/testtask'
|
require 'rake/testtask'
|
||||||
require HERE + 'rakefile_helper'
|
require_relative 'rakefile_helper'
|
||||||
|
|
||||||
TEMP_DIRS = [
|
TEMP_DIRS = [
|
||||||
File.join(HERE, 'build')
|
File.join(__dir__, 'build')
|
||||||
]
|
].freeze
|
||||||
|
|
||||||
TEMP_DIRS.each do |dir|
|
TEMP_DIRS.each do |dir|
|
||||||
directory(dir)
|
directory(dir)
|
||||||
CLOBBER.include(dir)
|
CLOBBER.include(dir)
|
||||||
end
|
end
|
||||||
|
|
||||||
task :prepare_for_tests => TEMP_DIRS
|
task prepare_for_tests: TEMP_DIRS
|
||||||
|
|
||||||
include RakefileHelpers
|
|
||||||
|
|
||||||
# Load default configuration, for now
|
# Load default configuration, for now
|
||||||
DEFAULT_CONFIG_FILE = 'gcc_auto_stdint.yml'
|
DEFAULT_CONFIG_FILE = 'gcc_auto_stdint.yml'.freeze
|
||||||
configure_toolchain(DEFAULT_CONFIG_FILE)
|
configure_toolchain(DEFAULT_CONFIG_FILE)
|
||||||
|
|
||||||
task :unit => [:prepare_for_tests] do
|
task unit: [:prepare_for_tests] do
|
||||||
run_tests
|
run_tests
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "Build and test Unity Framework"
|
desc 'Build and test Unity Framework'
|
||||||
task :all => [:clean, :unit]
|
task all: %i[clean unit]
|
||||||
task :default => [:clobber, :all]
|
task default: %i[clobber all]
|
||||||
task :ci => [:no_color, :default]
|
task ci: %i[no_color default]
|
||||||
task :cruise => [:no_color, :default]
|
task cruise: %i[no_color default]
|
||||||
|
|
||||||
desc "Load configuration"
|
desc 'Load configuration'
|
||||||
task :config, :config_file do |t, args|
|
task :config, :config_file do |_t, args|
|
||||||
configure_toolchain(args[:config_file])
|
configure_toolchain(args[:config_file])
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -6,174 +6,178 @@
|
|||||||
|
|
||||||
require 'yaml'
|
require 'yaml'
|
||||||
require 'fileutils'
|
require 'fileutils'
|
||||||
require HERE+'../../auto/unity_test_summary'
|
require 'rbconfig'
|
||||||
require HERE+'../../auto/generate_test_runner'
|
require_relative '../../auto/unity_test_summary'
|
||||||
require HERE+'../../auto/colour_reporter'
|
require_relative '../../auto/generate_test_runner'
|
||||||
|
require_relative '../../auto/colour_reporter'
|
||||||
|
|
||||||
module RakefileHelpers
|
$is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
|
||||||
|
|
||||||
C_EXTENSION = '.c'
|
C_EXTENSION = '.c'.freeze
|
||||||
|
|
||||||
def load_configuration(config_file)
|
def load_configuration(config_file)
|
||||||
unless ($configured)
|
return if $configured
|
||||||
$cfg_file = HERE+"../../test/targets/#{config_file}" unless (config_file =~ /[\\|\/]/)
|
|
||||||
$cfg = YAML.load(File.read($cfg_file))
|
|
||||||
$colour_output = false unless $cfg['colour']
|
|
||||||
$configured = true if (config_file != DEFAULT_CONFIG_FILE)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def configure_clean
|
$cfg_file = "#{__dir__}/../../test/targets/#{config_file}" unless config_file =~ /[\\|\/]/
|
||||||
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
|
$cfg = YAML.load(File.read($cfg_file))
|
||||||
end
|
$colour_output = false unless $cfg['colour']
|
||||||
|
$configured = true if config_file != DEFAULT_CONFIG_FILE
|
||||||
def configure_toolchain(config_file=DEFAULT_CONFIG_FILE)
|
end
|
||||||
config_file += '.yml' unless config_file =~ /\.yml$/
|
|
||||||
config_file = config_file unless config_file =~ /[\\|\/]/
|
def configure_clean
|
||||||
load_configuration(config_file)
|
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
|
||||||
configure_clean
|
end
|
||||||
end
|
|
||||||
|
def configure_toolchain(config_file = DEFAULT_CONFIG_FILE)
|
||||||
def tackit(strings)
|
config_file += '.yml' unless config_file =~ /\.yml$/
|
||||||
if strings.is_a?(Array)
|
config_file = config_file unless config_file =~ /[\\|\/]/
|
||||||
result = "\"#{strings.join}\""
|
load_configuration(config_file)
|
||||||
else
|
configure_clean
|
||||||
result = strings
|
end
|
||||||
end
|
|
||||||
return result
|
def tackit(strings)
|
||||||
end
|
result = if strings.is_a?(Array)
|
||||||
|
"\"#{strings.join}\""
|
||||||
def squash(prefix, items)
|
else
|
||||||
result = ''
|
strings
|
||||||
items.each { |item| result += " #{prefix}#{tackit(item)}" }
|
end
|
||||||
return result
|
result
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_compiler_fields
|
def squash(prefix, items)
|
||||||
command = tackit($cfg['compiler']['path'])
|
result = ''
|
||||||
if $cfg['compiler']['defines']['items'].nil?
|
items.each { |item| result += " #{prefix}#{tackit(item)}" }
|
||||||
defines = ''
|
result
|
||||||
else
|
end
|
||||||
defines = squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'] + ['UNITY_OUTPUT_CHAR=UnityOutputCharSpy_OutputChar'])
|
|
||||||
end
|
def build_compiler_fields
|
||||||
options = squash('', $cfg['compiler']['options'])
|
command = tackit($cfg['compiler']['path'])
|
||||||
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
|
defines = if $cfg['compiler']['defines']['items'].nil?
|
||||||
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
''
|
||||||
return {:command => command, :defines => defines, :options => options, :includes => includes}
|
else
|
||||||
end
|
squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'])
|
||||||
|
end
|
||||||
def compile(file, defines=[])
|
options = squash('', $cfg['compiler']['options'])
|
||||||
compiler = build_compiler_fields
|
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
|
||||||
unity_include = $cfg['compiler']['includes']['prefix']+'../../src'
|
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
||||||
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{unity_include} #{file} " +
|
|
||||||
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}" +
|
{ command: command, defines: defines, options: options, includes: includes }
|
||||||
"#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
|
end
|
||||||
execute(cmd_str)
|
|
||||||
end
|
def compile(file, _defines = [])
|
||||||
|
compiler = build_compiler_fields
|
||||||
def build_linker_fields
|
unity_include = $cfg['compiler']['includes']['prefix'] + '../../src'
|
||||||
command = tackit($cfg['linker']['path'])
|
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{unity_include} #{file} " \
|
||||||
if $cfg['linker']['options'].nil?
|
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}" \
|
||||||
options = ''
|
"#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
|
||||||
else
|
|
||||||
options = squash('', $cfg['linker']['options'])
|
execute(cmd_str)
|
||||||
end
|
end
|
||||||
if ($cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?)
|
|
||||||
includes = ''
|
def build_linker_fields
|
||||||
else
|
command = tackit($cfg['linker']['path'])
|
||||||
includes = squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
|
options = if $cfg['linker']['options'].nil?
|
||||||
end
|
''
|
||||||
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
else
|
||||||
return {:command => command, :options => options, :includes => includes}
|
squash('', $cfg['linker']['options'])
|
||||||
end
|
end
|
||||||
|
includes = if $cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?
|
||||||
def link_it(exe_name, obj_list)
|
''
|
||||||
linker = build_linker_fields
|
else
|
||||||
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
|
squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
|
||||||
(obj_list.map{|obj|"#{$cfg['linker']['object_files']['path']}#{obj} "}).join +
|
end.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
||||||
$cfg['linker']['bin_files']['prefix'] + ' ' +
|
|
||||||
$cfg['linker']['bin_files']['destination'] +
|
{ command: command, options: options, includes: includes }
|
||||||
exe_name + $cfg['linker']['bin_files']['extension']
|
end
|
||||||
execute(cmd_str)
|
|
||||||
end
|
def link_it(exe_name, obj_list)
|
||||||
|
linker = build_linker_fields
|
||||||
def build_simulator_fields
|
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
|
||||||
return nil if $cfg['simulator'].nil?
|
(obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join +
|
||||||
if $cfg['simulator']['path'].nil?
|
$cfg['linker']['bin_files']['prefix'] + ' ' +
|
||||||
command = ''
|
$cfg['linker']['bin_files']['destination'] +
|
||||||
else
|
exe_name + $cfg['linker']['bin_files']['extension']
|
||||||
command = (tackit($cfg['simulator']['path']) + ' ')
|
execute(cmd_str)
|
||||||
end
|
end
|
||||||
if $cfg['simulator']['pre_support'].nil?
|
|
||||||
pre_support = ''
|
def build_simulator_fields
|
||||||
else
|
return nil if $cfg['simulator'].nil?
|
||||||
pre_support = squash('', $cfg['simulator']['pre_support'])
|
|
||||||
end
|
command = if $cfg['simulator']['path'].nil?
|
||||||
if $cfg['simulator']['post_support'].nil?
|
''
|
||||||
post_support = ''
|
else
|
||||||
else
|
(tackit($cfg['simulator']['path']) + ' ')
|
||||||
post_support = squash('', $cfg['simulator']['post_support'])
|
end
|
||||||
end
|
pre_support = if $cfg['simulator']['pre_support'].nil?
|
||||||
return {:command => command, :pre_support => pre_support, :post_support => post_support}
|
''
|
||||||
end
|
else
|
||||||
|
squash('', $cfg['simulator']['pre_support'])
|
||||||
def execute(command_string, verbose=true)
|
end
|
||||||
report command_string
|
post_support = if $cfg['simulator']['post_support'].nil?
|
||||||
output = `#{command_string}`.chomp
|
''
|
||||||
report(output) if (verbose && !output.nil? && (output.length > 0))
|
else
|
||||||
if ($?.exitstatus != 0)
|
squash('', $cfg['simulator']['post_support'])
|
||||||
raise "Command failed. (Returned #{$?.exitstatus})"
|
end
|
||||||
end
|
{ command: command, pre_support: pre_support, post_support: post_support }
|
||||||
return output
|
end
|
||||||
end
|
|
||||||
|
def execute(command_string, verbose = true)
|
||||||
def report_summary
|
report command_string
|
||||||
summary = UnityTestSummary.new
|
output = `#{command_string}`.chomp
|
||||||
summary.set_root_path(HERE)
|
report(output) if verbose && !output.nil? && !output.empty?
|
||||||
results_glob = "#{$cfg['compiler']['build_path']}*.test*"
|
|
||||||
results_glob.gsub!(/\\/, '/')
|
raise "Command failed. (Returned #{$?.exitstatus})" if $?.exitstatus != 0
|
||||||
results = Dir[results_glob]
|
|
||||||
summary.set_targets(results)
|
output
|
||||||
summary.run
|
end
|
||||||
end
|
|
||||||
|
def report_summary
|
||||||
def run_tests
|
summary = UnityTestSummary.new
|
||||||
report 'Running Unity system tests...'
|
summary.root = __dir__
|
||||||
|
results_glob = "#{$cfg['compiler']['build_path']}*.test*"
|
||||||
# Tack on TEST define for compiling unit tests
|
results_glob.tr!('\\', '/')
|
||||||
load_configuration($cfg_file)
|
results = Dir[results_glob]
|
||||||
test_defines = ['TEST']
|
summary.targets = results
|
||||||
$cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil?
|
summary.run
|
||||||
|
end
|
||||||
# Get a list of all source files needed
|
|
||||||
src_files = Dir[HERE+'src/*.c']
|
def run_tests
|
||||||
src_files += Dir[HERE+'test/*.c']
|
report 'Running Unity system tests...'
|
||||||
src_files += Dir[HERE+'test/main/*.c']
|
|
||||||
src_files << '../../src/unity.c'
|
# Tack on TEST define for compiling unit tests
|
||||||
|
load_configuration($cfg_file)
|
||||||
# Build object files
|
test_defines = ['TEST']
|
||||||
src_files.each { |f| compile(f, test_defines) }
|
$cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil?
|
||||||
obj_list = src_files.map {|f| File.basename(f.ext($cfg['compiler']['object_files']['extension'])) }
|
$cfg['compiler']['defines']['items'] << "UNITY_FIXTURE_NO_EXTRAS"
|
||||||
|
|
||||||
# Link the test executable
|
# Get a list of all source files needed
|
||||||
test_base = "framework_test"
|
src_files = Dir["#{__dir__}/src/*.c"]
|
||||||
link_it(test_base, obj_list)
|
src_files += Dir["#{__dir__}/test/*.c"]
|
||||||
|
src_files += Dir["#{__dir__}/test/main/*.c"]
|
||||||
# Execute unit test and generate results file
|
src_files << '../../src/unity.c'
|
||||||
simulator = build_simulator_fields
|
|
||||||
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
|
# Build object files
|
||||||
if simulator.nil?
|
src_files.each { |f| compile(f, test_defines) }
|
||||||
cmd_str = executable + " -v -r"
|
obj_list = src_files.map { |f| File.basename(f.ext($cfg['compiler']['object_files']['extension'])) }
|
||||||
else
|
|
||||||
cmd_str = "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
# Link the test executable
|
||||||
end
|
test_base = 'framework_test'
|
||||||
output = execute(cmd_str)
|
link_it(test_base, obj_list)
|
||||||
test_results = $cfg['compiler']['build_path'] + test_base
|
|
||||||
if output.match(/OK$/m).nil?
|
# Execute unit test and generate results file
|
||||||
test_results += '.testfail'
|
simulator = build_simulator_fields
|
||||||
else
|
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
|
||||||
test_results += '.testpass'
|
cmd_str = if simulator.nil?
|
||||||
end
|
executable + ' -v -r'
|
||||||
File.open(test_results, 'w') { |f| f.print output }
|
else
|
||||||
end
|
"#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
||||||
|
end
|
||||||
|
output = execute(cmd_str)
|
||||||
|
test_results = $cfg['compiler']['build_path'] + test_base
|
||||||
|
test_results += if output.match(/OK$/m).nil?
|
||||||
|
'.testfail'
|
||||||
|
else
|
||||||
|
'.testpass'
|
||||||
|
end
|
||||||
|
File.open(test_results, 'w') { |f| f.print output }
|
||||||
end
|
end
|
||||||
|
|||||||
17
extras/fixture/readme.md
Normal file
17
extras/fixture/readme.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# Unity Fixtures
|
||||||
|
|
||||||
|
This Framework is an optional add-on to Unity. By including unity_framework.h in place of unity.h,
|
||||||
|
you may now work with Unity in a manner similar to CppUTest. This framework adds the concepts of
|
||||||
|
test groups and gives finer control of your tests over the command line.
|
||||||
|
|
||||||
|
This framework is primarily supplied for those working through James Grenning's book on Embedded
|
||||||
|
Test Driven Development, or those coming to Unity from CppUTest. We should note that using this
|
||||||
|
framework glosses over some of the features of Unity, and makes it more difficult
|
||||||
|
to integrate with other testing tools like Ceedling and CMock.
|
||||||
|
|
||||||
|
# Dependency Notification
|
||||||
|
|
||||||
|
Fixtures, by default, uses the Memory addon as well. This is to make it simple for those trying to
|
||||||
|
follow along with James' book. Using them together is completely optional. You may choose to use
|
||||||
|
Fixtures without Memory handling by defining `UNITY_FIXTURE_NO_EXTRAS`. It will then stop automatically
|
||||||
|
pulling in extras and leave you to do it as desired.
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
Copyright (c) 2010 James Grenning and Contributed to Unity Project
|
|
||||||
|
|
||||||
Unity Project - A Test Framework for C
|
|
||||||
Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
|
||||||
[Released under MIT License. Please refer to license.txt for details]
|
|
||||||
|
|
||||||
This Framework is an optional add-on to Unity. By including unity_framework.h in place of unity.h,
|
|
||||||
you may now work with Unity in a manner similar to CppUTest. This framework adds the concepts of
|
|
||||||
test groups and gives finer control of your tests over the command line.
|
|
||||||
@@ -5,20 +5,18 @@
|
|||||||
* [Released under MIT License. Please refer to license.txt for details]
|
* [Released under MIT License. Please refer to license.txt for details]
|
||||||
* ========================================== */
|
* ========================================== */
|
||||||
|
|
||||||
#include <string.h>
|
|
||||||
#include "unity_fixture.h"
|
#include "unity_fixture.h"
|
||||||
#include "unity_internals.h"
|
#include "unity_internals.h"
|
||||||
|
#include <string.h>
|
||||||
|
|
||||||
struct _UnityFixture UnityFixture;
|
struct UNITY_FIXTURE_T UnityFixture;
|
||||||
|
|
||||||
/* If you decide to use the function pointer approach.
|
/* If you decide to use the function pointer approach.
|
||||||
* Build with -D UNITY_OUTPUT_CHAR=outputChar and include <stdio.h>
|
* Build with -D UNITY_OUTPUT_CHAR=outputChar and include <stdio.h>
|
||||||
* int (*outputChar)(int) = putchar; */
|
* int (*outputChar)(int) = putchar; */
|
||||||
|
|
||||||
#if !defined(UNITY_WEAK_ATTRIBUTE) && !defined(UNITY_WEAK_PRAGMA)
|
|
||||||
void setUp(void) { /*does nothing*/ }
|
void setUp(void) { /*does nothing*/ }
|
||||||
void tearDown(void) { /*does nothing*/ }
|
void tearDown(void) { /*does nothing*/ }
|
||||||
#endif
|
|
||||||
|
|
||||||
static void announceTestRun(unsigned int runNumber)
|
static void announceTestRun(unsigned int runNumber)
|
||||||
{
|
{
|
||||||
@@ -71,22 +69,35 @@ void UnityTestRunner(unityfunction* setup,
|
|||||||
const char* printableName,
|
const char* printableName,
|
||||||
const char* group,
|
const char* group,
|
||||||
const char* name,
|
const char* name,
|
||||||
const char* file, unsigned int line)
|
const char* file,
|
||||||
|
unsigned int line)
|
||||||
{
|
{
|
||||||
if (testSelected(name) && groupSelected(group))
|
if (testSelected(name) && groupSelected(group))
|
||||||
{
|
{
|
||||||
Unity.TestFile = file;
|
Unity.TestFile = file;
|
||||||
Unity.CurrentTestName = printableName;
|
Unity.CurrentTestName = printableName;
|
||||||
Unity.CurrentTestLineNumber = line;
|
Unity.CurrentTestLineNumber = line;
|
||||||
if (!UnityFixture.Verbose)
|
if (UnityFixture.Verbose)
|
||||||
UNITY_OUTPUT_CHAR('.');
|
{
|
||||||
else
|
|
||||||
UnityPrint(printableName);
|
UnityPrint(printableName);
|
||||||
|
#ifndef UNITY_REPEAT_TEST_NAME
|
||||||
|
Unity.CurrentTestName = NULL;
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
else if (UnityFixture.Silent)
|
||||||
|
{
|
||||||
|
/* Do Nothing */
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
UNITY_OUTPUT_CHAR('.');
|
||||||
|
}
|
||||||
|
|
||||||
Unity.NumberOfTests++;
|
Unity.NumberOfTests++;
|
||||||
UnityMalloc_StartTest();
|
|
||||||
UnityPointer_Init();
|
UnityPointer_Init();
|
||||||
|
|
||||||
|
UNITY_EXEC_TIME_START();
|
||||||
|
|
||||||
if (TEST_PROTECT())
|
if (TEST_PROTECT())
|
||||||
{
|
{
|
||||||
setup();
|
setup();
|
||||||
@@ -99,8 +110,6 @@ void UnityTestRunner(unityfunction* setup,
|
|||||||
if (TEST_PROTECT())
|
if (TEST_PROTECT())
|
||||||
{
|
{
|
||||||
UnityPointer_UndoAllSets();
|
UnityPointer_UndoAllSets();
|
||||||
if (!Unity.CurrentTestFailed)
|
|
||||||
UnityMalloc_EndTest();
|
|
||||||
}
|
}
|
||||||
UnityConcludeFixtureTest();
|
UnityConcludeFixtureTest();
|
||||||
}
|
}
|
||||||
@@ -112,191 +121,22 @@ void UnityIgnoreTest(const char* printableName, const char* group, const char* n
|
|||||||
{
|
{
|
||||||
Unity.NumberOfTests++;
|
Unity.NumberOfTests++;
|
||||||
Unity.TestIgnores++;
|
Unity.TestIgnores++;
|
||||||
if (!UnityFixture.Verbose)
|
if (UnityFixture.Verbose)
|
||||||
UNITY_OUTPUT_CHAR('!');
|
|
||||||
else
|
|
||||||
{
|
{
|
||||||
UnityPrint(printableName);
|
UnityPrint(printableName);
|
||||||
UNITY_PRINT_EOL();
|
UNITY_PRINT_EOL();
|
||||||
}
|
}
|
||||||
|
else if (UnityFixture.Silent)
|
||||||
|
{
|
||||||
|
/* Do Nothing */
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
UNITY_OUTPUT_CHAR('!');
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/*------------------------------------------------- */
|
|
||||||
/* Malloc and free stuff */
|
|
||||||
#define MALLOC_DONT_FAIL -1
|
|
||||||
static int malloc_count;
|
|
||||||
static int malloc_fail_countdown = MALLOC_DONT_FAIL;
|
|
||||||
|
|
||||||
void UnityMalloc_StartTest(void)
|
|
||||||
{
|
|
||||||
malloc_count = 0;
|
|
||||||
malloc_fail_countdown = MALLOC_DONT_FAIL;
|
|
||||||
}
|
|
||||||
|
|
||||||
void UnityMalloc_EndTest(void)
|
|
||||||
{
|
|
||||||
malloc_fail_countdown = MALLOC_DONT_FAIL;
|
|
||||||
if (malloc_count != 0)
|
|
||||||
{
|
|
||||||
UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "This test leaks!");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void UnityMalloc_MakeMallocFailAfterCount(int countdown)
|
|
||||||
{
|
|
||||||
malloc_fail_countdown = countdown;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* These definitions are always included from unity_fixture_malloc_overrides.h */
|
|
||||||
/* We undef to use them or avoid conflict with <stdlib.h> per the C standard */
|
|
||||||
#undef malloc
|
|
||||||
#undef free
|
|
||||||
#undef calloc
|
|
||||||
#undef realloc
|
|
||||||
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
|
||||||
static unsigned char unity_heap[UNITY_INTERNAL_HEAP_SIZE_BYTES];
|
|
||||||
static size_t heap_index;
|
|
||||||
#else
|
|
||||||
#include <stdlib.h>
|
|
||||||
#endif
|
|
||||||
|
|
||||||
typedef struct GuardBytes
|
|
||||||
{
|
|
||||||
size_t size;
|
|
||||||
size_t guard_space;
|
|
||||||
} Guard;
|
|
||||||
|
|
||||||
|
|
||||||
static const char end[] = "END";
|
|
||||||
|
|
||||||
void* unity_malloc(size_t size)
|
|
||||||
{
|
|
||||||
char* mem;
|
|
||||||
Guard* guard;
|
|
||||||
size_t total_size = size + sizeof(Guard) + sizeof(end);
|
|
||||||
|
|
||||||
if (malloc_fail_countdown != MALLOC_DONT_FAIL)
|
|
||||||
{
|
|
||||||
if (malloc_fail_countdown == 0)
|
|
||||||
return NULL;
|
|
||||||
malloc_fail_countdown--;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (size == 0) return NULL;
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
|
||||||
if (heap_index + total_size > UNITY_INTERNAL_HEAP_SIZE_BYTES)
|
|
||||||
{
|
|
||||||
guard = NULL;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
guard = (Guard*) &unity_heap[heap_index];
|
|
||||||
heap_index += total_size;
|
|
||||||
}
|
|
||||||
#else
|
|
||||||
guard = (Guard*)UNITY_FIXTURE_MALLOC(total_size);
|
|
||||||
#endif
|
|
||||||
if (guard == NULL) return NULL;
|
|
||||||
malloc_count++;
|
|
||||||
guard->size = size;
|
|
||||||
guard->guard_space = 0;
|
|
||||||
mem = (char*)&(guard[1]);
|
|
||||||
memcpy(&mem[size], end, sizeof(end));
|
|
||||||
|
|
||||||
return (void*)mem;
|
|
||||||
}
|
|
||||||
|
|
||||||
static int isOverrun(void* mem)
|
|
||||||
{
|
|
||||||
Guard* guard = (Guard*)mem;
|
|
||||||
char* memAsChar = (char*)mem;
|
|
||||||
guard--;
|
|
||||||
|
|
||||||
return guard->guard_space != 0 || strcmp(&memAsChar[guard->size], end) != 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
static void release_memory(void* mem)
|
|
||||||
{
|
|
||||||
Guard* guard = (Guard*)mem;
|
|
||||||
guard--;
|
|
||||||
|
|
||||||
malloc_count--;
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
|
||||||
if (mem == unity_heap + heap_index - guard->size - sizeof(end))
|
|
||||||
{
|
|
||||||
heap_index -= (guard->size + sizeof(Guard) + sizeof(end));
|
|
||||||
}
|
|
||||||
#else
|
|
||||||
UNITY_FIXTURE_FREE(guard);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
void unity_free(void* mem)
|
|
||||||
{
|
|
||||||
int overrun;
|
|
||||||
|
|
||||||
if (mem == NULL)
|
|
||||||
{
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
overrun = isOverrun(mem);
|
|
||||||
release_memory(mem);
|
|
||||||
if (overrun)
|
|
||||||
{
|
|
||||||
UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "Buffer overrun detected during free()");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void* unity_calloc(size_t num, size_t size)
|
|
||||||
{
|
|
||||||
void* mem = unity_malloc(num * size);
|
|
||||||
if (mem == NULL) return NULL;
|
|
||||||
memset(mem, 0, num * size);
|
|
||||||
return mem;
|
|
||||||
}
|
|
||||||
|
|
||||||
void* unity_realloc(void* oldMem, size_t size)
|
|
||||||
{
|
|
||||||
Guard* guard = (Guard*)oldMem;
|
|
||||||
void* newMem;
|
|
||||||
|
|
||||||
if (oldMem == NULL) return unity_malloc(size);
|
|
||||||
|
|
||||||
guard--;
|
|
||||||
if (isOverrun(oldMem))
|
|
||||||
{
|
|
||||||
release_memory(oldMem);
|
|
||||||
UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "Buffer overrun detected during realloc()");
|
|
||||||
}
|
|
||||||
|
|
||||||
if (size == 0)
|
|
||||||
{
|
|
||||||
release_memory(oldMem);
|
|
||||||
return NULL;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (guard->size >= size) return oldMem;
|
|
||||||
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC /* Optimization if memory is expandable */
|
|
||||||
if (oldMem == unity_heap + heap_index - guard->size - sizeof(end) &&
|
|
||||||
heap_index + size - guard->size <= UNITY_INTERNAL_HEAP_SIZE_BYTES)
|
|
||||||
{
|
|
||||||
release_memory(oldMem); /* Not thread-safe, like unity_heap generally */
|
|
||||||
return unity_malloc(size); /* No memcpy since data is in place */
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
newMem = unity_malloc(size);
|
|
||||||
if (newMem == NULL) return NULL; /* Do not release old memory */
|
|
||||||
memcpy(newMem, oldMem, guard->size);
|
|
||||||
release_memory(oldMem);
|
|
||||||
return newMem;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/*-------------------------------------------------------- */
|
/*-------------------------------------------------------- */
|
||||||
/*Automatic pointer restoration functions */
|
/*Automatic pointer restoration functions */
|
||||||
struct PointerPair
|
struct PointerPair
|
||||||
@@ -305,8 +145,7 @@ struct PointerPair
|
|||||||
void* old_value;
|
void* old_value;
|
||||||
};
|
};
|
||||||
|
|
||||||
enum { MAX_POINTERS = 50 };
|
static struct PointerPair pointer_store[UNITY_MAX_POINTERS];
|
||||||
static struct PointerPair pointer_store[MAX_POINTERS];
|
|
||||||
static int pointer_index = 0;
|
static int pointer_index = 0;
|
||||||
|
|
||||||
void UnityPointer_Init(void)
|
void UnityPointer_Init(void)
|
||||||
@@ -316,7 +155,7 @@ void UnityPointer_Init(void)
|
|||||||
|
|
||||||
void UnityPointer_Set(void** pointer, void* newValue, UNITY_LINE_TYPE line)
|
void UnityPointer_Set(void** pointer, void* newValue, UNITY_LINE_TYPE line)
|
||||||
{
|
{
|
||||||
if (pointer_index >= MAX_POINTERS)
|
if (pointer_index >= UNITY_MAX_POINTERS)
|
||||||
{
|
{
|
||||||
UNITY_TEST_FAIL(line, "Too many pointers set");
|
UNITY_TEST_FAIL(line, "Too many pointers set");
|
||||||
}
|
}
|
||||||
@@ -343,6 +182,7 @@ int UnityGetCommandLineOptions(int argc, const char* argv[])
|
|||||||
{
|
{
|
||||||
int i;
|
int i;
|
||||||
UnityFixture.Verbose = 0;
|
UnityFixture.Verbose = 0;
|
||||||
|
UnityFixture.Silent = 0;
|
||||||
UnityFixture.GroupFilter = 0;
|
UnityFixture.GroupFilter = 0;
|
||||||
UnityFixture.NameFilter = 0;
|
UnityFixture.NameFilter = 0;
|
||||||
UnityFixture.RepeatCount = 1;
|
UnityFixture.RepeatCount = 1;
|
||||||
@@ -357,6 +197,11 @@ int UnityGetCommandLineOptions(int argc, const char* argv[])
|
|||||||
UnityFixture.Verbose = 1;
|
UnityFixture.Verbose = 1;
|
||||||
i++;
|
i++;
|
||||||
}
|
}
|
||||||
|
else if (strcmp(argv[i], "-s") == 0)
|
||||||
|
{
|
||||||
|
UnityFixture.Silent = 1;
|
||||||
|
i++;
|
||||||
|
}
|
||||||
else if (strcmp(argv[i], "-g") == 0)
|
else if (strcmp(argv[i], "-g") == 0)
|
||||||
{
|
{
|
||||||
i++;
|
i++;
|
||||||
@@ -391,7 +236,9 @@ int UnityGetCommandLineOptions(int argc, const char* argv[])
|
|||||||
i++;
|
i++;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
/* ignore unknown parameter */
|
/* ignore unknown parameter */
|
||||||
i++;
|
i++;
|
||||||
}
|
}
|
||||||
@@ -410,7 +257,10 @@ void UnityConcludeFixtureTest(void)
|
|||||||
{
|
{
|
||||||
if (UnityFixture.Verbose)
|
if (UnityFixture.Verbose)
|
||||||
{
|
{
|
||||||
UnityPrint(" PASS");
|
UnityPrint(" ");
|
||||||
|
UnityPrint(UnityStrPass);
|
||||||
|
UNITY_EXEC_TIME_STOP();
|
||||||
|
UNITY_PRINT_EXEC_TIME();
|
||||||
UNITY_PRINT_EOL();
|
UNITY_PRINT_EOL();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,9 +10,12 @@
|
|||||||
|
|
||||||
#include "unity.h"
|
#include "unity.h"
|
||||||
#include "unity_internals.h"
|
#include "unity_internals.h"
|
||||||
#include "unity_fixture_malloc_overrides.h"
|
|
||||||
#include "unity_fixture_internals.h"
|
#include "unity_fixture_internals.h"
|
||||||
|
|
||||||
|
#ifndef UNITY_FIXTURE_NO_EXTRAS
|
||||||
|
#include "unity_memory.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
int UnityMain(int argc, const char* argv[], void (*runAllTests)(void));
|
int UnityMain(int argc, const char* argv[], void (*runAllTests)(void));
|
||||||
|
|
||||||
|
|
||||||
@@ -49,6 +52,7 @@ int UnityMain(int argc, const char* argv[], void (*runAllTests)(void));
|
|||||||
}\
|
}\
|
||||||
void TEST_##group##_##name##_(void)
|
void TEST_##group##_##name##_(void)
|
||||||
|
|
||||||
|
/* Call this for each test, insider the group runner */
|
||||||
#define RUN_TEST_CASE(group, name) \
|
#define RUN_TEST_CASE(group, name) \
|
||||||
{ void TEST_##group##_##name##_run(void);\
|
{ void TEST_##group##_##name##_run(void);\
|
||||||
TEST_##group##_##name##_run(); }
|
TEST_##group##_##name##_run(); }
|
||||||
@@ -64,6 +68,8 @@ int UnityMain(int argc, const char* argv[], void (*runAllTests)(void));
|
|||||||
TEST_##group##_GROUP_RUNNER(); }
|
TEST_##group##_GROUP_RUNNER(); }
|
||||||
|
|
||||||
/* CppUTest Compatibility Macros */
|
/* CppUTest Compatibility Macros */
|
||||||
|
#ifndef UNITY_EXCLUDE_CPPUTEST_ASSERTS
|
||||||
|
/* Sets a pointer and automatically restores it to its old value after teardown */
|
||||||
#define UT_PTR_SET(ptr, newPointerValue) UnityPointer_Set((void**)&(ptr), (void*)(newPointerValue), __LINE__)
|
#define UT_PTR_SET(ptr, newPointerValue) UnityPointer_Set((void**)&(ptr), (void*)(newPointerValue), __LINE__)
|
||||||
#define TEST_ASSERT_POINTERS_EQUAL(expected, actual) TEST_ASSERT_EQUAL_PTR((expected), (actual))
|
#define TEST_ASSERT_POINTERS_EQUAL(expected, actual) TEST_ASSERT_EQUAL_PTR((expected), (actual))
|
||||||
#define TEST_ASSERT_BYTES_EQUAL(expected, actual) TEST_ASSERT_EQUAL_HEX8(0xff & (expected), 0xff & (actual))
|
#define TEST_ASSERT_BYTES_EQUAL(expected, actual) TEST_ASSERT_EQUAL_HEX8(0xff & (expected), 0xff & (actual))
|
||||||
@@ -71,8 +77,7 @@ int UnityMain(int argc, const char* argv[], void (*runAllTests)(void));
|
|||||||
#define CHECK(condition) TEST_ASSERT_TRUE((condition))
|
#define CHECK(condition) TEST_ASSERT_TRUE((condition))
|
||||||
#define LONGS_EQUAL(expected, actual) TEST_ASSERT_EQUAL_INT((expected), (actual))
|
#define LONGS_EQUAL(expected, actual) TEST_ASSERT_EQUAL_INT((expected), (actual))
|
||||||
#define STRCMP_EQUAL(expected, actual) TEST_ASSERT_EQUAL_STRING((expected), (actual))
|
#define STRCMP_EQUAL(expected, actual) TEST_ASSERT_EQUAL_STRING((expected), (actual))
|
||||||
#define DOUBLES_EQUAL(expected, actual, delta) TEST_ASSERT_FLOAT_WITHIN(((expected), (actual), (delta))
|
#define DOUBLES_EQUAL(expected, actual, delta) TEST_ASSERT_DOUBLE_WITHIN((delta), (expected), (actual))
|
||||||
|
#endif
|
||||||
void UnityMalloc_MakeMallocFailAfterCount(int count);
|
|
||||||
|
|
||||||
#endif /* UNITY_FIXTURE_H_ */
|
#endif /* UNITY_FIXTURE_H_ */
|
||||||
|
|||||||
@@ -13,18 +13,19 @@ extern "C"
|
|||||||
{
|
{
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
struct _UnityFixture
|
struct UNITY_FIXTURE_T
|
||||||
{
|
{
|
||||||
int Verbose;
|
int Verbose;
|
||||||
|
int Silent;
|
||||||
unsigned int RepeatCount;
|
unsigned int RepeatCount;
|
||||||
const char* NameFilter;
|
const char* NameFilter;
|
||||||
const char* GroupFilter;
|
const char* GroupFilter;
|
||||||
};
|
};
|
||||||
extern struct _UnityFixture UnityFixture;
|
extern struct UNITY_FIXTURE_T UnityFixture;
|
||||||
|
|
||||||
typedef void unityfunction(void);
|
typedef void unityfunction(void);
|
||||||
void UnityTestRunner(unityfunction* setup,
|
void UnityTestRunner(unityfunction* setup,
|
||||||
unityfunction* body,
|
unityfunction* testBody,
|
||||||
unityfunction* teardown,
|
unityfunction* teardown,
|
||||||
const char* printableName,
|
const char* printableName,
|
||||||
const char* group,
|
const char* group,
|
||||||
@@ -32,14 +33,15 @@ void UnityTestRunner(unityfunction* setup,
|
|||||||
const char* file, unsigned int line);
|
const char* file, unsigned int line);
|
||||||
|
|
||||||
void UnityIgnoreTest(const char* printableName, const char* group, const char* name);
|
void UnityIgnoreTest(const char* printableName, const char* group, const char* name);
|
||||||
void UnityMalloc_StartTest(void);
|
|
||||||
void UnityMalloc_EndTest(void);
|
|
||||||
int UnityGetCommandLineOptions(int argc, const char* argv[]);
|
int UnityGetCommandLineOptions(int argc, const char* argv[]);
|
||||||
void UnityConcludeFixtureTest(void);
|
void UnityConcludeFixtureTest(void);
|
||||||
|
|
||||||
void UnityPointer_Set(void** ptr, void* newValue, UNITY_LINE_TYPE line);
|
void UnityPointer_Set(void** pointer, void* newValue, UNITY_LINE_TYPE line);
|
||||||
void UnityPointer_UndoAllSets(void);
|
void UnityPointer_UndoAllSets(void);
|
||||||
void UnityPointer_Init(void);
|
void UnityPointer_Init(void);
|
||||||
|
#ifndef UNITY_MAX_POINTERS
|
||||||
|
#define UNITY_MAX_POINTERS 5
|
||||||
|
#endif
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,14 +3,12 @@ ifeq ($(shell uname -s), Darwin)
|
|||||||
CC = clang
|
CC = clang
|
||||||
endif
|
endif
|
||||||
#DEBUG = -O0 -g
|
#DEBUG = -O0 -g
|
||||||
CFLAGS += -std=c99 -pedantic -Wall -Wextra -Werror
|
CFLAGS += -std=c99 -pedantic -Wall -Wextra -Werror -DUNITY_FIXTURE_NO_EXTRAS
|
||||||
CFLAGS += $(DEBUG)
|
CFLAGS += $(DEBUG)
|
||||||
DEFINES = -D UNITY_OUTPUT_CHAR=UnityOutputCharSpy_OutputChar
|
|
||||||
SRC = ../src/unity_fixture.c \
|
SRC = ../src/unity_fixture.c \
|
||||||
../../../src/unity.c \
|
../../../src/unity.c \
|
||||||
unity_fixture_Test.c \
|
unity_fixture_Test.c \
|
||||||
unity_fixture_TestRunner.c \
|
unity_fixture_TestRunner.c \
|
||||||
unity_output_Spy.c \
|
|
||||||
main/AllTests.c
|
main/AllTests.c
|
||||||
|
|
||||||
INC_DIR = -I../src -I../../../src/
|
INC_DIR = -I../src -I../../../src/
|
||||||
|
|||||||
@@ -11,8 +11,6 @@ static void runAllTests(void)
|
|||||||
{
|
{
|
||||||
RUN_TEST_GROUP(UnityFixture);
|
RUN_TEST_GROUP(UnityFixture);
|
||||||
RUN_TEST_GROUP(UnityCommandOptions);
|
RUN_TEST_GROUP(UnityCommandOptions);
|
||||||
RUN_TEST_GROUP(LeakDetection);
|
|
||||||
RUN_TEST_GROUP(InternalMalloc);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
int main(int argc, const char* argv[])
|
int main(int argc, const char* argv[])
|
||||||
|
|||||||
@@ -6,7 +6,6 @@
|
|||||||
* ========================================== */
|
* ========================================== */
|
||||||
|
|
||||||
#include "unity_fixture.h"
|
#include "unity_fixture.h"
|
||||||
#include "unity_output_Spy.h"
|
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
|
|
||||||
@@ -44,71 +43,6 @@ TEST(UnityFixture, PointerSetting)
|
|||||||
TEST_ASSERT_POINTERS_EQUAL(pointer3, (int*)3);
|
TEST_ASSERT_POINTERS_EQUAL(pointer3, (int*)3);
|
||||||
}
|
}
|
||||||
|
|
||||||
TEST(UnityFixture, ForceMallocFail)
|
|
||||||
{
|
|
||||||
void* m;
|
|
||||||
void* mfails;
|
|
||||||
UnityMalloc_MakeMallocFailAfterCount(1);
|
|
||||||
m = malloc(10);
|
|
||||||
CHECK(m);
|
|
||||||
mfails = malloc(10);
|
|
||||||
TEST_ASSERT_POINTERS_EQUAL(0, mfails);
|
|
||||||
free(m);
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(UnityFixture, ReallocSmallerIsUnchanged)
|
|
||||||
{
|
|
||||||
void* m1 = malloc(10);
|
|
||||||
void* m2 = realloc(m1, 5);
|
|
||||||
TEST_ASSERT_POINTERS_EQUAL(m1, m2);
|
|
||||||
free(m2);
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(UnityFixture, ReallocSameIsUnchanged)
|
|
||||||
{
|
|
||||||
void* m1 = malloc(10);
|
|
||||||
void* m2 = realloc(m1, 10);
|
|
||||||
TEST_ASSERT_POINTERS_EQUAL(m1, m2);
|
|
||||||
free(m2);
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(UnityFixture, ReallocLargerNeeded)
|
|
||||||
{
|
|
||||||
void* m1 = malloc(10);
|
|
||||||
void* m2;
|
|
||||||
CHECK(m1);
|
|
||||||
strcpy((char*)m1, "123456789");
|
|
||||||
m2 = realloc(m1, 15);
|
|
||||||
/* CHECK(m1 != m2); //Depends on implementation */
|
|
||||||
STRCMP_EQUAL("123456789", m2);
|
|
||||||
free(m2);
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(UnityFixture, ReallocNullPointerIsLikeMalloc)
|
|
||||||
{
|
|
||||||
void* m = realloc(0, 15);
|
|
||||||
CHECK(m != 0);
|
|
||||||
free(m);
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(UnityFixture, ReallocSizeZeroFreesMemAndReturnsNullPointer)
|
|
||||||
{
|
|
||||||
void* m1 = malloc(10);
|
|
||||||
void* m2 = realloc(m1, 0);
|
|
||||||
TEST_ASSERT_POINTERS_EQUAL(0, m2);
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(UnityFixture, CallocFillsWithZero)
|
|
||||||
{
|
|
||||||
void* m = calloc(3, sizeof(char));
|
|
||||||
char* s = (char*)m;
|
|
||||||
CHECK(m);
|
|
||||||
TEST_ASSERT_BYTES_EQUAL(0, s[0]);
|
|
||||||
TEST_ASSERT_BYTES_EQUAL(0, s[1]);
|
|
||||||
TEST_ASSERT_BYTES_EQUAL(0, s[2]);
|
|
||||||
free(m);
|
|
||||||
}
|
|
||||||
|
|
||||||
static char *p1;
|
static char *p1;
|
||||||
static char *p2;
|
static char *p2;
|
||||||
|
|
||||||
@@ -138,14 +72,12 @@ TEST(UnityFixture, FreeNULLSafety)
|
|||||||
|
|
||||||
TEST(UnityFixture, ConcludeTestIncrementsFailCount)
|
TEST(UnityFixture, ConcludeTestIncrementsFailCount)
|
||||||
{
|
{
|
||||||
_U_UINT savedFails = Unity.TestFailures;
|
UNITY_UINT savedFails = Unity.TestFailures;
|
||||||
_U_UINT savedIgnores = Unity.TestIgnores;
|
UNITY_UINT savedIgnores = Unity.TestIgnores;
|
||||||
UnityOutputCharSpy_Enable(1);
|
|
||||||
Unity.CurrentTestFailed = 1;
|
Unity.CurrentTestFailed = 1;
|
||||||
UnityConcludeFixtureTest(); /* Resets TestFailed for this test to pass */
|
UnityConcludeFixtureTest(); /* Resets TestFailed for this test to pass */
|
||||||
Unity.CurrentTestIgnored = 1;
|
Unity.CurrentTestIgnored = 1;
|
||||||
UnityConcludeFixtureTest(); /* Resets TestIgnored */
|
UnityConcludeFixtureTest(); /* Resets TestIgnored */
|
||||||
UnityOutputCharSpy_Enable(0);
|
|
||||||
TEST_ASSERT_EQUAL(savedFails + 1, Unity.TestFailures);
|
TEST_ASSERT_EQUAL(savedFails + 1, Unity.TestFailures);
|
||||||
TEST_ASSERT_EQUAL(savedIgnores + 1, Unity.TestIgnores);
|
TEST_ASSERT_EQUAL(savedIgnores + 1, Unity.TestIgnores);
|
||||||
Unity.TestFailures = savedFails;
|
Unity.TestFailures = savedFails;
|
||||||
@@ -301,7 +233,7 @@ TEST(UnityCommandOptions, GroupOrNameFilterWithoutStringFails)
|
|||||||
|
|
||||||
TEST(UnityCommandOptions, GroupFilterReallyFilters)
|
TEST(UnityCommandOptions, GroupFilterReallyFilters)
|
||||||
{
|
{
|
||||||
_U_UINT saved = Unity.NumberOfTests;
|
UNITY_UINT saved = Unity.NumberOfTests;
|
||||||
TEST_ASSERT_EQUAL(0, UnityGetCommandLineOptions(4, unknownCommand));
|
TEST_ASSERT_EQUAL(0, UnityGetCommandLineOptions(4, unknownCommand));
|
||||||
UnityIgnoreTest(NULL, "non-matching", NULL);
|
UnityIgnoreTest(NULL, "non-matching", NULL);
|
||||||
TEST_ASSERT_EQUAL(saved, Unity.NumberOfTests);
|
TEST_ASSERT_EQUAL(saved, Unity.NumberOfTests);
|
||||||
@@ -311,233 +243,3 @@ IGNORE_TEST(UnityCommandOptions, TestShouldBeIgnored)
|
|||||||
{
|
{
|
||||||
TEST_FAIL_MESSAGE("This test should not run!");
|
TEST_FAIL_MESSAGE("This test should not run!");
|
||||||
}
|
}
|
||||||
|
|
||||||
/*------------------------------------------------------------ */
|
|
||||||
|
|
||||||
TEST_GROUP(LeakDetection);
|
|
||||||
|
|
||||||
TEST_SETUP(LeakDetection)
|
|
||||||
{
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
|
||||||
UnityOutputCharSpy_Create(200);
|
|
||||||
#else
|
|
||||||
UnityOutputCharSpy_Create(1000);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST_TEAR_DOWN(LeakDetection)
|
|
||||||
{
|
|
||||||
UnityOutputCharSpy_Destroy();
|
|
||||||
}
|
|
||||||
|
|
||||||
#define EXPECT_ABORT_BEGIN \
|
|
||||||
{ \
|
|
||||||
jmp_buf TestAbortFrame; \
|
|
||||||
memcpy(TestAbortFrame, Unity.AbortFrame, sizeof(jmp_buf)); \
|
|
||||||
if (TEST_PROTECT()) \
|
|
||||||
{
|
|
||||||
|
|
||||||
#define EXPECT_ABORT_END \
|
|
||||||
} \
|
|
||||||
memcpy(Unity.AbortFrame, TestAbortFrame, sizeof(jmp_buf)); \
|
|
||||||
}
|
|
||||||
|
|
||||||
/* This tricky set of defines lets us see if we are using the Spy, returns 1 if true */
|
|
||||||
#ifdef __STDC_VERSION__
|
|
||||||
|
|
||||||
#if __STDC_VERSION__ >= 199901L
|
|
||||||
#define USING_SPY_AS(a) EXPAND_AND_USE_2ND(ASSIGN_VALUE(a), 0)
|
|
||||||
#define ASSIGN_VALUE(a) VAL_##a
|
|
||||||
#define VAL_UnityOutputCharSpy_OutputChar 0, 1
|
|
||||||
#define EXPAND_AND_USE_2ND(a, b) SECOND_PARAM(a, b, throwaway)
|
|
||||||
#define SECOND_PARAM(a, b, ...) b
|
|
||||||
#if USING_SPY_AS(UNITY_OUTPUT_CHAR)
|
|
||||||
#define USING_OUTPUT_SPY /* UNITY_OUTPUT_CHAR = UnityOutputCharSpy_OutputChar */
|
|
||||||
#endif
|
|
||||||
#endif /* >= 199901 */
|
|
||||||
|
|
||||||
#else /* __STDC_VERSION__ else */
|
|
||||||
#define UnityOutputCharSpy_OutputChar 42
|
|
||||||
#if UNITY_OUTPUT_CHAR == UnityOutputCharSpy_OutputChar /* Works if no -Wundef -Werror */
|
|
||||||
#define USING_OUTPUT_SPY
|
|
||||||
#endif
|
|
||||||
#undef UnityOutputCharSpy_OutputChar
|
|
||||||
#endif /* __STDC_VERSION__ */
|
|
||||||
|
|
||||||
TEST(LeakDetection, DetectsLeak)
|
|
||||||
{
|
|
||||||
#ifndef USING_OUTPUT_SPY
|
|
||||||
TEST_IGNORE_MESSAGE("Build with '-D UNITY_OUTPUT_CHAR=UnityOutputCharSpy_OutputChar' to enable tests");
|
|
||||||
#else
|
|
||||||
void* m = malloc(10);
|
|
||||||
TEST_ASSERT_NOT_NULL(m);
|
|
||||||
UnityOutputCharSpy_Enable(1);
|
|
||||||
EXPECT_ABORT_BEGIN
|
|
||||||
UnityMalloc_EndTest();
|
|
||||||
EXPECT_ABORT_END
|
|
||||||
UnityOutputCharSpy_Enable(0);
|
|
||||||
Unity.CurrentTestFailed = 0;
|
|
||||||
CHECK(strstr(UnityOutputCharSpy_Get(), "This test leaks!"));
|
|
||||||
free(m);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(LeakDetection, BufferOverrunFoundDuringFree)
|
|
||||||
{
|
|
||||||
#ifndef USING_OUTPUT_SPY
|
|
||||||
TEST_IGNORE();
|
|
||||||
#else
|
|
||||||
void* m = malloc(10);
|
|
||||||
char* s = (char*)m;
|
|
||||||
TEST_ASSERT_NOT_NULL(m);
|
|
||||||
s[10] = (char)0xFF;
|
|
||||||
UnityOutputCharSpy_Enable(1);
|
|
||||||
EXPECT_ABORT_BEGIN
|
|
||||||
free(m);
|
|
||||||
EXPECT_ABORT_END
|
|
||||||
UnityOutputCharSpy_Enable(0);
|
|
||||||
Unity.CurrentTestFailed = 0;
|
|
||||||
CHECK(strstr(UnityOutputCharSpy_Get(), "Buffer overrun detected during free()"));
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(LeakDetection, BufferOverrunFoundDuringRealloc)
|
|
||||||
{
|
|
||||||
#ifndef USING_OUTPUT_SPY
|
|
||||||
TEST_IGNORE();
|
|
||||||
#else
|
|
||||||
void* m = malloc(10);
|
|
||||||
char* s = (char*)m;
|
|
||||||
TEST_ASSERT_NOT_NULL(m);
|
|
||||||
s[10] = (char)0xFF;
|
|
||||||
UnityOutputCharSpy_Enable(1);
|
|
||||||
EXPECT_ABORT_BEGIN
|
|
||||||
m = realloc(m, 100);
|
|
||||||
EXPECT_ABORT_END
|
|
||||||
UnityOutputCharSpy_Enable(0);
|
|
||||||
Unity.CurrentTestFailed = 0;
|
|
||||||
CHECK(strstr(UnityOutputCharSpy_Get(), "Buffer overrun detected during realloc()"));
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(LeakDetection, BufferGuardWriteFoundDuringFree)
|
|
||||||
{
|
|
||||||
#ifndef USING_OUTPUT_SPY
|
|
||||||
TEST_IGNORE();
|
|
||||||
#else
|
|
||||||
void* m = malloc(10);
|
|
||||||
char* s = (char*)m;
|
|
||||||
TEST_ASSERT_NOT_NULL(m);
|
|
||||||
s[-1] = (char)0x00; /* Will not detect 0 */
|
|
||||||
s[-2] = (char)0x01;
|
|
||||||
UnityOutputCharSpy_Enable(1);
|
|
||||||
EXPECT_ABORT_BEGIN
|
|
||||||
free(m);
|
|
||||||
EXPECT_ABORT_END
|
|
||||||
UnityOutputCharSpy_Enable(0);
|
|
||||||
Unity.CurrentTestFailed = 0;
|
|
||||||
CHECK(strstr(UnityOutputCharSpy_Get(), "Buffer overrun detected during free()"));
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(LeakDetection, BufferGuardWriteFoundDuringRealloc)
|
|
||||||
{
|
|
||||||
#ifndef USING_OUTPUT_SPY
|
|
||||||
TEST_IGNORE();
|
|
||||||
#else
|
|
||||||
void* m = malloc(10);
|
|
||||||
char* s = (char*)m;
|
|
||||||
TEST_ASSERT_NOT_NULL(m);
|
|
||||||
s[-1] = (char)0x0A;
|
|
||||||
UnityOutputCharSpy_Enable(1);
|
|
||||||
EXPECT_ABORT_BEGIN
|
|
||||||
m = realloc(m, 100);
|
|
||||||
EXPECT_ABORT_END
|
|
||||||
UnityOutputCharSpy_Enable(0);
|
|
||||||
Unity.CurrentTestFailed = 0;
|
|
||||||
CHECK(strstr(UnityOutputCharSpy_Get(), "Buffer overrun detected during realloc()"));
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(LeakDetection, PointerSettingMax)
|
|
||||||
{
|
|
||||||
#ifndef USING_OUTPUT_SPY
|
|
||||||
TEST_IGNORE();
|
|
||||||
#else
|
|
||||||
int i;
|
|
||||||
for (i = 0; i < 50; i++) UT_PTR_SET(pointer1, &int1);
|
|
||||||
UnityOutputCharSpy_Enable(1);
|
|
||||||
EXPECT_ABORT_BEGIN
|
|
||||||
UT_PTR_SET(pointer1, &int1);
|
|
||||||
EXPECT_ABORT_END
|
|
||||||
UnityOutputCharSpy_Enable(0);
|
|
||||||
Unity.CurrentTestFailed = 0;
|
|
||||||
CHECK(strstr(UnityOutputCharSpy_Get(), "Too many pointers set"));
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
/*------------------------------------------------------------ */
|
|
||||||
|
|
||||||
TEST_GROUP(InternalMalloc);
|
|
||||||
#define TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(first_mem_ptr, ptr) \
|
|
||||||
ptr = malloc(10); free(ptr); \
|
|
||||||
TEST_ASSERT_EQUAL_PTR_MESSAGE(first_mem_ptr, ptr, "Memory was stranded, free in LIFO order");
|
|
||||||
|
|
||||||
|
|
||||||
TEST_SETUP(InternalMalloc) { }
|
|
||||||
TEST_TEAR_DOWN(InternalMalloc) { }
|
|
||||||
|
|
||||||
TEST(InternalMalloc, MallocPastBufferFails)
|
|
||||||
{
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
|
||||||
void* m = malloc(UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 1);
|
|
||||||
void* n = malloc(UNITY_INTERNAL_HEAP_SIZE_BYTES/2);
|
|
||||||
free(m);
|
|
||||||
TEST_ASSERT_NOT_NULL(m);
|
|
||||||
TEST_ASSERT_NULL(n);
|
|
||||||
TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(m, n);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(InternalMalloc, CallocPastBufferFails)
|
|
||||||
{
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
|
||||||
void* m = calloc(1, UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 1);
|
|
||||||
void* n = calloc(1, UNITY_INTERNAL_HEAP_SIZE_BYTES/2);
|
|
||||||
free(m);
|
|
||||||
TEST_ASSERT_NOT_NULL(m);
|
|
||||||
TEST_ASSERT_NULL(n);
|
|
||||||
TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(m, n);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(InternalMalloc, MallocThenReallocGrowsMemoryInPlace)
|
|
||||||
{
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
|
||||||
void* m = malloc(UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 1);
|
|
||||||
void* n = realloc(m, UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 9);
|
|
||||||
free(n);
|
|
||||||
TEST_ASSERT_NOT_NULL(m);
|
|
||||||
TEST_ASSERT_EQUAL(m, n);
|
|
||||||
TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(m, n);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST(InternalMalloc, ReallocFailDoesNotFreeMem)
|
|
||||||
{
|
|
||||||
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
|
||||||
void* m = malloc(UNITY_INTERNAL_HEAP_SIZE_BYTES/2);
|
|
||||||
void* n1 = malloc(10);
|
|
||||||
void* out_of_mem = realloc(n1, UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 1);
|
|
||||||
void* n2 = malloc(10);
|
|
||||||
|
|
||||||
free(n2);
|
|
||||||
if (out_of_mem == NULL) free(n1);
|
|
||||||
free(m);
|
|
||||||
|
|
||||||
TEST_ASSERT_NOT_NULL(m); /* Got a real memory location */
|
|
||||||
TEST_ASSERT_NULL(out_of_mem); /* The realloc should have failed */
|
|
||||||
TEST_ASSERT_NOT_EQUAL(n2, n1); /* If n1 != n2 then realloc did not free n1 */
|
|
||||||
TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(m, n2);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -10,13 +10,6 @@
|
|||||||
TEST_GROUP_RUNNER(UnityFixture)
|
TEST_GROUP_RUNNER(UnityFixture)
|
||||||
{
|
{
|
||||||
RUN_TEST_CASE(UnityFixture, PointerSetting);
|
RUN_TEST_CASE(UnityFixture, PointerSetting);
|
||||||
RUN_TEST_CASE(UnityFixture, ForceMallocFail);
|
|
||||||
RUN_TEST_CASE(UnityFixture, ReallocSmallerIsUnchanged);
|
|
||||||
RUN_TEST_CASE(UnityFixture, ReallocSameIsUnchanged);
|
|
||||||
RUN_TEST_CASE(UnityFixture, ReallocLargerNeeded);
|
|
||||||
RUN_TEST_CASE(UnityFixture, ReallocNullPointerIsLikeMalloc);
|
|
||||||
RUN_TEST_CASE(UnityFixture, ReallocSizeZeroFreesMemAndReturnsNullPointer);
|
|
||||||
RUN_TEST_CASE(UnityFixture, CallocFillsWithZero);
|
|
||||||
RUN_TEST_CASE(UnityFixture, PointerSet);
|
RUN_TEST_CASE(UnityFixture, PointerSet);
|
||||||
RUN_TEST_CASE(UnityFixture, FreeNULLSafety);
|
RUN_TEST_CASE(UnityFixture, FreeNULLSafety);
|
||||||
RUN_TEST_CASE(UnityFixture, ConcludeTestIncrementsFailCount);
|
RUN_TEST_CASE(UnityFixture, ConcludeTestIncrementsFailCount);
|
||||||
@@ -37,21 +30,3 @@ TEST_GROUP_RUNNER(UnityCommandOptions)
|
|||||||
RUN_TEST_CASE(UnityCommandOptions, GroupFilterReallyFilters);
|
RUN_TEST_CASE(UnityCommandOptions, GroupFilterReallyFilters);
|
||||||
RUN_TEST_CASE(UnityCommandOptions, TestShouldBeIgnored);
|
RUN_TEST_CASE(UnityCommandOptions, TestShouldBeIgnored);
|
||||||
}
|
}
|
||||||
|
|
||||||
TEST_GROUP_RUNNER(LeakDetection)
|
|
||||||
{
|
|
||||||
RUN_TEST_CASE(LeakDetection, DetectsLeak);
|
|
||||||
RUN_TEST_CASE(LeakDetection, BufferOverrunFoundDuringFree);
|
|
||||||
RUN_TEST_CASE(LeakDetection, BufferOverrunFoundDuringRealloc);
|
|
||||||
RUN_TEST_CASE(LeakDetection, BufferGuardWriteFoundDuringFree);
|
|
||||||
RUN_TEST_CASE(LeakDetection, BufferGuardWriteFoundDuringRealloc);
|
|
||||||
RUN_TEST_CASE(LeakDetection, PointerSettingMax);
|
|
||||||
}
|
|
||||||
|
|
||||||
TEST_GROUP_RUNNER(InternalMalloc)
|
|
||||||
{
|
|
||||||
RUN_TEST_CASE(InternalMalloc, MallocPastBufferFails);
|
|
||||||
RUN_TEST_CASE(InternalMalloc, CallocPastBufferFails);
|
|
||||||
RUN_TEST_CASE(InternalMalloc, MallocThenReallocGrowsMemoryInPlace);
|
|
||||||
RUN_TEST_CASE(InternalMalloc, ReallocFailDoesNotFreeMem);
|
|
||||||
}
|
|
||||||
|
|||||||
45
extras/memory/rakefile.rb
Normal file
45
extras/memory/rakefile.rb
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# ==========================================
|
||||||
|
# Unity Project - A Test Framework for C
|
||||||
|
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
|
# ==========================================
|
||||||
|
|
||||||
|
require 'rake'
|
||||||
|
require 'rake/clean'
|
||||||
|
require 'rake/testtask'
|
||||||
|
require_relative 'rakefile_helper'
|
||||||
|
|
||||||
|
TEMP_DIRS = [
|
||||||
|
File.join(__dir__, 'build')
|
||||||
|
].freeze
|
||||||
|
|
||||||
|
TEMP_DIRS.each do |dir|
|
||||||
|
directory(dir)
|
||||||
|
CLOBBER.include(dir)
|
||||||
|
end
|
||||||
|
|
||||||
|
task prepare_for_tests: TEMP_DIRS
|
||||||
|
|
||||||
|
# Load default configuration, for now
|
||||||
|
DEFAULT_CONFIG_FILE = 'gcc_auto_stdint.yml'.freeze
|
||||||
|
configure_toolchain(DEFAULT_CONFIG_FILE)
|
||||||
|
|
||||||
|
task unit: [:prepare_for_tests] do
|
||||||
|
run_tests(false)
|
||||||
|
run_tests(true)
|
||||||
|
end
|
||||||
|
|
||||||
|
desc 'Build and test Unity Framework'
|
||||||
|
task all: %i[clean unit]
|
||||||
|
task default: %i[clobber all]
|
||||||
|
task ci: %i[no_color default]
|
||||||
|
task cruise: %i[no_color default]
|
||||||
|
|
||||||
|
desc 'Load configuration'
|
||||||
|
task :config, :config_file do |_t, args|
|
||||||
|
configure_toolchain(args[:config_file])
|
||||||
|
end
|
||||||
|
|
||||||
|
task :no_color do
|
||||||
|
$colour_output = false
|
||||||
|
end
|
||||||
187
extras/memory/rakefile_helper.rb
Normal file
187
extras/memory/rakefile_helper.rb
Normal file
@@ -0,0 +1,187 @@
|
|||||||
|
# ==========================================
|
||||||
|
# Unity Project - A Test Framework for C
|
||||||
|
# Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
|
# ==========================================
|
||||||
|
|
||||||
|
require 'yaml'
|
||||||
|
require 'fileutils'
|
||||||
|
require 'rbconfig'
|
||||||
|
require_relative '../../auto/unity_test_summary'
|
||||||
|
require_relative '../../auto/generate_test_runner'
|
||||||
|
require_relative '../../auto/colour_reporter'
|
||||||
|
|
||||||
|
$is_windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
|
||||||
|
|
||||||
|
C_EXTENSION = '.c'.freeze
|
||||||
|
|
||||||
|
def load_configuration(config_file)
|
||||||
|
return if $configured
|
||||||
|
|
||||||
|
$cfg_file = "#{__dir__}/../../test/targets/#{config_file}" unless config_file =~ /[\\|\/]/
|
||||||
|
$cfg = YAML.load(File.read($cfg_file))
|
||||||
|
$colour_output = false unless $cfg['colour']
|
||||||
|
$configured = true if config_file != DEFAULT_CONFIG_FILE
|
||||||
|
end
|
||||||
|
|
||||||
|
def configure_clean
|
||||||
|
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
def configure_toolchain(config_file = DEFAULT_CONFIG_FILE)
|
||||||
|
config_file += '.yml' unless config_file =~ /\.yml$/
|
||||||
|
config_file = config_file unless config_file =~ /[\\|\/]/
|
||||||
|
load_configuration(config_file)
|
||||||
|
configure_clean
|
||||||
|
end
|
||||||
|
|
||||||
|
def tackit(strings)
|
||||||
|
result = if strings.is_a?(Array)
|
||||||
|
"\"#{strings.join}\""
|
||||||
|
else
|
||||||
|
strings
|
||||||
|
end
|
||||||
|
result
|
||||||
|
end
|
||||||
|
|
||||||
|
def squash(prefix, items)
|
||||||
|
result = ''
|
||||||
|
items.each { |item| result += " #{prefix}#{tackit(item)}" }
|
||||||
|
result
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_compiler_fields
|
||||||
|
command = tackit($cfg['compiler']['path'])
|
||||||
|
defines = if $cfg['compiler']['defines']['items'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
decl = if $is_windows
|
||||||
|
'UNITY_OUTPUT_CHAR_HEADER_DECLARATION=UnityOutputCharSpy_OutputChar(int)'
|
||||||
|
else
|
||||||
|
'UNITY_OUTPUT_CHAR_HEADER_DECLARATION=UnityOutputCharSpy_OutputChar\(int\)'
|
||||||
|
end
|
||||||
|
squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'] + ['UNITY_OUTPUT_CHAR=UnityOutputCharSpy_OutputChar'] + [decl])
|
||||||
|
end
|
||||||
|
options = squash('', $cfg['compiler']['options'])
|
||||||
|
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
|
||||||
|
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
||||||
|
|
||||||
|
{ command: command, defines: defines, options: options, includes: includes }
|
||||||
|
end
|
||||||
|
|
||||||
|
def compile(file, _defines = [])
|
||||||
|
compiler = build_compiler_fields
|
||||||
|
unity_include = $cfg['compiler']['includes']['prefix'] + '../../src'
|
||||||
|
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{unity_include} #{file} " \
|
||||||
|
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}" \
|
||||||
|
"#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
|
||||||
|
|
||||||
|
execute(cmd_str)
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_linker_fields
|
||||||
|
command = tackit($cfg['linker']['path'])
|
||||||
|
options = if $cfg['linker']['options'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash('', $cfg['linker']['options'])
|
||||||
|
end
|
||||||
|
includes = if $cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
|
||||||
|
end.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
||||||
|
|
||||||
|
{ command: command, options: options, includes: includes }
|
||||||
|
end
|
||||||
|
|
||||||
|
def link_it(exe_name, obj_list)
|
||||||
|
linker = build_linker_fields
|
||||||
|
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
|
||||||
|
(obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join +
|
||||||
|
$cfg['linker']['bin_files']['prefix'] + ' ' +
|
||||||
|
$cfg['linker']['bin_files']['destination'] +
|
||||||
|
exe_name + $cfg['linker']['bin_files']['extension']
|
||||||
|
execute(cmd_str)
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_simulator_fields
|
||||||
|
return nil if $cfg['simulator'].nil?
|
||||||
|
|
||||||
|
command = if $cfg['simulator']['path'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
(tackit($cfg['simulator']['path']) + ' ')
|
||||||
|
end
|
||||||
|
pre_support = if $cfg['simulator']['pre_support'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash('', $cfg['simulator']['pre_support'])
|
||||||
|
end
|
||||||
|
post_support = if $cfg['simulator']['post_support'].nil?
|
||||||
|
''
|
||||||
|
else
|
||||||
|
squash('', $cfg['simulator']['post_support'])
|
||||||
|
end
|
||||||
|
{ command: command, pre_support: pre_support, post_support: post_support }
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute(command_string, verbose = true)
|
||||||
|
report command_string
|
||||||
|
output = `#{command_string}`.chomp
|
||||||
|
report(output) if verbose && !output.nil? && !output.empty?
|
||||||
|
|
||||||
|
raise "Command failed. (Returned #{$?.exitstatus})" if $?.exitstatus != 0
|
||||||
|
|
||||||
|
output
|
||||||
|
end
|
||||||
|
|
||||||
|
def report_summary
|
||||||
|
summary = UnityTestSummary.new
|
||||||
|
summary.root = __dir__
|
||||||
|
results_glob = "#{$cfg['compiler']['build_path']}*.test*"
|
||||||
|
results_glob.tr!('\\', '/')
|
||||||
|
results = Dir[results_glob]
|
||||||
|
summary.targets = results
|
||||||
|
summary.run
|
||||||
|
end
|
||||||
|
|
||||||
|
def run_tests(exclude_stdlib=false)
|
||||||
|
report 'Running Unity system tests...'
|
||||||
|
|
||||||
|
# Tack on TEST define for compiling unit tests
|
||||||
|
load_configuration($cfg_file)
|
||||||
|
test_defines = ['TEST']
|
||||||
|
$cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil?
|
||||||
|
$cfg['compiler']['defines']['items'] << 'UNITY_EXCLUDE_STDLIB_MALLOC' if exclude_stdlib
|
||||||
|
|
||||||
|
# Get a list of all source files needed
|
||||||
|
src_files = Dir["#{__dir__}/src/*.c"]
|
||||||
|
src_files += Dir["#{__dir__}/test/*.c"]
|
||||||
|
src_files << '../../src/unity.c'
|
||||||
|
|
||||||
|
# Build object files
|
||||||
|
src_files.each { |f| compile(f, test_defines) }
|
||||||
|
obj_list = src_files.map { |f| File.basename(f.ext($cfg['compiler']['object_files']['extension'])) }
|
||||||
|
|
||||||
|
# Link the test executable
|
||||||
|
test_base = 'framework_test'
|
||||||
|
link_it(test_base, obj_list)
|
||||||
|
|
||||||
|
# Execute unit test and generate results file
|
||||||
|
simulator = build_simulator_fields
|
||||||
|
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
|
||||||
|
cmd_str = if simulator.nil?
|
||||||
|
executable + ' -v -r'
|
||||||
|
else
|
||||||
|
"#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
||||||
|
end
|
||||||
|
output = execute(cmd_str)
|
||||||
|
test_results = $cfg['compiler']['build_path'] + test_base
|
||||||
|
test_results += if output.match(/OK$/m).nil?
|
||||||
|
'.testfail'
|
||||||
|
else
|
||||||
|
'.testpass'
|
||||||
|
end
|
||||||
|
File.open(test_results, 'w') { |f| f.print output }
|
||||||
|
end
|
||||||
49
extras/memory/readme.md
Normal file
49
extras/memory/readme.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
# Unity Memory
|
||||||
|
|
||||||
|
This Framework is an optional add-on to Unity. By including unity.h and then
|
||||||
|
unity_memory.h, you have the added ability to track malloc and free calls. This
|
||||||
|
addon requires that the stdlib functions be overridden by its own defines. These
|
||||||
|
defines will still malloc / realloc / free etc, but will also track the calls
|
||||||
|
in order to ensure that you don't have any memory leaks in your programs.
|
||||||
|
|
||||||
|
Note that this is only useful in situations where a unit is in charge of both
|
||||||
|
the allocation and deallocation of memory. When it is not symmetric, unit testing
|
||||||
|
can report a number of false failures. A more advanced runtime tool is required to
|
||||||
|
track complete system memory handling.
|
||||||
|
|
||||||
|
# Module API
|
||||||
|
|
||||||
|
## `UnityMalloc_StartTest` and `UnityMalloc_EndTest`
|
||||||
|
|
||||||
|
These must be called at the beginning and end of each test. For simplicity, they can
|
||||||
|
be added to `setUp` and `tearDown` in order to do their job. When using the test
|
||||||
|
runner generator scripts, these will be automatically added to the runner whenever
|
||||||
|
unity_memory.h is included.
|
||||||
|
|
||||||
|
## `UnityMalloc_MakeMallocFailAfterCount`
|
||||||
|
|
||||||
|
This can be called from the tests themselves. Passing this function a number will
|
||||||
|
force the reference counter to start keeping track of malloc calls. During that test,
|
||||||
|
if the number of malloc calls exceeds the number given, malloc will immediately
|
||||||
|
start returning `NULL`. This allows you to test error conditions. Think of it as a
|
||||||
|
simplified mock.
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
|
||||||
|
## `UNITY_MALLOC` and `UNITY_FREE`
|
||||||
|
|
||||||
|
By default, this module tries to use the real stdlib `malloc` and `free` internally.
|
||||||
|
If you would prefer it to use something else, like FreeRTOS's `pvPortMalloc` and
|
||||||
|
`pvPortFree`, then you can use these defines to make it so.
|
||||||
|
|
||||||
|
## `UNITY_EXCLUDE_STDLIB_MALLOC`
|
||||||
|
|
||||||
|
If you would like this library to ignore stdlib or other heap engines completely, and
|
||||||
|
manage the memory on its own, then define this. All memory will be handled internally
|
||||||
|
(and at likely lower overhead). Note that this is not a very featureful memory manager,
|
||||||
|
but is sufficient for most testing purposes.
|
||||||
|
|
||||||
|
## `UNITY_INTERNAL_HEAP_SIZE_BYTES`
|
||||||
|
|
||||||
|
When using the built-in memory manager (see `UNITY_EXCLUDE_STDLIB_MALLOC`) this define
|
||||||
|
allows you to set the heap size this library will use to manage the memory.
|
||||||
202
extras/memory/src/unity_memory.c
Normal file
202
extras/memory/src/unity_memory.c
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
/* ==========================================
|
||||||
|
* Unity Project - A Test Framework for C
|
||||||
|
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
|
* [Released under MIT License. Please refer to license.txt for details]
|
||||||
|
* ========================================== */
|
||||||
|
|
||||||
|
#include "unity.h"
|
||||||
|
#include "unity_memory.h"
|
||||||
|
#include <string.h>
|
||||||
|
|
||||||
|
#define MALLOC_DONT_FAIL -1
|
||||||
|
static int malloc_count;
|
||||||
|
static int malloc_fail_countdown = MALLOC_DONT_FAIL;
|
||||||
|
|
||||||
|
void UnityMalloc_StartTest(void)
|
||||||
|
{
|
||||||
|
malloc_count = 0;
|
||||||
|
malloc_fail_countdown = MALLOC_DONT_FAIL;
|
||||||
|
}
|
||||||
|
|
||||||
|
void UnityMalloc_EndTest(void)
|
||||||
|
{
|
||||||
|
malloc_fail_countdown = MALLOC_DONT_FAIL;
|
||||||
|
if (malloc_count != 0)
|
||||||
|
{
|
||||||
|
UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "This test leaks!");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void UnityMalloc_MakeMallocFailAfterCount(int countdown)
|
||||||
|
{
|
||||||
|
malloc_fail_countdown = countdown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* These definitions are always included from unity_fixture_malloc_overrides.h */
|
||||||
|
/* We undef to use them or avoid conflict with <stdlib.h> per the C standard */
|
||||||
|
#undef malloc
|
||||||
|
#undef free
|
||||||
|
#undef calloc
|
||||||
|
#undef realloc
|
||||||
|
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
static unsigned char unity_heap[UNITY_INTERNAL_HEAP_SIZE_BYTES];
|
||||||
|
static size_t heap_index;
|
||||||
|
#else
|
||||||
|
#include <stdlib.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
typedef struct GuardBytes
|
||||||
|
{
|
||||||
|
size_t size;
|
||||||
|
size_t guard_space;
|
||||||
|
} Guard;
|
||||||
|
|
||||||
|
#define UNITY_MALLOC_ALIGNMENT (UNITY_POINTER_WIDTH / 8)
|
||||||
|
static const char end[] = "END";
|
||||||
|
|
||||||
|
static size_t unity_size_round_up(size_t size)
|
||||||
|
{
|
||||||
|
size_t rounded_size;
|
||||||
|
|
||||||
|
rounded_size = ((size + UNITY_MALLOC_ALIGNMENT - 1) / UNITY_MALLOC_ALIGNMENT) * UNITY_MALLOC_ALIGNMENT;
|
||||||
|
|
||||||
|
return rounded_size;
|
||||||
|
}
|
||||||
|
|
||||||
|
void* unity_malloc(size_t size)
|
||||||
|
{
|
||||||
|
char* mem;
|
||||||
|
Guard* guard;
|
||||||
|
size_t total_size;
|
||||||
|
|
||||||
|
total_size = sizeof(Guard) + unity_size_round_up(size + sizeof(end));
|
||||||
|
|
||||||
|
if (malloc_fail_countdown != MALLOC_DONT_FAIL)
|
||||||
|
{
|
||||||
|
if (malloc_fail_countdown == 0)
|
||||||
|
return NULL;
|
||||||
|
malloc_fail_countdown--;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (size == 0) return NULL;
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
if (heap_index + total_size > UNITY_INTERNAL_HEAP_SIZE_BYTES)
|
||||||
|
{
|
||||||
|
guard = NULL;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
/* We know we can get away with this cast because we aligned memory already */
|
||||||
|
guard = (Guard*)(void*)(&unity_heap[heap_index]);
|
||||||
|
heap_index += total_size;
|
||||||
|
}
|
||||||
|
#else
|
||||||
|
guard = (Guard*)UNITY_MALLOC(total_size);
|
||||||
|
#endif
|
||||||
|
if (guard == NULL) return NULL;
|
||||||
|
malloc_count++;
|
||||||
|
guard->size = size;
|
||||||
|
guard->guard_space = 0;
|
||||||
|
mem = (char*)&(guard[1]);
|
||||||
|
memcpy(&mem[size], end, sizeof(end));
|
||||||
|
|
||||||
|
return (void*)mem;
|
||||||
|
}
|
||||||
|
|
||||||
|
static int isOverrun(void* mem)
|
||||||
|
{
|
||||||
|
Guard* guard = (Guard*)mem;
|
||||||
|
char* memAsChar = (char*)mem;
|
||||||
|
guard--;
|
||||||
|
|
||||||
|
return guard->guard_space != 0 || strcmp(&memAsChar[guard->size], end) != 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
static void release_memory(void* mem)
|
||||||
|
{
|
||||||
|
Guard* guard = (Guard*)mem;
|
||||||
|
guard--;
|
||||||
|
|
||||||
|
malloc_count--;
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
{
|
||||||
|
size_t block_size;
|
||||||
|
|
||||||
|
block_size = unity_size_round_up(guard->size + sizeof(end));
|
||||||
|
|
||||||
|
if (mem == unity_heap + heap_index - block_size)
|
||||||
|
{
|
||||||
|
heap_index -= (sizeof(Guard) + block_size);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#else
|
||||||
|
UNITY_FREE(guard);
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void unity_free(void* mem)
|
||||||
|
{
|
||||||
|
int overrun;
|
||||||
|
|
||||||
|
if (mem == NULL)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
overrun = isOverrun(mem);
|
||||||
|
release_memory(mem);
|
||||||
|
if (overrun)
|
||||||
|
{
|
||||||
|
UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "Buffer overrun detected during free()");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void* unity_calloc(size_t num, size_t size)
|
||||||
|
{
|
||||||
|
void* mem = unity_malloc(num * size);
|
||||||
|
if (mem == NULL) return NULL;
|
||||||
|
memset(mem, 0, num * size);
|
||||||
|
return mem;
|
||||||
|
}
|
||||||
|
|
||||||
|
void* unity_realloc(void* oldMem, size_t size)
|
||||||
|
{
|
||||||
|
Guard* guard = (Guard*)oldMem;
|
||||||
|
void* newMem;
|
||||||
|
|
||||||
|
if (oldMem == NULL) return unity_malloc(size);
|
||||||
|
|
||||||
|
guard--;
|
||||||
|
if (isOverrun(oldMem))
|
||||||
|
{
|
||||||
|
release_memory(oldMem);
|
||||||
|
UNITY_TEST_FAIL(Unity.CurrentTestLineNumber, "Buffer overrun detected during realloc()");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (size == 0)
|
||||||
|
{
|
||||||
|
release_memory(oldMem);
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (guard->size >= size) return oldMem;
|
||||||
|
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC /* Optimization if memory is expandable */
|
||||||
|
{
|
||||||
|
size_t old_total_size = unity_size_round_up(guard->size + sizeof(end));
|
||||||
|
|
||||||
|
if ((oldMem == unity_heap + heap_index - old_total_size) &&
|
||||||
|
((heap_index - old_total_size + unity_size_round_up(size + sizeof(end))) <= UNITY_INTERNAL_HEAP_SIZE_BYTES))
|
||||||
|
{
|
||||||
|
release_memory(oldMem); /* Not thread-safe, like unity_heap generally */
|
||||||
|
return unity_malloc(size); /* No memcpy since data is in place */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
newMem = unity_malloc(size);
|
||||||
|
if (newMem == NULL) return NULL; /* Do not release old memory */
|
||||||
|
memcpy(newMem, oldMem, guard->size);
|
||||||
|
release_memory(oldMem);
|
||||||
|
return newMem;
|
||||||
|
}
|
||||||
@@ -1,12 +1,16 @@
|
|||||||
/* Copyright (c) 2010 James Grenning and Contributed to Unity Project
|
/* ==========================================
|
||||||
* ==========================================
|
|
||||||
* Unity Project - A Test Framework for C
|
* Unity Project - A Test Framework for C
|
||||||
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
* [Released under MIT License. Please refer to license.txt for details]
|
* [Released under MIT License. Please refer to license.txt for details]
|
||||||
* ========================================== */
|
* ========================================== */
|
||||||
|
|
||||||
#ifndef UNITY_FIXTURE_MALLOC_OVERRIDES_H_
|
#ifndef UNITY_MEMORY_OVERRIDES_H_
|
||||||
#define UNITY_FIXTURE_MALLOC_OVERRIDES_H_
|
#define UNITY_MEMORY_OVERRIDES_H_
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C"
|
||||||
|
{
|
||||||
|
#endif
|
||||||
|
|
||||||
#include <stddef.h>
|
#include <stddef.h>
|
||||||
|
|
||||||
@@ -21,16 +25,17 @@
|
|||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* These functions are used by the Unity Fixture to allocate and release memory
|
/* These functions are used by Unity to allocate and release memory
|
||||||
* on the heap and can be overridden with platform-specific implementations.
|
* on the heap and can be overridden with platform-specific implementations.
|
||||||
* For example, when using FreeRTOS UNITY_FIXTURE_MALLOC becomes pvPortMalloc()
|
* For example, when using FreeRTOS UNITY_MALLOC becomes pvPortMalloc()
|
||||||
* and UNITY_FIXTURE_FREE becomes vPortFree(). */
|
* and UNITY_FREE becomes vPortFree(). */
|
||||||
#if !defined(UNITY_FIXTURE_MALLOC) || !defined(UNITY_FIXTURE_FREE)
|
#if !defined(UNITY_MALLOC) || !defined(UNITY_FREE)
|
||||||
#define UNITY_FIXTURE_MALLOC(size) malloc(size)
|
#include <stdlib.h>
|
||||||
#define UNITY_FIXTURE_FREE(ptr) free(ptr)
|
#define UNITY_MALLOC(size) malloc(size)
|
||||||
|
#define UNITY_FREE(ptr) free(ptr)
|
||||||
#else
|
#else
|
||||||
extern void* UNITY_FIXTURE_MALLOC(size_t size);
|
extern void* UNITY_MALLOC(size_t size);
|
||||||
extern void UNITY_FIXTURE_FREE(void* ptr);
|
extern void UNITY_FREE(void* ptr);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#define malloc unity_malloc
|
#define malloc unity_malloc
|
||||||
@@ -43,4 +48,13 @@ void* unity_calloc(size_t num, size_t size);
|
|||||||
void* unity_realloc(void * oldMem, size_t size);
|
void* unity_realloc(void * oldMem, size_t size);
|
||||||
void unity_free(void * mem);
|
void unity_free(void * mem);
|
||||||
|
|
||||||
#endif /* UNITY_FIXTURE_MALLOC_OVERRIDES_H_ */
|
/* You must compile with malloc replacement, as defined in unity_fixture_malloc_overrides.h */
|
||||||
|
void UnityMalloc_StartTest(void);
|
||||||
|
void UnityMalloc_EndTest(void);
|
||||||
|
void UnityMalloc_MakeMallocFailAfterCount(int countdown);
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
78
extras/memory/test/Makefile
Normal file
78
extras/memory/test/Makefile
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
CC = gcc
|
||||||
|
ifeq ($(shell uname -s), Darwin)
|
||||||
|
CC = clang
|
||||||
|
endif
|
||||||
|
#DEBUG = -O0 -g
|
||||||
|
CFLAGS += -std=c99 -pedantic -Wall -Wextra -Werror
|
||||||
|
CFLAGS += $(DEBUG)
|
||||||
|
DEFINES = -D UNITY_OUTPUT_CHAR=UnityOutputCharSpy_OutputChar
|
||||||
|
ifeq ($(OS),Windows_NT)
|
||||||
|
DEFINES += -D UNITY_OUTPUT_CHAR_HEADER_DECLARATION=UnityOutputCharSpy_OutputChar(int)
|
||||||
|
else
|
||||||
|
DEFINES += -D UNITY_OUTPUT_CHAR_HEADER_DECLARATION=UnityOutputCharSpy_OutputChar\(int\)
|
||||||
|
endif
|
||||||
|
SRC = ../src/unity_memory.c \
|
||||||
|
../../../src/unity.c \
|
||||||
|
unity_memory_Test.c \
|
||||||
|
unity_memory_TestRunner.c \
|
||||||
|
unity_output_Spy.c \
|
||||||
|
|
||||||
|
INC_DIR = -I../src -I../../../src/
|
||||||
|
BUILD_DIR = ../build
|
||||||
|
TARGET = ../build/memory_tests.exe
|
||||||
|
|
||||||
|
all: default noStdlibMalloc 32bits
|
||||||
|
|
||||||
|
default: $(BUILD_DIR)
|
||||||
|
$(CC) $(CFLAGS) $(DEFINES) $(SRC) $(INC_DIR) -o $(TARGET) -D UNITY_SUPPORT_64
|
||||||
|
@ echo "default build"
|
||||||
|
./$(TARGET)
|
||||||
|
|
||||||
|
32bits: $(BUILD_DIR)
|
||||||
|
$(CC) $(CFLAGS) $(DEFINES) $(SRC) $(INC_DIR) -o $(TARGET) -m32
|
||||||
|
@ echo "32bits build"
|
||||||
|
./$(TARGET)
|
||||||
|
|
||||||
|
noStdlibMalloc: $(BUILD_DIR)
|
||||||
|
$(CC) $(CFLAGS) $(DEFINES) $(SRC) $(INC_DIR) -o $(TARGET) -D UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
@ echo "build with noStdlibMalloc"
|
||||||
|
./$(TARGET)
|
||||||
|
|
||||||
|
C89: CFLAGS += -D UNITY_EXCLUDE_STDINT_H # C89 did not have type 'long long', <stdint.h>
|
||||||
|
C89: $(BUILD_DIR)
|
||||||
|
$(CC) $(CFLAGS) $(DEFINES) $(SRC) $(INC_DIR) -o $(TARGET) -std=c89 && ./$(TARGET)
|
||||||
|
$(CC) $(CFLAGS) $(DEFINES) $(SRC) $(INC_DIR) -o $(TARGET) -D UNITY_EXCLUDE_STDLIB_MALLOC -std=c89
|
||||||
|
./$(TARGET)
|
||||||
|
|
||||||
|
$(BUILD_DIR):
|
||||||
|
mkdir -p $(BUILD_DIR)
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -f $(TARGET) $(BUILD_DIR)/*.gc*
|
||||||
|
|
||||||
|
cov: $(BUILD_DIR)
|
||||||
|
cd $(BUILD_DIR) && \
|
||||||
|
$(CC) $(DEFINES) $(foreach i, $(SRC), ../test/$(i)) $(INC_DIR) -o $(TARGET) -fprofile-arcs -ftest-coverage
|
||||||
|
rm -f $(BUILD_DIR)/*.gcda
|
||||||
|
./$(TARGET) > /dev/null ; ./$(TARGET) -v > /dev/null
|
||||||
|
cd $(BUILD_DIR) && \
|
||||||
|
gcov unity_memory.c | head -3
|
||||||
|
grep '###' $(BUILD_DIR)/unity_memory.c.gcov -C2 || true # Show uncovered lines
|
||||||
|
|
||||||
|
# These extended flags DO get included before any target build runs
|
||||||
|
CFLAGS += -Wbad-function-cast
|
||||||
|
CFLAGS += -Wcast-qual
|
||||||
|
CFLAGS += -Wconversion
|
||||||
|
CFLAGS += -Wformat=2
|
||||||
|
CFLAGS += -Wmissing-prototypes
|
||||||
|
CFLAGS += -Wold-style-definition
|
||||||
|
CFLAGS += -Wpointer-arith
|
||||||
|
CFLAGS += -Wshadow
|
||||||
|
CFLAGS += -Wstrict-overflow=5
|
||||||
|
CFLAGS += -Wstrict-prototypes
|
||||||
|
CFLAGS += -Wswitch-default
|
||||||
|
CFLAGS += -Wundef
|
||||||
|
CFLAGS += -Wno-error=undef # Warning only, this should not stop the build
|
||||||
|
CFLAGS += -Wunreachable-code
|
||||||
|
CFLAGS += -Wunused
|
||||||
|
CFLAGS += -fstrict-aliasing
|
||||||
325
extras/memory/test/unity_memory_Test.c
Normal file
325
extras/memory/test/unity_memory_Test.c
Normal file
@@ -0,0 +1,325 @@
|
|||||||
|
/* ==========================================
|
||||||
|
* Unity Project - A Test Framework for C
|
||||||
|
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
|
* [Released under MIT License. Please refer to license.txt for details]
|
||||||
|
* ========================================== */
|
||||||
|
|
||||||
|
#include "unity.h"
|
||||||
|
#include "unity_memory.h"
|
||||||
|
#include "unity_output_Spy.h"
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <string.h>
|
||||||
|
|
||||||
|
/* This test module includes the following tests: */
|
||||||
|
|
||||||
|
void test_ForceMallocFail(void);
|
||||||
|
void test_ReallocSmallerIsUnchanged(void);
|
||||||
|
void test_ReallocSameIsUnchanged(void);
|
||||||
|
void test_ReallocLargerNeeded(void);
|
||||||
|
void test_ReallocNullPointerIsLikeMalloc(void);
|
||||||
|
void test_ReallocSizeZeroFreesMemAndReturnsNullPointer(void);
|
||||||
|
void test_CallocFillsWithZero(void);
|
||||||
|
void test_FreeNULLSafety(void);
|
||||||
|
void test_DetectsLeak(void);
|
||||||
|
void test_BufferOverrunFoundDuringFree(void);
|
||||||
|
void test_BufferOverrunFoundDuringRealloc(void);
|
||||||
|
void test_BufferGuardWriteFoundDuringFree(void);
|
||||||
|
void test_BufferGuardWriteFoundDuringRealloc(void);
|
||||||
|
void test_MallocPastBufferFails(void);
|
||||||
|
void test_CallocPastBufferFails(void);
|
||||||
|
void test_MallocThenReallocGrowsMemoryInPlace(void);
|
||||||
|
void test_ReallocFailDoesNotFreeMem(void);
|
||||||
|
|
||||||
|
/* It makes use of the following features */
|
||||||
|
void setUp(void);
|
||||||
|
void tearDown(void);
|
||||||
|
|
||||||
|
/* Let's Go! */
|
||||||
|
void setUp(void)
|
||||||
|
{
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
UnityOutputCharSpy_Create(200);
|
||||||
|
#else
|
||||||
|
UnityOutputCharSpy_Create(1000);
|
||||||
|
#endif
|
||||||
|
UnityMalloc_StartTest();
|
||||||
|
}
|
||||||
|
|
||||||
|
void tearDown(void)
|
||||||
|
{
|
||||||
|
UnityMalloc_EndTest();
|
||||||
|
UnityOutputCharSpy_Destroy();
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_ForceMallocFail(void)
|
||||||
|
{
|
||||||
|
void* m;
|
||||||
|
void* mfails;
|
||||||
|
UnityMalloc_MakeMallocFailAfterCount(1);
|
||||||
|
m = malloc(10);
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
mfails = malloc(10);
|
||||||
|
TEST_ASSERT_EQUAL_PTR(0, mfails);
|
||||||
|
free(m);
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_ReallocSmallerIsUnchanged(void)
|
||||||
|
{
|
||||||
|
void* m1 = malloc(10);
|
||||||
|
void* m2 = realloc(m1, 5);
|
||||||
|
TEST_ASSERT_NOT_NULL(m1);
|
||||||
|
TEST_ASSERT_EQUAL_PTR(m1, m2);
|
||||||
|
free(m2);
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_ReallocSameIsUnchanged(void)
|
||||||
|
{
|
||||||
|
void* m1 = malloc(10);
|
||||||
|
void* m2 = realloc(m1, 10);
|
||||||
|
TEST_ASSERT_NOT_NULL(m1);
|
||||||
|
TEST_ASSERT_EQUAL_PTR(m1, m2);
|
||||||
|
free(m2);
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_ReallocLargerNeeded(void)
|
||||||
|
{
|
||||||
|
void* m2;
|
||||||
|
void* m1 = malloc(10);
|
||||||
|
TEST_ASSERT_NOT_NULL(m1);
|
||||||
|
strcpy((char*)m1, "123456789");
|
||||||
|
m2 = realloc(m1, 15);
|
||||||
|
TEST_ASSERT_EQUAL_STRING("123456789", m2);
|
||||||
|
free(m2);
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_ReallocNullPointerIsLikeMalloc(void)
|
||||||
|
{
|
||||||
|
void* m = realloc(0, 15);
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
free(m);
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_ReallocSizeZeroFreesMemAndReturnsNullPointer(void)
|
||||||
|
{
|
||||||
|
void* m1 = malloc(10);
|
||||||
|
void* m2 = realloc(m1, 0);
|
||||||
|
TEST_ASSERT_EQUAL_PTR(0, m2);
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_CallocFillsWithZero(void)
|
||||||
|
{
|
||||||
|
void* m = calloc(3, sizeof(char));
|
||||||
|
char* s = (char*)m;
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
TEST_ASSERT_EQUAL_HEX8(0, s[0]);
|
||||||
|
TEST_ASSERT_EQUAL_HEX8(0, s[1]);
|
||||||
|
TEST_ASSERT_EQUAL_HEX8(0, s[2]);
|
||||||
|
free(m);
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_FreeNULLSafety(void)
|
||||||
|
{
|
||||||
|
free(NULL);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*------------------------------------------------------------ */
|
||||||
|
|
||||||
|
#define EXPECT_ABORT_BEGIN \
|
||||||
|
{ \
|
||||||
|
jmp_buf TestAbortFrame; \
|
||||||
|
memcpy(TestAbortFrame, Unity.AbortFrame, sizeof(jmp_buf)); \
|
||||||
|
if (TEST_PROTECT()) \
|
||||||
|
{
|
||||||
|
|
||||||
|
#define EXPECT_ABORT_END \
|
||||||
|
} \
|
||||||
|
memcpy(Unity.AbortFrame, TestAbortFrame, sizeof(jmp_buf)); \
|
||||||
|
}
|
||||||
|
|
||||||
|
/* This tricky set of defines lets us see if we are using the Spy, returns 1 if true */
|
||||||
|
#ifdef __STDC_VERSION__
|
||||||
|
|
||||||
|
#ifdef UNITY_SUPPORT_VARIADIC_MACROS
|
||||||
|
#define USING_SPY_AS(a) EXPAND_AND_USE_2ND(ASSIGN_VALUE(a), 0)
|
||||||
|
#define ASSIGN_VALUE(a) VAL_##a
|
||||||
|
#define VAL_UnityOutputCharSpy_OutputChar 0, 1
|
||||||
|
#define EXPAND_AND_USE_2ND(a, b) SECOND_PARAM(a, b, throwaway)
|
||||||
|
#define SECOND_PARAM(a, b, ...) b
|
||||||
|
#if USING_SPY_AS(UNITY_OUTPUT_CHAR)
|
||||||
|
#define USING_OUTPUT_SPY /* UNITY_OUTPUT_CHAR = UnityOutputCharSpy_OutputChar */
|
||||||
|
#endif
|
||||||
|
#endif /* UNITY_SUPPORT_VARIADIC_MACROS */
|
||||||
|
|
||||||
|
#else /* __STDC_VERSION__ else */
|
||||||
|
|
||||||
|
#define UnityOutputCharSpy_OutputChar 42
|
||||||
|
#if UNITY_OUTPUT_CHAR == UnityOutputCharSpy_OutputChar /* Works if no -Wundef -Werror */
|
||||||
|
#define USING_OUTPUT_SPY
|
||||||
|
#endif
|
||||||
|
#undef UnityOutputCharSpy_OutputChar
|
||||||
|
|
||||||
|
#endif /* __STDC_VERSION__ */
|
||||||
|
|
||||||
|
void test_DetectsLeak(void)
|
||||||
|
{
|
||||||
|
#ifdef USING_OUTPUT_SPY
|
||||||
|
void* m = malloc(10);
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
UnityOutputCharSpy_Enable(1);
|
||||||
|
EXPECT_ABORT_BEGIN
|
||||||
|
UnityMalloc_EndTest();
|
||||||
|
EXPECT_ABORT_END
|
||||||
|
UnityOutputCharSpy_Enable(0);
|
||||||
|
Unity.CurrentTestFailed = 0;
|
||||||
|
TEST_ASSERT_NOT_NULL(strstr(UnityOutputCharSpy_Get(), "This test leaks!"));
|
||||||
|
free(m);
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable USING_OUTPUT_SPY To Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_BufferOverrunFoundDuringFree(void)
|
||||||
|
{
|
||||||
|
#ifdef USING_OUTPUT_SPY
|
||||||
|
void* m = malloc(10);
|
||||||
|
char* s = (char*)m;
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
s[10] = (char)0xFF;
|
||||||
|
UnityOutputCharSpy_Enable(1);
|
||||||
|
EXPECT_ABORT_BEGIN
|
||||||
|
free(m);
|
||||||
|
EXPECT_ABORT_END
|
||||||
|
UnityOutputCharSpy_Enable(0);
|
||||||
|
Unity.CurrentTestFailed = 0;
|
||||||
|
TEST_ASSERT_NOT_NULL(strstr(UnityOutputCharSpy_Get(), "Buffer overrun detected during free()"));
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable USING_OUTPUT_SPY To Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_BufferOverrunFoundDuringRealloc(void)
|
||||||
|
{
|
||||||
|
#ifdef USING_OUTPUT_SPY
|
||||||
|
void* m = malloc(10);
|
||||||
|
char* s = (char*)m;
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
s[10] = (char)0xFF;
|
||||||
|
UnityOutputCharSpy_Enable(1);
|
||||||
|
EXPECT_ABORT_BEGIN
|
||||||
|
m = realloc(m, 100);
|
||||||
|
EXPECT_ABORT_END
|
||||||
|
UnityOutputCharSpy_Enable(0);
|
||||||
|
Unity.CurrentTestFailed = 0;
|
||||||
|
TEST_ASSERT_NOT_NULL(strstr(UnityOutputCharSpy_Get(), "Buffer overrun detected during realloc()"));
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable USING_OUTPUT_SPY To Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_BufferGuardWriteFoundDuringFree(void)
|
||||||
|
{
|
||||||
|
#ifdef USING_OUTPUT_SPY
|
||||||
|
void* m = malloc(10);
|
||||||
|
char* s = (char*)m;
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
s[-1] = (char)0x00; /* Will not detect 0 */
|
||||||
|
s[-2] = (char)0x01;
|
||||||
|
UnityOutputCharSpy_Enable(1);
|
||||||
|
EXPECT_ABORT_BEGIN
|
||||||
|
free(m);
|
||||||
|
EXPECT_ABORT_END
|
||||||
|
UnityOutputCharSpy_Enable(0);
|
||||||
|
Unity.CurrentTestFailed = 0;
|
||||||
|
TEST_ASSERT_NOT_NULL(strstr(UnityOutputCharSpy_Get(), "Buffer overrun detected during free()"));
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable USING_OUTPUT_SPY To Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_BufferGuardWriteFoundDuringRealloc(void)
|
||||||
|
{
|
||||||
|
#ifdef USING_OUTPUT_SPY
|
||||||
|
void* m = malloc(10);
|
||||||
|
char* s = (char*)m;
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
s[-1] = (char)0x0A;
|
||||||
|
UnityOutputCharSpy_Enable(1);
|
||||||
|
EXPECT_ABORT_BEGIN
|
||||||
|
m = realloc(m, 100);
|
||||||
|
EXPECT_ABORT_END
|
||||||
|
UnityOutputCharSpy_Enable(0);
|
||||||
|
Unity.CurrentTestFailed = 0;
|
||||||
|
TEST_ASSERT_NOT_NULL(strstr(UnityOutputCharSpy_Get(), "Buffer overrun detected during realloc()"));
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable USING_OUTPUT_SPY To Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
/*------------------------------------------------------------ */
|
||||||
|
|
||||||
|
#define TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(first_mem_ptr, ptr) \
|
||||||
|
ptr = malloc(10); free(ptr); \
|
||||||
|
TEST_ASSERT_EQUAL_PTR_MESSAGE(first_mem_ptr, ptr, "Memory was stranded, free in LIFO order");
|
||||||
|
|
||||||
|
void test_MallocPastBufferFails(void)
|
||||||
|
{
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
void* m = malloc(UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 1);
|
||||||
|
void* n = malloc(UNITY_INTERNAL_HEAP_SIZE_BYTES/2);
|
||||||
|
free(m);
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
TEST_ASSERT_NULL(n);
|
||||||
|
TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(m, n);
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable UNITY_EXCLUDE_STDLIB_MALLOC to Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_CallocPastBufferFails(void)
|
||||||
|
{
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
void* m = calloc(1, UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 1);
|
||||||
|
void* n = calloc(1, UNITY_INTERNAL_HEAP_SIZE_BYTES/2);
|
||||||
|
free(m);
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
TEST_ASSERT_NULL(n);
|
||||||
|
TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(m, n);
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable UNITY_EXCLUDE_STDLIB_MALLOC to Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_MallocThenReallocGrowsMemoryInPlace(void)
|
||||||
|
{
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
void* m = malloc(UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 1);
|
||||||
|
void* n = realloc(m, UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 9);
|
||||||
|
free(n);
|
||||||
|
TEST_ASSERT_NOT_NULL(m);
|
||||||
|
TEST_ASSERT_EQUAL(m, n);
|
||||||
|
TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(m, n);
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable UNITY_EXCLUDE_STDLIB_MALLOC to Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_ReallocFailDoesNotFreeMem(void)
|
||||||
|
{
|
||||||
|
#ifdef UNITY_EXCLUDE_STDLIB_MALLOC
|
||||||
|
void* m = malloc(UNITY_INTERNAL_HEAP_SIZE_BYTES/2);
|
||||||
|
void* n1 = malloc(10);
|
||||||
|
void* out_of_mem = realloc(n1, UNITY_INTERNAL_HEAP_SIZE_BYTES/2 + 1);
|
||||||
|
void* n2 = malloc(10);
|
||||||
|
|
||||||
|
free(n2);
|
||||||
|
if (out_of_mem == NULL) free(n1);
|
||||||
|
free(m);
|
||||||
|
|
||||||
|
TEST_ASSERT_NOT_NULL(m); /* Got a real memory location */
|
||||||
|
TEST_ASSERT_NULL(out_of_mem); /* The realloc should have failed */
|
||||||
|
TEST_ASSERT_NOT_EQUAL(n2, n1); /* If n1 != n2 then realloc did not free n1 */
|
||||||
|
TEST_ASSERT_MEMORY_ALL_FREE_LIFO_ORDER(m, n2);
|
||||||
|
#else
|
||||||
|
TEST_IGNORE_MESSAGE("Enable UNITY_EXCLUDE_STDLIB_MALLOC to Run This Test");
|
||||||
|
#endif
|
||||||
|
}
|
||||||
49
extras/memory/test/unity_memory_TestRunner.c
Normal file
49
extras/memory/test/unity_memory_TestRunner.c
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
/* ==========================================
|
||||||
|
* Unity Project - A Test Framework for C
|
||||||
|
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
|
* [Released under MIT License. Please refer to license.txt for details]
|
||||||
|
* ========================================== */
|
||||||
|
|
||||||
|
#include "unity.h"
|
||||||
|
#include "unity_memory.h"
|
||||||
|
|
||||||
|
extern void test_ForceMallocFail(void);
|
||||||
|
extern void test_ReallocSmallerIsUnchanged(void);
|
||||||
|
extern void test_ReallocSameIsUnchanged(void);
|
||||||
|
extern void test_ReallocLargerNeeded(void);
|
||||||
|
extern void test_ReallocNullPointerIsLikeMalloc(void);
|
||||||
|
extern void test_ReallocSizeZeroFreesMemAndReturnsNullPointer(void);
|
||||||
|
extern void test_CallocFillsWithZero(void);
|
||||||
|
extern void test_FreeNULLSafety(void);
|
||||||
|
extern void test_DetectsLeak(void);
|
||||||
|
extern void test_BufferOverrunFoundDuringFree(void);
|
||||||
|
extern void test_BufferOverrunFoundDuringRealloc(void);
|
||||||
|
extern void test_BufferGuardWriteFoundDuringFree(void);
|
||||||
|
extern void test_BufferGuardWriteFoundDuringRealloc(void);
|
||||||
|
extern void test_MallocPastBufferFails(void);
|
||||||
|
extern void test_CallocPastBufferFails(void);
|
||||||
|
extern void test_MallocThenReallocGrowsMemoryInPlace(void);
|
||||||
|
extern void test_ReallocFailDoesNotFreeMem(void);
|
||||||
|
|
||||||
|
int main(void)
|
||||||
|
{
|
||||||
|
UnityBegin("unity_memory_Test.c");
|
||||||
|
RUN_TEST(test_ForceMallocFail);
|
||||||
|
RUN_TEST(test_ReallocSmallerIsUnchanged);
|
||||||
|
RUN_TEST(test_ReallocSameIsUnchanged);
|
||||||
|
RUN_TEST(test_ReallocLargerNeeded);
|
||||||
|
RUN_TEST(test_ReallocNullPointerIsLikeMalloc);
|
||||||
|
RUN_TEST(test_ReallocSizeZeroFreesMemAndReturnsNullPointer);
|
||||||
|
RUN_TEST(test_CallocFillsWithZero);
|
||||||
|
RUN_TEST(test_FreeNULLSafety);
|
||||||
|
RUN_TEST(test_DetectsLeak);
|
||||||
|
RUN_TEST(test_BufferOverrunFoundDuringFree);
|
||||||
|
RUN_TEST(test_BufferOverrunFoundDuringRealloc);
|
||||||
|
RUN_TEST(test_BufferGuardWriteFoundDuringFree);
|
||||||
|
RUN_TEST(test_BufferGuardWriteFoundDuringRealloc);
|
||||||
|
RUN_TEST(test_MallocPastBufferFails);
|
||||||
|
RUN_TEST(test_CallocPastBufferFails);
|
||||||
|
RUN_TEST(test_MallocThenReallocGrowsMemoryInPlace);
|
||||||
|
RUN_TEST(test_ReallocFailDoesNotFreeMem);
|
||||||
|
return UnityEnd();
|
||||||
|
}
|
||||||
@@ -1,16 +1,15 @@
|
|||||||
/* Copyright (c) 2010 James Grenning and Contributed to Unity Project
|
/* ==========================================
|
||||||
* ==========================================
|
|
||||||
* Unity Project - A Test Framework for C
|
* Unity Project - A Test Framework for C
|
||||||
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
* [Released under MIT License. Please refer to license.txt for details]
|
* [Released under MIT License. Please refer to license.txt for details]
|
||||||
* ========================================== */
|
* ========================================== */
|
||||||
|
|
||||||
|
#include "unity.h"
|
||||||
#include "unity_output_Spy.h"
|
#include "unity_output_Spy.h"
|
||||||
#include "unity_fixture.h"
|
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
|
||||||
static int size;
|
static int size;
|
||||||
static int count;
|
static int count;
|
||||||
@@ -1,12 +1,11 @@
|
|||||||
/* Copyright (c) 2010 James Grenning and Contributed to Unity Project
|
/* ==========================================
|
||||||
* ==========================================
|
|
||||||
* Unity Project - A Test Framework for C
|
* Unity Project - A Test Framework for C
|
||||||
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
* Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
* [Released under MIT License. Please refer to license.txt for details]
|
* [Released under MIT License. Please refer to license.txt for details]
|
||||||
* ========================================== */
|
* ========================================== */
|
||||||
|
|
||||||
#ifndef D_unity_output_Spy_H
|
#ifndef UNITY_OUTPUT_SPY_H
|
||||||
#define D_unity_output_Spy_H
|
#define UNITY_OUTPUT_SPY_H
|
||||||
|
|
||||||
void UnityOutputCharSpy_Create(int s);
|
void UnityOutputCharSpy_Create(int s);
|
||||||
void UnityOutputCharSpy_Destroy(void);
|
void UnityOutputCharSpy_Destroy(void);
|
||||||
69
meson.build
Normal file
69
meson.build
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
###################################################################################
|
||||||
|
# #
|
||||||
|
# NAME: meson.build #
|
||||||
|
# #
|
||||||
|
# AUTHOR: Mike Karlesky, Mark VanderVoord, Greg Williams. #
|
||||||
|
# WRITTEN BY: Michael Brockus. #
|
||||||
|
# #
|
||||||
|
# License: MIT #
|
||||||
|
# #
|
||||||
|
###################################################################################
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
project('unity', 'c',
|
||||||
|
license : 'MIT',
|
||||||
|
meson_version : '>=0.52.0',
|
||||||
|
default_options: [
|
||||||
|
'buildtype=minsize',
|
||||||
|
'optimization=3',
|
||||||
|
'warning_level=3',
|
||||||
|
'werror=true',
|
||||||
|
]
|
||||||
|
)
|
||||||
|
lang = 'c'
|
||||||
|
cc = meson.get_compiler(lang)
|
||||||
|
|
||||||
|
|
||||||
|
##
|
||||||
|
#
|
||||||
|
# Meson: Add compiler flags
|
||||||
|
#
|
||||||
|
##
|
||||||
|
if cc.get_id() == 'clang'
|
||||||
|
add_project_arguments(cc.get_supported_arguments(
|
||||||
|
[
|
||||||
|
'-Wweak-vtables', '-Wexit-time-destructors',
|
||||||
|
'-Wglobal-constructors', '-Wmissing-noreturn'
|
||||||
|
]
|
||||||
|
), language: lang)
|
||||||
|
endif
|
||||||
|
|
||||||
|
if cc.get_argument_syntax() == 'gcc'
|
||||||
|
add_project_arguments(cc.get_supported_arguments(
|
||||||
|
[
|
||||||
|
'-Wformat', '-Waddress', '-Winit-self', '-Wno-multichar',
|
||||||
|
'-Wpointer-arith' , '-Wwrite-strings' ,
|
||||||
|
'-Wno-parentheses' , '-Wno-type-limits' ,
|
||||||
|
'-Wformat-security' , '-Wunreachable-code' ,
|
||||||
|
'-Waggregate-return' , '-Wformat-nonliteral' ,
|
||||||
|
'-Wmissing-prototypes' , '-Wold-style-definition' ,
|
||||||
|
'-Wmissing-declarations', '-Wmissing-include-dirs' ,
|
||||||
|
'-Wno-unused-parameter' , '-Wdeclaration-after-statement'
|
||||||
|
]
|
||||||
|
), language: lang)
|
||||||
|
endif
|
||||||
|
|
||||||
|
if cc.get_id() == 'msvc'
|
||||||
|
add_project_arguments(cc.get_supported_arguments(
|
||||||
|
[
|
||||||
|
'/w44265', '/w44061', '/w44062',
|
||||||
|
'/wd4018', '/wd4146', '/wd4244',
|
||||||
|
'/wd4305',
|
||||||
|
]
|
||||||
|
), language: lang)
|
||||||
|
endif
|
||||||
|
|
||||||
|
subdir('src')
|
||||||
|
|
||||||
|
unity_dep = declare_dependency(link_with: unity_lib, include_directories: unity_dir)
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
120
|
|
||||||
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
2.4.0
|
|
||||||
|
|
||||||
22
src/CMakeLists.txt
Normal file
22
src/CMakeLists.txt
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
###################################################################################
|
||||||
|
# #
|
||||||
|
# NAME: CMakeLists.txt #
|
||||||
|
# #
|
||||||
|
# AUTHOR: Mike Karlesky, Mark VanderVoord, Greg Williams. #
|
||||||
|
# WRITTEN BY: Michael Brockus. #
|
||||||
|
# #
|
||||||
|
# License: MIT #
|
||||||
|
# #
|
||||||
|
###################################################################################
|
||||||
|
cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
|
||||||
|
|
||||||
|
|
||||||
|
add_library(unity STATIC "unity.c")
|
||||||
|
|
||||||
|
install(TARGETS unity EXPORT unityConfig
|
||||||
|
ARCHIVE DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/${CMAKE_INSTALL_LIBDIR}"
|
||||||
|
LIBRARY DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/${CMAKE_INSTALL_LIBDIR}"
|
||||||
|
RUNTIME DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/${CMAKE_INSTALL_BINDIR}"
|
||||||
|
INCLUDES DESTINATION "${CMAKE_INSTALL_LIBDIR}")
|
||||||
|
|
||||||
|
|
||||||
16
src/meson.build
Normal file
16
src/meson.build
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
###################################################################################
|
||||||
|
# #
|
||||||
|
# NAME: meson.build #
|
||||||
|
# #
|
||||||
|
# AUTHOR: Mike Karlesky, Mark VanderVoord, Greg Williams. #
|
||||||
|
# WRITTEN BY: Michael Brockus. #
|
||||||
|
# #
|
||||||
|
# License: MIT #
|
||||||
|
# #
|
||||||
|
###################################################################################
|
||||||
|
|
||||||
|
unity_dir = include_directories('.')
|
||||||
|
|
||||||
|
unity_lib = static_library(meson.project_name(),
|
||||||
|
sources: ['unity.c'],
|
||||||
|
include_directories: unity_dir)
|
||||||
1538
src/unity.c
1538
src/unity.c
File diff suppressed because it is too large
Load Diff
358
src/unity.h
358
src/unity.h
@@ -1,6 +1,6 @@
|
|||||||
/* ==========================================
|
/* ==========================================
|
||||||
Unity Project - A Test Framework for C
|
Unity Project - A Test Framework for C
|
||||||
Copyright (c) 2007-14 Mike Karlesky, Mark VanderVoord, Greg Williams
|
Copyright (c) 2007-19 Mike Karlesky, Mark VanderVoord, Greg Williams
|
||||||
[Released under MIT License. Please refer to license.txt for details]
|
[Released under MIT License. Please refer to license.txt for details]
|
||||||
========================================== */
|
========================================== */
|
||||||
|
|
||||||
@@ -8,6 +8,11 @@
|
|||||||
#define UNITY_FRAMEWORK_H
|
#define UNITY_FRAMEWORK_H
|
||||||
#define UNITY
|
#define UNITY
|
||||||
|
|
||||||
|
#define UNITY_VERSION_MAJOR 2
|
||||||
|
#define UNITY_VERSION_MINOR 5
|
||||||
|
#define UNITY_VERSION_BUILD 0
|
||||||
|
#define UNITY_VERSION ((UNITY_VERSION_MAJOR << 16) | (UNITY_VERSION_MINOR << 8) | UNITY_VERSION_BUILD)
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C"
|
extern "C"
|
||||||
{
|
{
|
||||||
@@ -15,9 +20,38 @@ extern "C"
|
|||||||
|
|
||||||
#include "unity_internals.h"
|
#include "unity_internals.h"
|
||||||
|
|
||||||
|
/*-------------------------------------------------------
|
||||||
|
* Test Setup / Teardown
|
||||||
|
*-------------------------------------------------------*/
|
||||||
|
|
||||||
|
/* These functions are intended to be called before and after each test.
|
||||||
|
* If using unity directly, these will need to be provided for each test
|
||||||
|
* executable built. If you are using the test runner generator and/or
|
||||||
|
* Ceedling, these are optional. */
|
||||||
void setUp(void);
|
void setUp(void);
|
||||||
void tearDown(void);
|
void tearDown(void);
|
||||||
|
|
||||||
|
/* These functions are intended to be called at the beginning and end of an
|
||||||
|
* entire test suite. suiteTearDown() is passed the number of tests that
|
||||||
|
* failed, and its return value becomes the exit code of main(). If using
|
||||||
|
* Unity directly, you're in charge of calling these if they are desired.
|
||||||
|
* If using Ceedling or the test runner generator, these will be called
|
||||||
|
* automatically if they exist. */
|
||||||
|
void suiteSetUp(void);
|
||||||
|
int suiteTearDown(int num_failures);
|
||||||
|
|
||||||
|
/*-------------------------------------------------------
|
||||||
|
* Test Reset and Verify
|
||||||
|
*-------------------------------------------------------*/
|
||||||
|
|
||||||
|
/* These functions are intended to be called before during tests in order
|
||||||
|
* to support complex test loops, etc. Both are NOT built into Unity. Instead
|
||||||
|
* the test runner generator will create them. resetTest will run teardown and
|
||||||
|
* setup again, verifying any end-of-test needs between. verifyTest will only
|
||||||
|
* run the verification. */
|
||||||
|
void resetTest(void);
|
||||||
|
void verifyTest(void);
|
||||||
|
|
||||||
/*-------------------------------------------------------
|
/*-------------------------------------------------------
|
||||||
* Configuration Options
|
* Configuration Options
|
||||||
*-------------------------------------------------------
|
*-------------------------------------------------------
|
||||||
@@ -37,13 +71,11 @@ void tearDown(void);
|
|||||||
* - define UNITY_EXCLUDE_FLOAT to disallow floating point comparisons
|
* - define UNITY_EXCLUDE_FLOAT to disallow floating point comparisons
|
||||||
* - define UNITY_FLOAT_PRECISION to specify the precision to use when doing TEST_ASSERT_EQUAL_FLOAT
|
* - define UNITY_FLOAT_PRECISION to specify the precision to use when doing TEST_ASSERT_EQUAL_FLOAT
|
||||||
* - define UNITY_FLOAT_TYPE to specify doubles instead of single precision floats
|
* - define UNITY_FLOAT_TYPE to specify doubles instead of single precision floats
|
||||||
* - define UNITY_FLOAT_VERBOSE to print floating point values in errors (uses sprintf)
|
|
||||||
* - define UNITY_INCLUDE_DOUBLE to allow double floating point comparisons
|
* - define UNITY_INCLUDE_DOUBLE to allow double floating point comparisons
|
||||||
* - define UNITY_EXCLUDE_DOUBLE to disallow double floating point comparisons (default)
|
* - define UNITY_EXCLUDE_DOUBLE to disallow double floating point comparisons (default)
|
||||||
* - define UNITY_DOUBLE_PRECISION to specify the precision to use when doing TEST_ASSERT_EQUAL_DOUBLE
|
* - define UNITY_DOUBLE_PRECISION to specify the precision to use when doing TEST_ASSERT_EQUAL_DOUBLE
|
||||||
* - define UNITY_DOUBLE_TYPE to specify something other than double
|
* - define UNITY_DOUBLE_TYPE to specify something other than double
|
||||||
* - define UNITY_DOUBLE_VERBOSE to print floating point values in errors (uses sprintf)
|
* - define UNITY_EXCLUDE_FLOAT_PRINT to trim binary size, won't print floating point values in errors
|
||||||
* - define UNITY_VERBOSE_NUMBER_MAX_LENGTH to change maximum length of printed numbers (used by sprintf)
|
|
||||||
|
|
||||||
* Output
|
* Output
|
||||||
* - by default, Unity prints to standard out with putchar. define UNITY_OUTPUT_CHAR(a) with a different function if desired
|
* - by default, Unity prints to standard out with putchar. define UNITY_OUTPUT_CHAR(a) with a different function if desired
|
||||||
@@ -70,11 +102,17 @@ void tearDown(void);
|
|||||||
#define TEST_FAIL() UNITY_TEST_FAIL(__LINE__, NULL)
|
#define TEST_FAIL() UNITY_TEST_FAIL(__LINE__, NULL)
|
||||||
#define TEST_IGNORE_MESSAGE(message) UNITY_TEST_IGNORE(__LINE__, (message))
|
#define TEST_IGNORE_MESSAGE(message) UNITY_TEST_IGNORE(__LINE__, (message))
|
||||||
#define TEST_IGNORE() UNITY_TEST_IGNORE(__LINE__, NULL)
|
#define TEST_IGNORE() UNITY_TEST_IGNORE(__LINE__, NULL)
|
||||||
|
#define TEST_MESSAGE(message) UnityMessage((message), __LINE__)
|
||||||
#define TEST_ONLY()
|
#define TEST_ONLY()
|
||||||
|
|
||||||
/* It is not necessary for you to call PASS. A PASS condition is assumed if nothing fails.
|
/* It is not necessary for you to call PASS. A PASS condition is assumed if nothing fails.
|
||||||
* This method allows you to abort a test immediately with a PASS state, ignoring the remainder of the test. */
|
* This method allows you to abort a test immediately with a PASS state, ignoring the remainder of the test. */
|
||||||
#define TEST_PASS() longjmp(Unity.AbortFrame, 1)
|
#define TEST_PASS() TEST_ABORT()
|
||||||
|
#define TEST_PASS_MESSAGE(message) do { UnityMessage((message), __LINE__); TEST_ABORT(); } while(0)
|
||||||
|
|
||||||
|
/* This macro does nothing, but it is useful for build tools (like Ceedling) to make use of this to figure out
|
||||||
|
* which files should be linked to in order to perform a test. Use it like TEST_FILE("sandwiches.c") */
|
||||||
|
#define TEST_FILE(a)
|
||||||
|
|
||||||
/*-------------------------------------------------------
|
/*-------------------------------------------------------
|
||||||
* Test Asserts (simple)
|
* Test Asserts (simple)
|
||||||
@@ -94,23 +132,96 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_EQUAL_INT16(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT16((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_INT16(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT16((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_INT32(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT32((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_INT32(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT32((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_INT64(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT64((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_INT64(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT64((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT((expected), (actual), __LINE__, NULL)
|
|
||||||
#define TEST_ASSERT_NOT_EQUAL(expected, actual) UNITY_TEST_ASSERT(((expected) != (actual)), __LINE__, " Expected Not-Equal")
|
|
||||||
#define TEST_ASSERT_EQUAL_UINT(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT( (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_UINT(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT( (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_UINT8(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT8( (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_UINT8(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT8( (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_UINT16(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT16( (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_UINT16(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT16( (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_UINT32(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT32( (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_UINT32(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT32( (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_UINT64(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT64( (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_UINT64(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT64( (expected), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EQUAL_size_t(expected, actual) UNITY_TEST_ASSERT_EQUAL_UINT((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_HEX(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX32((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_HEX(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX32((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_HEX8(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX8( (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_HEX8(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX8( (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_HEX16(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX16((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_HEX16(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX16((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_HEX32(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX32((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_HEX32(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX32((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_HEX64(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX64((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_HEX64(expected, actual) UNITY_TEST_ASSERT_EQUAL_HEX64((expected), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EQUAL_CHAR(expected, actual) UNITY_TEST_ASSERT_EQUAL_CHAR((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_BITS(mask, expected, actual) UNITY_TEST_ASSERT_BITS((mask), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_BITS(mask, expected, actual) UNITY_TEST_ASSERT_BITS((mask), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_BITS_HIGH(mask, actual) UNITY_TEST_ASSERT_BITS((mask), (_UU32)(-1), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_BITS_HIGH(mask, actual) UNITY_TEST_ASSERT_BITS((mask), (UNITY_UINT32)(-1), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_BITS_LOW(mask, actual) UNITY_TEST_ASSERT_BITS((mask), (_UU32)(0), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_BITS_LOW(mask, actual) UNITY_TEST_ASSERT_BITS((mask), (UNITY_UINT32)(0), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_BIT_HIGH(bit, actual) UNITY_TEST_ASSERT_BITS(((_UU32)1 << (bit)), (_UU32)(-1), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_BIT_HIGH(bit, actual) UNITY_TEST_ASSERT_BITS(((UNITY_UINT32)1 << (bit)), (UNITY_UINT32)(-1), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_BIT_LOW(bit, actual) UNITY_TEST_ASSERT_BITS(((_UU32)1 << (bit)), (_UU32)(0), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_BIT_LOW(bit, actual) UNITY_TEST_ASSERT_BITS(((UNITY_UINT32)1 << (bit)), (UNITY_UINT32)(0), (actual), __LINE__, NULL)
|
||||||
|
|
||||||
|
/* Integer Greater Than/ Less Than (of all sizes) */
|
||||||
|
#define TEST_ASSERT_GREATER_THAN(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_INT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_INT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT8(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_INT8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT16(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_INT16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT32(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_INT32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT64(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_INT64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_UINT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT8(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_UINT8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT16(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_UINT16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT32(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_UINT32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT64(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_UINT64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_size_t(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_UINT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_HEX8(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_HEX8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_HEX16(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_HEX16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_HEX32(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_HEX32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_HEX64(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_HEX64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_CHAR(threshold, actual) UNITY_TEST_ASSERT_GREATER_THAN_CHAR((threshold), (actual), __LINE__, NULL)
|
||||||
|
|
||||||
|
#define TEST_ASSERT_LESS_THAN(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_INT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_INT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT8(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_INT8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT16(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_INT16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT32(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_INT32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT64(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_INT64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_UINT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT8(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_UINT8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT16(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_UINT16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT32(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_UINT32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT64(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_UINT64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_size_t(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_UINT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_HEX8(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_HEX8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_HEX16(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_HEX16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_HEX32(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_HEX32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_HEX64(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_HEX64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_THAN_CHAR(threshold, actual) UNITY_TEST_ASSERT_SMALLER_THAN_CHAR((threshold), (actual), __LINE__, NULL)
|
||||||
|
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT8(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT16(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT32(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT64(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT8(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT16(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT32(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT64(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_size_t(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_HEX8(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_HEX8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_HEX16(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_HEX16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_HEX32(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_HEX32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_HEX64(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_HEX64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_CHAR(threshold, actual) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_CHAR((threshold), (actual), __LINE__, NULL)
|
||||||
|
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT8(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT16(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT32(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT64(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT8(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT16(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT32(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT64(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_size_t(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_HEX8(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_HEX8((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_HEX16(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_HEX16((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_HEX32(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_HEX32((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_HEX64(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_HEX64((threshold), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_CHAR(threshold, actual) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_CHAR((threshold), (actual), __LINE__, NULL)
|
||||||
|
|
||||||
/* Integer Ranges (of all sizes) */
|
/* Integer Ranges (of all sizes) */
|
||||||
#define TEST_ASSERT_INT_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_INT_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_INT_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_INT_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
@@ -123,11 +234,33 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_UINT16_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_UINT16_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_UINT16_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_UINT16_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_UINT32_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_UINT32_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_UINT32_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_UINT32_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_UINT64_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_UINT64_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_UINT64_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_UINT64_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_size_t_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_UINT_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_HEX_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX32_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_HEX_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX32_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_HEX8_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX8_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_HEX8_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX8_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_HEX16_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX16_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_HEX16_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX16_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_HEX32_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX32_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_HEX32_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX32_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_HEX64_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX64_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_HEX64_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_HEX64_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_CHAR_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_CHAR_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
|
|
||||||
|
/* Integer Array Ranges (of all sizes) */
|
||||||
|
#define TEST_ASSERT_INT_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_INT_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_INT8_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_INT8_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_INT16_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_INT16_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_INT32_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_INT32_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_INT64_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_INT64_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_UINT_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_UINT_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_UINT8_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_UINT8_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_UINT16_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_UINT16_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_UINT32_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_UINT32_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_UINT64_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_UINT64_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_size_t_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_UINT_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_HEX_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_HEX32_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_HEX8_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_HEX8_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_HEX16_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_HEX16_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_HEX32_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_HEX32_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_HEX64_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_HEX64_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_CHAR_ARRAY_WITHIN(delta, expected, actual, num_elements) UNITY_TEST_ASSERT_CHAR_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, NULL)
|
||||||
|
|
||||||
|
|
||||||
/* Structs and Strings */
|
/* Structs and Strings */
|
||||||
#define TEST_ASSERT_EQUAL_PTR(expected, actual) UNITY_TEST_ASSERT_EQUAL_PTR((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_PTR(expected, actual) UNITY_TEST_ASSERT_EQUAL_PTR((expected), (actual), __LINE__, NULL)
|
||||||
@@ -146,6 +279,7 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_EQUAL_UINT16_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_UINT16_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_UINT16_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_UINT16_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_UINT32_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_UINT32_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_UINT32_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_UINT32_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_UINT64_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_UINT64_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_UINT64_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_UINT64_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EQUAL_size_t_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_UINT_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_HEX_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_HEX32_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_HEX_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_HEX32_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_HEX8_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_HEX8_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_HEX8_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_HEX8_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_HEX16_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_HEX16_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_HEX16_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_HEX16_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
@@ -154,11 +288,35 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_EQUAL_PTR_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_PTR_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_PTR_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_PTR_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_STRING_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_STRING_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_STRING_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_STRING_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_MEMORY_ARRAY(expected, actual, len, num_elements) UNITY_TEST_ASSERT_EQUAL_MEMORY_ARRAY((expected), (actual), (len), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_MEMORY_ARRAY(expected, actual, len, num_elements) UNITY_TEST_ASSERT_EQUAL_MEMORY_ARRAY((expected), (actual), (len), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EQUAL_CHAR_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_CHAR_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
|
||||||
|
/* Arrays Compared To Single Value */
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_INT((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT8(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_INT8((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT16(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_INT16((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT32(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_INT32((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT64(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_INT64((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_UINT((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT8(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_UINT8((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT16(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_UINT16((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT32(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_UINT32((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT64(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_UINT64((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_size_t(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_UINT((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_HEX32((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX8(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_HEX8((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX16(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_HEX16((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX32(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_HEX32((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX64(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_HEX64((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_PTR(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_PTR((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_STRING(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_STRING((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_MEMORY(expected, actual, len, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_MEMORY((expected), (actual), (len), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_CHAR(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_CHAR((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
|
||||||
/* Floating Point (If Enabled) */
|
/* Floating Point (If Enabled) */
|
||||||
#define TEST_ASSERT_FLOAT_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_FLOAT_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_FLOAT_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_FLOAT_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_FLOAT(expected, actual) UNITY_TEST_ASSERT_EQUAL_FLOAT((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_FLOAT(expected, actual) UNITY_TEST_ASSERT_EQUAL_FLOAT((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_FLOAT_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_FLOAT_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_FLOAT(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_FLOAT((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_FLOAT_IS_INF(actual) UNITY_TEST_ASSERT_FLOAT_IS_INF((actual), __LINE__, NULL)
|
#define TEST_ASSERT_FLOAT_IS_INF(actual) UNITY_TEST_ASSERT_FLOAT_IS_INF((actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_FLOAT_IS_NEG_INF(actual) UNITY_TEST_ASSERT_FLOAT_IS_NEG_INF((actual), __LINE__, NULL)
|
#define TEST_ASSERT_FLOAT_IS_NEG_INF(actual) UNITY_TEST_ASSERT_FLOAT_IS_NEG_INF((actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_FLOAT_IS_NAN(actual) UNITY_TEST_ASSERT_FLOAT_IS_NAN((actual), __LINE__, NULL)
|
#define TEST_ASSERT_FLOAT_IS_NAN(actual) UNITY_TEST_ASSERT_FLOAT_IS_NAN((actual), __LINE__, NULL)
|
||||||
@@ -172,6 +330,7 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_DOUBLE_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_DOUBLE_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_DOUBLE_WITHIN(delta, expected, actual) UNITY_TEST_ASSERT_DOUBLE_WITHIN((delta), (expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_DOUBLE(expected, actual) UNITY_TEST_ASSERT_EQUAL_DOUBLE((expected), (actual), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_DOUBLE(expected, actual) UNITY_TEST_ASSERT_EQUAL_DOUBLE((expected), (actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_EQUAL_DOUBLE_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
#define TEST_ASSERT_EQUAL_DOUBLE_ARRAY(expected, actual, num_elements) UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_DOUBLE(expected, actual, num_elements) UNITY_TEST_ASSERT_EACH_EQUAL_DOUBLE((expected), (actual), (num_elements), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_DOUBLE_IS_INF(actual) UNITY_TEST_ASSERT_DOUBLE_IS_INF((actual), __LINE__, NULL)
|
#define TEST_ASSERT_DOUBLE_IS_INF(actual) UNITY_TEST_ASSERT_DOUBLE_IS_INF((actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_DOUBLE_IS_NEG_INF(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NEG_INF((actual), __LINE__, NULL)
|
#define TEST_ASSERT_DOUBLE_IS_NEG_INF(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NEG_INF((actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_DOUBLE_IS_NAN(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NAN((actual), __LINE__, NULL)
|
#define TEST_ASSERT_DOUBLE_IS_NAN(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NAN((actual), __LINE__, NULL)
|
||||||
@@ -181,6 +340,28 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_DOUBLE_IS_NOT_NAN(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NOT_NAN((actual), __LINE__, NULL)
|
#define TEST_ASSERT_DOUBLE_IS_NOT_NAN(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NOT_NAN((actual), __LINE__, NULL)
|
||||||
#define TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE((actual), __LINE__, NULL)
|
#define TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE(actual) UNITY_TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE((actual), __LINE__, NULL)
|
||||||
|
|
||||||
|
/* Shorthand */
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_OLD
|
||||||
|
#define TEST_ASSERT_EQUAL(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT((expected), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL(expected, actual) UNITY_TEST_ASSERT(((expected) != (actual)), __LINE__, " Expected Not-Equal")
|
||||||
|
#endif
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_INT
|
||||||
|
#define TEST_ASSERT_EQUAL(expected, actual) UNITY_TEST_ASSERT_EQUAL_INT((expected), (actual), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL(expected, actual) UNITY_TEST_FAIL(__LINE__, UnityStrErrShorthand)
|
||||||
|
#endif
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_MEM
|
||||||
|
#define TEST_ASSERT_EQUAL(expected, actual) UNITY_TEST_ASSERT_EQUAL_MEMORY((&expected), (&actual), sizeof(expected), __LINE__, NULL)
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL(expected, actual) UNITY_TEST_FAIL(__LINE__, UnityStrErrShorthand)
|
||||||
|
#endif
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_RAW
|
||||||
|
#define TEST_ASSERT_EQUAL(expected, actual) UNITY_TEST_ASSERT(((expected) == (actual)), __LINE__, " Expected Equal")
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL(expected, actual) UNITY_TEST_ASSERT(((expected) != (actual)), __LINE__, " Expected Not-Equal")
|
||||||
|
#endif
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_NONE
|
||||||
|
#define TEST_ASSERT_EQUAL(expected, actual) UNITY_TEST_FAIL(__LINE__, UnityStrErrShorthand)
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL(expected, actual) UNITY_TEST_FAIL(__LINE__, UnityStrErrShorthand)
|
||||||
|
#endif
|
||||||
|
|
||||||
/*-------------------------------------------------------
|
/*-------------------------------------------------------
|
||||||
* Test Asserts (with additional messages)
|
* Test Asserts (with additional messages)
|
||||||
*-------------------------------------------------------*/
|
*-------------------------------------------------------*/
|
||||||
@@ -199,23 +380,96 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_EQUAL_INT16_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT16((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_INT16_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT16((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_INT32_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT32((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_INT32_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT32((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_INT64_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT64((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_INT64_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT64((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT((expected), (actual), __LINE__, (message))
|
|
||||||
#define TEST_ASSERT_NOT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT(((expected) != (actual)), __LINE__, (message))
|
|
||||||
#define TEST_ASSERT_EQUAL_UINT_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT( (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_UINT_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT( (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_UINT8_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT8( (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_UINT8_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT8( (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_UINT16_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT16( (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_UINT16_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT16( (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_UINT32_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT32( (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_UINT32_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT32( (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_UINT64_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT64( (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_UINT64_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT64( (expected), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EQUAL_size_t_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_UINT( (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_HEX_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX32((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_HEX_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX32((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_HEX8_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX8( (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_HEX8_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX8( (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_HEX16_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX16((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_HEX16_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX16((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_HEX32_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX32((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_HEX32_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX32((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_HEX64_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX64((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_HEX64_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_HEX64((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_BITS_MESSAGE(mask, expected, actual, message) UNITY_TEST_ASSERT_BITS((mask), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_BITS_MESSAGE(mask, expected, actual, message) UNITY_TEST_ASSERT_BITS((mask), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_BITS_HIGH_MESSAGE(mask, actual, message) UNITY_TEST_ASSERT_BITS((mask), (_UU32)(-1), (actual), __LINE__, (message))
|
#define TEST_ASSERT_BITS_HIGH_MESSAGE(mask, actual, message) UNITY_TEST_ASSERT_BITS((mask), (UNITY_UINT32)(-1), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_BITS_LOW_MESSAGE(mask, actual, message) UNITY_TEST_ASSERT_BITS((mask), (_UU32)(0), (actual), __LINE__, (message))
|
#define TEST_ASSERT_BITS_LOW_MESSAGE(mask, actual, message) UNITY_TEST_ASSERT_BITS((mask), (UNITY_UINT32)(0), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_BIT_HIGH_MESSAGE(bit, actual, message) UNITY_TEST_ASSERT_BITS(((_UU32)1 << (bit)), (_UU32)(-1), (actual), __LINE__, (message))
|
#define TEST_ASSERT_BIT_HIGH_MESSAGE(bit, actual, message) UNITY_TEST_ASSERT_BITS(((UNITY_UINT32)1 << (bit)), (UNITY_UINT32)(-1), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_BIT_LOW_MESSAGE(bit, actual, message) UNITY_TEST_ASSERT_BITS(((_UU32)1 << (bit)), (_UU32)(0), (actual), __LINE__, (message))
|
#define TEST_ASSERT_BIT_LOW_MESSAGE(bit, actual, message) UNITY_TEST_ASSERT_BITS(((UNITY_UINT32)1 << (bit)), (UNITY_UINT32)(0), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EQUAL_CHAR_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_CHAR((expected), (actual), __LINE__, (message))
|
||||||
|
|
||||||
|
/* Integer Greater Than/ Less Than (of all sizes) */
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_INT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_INT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_INT8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_INT16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_INT32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_INT64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_INT64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_UINT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_UINT8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_UINT16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_UINT32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_UINT64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_UINT64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_size_t_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_UINT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_HEX8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_HEX8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_HEX16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_HEX16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_HEX32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_HEX32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_HEX64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_HEX64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_THAN_CHAR_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_THAN_CHAR((threshold), (actual), __LINE__, (message))
|
||||||
|
|
||||||
|
#define TEST_ASSERT_LESS_THAN_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_INT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_INT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_INT8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_INT16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_INT32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_INT64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_INT64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_UINT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_UINT8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_UINT16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_UINT32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_UINT64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_UINT64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_size_t_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_UINT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_HEX8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_HEX8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_HEX16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_HEX16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_HEX32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_HEX32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_HEX64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_HEX64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_THAN_CHAR_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_THAN_CHAR((threshold), (actual), __LINE__, (message))
|
||||||
|
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_INT64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_INT64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_UINT64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_size_t_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_UINT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_HEX8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_HEX8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_HEX16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_HEX16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_HEX32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_HEX32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_HEX64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_HEX64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_GREATER_OR_EQUAL_CHAR_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_GREATER_OR_EQUAL_CHAR((threshold), (actual), __LINE__, (message))
|
||||||
|
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_INT64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_INT64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_UINT64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_size_t_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_UINT((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_HEX8_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_HEX8((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_HEX16_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_HEX16((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_HEX32_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_HEX32((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_HEX64_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_HEX64((threshold), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_LESS_OR_EQUAL_CHAR_MESSAGE(threshold, actual, message) UNITY_TEST_ASSERT_SMALLER_OR_EQUAL_CHAR((threshold), (actual), __LINE__, (message))
|
||||||
|
|
||||||
/* Integer Ranges (of all sizes) */
|
/* Integer Ranges (of all sizes) */
|
||||||
#define TEST_ASSERT_INT_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_INT_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_INT_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_INT_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
@@ -228,11 +482,33 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_UINT16_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_UINT16_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_UINT16_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_UINT16_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_UINT32_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_UINT32_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_UINT32_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_UINT32_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_UINT64_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_UINT64_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_UINT64_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_UINT64_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_size_t_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_UINT_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_HEX_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX32_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_HEX_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX32_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_HEX8_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX8_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_HEX8_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX8_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_HEX16_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX16_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_HEX16_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX16_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_HEX32_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX32_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_HEX32_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX32_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_HEX64_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX64_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_HEX64_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_HEX64_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_CHAR_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_CHAR_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
|
|
||||||
|
/* Integer Array Ranges (of all sizes) */
|
||||||
|
#define TEST_ASSERT_INT_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_INT_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_INT8_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_INT8_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_INT16_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_INT16_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_INT32_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_INT32_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_INT64_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_INT64_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_UINT_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_UINT_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_UINT8_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_UINT8_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_UINT16_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_UINT16_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_UINT32_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_UINT32_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_UINT64_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_UINT64_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_size_t_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_UINT_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_HEX_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_HEX32_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_HEX8_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_HEX8_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_HEX16_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_HEX16_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_HEX32_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_HEX32_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_HEX64_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_HEX64_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_CHAR_ARRAY_WITHIN_MESSAGE(delta, expected, actual, num_elements, message) UNITY_TEST_ASSERT_CHAR_ARRAY_WITHIN((delta), (expected), (actual), num_elements, __LINE__, (message))
|
||||||
|
|
||||||
|
|
||||||
/* Structs and Strings */
|
/* Structs and Strings */
|
||||||
#define TEST_ASSERT_EQUAL_PTR_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_PTR((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_PTR_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_PTR((expected), (actual), __LINE__, (message))
|
||||||
@@ -251,6 +527,7 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_EQUAL_UINT16_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_UINT16_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_UINT16_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_UINT16_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_UINT32_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_UINT32_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_UINT32_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_UINT32_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_UINT64_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_UINT64_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_UINT64_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_UINT64_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EQUAL_size_t_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_UINT_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_HEX_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_HEX32_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_HEX_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_HEX32_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_HEX8_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_HEX8_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_HEX8_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_HEX8_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_HEX16_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_HEX16_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_HEX16_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_HEX16_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
@@ -259,11 +536,35 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_EQUAL_PTR_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_PTR_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_PTR_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_PTR_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_STRING_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_STRING_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_STRING_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_STRING_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_MEMORY_ARRAY_MESSAGE(expected, actual, len, num_elements, message) UNITY_TEST_ASSERT_EQUAL_MEMORY_ARRAY((expected), (actual), (len), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_MEMORY_ARRAY_MESSAGE(expected, actual, len, num_elements, message) UNITY_TEST_ASSERT_EQUAL_MEMORY_ARRAY((expected), (actual), (len), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EQUAL_CHAR_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_CHAR_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
|
||||||
|
/* Arrays Compared To Single Value*/
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_INT((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT8_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_INT8((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT16_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_INT16((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT32_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_INT32((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_INT64_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_INT64((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_UINT((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT8_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_UINT8((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT16_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_UINT16((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT32_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_UINT32((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_UINT64_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_UINT64((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_size_t_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_UINT((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_HEX32((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX8_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_HEX8((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX16_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_HEX16((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX32_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_HEX32((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_HEX64_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_HEX64((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_PTR_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_PTR((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_STRING_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_STRING((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_MEMORY_MESSAGE(expected, actual, len, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_MEMORY((expected), (actual), (len), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_CHAR_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_CHAR((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
|
||||||
/* Floating Point (If Enabled) */
|
/* Floating Point (If Enabled) */
|
||||||
#define TEST_ASSERT_FLOAT_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_FLOAT_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_FLOAT_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_FLOAT_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_FLOAT_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_FLOAT((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_FLOAT_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_FLOAT((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_FLOAT_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_FLOAT_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_FLOAT_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_FLOAT_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_FLOAT((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_FLOAT_IS_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_INF((actual), __LINE__, (message))
|
#define TEST_ASSERT_FLOAT_IS_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_INF((actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_FLOAT_IS_NEG_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_NEG_INF((actual), __LINE__, (message))
|
#define TEST_ASSERT_FLOAT_IS_NEG_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_NEG_INF((actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_FLOAT_IS_NAN_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_NAN((actual), __LINE__, (message))
|
#define TEST_ASSERT_FLOAT_IS_NAN_MESSAGE(actual, message) UNITY_TEST_ASSERT_FLOAT_IS_NAN((actual), __LINE__, (message))
|
||||||
@@ -277,6 +578,7 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_DOUBLE_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_DOUBLE_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_DOUBLE_WITHIN_MESSAGE(delta, expected, actual, message) UNITY_TEST_ASSERT_DOUBLE_WITHIN((delta), (expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_DOUBLE_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_DOUBLE((expected), (actual), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_DOUBLE_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_DOUBLE((expected), (actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_EQUAL_DOUBLE_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
#define TEST_ASSERT_EQUAL_DOUBLE_ARRAY_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EQUAL_DOUBLE_ARRAY((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_EACH_EQUAL_DOUBLE_MESSAGE(expected, actual, num_elements, message) UNITY_TEST_ASSERT_EACH_EQUAL_DOUBLE((expected), (actual), (num_elements), __LINE__, (message))
|
||||||
#define TEST_ASSERT_DOUBLE_IS_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_INF((actual), __LINE__, (message))
|
#define TEST_ASSERT_DOUBLE_IS_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_INF((actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_DOUBLE_IS_NEG_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NEG_INF((actual), __LINE__, (message))
|
#define TEST_ASSERT_DOUBLE_IS_NEG_INF_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NEG_INF((actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_DOUBLE_IS_NAN_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NAN((actual), __LINE__, (message))
|
#define TEST_ASSERT_DOUBLE_IS_NAN_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NAN((actual), __LINE__, (message))
|
||||||
@@ -286,6 +588,28 @@ void tearDown(void);
|
|||||||
#define TEST_ASSERT_DOUBLE_IS_NOT_NAN_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NOT_NAN((actual), __LINE__, (message))
|
#define TEST_ASSERT_DOUBLE_IS_NOT_NAN_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NOT_NAN((actual), __LINE__, (message))
|
||||||
#define TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE((actual), __LINE__, (message))
|
#define TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE_MESSAGE(actual, message) UNITY_TEST_ASSERT_DOUBLE_IS_NOT_DETERMINATE((actual), __LINE__, (message))
|
||||||
|
|
||||||
|
/* Shorthand */
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_OLD
|
||||||
|
#define TEST_ASSERT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT((expected), (actual), __LINE__, (message))
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT(((expected) != (actual)), __LINE__, (message))
|
||||||
|
#endif
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_INT
|
||||||
|
#define TEST_ASSERT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_INT((expected), (actual), __LINE__, message)
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_FAIL(__LINE__, UnityStrErrShorthand)
|
||||||
|
#endif
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_MEM
|
||||||
|
#define TEST_ASSERT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT_EQUAL_MEMORY((&expected), (&actual), sizeof(expected), __LINE__, message)
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_FAIL(__LINE__, UnityStrErrShorthand)
|
||||||
|
#endif
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_RAW
|
||||||
|
#define TEST_ASSERT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT(((expected) == (actual)), __LINE__, message)
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_ASSERT(((expected) != (actual)), __LINE__, message)
|
||||||
|
#endif
|
||||||
|
#ifdef UNITY_SHORTHAND_AS_NONE
|
||||||
|
#define TEST_ASSERT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_FAIL(__LINE__, UnityStrErrShorthand)
|
||||||
|
#define TEST_ASSERT_NOT_EQUAL_MESSAGE(expected, actual, message) UNITY_TEST_FAIL(__LINE__, UnityStrErrShorthand)
|
||||||
|
#endif
|
||||||
|
|
||||||
/* end of UNITY_FRAMEWORK_H */
|
/* end of UNITY_FRAMEWORK_H */
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
68
test/.rubocop.yml
Normal file
68
test/.rubocop.yml
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
# This is the configuration used to check the rubocop source code.
|
||||||
|
|
||||||
|
#inherit_from: .rubocop_todo.yml
|
||||||
|
|
||||||
|
AllCops:
|
||||||
|
TargetRubyVersion: 2.3
|
||||||
|
|
||||||
|
# These are areas where ThrowTheSwitch's coding style diverges from the Ruby standard
|
||||||
|
Style/SpecialGlobalVars:
|
||||||
|
EnforcedStyle: use_perl_names
|
||||||
|
Style/FormatString:
|
||||||
|
Enabled: false
|
||||||
|
Style/GlobalVars:
|
||||||
|
Enabled: false
|
||||||
|
Style/FrozenStringLiteralComment:
|
||||||
|
Enabled: false
|
||||||
|
Style/RegexpLiteral:
|
||||||
|
AllowInnerSlashes: true
|
||||||
|
Style/HashSyntax:
|
||||||
|
EnforcedStyle: no_mixed_keys
|
||||||
|
Style/NumericPredicate:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# These are also places we diverge... but we will likely comply down the road
|
||||||
|
Style/IfUnlessModifier:
|
||||||
|
Enabled: false
|
||||||
|
Style/FormatStringToken:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# This is disabled because it seems to get confused over nested hashes
|
||||||
|
Layout/AlignHash:
|
||||||
|
Enabled: false
|
||||||
|
EnforcedHashRocketStyle: table
|
||||||
|
EnforcedColonStyle: table
|
||||||
|
|
||||||
|
# We purposefully use these insecure features because they're what makes Ruby awesome
|
||||||
|
Security/Eval:
|
||||||
|
Enabled: false
|
||||||
|
Security/YAMLLoad:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# At this point, we're not ready to enforce inline documentation requirements
|
||||||
|
Style/Documentation:
|
||||||
|
Enabled: false
|
||||||
|
Style/DocumentationMethod:
|
||||||
|
Enabled: false
|
||||||
|
|
||||||
|
# At this point, we're not ready to enforce any metrics
|
||||||
|
Metrics/AbcSize:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/BlockLength:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/BlockNesting:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/ClassLength:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/CyclomaticComplexity:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/LineLength:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/MethodLength:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/ModuleLength:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/ParameterLists:
|
||||||
|
Enabled: false
|
||||||
|
Metrics/PerceivedComplexity:
|
||||||
|
Enabled: false
|
||||||
@@ -1,18 +1,25 @@
|
|||||||
CC = gcc
|
CC = gcc
|
||||||
ifeq ($(shell uname -s), Darwin)
|
ifeq ($(shell uname -s), Darwin)
|
||||||
CC = clang
|
CC = clang
|
||||||
CFLAGS += -std=c99 -pedantic -Wall -Weverything -Werror
|
|
||||||
CFLAGS += -Wno-unknown-warning-option -Wno-switch-enum
|
|
||||||
CFLAGS += -Wno-padded -Wno-double-promotion -Wno-missing-noreturn
|
|
||||||
CFLAGS += -Wno-missing-prototypes
|
|
||||||
endif
|
endif
|
||||||
ifeq ($(shell uname -s), Linux)
|
ifeq ($(findstring clang, $(CC)), clang)
|
||||||
CFLAGS += -std=c99 -pedantic -Wall -Wextra -Werror
|
E = -Weverything
|
||||||
|
CFLAGS += $E -Wno-unknown-warning-option -Wno-missing-prototypes
|
||||||
|
CFLAGS += -Wno-unused-macros -Wno-padded -Wno-missing-noreturn
|
||||||
endif
|
endif
|
||||||
|
CFLAGS += -std=c99 -pedantic -Wall -Wextra -Wconversion -Werror
|
||||||
|
CFLAGS += -Wno-switch-enum -Wno-double-promotion
|
||||||
|
CFLAGS += -Wbad-function-cast -Wcast-qual -Wold-style-definition -Wshadow -Wstrict-overflow \
|
||||||
|
-Wstrict-prototypes -Wswitch-default -Wundef
|
||||||
#DEBUG = -O0 -g
|
#DEBUG = -O0 -g
|
||||||
CFLAGS += $(DEBUG)
|
CFLAGS += $(DEBUG)
|
||||||
|
UNITY_SUPPORT_64 = -D UNITY_SUPPORT_64
|
||||||
|
UNITY_INCLUDE_DOUBLE = -D UNITY_INCLUDE_DOUBLE
|
||||||
DEFINES = -D UNITY_OUTPUT_CHAR=putcharSpy
|
DEFINES = -D UNITY_OUTPUT_CHAR=putcharSpy
|
||||||
DEFINES += -D UNITY_SUPPORT_64 -D UNITY_INCLUDE_DOUBLE -D UNITY_NO_WEAK
|
DEFINES += -D UNITY_OUTPUT_CHAR_HEADER_DECLARATION=putcharSpy\(int\)
|
||||||
|
DEFINES += -D UNITY_OUTPUT_FLUSH=flushSpy
|
||||||
|
DEFINES += -D UNITY_OUTPUT_FLUSH_HEADER_DECLARATION=flushSpy\(void\)
|
||||||
|
DEFINES += $(UNITY_SUPPORT_64) $(UNITY_INCLUDE_DOUBLE)
|
||||||
SRC = ../src/unity.c tests/testunity.c build/testunityRunner.c
|
SRC = ../src/unity.c tests/testunity.c build/testunityRunner.c
|
||||||
INC_DIR = -I ../src
|
INC_DIR = -I ../src
|
||||||
COV_FLAGS = -fprofile-arcs -ftest-coverage -I ../../src
|
COV_FLAGS = -fprofile-arcs -ftest-coverage -I ../../src
|
||||||
@@ -27,14 +34,11 @@ coverage: $(BUILD_DIR)/testunityRunner.c
|
|||||||
cd $(BUILD_DIR) && \
|
cd $(BUILD_DIR) && \
|
||||||
$(CC) $(CFLAGS) $(DEFINES) $(foreach i,$(SRC), ../$i) $(COV_FLAGS) -o ../$(TARGET)
|
$(CC) $(CFLAGS) $(DEFINES) $(foreach i,$(SRC), ../$i) $(COV_FLAGS) -o ../$(TARGET)
|
||||||
rm -f $(BUILD_DIR)/*.gcda
|
rm -f $(BUILD_DIR)/*.gcda
|
||||||
./$(TARGET) | grep Tests -A1
|
./$(TARGET) | grep 'Tests\|]]]' -A1
|
||||||
cd $(BUILD_DIR) && \
|
cd $(BUILD_DIR) && \
|
||||||
gcov unity.c | head -3
|
gcov unity.c | head -3
|
||||||
grep '###' $(BUILD_DIR)/unity.c.gcov -C2 || true
|
grep '###' $(BUILD_DIR)/unity.c.gcov -C2 || true
|
||||||
|
|
||||||
test: CFLAGS += -Wbad-function-cast -Wcast-qual -Wconversion -Wformat=2 -Wold-style-definition \
|
|
||||||
-Wpointer-arith -Wredundant-decls -Wshadow -Wstrict-overflow=5 -Wstrict-prototypes \
|
|
||||||
-Wswitch-default -Wundef -Wunreachable-code -Wunused -fstrict-aliasing
|
|
||||||
test: $(BUILD_DIR)/testunityRunner.c
|
test: $(BUILD_DIR)/testunityRunner.c
|
||||||
$(CC) $(CFLAGS) $(DEFINES) $(INC_DIR) $(SRC) -o $(TARGET)
|
$(CC) $(CFLAGS) $(DEFINES) $(INC_DIR) $(SRC) -o $(TARGET)
|
||||||
./$(TARGET)
|
./$(TARGET)
|
||||||
@@ -50,14 +54,14 @@ $(BUILD_DIR)/testunityRunner.c: tests/testunity.c | $(BUILD_DIR)
|
|||||||
|
|
||||||
AWK_SCRIPT=\
|
AWK_SCRIPT=\
|
||||||
'/^void test/{ declarations[d++]=$$0; gsub(/\(?void\)? ?/,""); tests[t++]=$$0; line[u++]=NR } \
|
'/^void test/{ declarations[d++]=$$0; gsub(/\(?void\)? ?/,""); tests[t++]=$$0; line[u++]=NR } \
|
||||||
END{ print "\#include \"unity.h\" /* Autogenerated by awk in Makefile */" ; \
|
END{ print "\#include \"unity.h\" /* Autogenerated by awk in Makefile */" ; \
|
||||||
for (i=0; i<d; i++) { print declarations[i] ";" } \
|
for (i=0; i<d; i++) { print declarations[i] ";" } \
|
||||||
printf "int main(void)\n{\n UNITY_BEGIN();\n" ; \
|
print "int main(void)\n{\n UnityBegin(\"" FILENAME "\");" ; \
|
||||||
for (i=0; i<t; i++) { print " RUN_TEST(" tests[i] ", " line[i] ");" } \
|
for (i=0; i<t; i++) { print " RUN_TEST(" tests[i] ", " line[i] ");" } \
|
||||||
printf " return UNITY_END();\n}\n" }'
|
print " return UNITY_END();\n}" }'
|
||||||
|
|
||||||
$(BUILD_DIR):
|
$(BUILD_DIR):
|
||||||
mkdir -p $(BUILD_DIR)
|
mkdir -p $(BUILD_DIR)
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f $(BUILD_DIR)/$(TARGET) $(BUILD_DIR)/*.gc* $(BUILD_DIR)/testunityRunner.c
|
rm -f $(TARGET) $(BUILD_DIR)/*.gc* $(BUILD_DIR)/testunityRunner.c
|
||||||
|
|||||||
@@ -4,15 +4,16 @@
|
|||||||
# [Released under MIT License. Please refer to license.txt for details]
|
# [Released under MIT License. Please refer to license.txt for details]
|
||||||
# ==========================================
|
# ==========================================
|
||||||
|
|
||||||
UNITY_ROOT = File.expand_path(File.dirname(__FILE__)) + '/'
|
|
||||||
$verbose = false
|
$verbose = false
|
||||||
|
|
||||||
require 'rake'
|
require 'rake'
|
||||||
require 'rake/clean'
|
require 'rake/clean'
|
||||||
require UNITY_ROOT + 'rakefile_helper'
|
require_relative 'rakefile_helper'
|
||||||
|
require 'rspec/core/rake_task'
|
||||||
|
|
||||||
TEMP_DIRS = [
|
TEMP_DIRS = [
|
||||||
File.join(UNITY_ROOT, 'build')
|
File.join(__dir__, 'build'),
|
||||||
|
File.join(__dir__, 'sandbox')
|
||||||
]
|
]
|
||||||
|
|
||||||
TEMP_DIRS.each do |dir|
|
TEMP_DIRS.each do |dir|
|
||||||
@@ -30,7 +31,7 @@ configure_toolchain(DEFAULT_CONFIG_FILE)
|
|||||||
|
|
||||||
desc "Test unity with its own unit tests"
|
desc "Test unity with its own unit tests"
|
||||||
task :unit => [:prepare_for_tests] do
|
task :unit => [:prepare_for_tests] do
|
||||||
run_tests get_unit_test_files
|
run_tests unit_test_files
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "Test unity's helper scripts"
|
desc "Test unity's helper scripts"
|
||||||
@@ -40,13 +41,18 @@ task :scripts => [:prepare_for_tests] do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "Run all rspecs"
|
||||||
|
RSpec::Core::RakeTask.new(:spec) do |t|
|
||||||
|
t.pattern = 'spec/**/*_spec.rb'
|
||||||
|
end
|
||||||
|
|
||||||
desc "Generate test summary"
|
desc "Generate test summary"
|
||||||
task :summary do
|
task :summary do
|
||||||
report_summary
|
report_summary
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "Build and test Unity"
|
desc "Build and test Unity"
|
||||||
task :all => [:clean, :prepare_for_tests, :scripts, :unit, :summary]
|
task :all => [:clean, :prepare_for_tests, :scripts, :unit, :style, :summary]
|
||||||
task :default => [:clobber, :all]
|
task :default => [:clobber, :all]
|
||||||
task :ci => [:no_color, :default]
|
task :ci => [:no_color, :default]
|
||||||
task :cruise => [:no_color, :default]
|
task :cruise => [:no_color, :default]
|
||||||
@@ -63,3 +69,56 @@ end
|
|||||||
task :verbose do
|
task :verbose do
|
||||||
$verbose = true
|
$verbose = true
|
||||||
end
|
end
|
||||||
|
|
||||||
|
namespace :style do
|
||||||
|
desc "Check style"
|
||||||
|
task :check do
|
||||||
|
report "\nVERIFYING RUBY STYLE"
|
||||||
|
report execute("rubocop ../auto ../examples ../extras --config .rubocop.yml", true)
|
||||||
|
report "Styling Ruby:PASS"
|
||||||
|
end
|
||||||
|
|
||||||
|
namespace :check do
|
||||||
|
Dir['../**/*.rb'].each do |f|
|
||||||
|
filename = File.basename(f, '.rb')
|
||||||
|
desc "Check Style of #{filename}"
|
||||||
|
task filename.to_sym => ['style:clean'] do
|
||||||
|
report execute("rubocop #{f} --color --config .rubocop.yml", true)
|
||||||
|
report "Style Checked for #{f}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "Fix Style of all C Code"
|
||||||
|
task :c do
|
||||||
|
run_astyle("../src/*.* ../extras/fixture/src/*.*")
|
||||||
|
end
|
||||||
|
|
||||||
|
namespace :c do
|
||||||
|
Dir['../{src,extras/**}/*.{c,h}'].each do |f|
|
||||||
|
filename = File.basename(f)[0..-3]
|
||||||
|
desc "Check Style of #{filename}"
|
||||||
|
task filename.to_sym do
|
||||||
|
run_astyle f
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "Attempt to Autocorrect style"
|
||||||
|
task :auto => ['style:clean'] do
|
||||||
|
execute("rubocop ../auto ../examples ../extras --auto-correct --config .rubocop.yml")
|
||||||
|
report "Autocorrected What We Could."
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "Update style todo list"
|
||||||
|
task :todo => ['style:clean'] do
|
||||||
|
execute("rubocop ../auto ../examples ../extras --auto-gen-config --config .rubocop.yml")
|
||||||
|
report "Updated Style TODO List."
|
||||||
|
end
|
||||||
|
|
||||||
|
task :clean do
|
||||||
|
File.delete(".rubocop_todo.yml") if File.exists?(".rubocop_todo.yml")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
task :style => ['style:check']
|
||||||
|
|||||||
@@ -6,44 +6,42 @@
|
|||||||
|
|
||||||
require 'yaml'
|
require 'yaml'
|
||||||
require 'fileutils'
|
require 'fileutils'
|
||||||
require UNITY_ROOT + '../auto/unity_test_summary'
|
require_relative '../auto/unity_test_summary'
|
||||||
require UNITY_ROOT + '../auto/generate_test_runner'
|
require_relative '../auto/generate_test_runner'
|
||||||
require UNITY_ROOT + '../auto/colour_reporter'
|
require_relative '../auto/colour_reporter'
|
||||||
|
|
||||||
module RakefileHelpers
|
module RakefileHelpers
|
||||||
|
C_EXTENSION = '.c'.freeze
|
||||||
C_EXTENSION = '.c'
|
|
||||||
|
|
||||||
def load_configuration(config_file)
|
def load_configuration(config_file)
|
||||||
unless ($configured)
|
return if $configured
|
||||||
$cfg_file = "targets/#{config_file}" unless (config_file =~ /[\\|\/]/)
|
|
||||||
$cfg = YAML.load(File.read($cfg_file))
|
$cfg_file = "targets/#{config_file}" unless config_file =~ /[\\|\/]/
|
||||||
$colour_output = false unless $cfg['colour']
|
$cfg = YAML.load(File.read($cfg_file))
|
||||||
$configured = true if (config_file != DEFAULT_CONFIG_FILE)
|
$colour_output = false unless $cfg['colour']
|
||||||
end
|
$configured = true if config_file != DEFAULT_CONFIG_FILE
|
||||||
end
|
end
|
||||||
|
|
||||||
def configure_clean
|
def configure_clean
|
||||||
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
|
CLEAN.include($cfg['compiler']['build_path'] + '*.*') unless $cfg['compiler']['build_path'].nil?
|
||||||
end
|
end
|
||||||
|
|
||||||
def configure_toolchain(config_file=DEFAULT_CONFIG_FILE)
|
def configure_toolchain(config_file = DEFAULT_CONFIG_FILE)
|
||||||
config_file += '.yml' unless config_file =~ /\.yml$/
|
config_file += '.yml' unless config_file =~ /\.yml$/
|
||||||
config_file = config_file unless config_file =~ /[\\|\/]/
|
config_file = config_file unless config_file =~ /[\\|\/]/
|
||||||
load_configuration(config_file)
|
load_configuration(config_file)
|
||||||
configure_clean
|
configure_clean
|
||||||
end
|
end
|
||||||
|
|
||||||
def get_unit_test_files
|
def unit_test_files
|
||||||
path = $cfg['compiler']['unit_tests_path'] + 'test*' + C_EXTENSION
|
path = $cfg['compiler']['unit_tests_path'] + 'test*' + C_EXTENSION
|
||||||
path.gsub!(/\\/, '/')
|
path.tr!('\\', '/')
|
||||||
FileList.new(path)
|
FileList.new(path)
|
||||||
end
|
end
|
||||||
|
|
||||||
def get_local_include_dirs
|
def local_include_dirs
|
||||||
include_dirs = $cfg['compiler']['includes']['items'].dup
|
include_dirs = $cfg['compiler']['includes']['items'].dup
|
||||||
include_dirs.delete_if {|dir| dir.is_a?(Array)}
|
include_dirs.delete_if { |dir| dir.is_a?(Array) }
|
||||||
return include_dirs
|
include_dirs
|
||||||
end
|
end
|
||||||
|
|
||||||
def extract_headers(filename)
|
def extract_headers(filename)
|
||||||
@@ -51,41 +49,37 @@ module RakefileHelpers
|
|||||||
lines = File.readlines(filename)
|
lines = File.readlines(filename)
|
||||||
lines.each do |line|
|
lines.each do |line|
|
||||||
m = line.match(/^\s*#include\s+\"\s*(.+\.[hH])\s*\"/)
|
m = line.match(/^\s*#include\s+\"\s*(.+\.[hH])\s*\"/)
|
||||||
if not m.nil?
|
includes << m[1] unless m.nil?
|
||||||
includes << m[1]
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
return includes
|
includes
|
||||||
end
|
end
|
||||||
|
|
||||||
def find_source_file(header, paths)
|
def find_source_file(header, paths)
|
||||||
paths.each do |dir|
|
paths.each do |dir|
|
||||||
src_file = dir + header.ext(C_EXTENSION)
|
src_file = dir + header.ext(C_EXTENSION)
|
||||||
if (File.exists?(src_file))
|
return src_file if File.exist?(src_file)
|
||||||
return src_file
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
return nil
|
nil
|
||||||
end
|
end
|
||||||
|
|
||||||
def tackit(strings)
|
def tackit(strings)
|
||||||
if strings.is_a?(Array)
|
result = if strings.is_a?(Array)
|
||||||
result = "\"#{strings.join}\""
|
"\"#{strings.join}\""
|
||||||
else
|
else
|
||||||
result = strings
|
strings
|
||||||
end
|
end
|
||||||
return result
|
result
|
||||||
end
|
end
|
||||||
|
|
||||||
def squash(prefix, items)
|
def squash(prefix, items)
|
||||||
result = ''
|
result = ''
|
||||||
items.each { |item| result += " #{prefix}#{tackit(item)}" }
|
items.each { |item| result += " #{prefix}#{tackit(item)}" }
|
||||||
return result
|
result
|
||||||
end
|
end
|
||||||
|
|
||||||
def should(behave, &block)
|
def should(behave, &block)
|
||||||
if block
|
if block
|
||||||
puts "Should " + behave
|
puts 'Should ' + behave
|
||||||
yield block
|
yield block
|
||||||
else
|
else
|
||||||
puts "UNIMPLEMENTED CASE: Should #{behave}"
|
puts "UNIMPLEMENTED CASE: Should #{behave}"
|
||||||
@@ -93,91 +87,103 @@ module RakefileHelpers
|
|||||||
end
|
end
|
||||||
|
|
||||||
def build_compiler_fields(inject_defines)
|
def build_compiler_fields(inject_defines)
|
||||||
command = tackit($cfg['compiler']['path'])
|
command = tackit($cfg['compiler']['path'])
|
||||||
if $cfg['compiler']['defines']['items'].nil?
|
defines = if $cfg['compiler']['defines']['items'].nil?
|
||||||
defines = ''
|
''
|
||||||
else
|
else
|
||||||
defines = squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'] + ['UNITY_OUTPUT_CHAR=putcharSpy'] + inject_defines)
|
squash($cfg['compiler']['defines']['prefix'], $cfg['compiler']['defines']['items'] + ['UNITY_OUTPUT_CHAR=putcharSpy'] + ['UNITY_OUTPUT_CHAR_HEADER_DECLARATION="putcharSpy(int)"'] + inject_defines)
|
||||||
end
|
end
|
||||||
options = squash('', $cfg['compiler']['options'])
|
options = squash('', $cfg['compiler']['options'])
|
||||||
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
|
includes = squash($cfg['compiler']['includes']['prefix'], $cfg['compiler']['includes']['items'])
|
||||||
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
||||||
return {:command => command, :defines => defines, :options => options, :includes => includes}
|
|
||||||
|
{ :command => command, :defines => defines, :options => options, :includes => includes }
|
||||||
end
|
end
|
||||||
|
|
||||||
def compile(file, defines=[])
|
def compile(file, defines = [])
|
||||||
compiler = build_compiler_fields(defines)
|
compiler = build_compiler_fields(defines)
|
||||||
defines =
|
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{file} " \
|
||||||
cmd_str = "#{compiler[:command]}#{compiler[:defines]}#{compiler[:options]}#{compiler[:includes]} #{file} " +
|
|
||||||
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}"
|
"#{$cfg['compiler']['object_files']['prefix']}#{$cfg['compiler']['object_files']['destination']}"
|
||||||
obj_file = "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
|
obj_file = "#{File.basename(file, C_EXTENSION)}#{$cfg['compiler']['object_files']['extension']}"
|
||||||
execute(cmd_str + obj_file)
|
execute(cmd_str + obj_file)
|
||||||
return obj_file
|
|
||||||
|
obj_file
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_linker_fields
|
def build_linker_fields
|
||||||
command = tackit($cfg['linker']['path'])
|
command = tackit($cfg['linker']['path'])
|
||||||
if $cfg['linker']['options'].nil?
|
options = if $cfg['linker']['options'].nil?
|
||||||
options = ''
|
''
|
||||||
else
|
else
|
||||||
options = squash('', $cfg['linker']['options'])
|
squash('', $cfg['linker']['options'])
|
||||||
end
|
end
|
||||||
if ($cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?)
|
includes = if $cfg['linker']['includes'].nil? || $cfg['linker']['includes']['items'].nil?
|
||||||
includes = ''
|
''
|
||||||
else
|
else
|
||||||
includes = squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
|
squash($cfg['linker']['includes']['prefix'], $cfg['linker']['includes']['items'])
|
||||||
end
|
end.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
||||||
includes = includes.gsub(/\\ /, ' ').gsub(/\\\"/, '"').gsub(/\\$/, '') # Remove trailing slashes (for IAR)
|
|
||||||
return {:command => command, :options => options, :includes => includes}
|
{ :command => command, :options => options, :includes => includes }
|
||||||
end
|
end
|
||||||
|
|
||||||
def link_it(exe_name, obj_list)
|
def link_it(exe_name, obj_list)
|
||||||
linker = build_linker_fields
|
linker = build_linker_fields
|
||||||
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
|
cmd_str = "#{linker[:command]}#{linker[:options]}#{linker[:includes]} " +
|
||||||
(obj_list.map{|obj|"#{$cfg['linker']['object_files']['path']}#{obj} "}).join +
|
(obj_list.map { |obj| "#{$cfg['linker']['object_files']['path']}#{obj} " }).join +
|
||||||
$cfg['linker']['bin_files']['prefix'] + ' ' +
|
$cfg['linker']['bin_files']['prefix'] + ' ' +
|
||||||
$cfg['linker']['bin_files']['destination'] +
|
$cfg['linker']['bin_files']['destination'] +
|
||||||
exe_name + $cfg['linker']['bin_files']['extension']
|
exe_name + $cfg['linker']['bin_files']['extension']
|
||||||
execute(cmd_str)
|
execute(cmd_str)
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_simulator_fields
|
def build_simulator_fields
|
||||||
return nil if $cfg['simulator'].nil?
|
return nil if $cfg['simulator'].nil?
|
||||||
if $cfg['simulator']['path'].nil?
|
command = if $cfg['simulator']['path'].nil?
|
||||||
command = ''
|
''
|
||||||
else
|
else
|
||||||
command = (tackit($cfg['simulator']['path']) + ' ')
|
(tackit($cfg['simulator']['path']) + ' ')
|
||||||
end
|
end
|
||||||
if $cfg['simulator']['pre_support'].nil?
|
pre_support = if $cfg['simulator']['pre_support'].nil?
|
||||||
pre_support = ''
|
''
|
||||||
else
|
else
|
||||||
pre_support = squash('', $cfg['simulator']['pre_support'])
|
squash('', $cfg['simulator']['pre_support'])
|
||||||
end
|
end
|
||||||
if $cfg['simulator']['post_support'].nil?
|
post_support = if $cfg['simulator']['post_support'].nil?
|
||||||
post_support = ''
|
''
|
||||||
else
|
else
|
||||||
post_support = squash('', $cfg['simulator']['post_support'])
|
squash('', $cfg['simulator']['post_support'])
|
||||||
end
|
end
|
||||||
return {:command => command, :pre_support => pre_support, :post_support => post_support}
|
|
||||||
|
{ :command => command, :pre_support => pre_support, :post_support => post_support }
|
||||||
end
|
end
|
||||||
|
|
||||||
def execute(command_string, ok_to_fail=false)
|
def run_astyle(style_what)
|
||||||
|
report "Styling C Code..."
|
||||||
|
command = "AStyle " \
|
||||||
|
"--style=allman --indent=spaces=4 --indent-switches --indent-preproc-define --indent-preproc-block " \
|
||||||
|
"--pad-oper --pad-comma --unpad-paren --pad-header " \
|
||||||
|
"--align-pointer=type --align-reference=name " \
|
||||||
|
"--add-brackets --mode=c --suffix=none " \
|
||||||
|
"#{style_what}"
|
||||||
|
execute(command, false)
|
||||||
|
report "Styling C:PASS"
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute(command_string, ok_to_fail = false)
|
||||||
report command_string if $verbose
|
report command_string if $verbose
|
||||||
output = `#{command_string}`.chomp
|
output = `#{command_string}`.chomp
|
||||||
report(output) if ($verbose && !output.nil? && (output.length > 0))
|
report(output) if $verbose && !output.nil? && !output.empty?
|
||||||
if (($?.exitstatus != 0) && !ok_to_fail)
|
raise "Command failed. (Returned #{$?.exitstatus})" if !$?.nil? && !$?.exitstatus.zero? && !ok_to_fail
|
||||||
raise "Command failed. (Returned #{$?.exitstatus})"
|
output
|
||||||
end
|
|
||||||
return output
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def report_summary
|
def report_summary
|
||||||
summary = UnityTestSummary.new
|
summary = UnityTestSummary.new
|
||||||
summary.set_root_path(UNITY_ROOT)
|
summary.root = __dir__
|
||||||
results_glob = "#{$cfg['compiler']['build_path']}*.test*"
|
results_glob = "#{$cfg['compiler']['build_path']}*.test*"
|
||||||
results_glob.gsub!(/\\/, '/')
|
results_glob.tr!('\\', '/')
|
||||||
results = Dir[results_glob]
|
results = Dir[results_glob]
|
||||||
summary.set_targets(results)
|
summary.targets = results
|
||||||
report summary.run
|
report summary.run
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -187,16 +193,25 @@ module RakefileHelpers
|
|||||||
# Tack on TEST define for compiling unit tests
|
# Tack on TEST define for compiling unit tests
|
||||||
load_configuration($cfg_file)
|
load_configuration($cfg_file)
|
||||||
test_defines = ['TEST']
|
test_defines = ['TEST']
|
||||||
$cfg['compiler']['defines']['items'] = [] if $cfg['compiler']['defines']['items'].nil?
|
$cfg['compiler']['defines']['items'] ||= []
|
||||||
$cfg['compiler']['defines']['items'] << 'TEST'
|
$cfg['compiler']['defines']['items'] << 'TEST'
|
||||||
|
|
||||||
include_dirs = get_local_include_dirs
|
include_dirs = local_include_dirs
|
||||||
|
|
||||||
# Build and execute each unit test
|
# Build and execute each unit test
|
||||||
test_files.each do |test|
|
test_files.each do |test|
|
||||||
|
|
||||||
|
# Drop Out if we're skipping this type of test
|
||||||
|
if $cfg[:skip_tests]
|
||||||
|
if $cfg[:skip_tests].include?(:parameterized) && test.match(/parameterized/)
|
||||||
|
report("Skipping Parameterized Tests for this Target:IGNORE")
|
||||||
|
next
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
obj_list = []
|
obj_list = []
|
||||||
|
|
||||||
if !$cfg['compiler']['aux_sources'].nil?
|
unless $cfg['compiler']['aux_sources'].nil?
|
||||||
$cfg['compiler']['aux_sources'].each do |aux|
|
$cfg['compiler']['aux_sources'].each do |aux|
|
||||||
obj_list << compile(aux, test_defines)
|
obj_list << compile(aux, test_defines)
|
||||||
end
|
end
|
||||||
@@ -206,25 +221,23 @@ module RakefileHelpers
|
|||||||
extract_headers(test).each do |header|
|
extract_headers(test).each do |header|
|
||||||
# Compile corresponding source file if it exists
|
# Compile corresponding source file if it exists
|
||||||
src_file = find_source_file(header, include_dirs)
|
src_file = find_source_file(header, include_dirs)
|
||||||
if !src_file.nil?
|
|
||||||
obj_list << compile(src_file, test_defines)
|
obj_list << compile(src_file, test_defines) unless src_file.nil?
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Build the test runner (generate if configured to do so)
|
# Build the test runner (generate if configured to do so)
|
||||||
test_base = File.basename(test, C_EXTENSION)
|
test_base = File.basename(test, C_EXTENSION)
|
||||||
|
|
||||||
runner_name = test_base + '_Runner.c'
|
runner_name = test_base + '_Runner.c'
|
||||||
runner_path = ''
|
|
||||||
|
|
||||||
if $cfg['compiler']['runner_path'].nil?
|
runner_path = if $cfg['compiler']['runner_path'].nil?
|
||||||
runner_path = $cfg['compiler']['build_path'] + runner_name
|
$cfg['compiler']['build_path'] + runner_name
|
||||||
else
|
else
|
||||||
runner_path = $cfg['compiler']['runner_path'] + runner_name
|
$cfg['compiler']['runner_path'] + runner_name
|
||||||
end
|
end
|
||||||
|
|
||||||
options = $cfg[:unity]
|
options = $cfg[:unity]
|
||||||
options[:use_param_tests] = (test =~ /parameterized/) ? true : false
|
options[:use_param_tests] = test =~ /parameterized/ ? true : false
|
||||||
UnityTestRunnerGenerator.new(options).run(test, runner_path)
|
UnityTestRunnerGenerator.new(options).run(test, runner_path)
|
||||||
obj_list << compile(runner_path, test_defines)
|
obj_list << compile(runner_path, test_defines)
|
||||||
|
|
||||||
@@ -237,21 +250,20 @@ module RakefileHelpers
|
|||||||
# Execute unit test and generate results file
|
# Execute unit test and generate results file
|
||||||
simulator = build_simulator_fields
|
simulator = build_simulator_fields
|
||||||
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
|
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension']
|
||||||
if simulator.nil?
|
cmd_str = if simulator.nil?
|
||||||
cmd_str = executable
|
executable
|
||||||
else
|
else
|
||||||
cmd_str = "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
"#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
||||||
end
|
end
|
||||||
output = execute(cmd_str)
|
output = execute(cmd_str)
|
||||||
test_results = $cfg['compiler']['build_path'] + test_base
|
test_results = $cfg['compiler']['build_path'] + test_base
|
||||||
if output.match(/OK$/m).nil?
|
if output.match(/OK$/m).nil?
|
||||||
test_results += '.testfail'
|
test_results += '.testfail'
|
||||||
else
|
else
|
||||||
report output if (!$verbose) #verbose already prints this line, as does a failure
|
report output unless $verbose # Verbose already prints this line, as does a failure
|
||||||
test_results += '.testpass'
|
test_results += '.testpass'
|
||||||
end
|
end
|
||||||
File.open(test_results, 'w') { |f| f.print output }
|
File.open(test_results, 'w') { |f| f.print output }
|
||||||
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
158
test/spec/generate_module_existing_file_spec.rb
Normal file
158
test/spec/generate_module_existing_file_spec.rb
Normal file
@@ -0,0 +1,158 @@
|
|||||||
|
|
||||||
|
require '../auto/generate_module.rb'
|
||||||
|
require 'fileutils'
|
||||||
|
|
||||||
|
def touch_src(file)
|
||||||
|
FileUtils.touch "sandbox/src/#{file}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def touch_test(file)
|
||||||
|
FileUtils.touch "sandbox/test/#{file}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_src_with_known_content(file)
|
||||||
|
File.open("sandbox/src/#{file}", "w") {|f| f.write("the original #{file}")}
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_test_with_known_content(file)
|
||||||
|
File.open("sandbox/test/#{file}", "w") {|f| f.write("the original #{file}")}
|
||||||
|
end
|
||||||
|
|
||||||
|
def expect_src_content_didnt_change(file)
|
||||||
|
expect(File.read("sandbox/src/#{file}")).to eq("the original #{file}")
|
||||||
|
end
|
||||||
|
|
||||||
|
def expect_test_content_didnt_change(file)
|
||||||
|
expect(File.read("sandbox/test/#{file}")).to eq("the original #{file}")
|
||||||
|
end
|
||||||
|
|
||||||
|
def expect_src_file_to_exist(file)
|
||||||
|
expect(File.exist?("sandbox/src/#{file}")).to be true
|
||||||
|
end
|
||||||
|
|
||||||
|
def expect_test_file_to_exist(file)
|
||||||
|
expect(File.exist?("sandbox/test/#{file}")).to be true
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "UnityModuleGenerator" do
|
||||||
|
|
||||||
|
before do
|
||||||
|
# clean sandbox and setup our "project" folders
|
||||||
|
FileUtils.rm_rf "sandbox"
|
||||||
|
FileUtils.mkdir_p "sandbox"
|
||||||
|
FileUtils.mkdir_p "sandbox/src"
|
||||||
|
FileUtils.mkdir_p "sandbox/test"
|
||||||
|
|
||||||
|
@options = {
|
||||||
|
:path_src => "sandbox/src",
|
||||||
|
:path_tst => "sandbox/test",
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
context "with src pattern" do
|
||||||
|
before do
|
||||||
|
@options[:pattern] = "src"
|
||||||
|
end
|
||||||
|
|
||||||
|
it "fails when all files already exist" do
|
||||||
|
# create an existing triad of files
|
||||||
|
touch_src "meh.c"
|
||||||
|
touch_src "meh.h"
|
||||||
|
touch_test "Testmeh.c"
|
||||||
|
expect {
|
||||||
|
UnityModuleGenerator.new(@options).generate("meh")
|
||||||
|
}.to raise_error("ERROR: File meh already exists. Exiting.")
|
||||||
|
end
|
||||||
|
|
||||||
|
it "creates the test file if the source and header files exist" do
|
||||||
|
# Create the existing files.
|
||||||
|
touch_src "meh.c"
|
||||||
|
touch_src "meh.h"
|
||||||
|
|
||||||
|
UnityModuleGenerator.new(@options).generate("meh")
|
||||||
|
|
||||||
|
expect_test_file_to_exist "Testmeh.c"
|
||||||
|
end
|
||||||
|
|
||||||
|
it "does not alter existing files" do
|
||||||
|
# Create some files with known content.
|
||||||
|
create_src_with_known_content "meh.c"
|
||||||
|
create_src_with_known_content "meh.h"
|
||||||
|
|
||||||
|
UnityModuleGenerator.new(@options).generate("meh")
|
||||||
|
|
||||||
|
expect_src_content_didnt_change "meh.c"
|
||||||
|
expect_src_content_didnt_change "meh.c"
|
||||||
|
end
|
||||||
|
|
||||||
|
it "does not alter existing test files" do
|
||||||
|
# Create some files with known content.
|
||||||
|
create_test_with_known_content "Testmeh.c"
|
||||||
|
|
||||||
|
UnityModuleGenerator.new(@options).generate("meh")
|
||||||
|
|
||||||
|
expect_test_content_didnt_change "Testmeh.c"
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
context "with mch pattern" do
|
||||||
|
before do
|
||||||
|
@options[:pattern] = "mch"
|
||||||
|
end
|
||||||
|
|
||||||
|
it "fails when all files exist" do
|
||||||
|
touch_src "meh_model.c"
|
||||||
|
touch_src "meh_conductor.c"
|
||||||
|
touch_src "meh_hardware.c"
|
||||||
|
touch_src "meh_model.h"
|
||||||
|
touch_src "meh_conductor.h"
|
||||||
|
touch_src "meh_hardware.h"
|
||||||
|
touch_test "Testmeh_model.c"
|
||||||
|
touch_test "Testmeh_conductor.c"
|
||||||
|
touch_test "Testmeh_hardware.c"
|
||||||
|
expect {
|
||||||
|
UnityModuleGenerator.new(@options).generate("meh")
|
||||||
|
}.to raise_error("ERROR: File meh_model already exists. Exiting.")
|
||||||
|
end
|
||||||
|
|
||||||
|
it "creates files that don't exist" do
|
||||||
|
touch_src "meh_model.c"
|
||||||
|
touch_src "meh_conductor.c"
|
||||||
|
touch_src "meh_hardware.c"
|
||||||
|
touch_src "meh_model.h"
|
||||||
|
touch_src "meh_conductor.h"
|
||||||
|
|
||||||
|
UnityModuleGenerator.new(@options).generate("meh")
|
||||||
|
|
||||||
|
expect_src_file_to_exist "meh_hardware.h"
|
||||||
|
expect_test_file_to_exist "Testmeh_model.c"
|
||||||
|
expect_test_file_to_exist "Testmeh_conductor.c"
|
||||||
|
expect_test_file_to_exist "Testmeh_hardware.c"
|
||||||
|
end
|
||||||
|
|
||||||
|
it "does not alter existing source files" do
|
||||||
|
create_src_with_known_content "meh_model.c"
|
||||||
|
create_src_with_known_content "meh_model.c"
|
||||||
|
create_src_with_known_content "meh_model.c"
|
||||||
|
create_src_with_known_content "meh_model.h"
|
||||||
|
create_src_with_known_content "meh_model.c"
|
||||||
|
|
||||||
|
UnityModuleGenerator.new(@options).generate("meh")
|
||||||
|
|
||||||
|
expect_src_content_didnt_change "meh_model.c"
|
||||||
|
expect_src_content_didnt_change "meh_model.c"
|
||||||
|
expect_src_content_didnt_change "meh_model.c"
|
||||||
|
expect_src_content_didnt_change "meh_model.c"
|
||||||
|
end
|
||||||
|
|
||||||
|
it "does not alter existing test files" do
|
||||||
|
create_test_with_known_content "Testmeh_model.c"
|
||||||
|
|
||||||
|
UnityModuleGenerator.new(@options).generate("meh")
|
||||||
|
|
||||||
|
expect_test_content_didnt_change "Testmeh_model.c"
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
|
end
|
||||||
49
test/targets/ansi.yml
Normal file
49
test/targets/ansi.yml
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
compiler:
|
||||||
|
path: gcc
|
||||||
|
source_path: '../src/'
|
||||||
|
unit_tests_path: &unit_tests_path 'tests/'
|
||||||
|
build_path: &build_path 'build/'
|
||||||
|
options:
|
||||||
|
- '-c'
|
||||||
|
- '-m64'
|
||||||
|
- '-Wall'
|
||||||
|
- '-Wno-address'
|
||||||
|
- '-ansi'
|
||||||
|
#- '-pedantic'
|
||||||
|
includes:
|
||||||
|
prefix: '-I'
|
||||||
|
items:
|
||||||
|
- 'src/'
|
||||||
|
- '../src/'
|
||||||
|
- 'testdata/'
|
||||||
|
- *unit_tests_path
|
||||||
|
defines:
|
||||||
|
prefix: '-D'
|
||||||
|
items:
|
||||||
|
- UNITY_INCLUDE_DOUBLE
|
||||||
|
- UNITY_SUPPORT_TEST_CASES
|
||||||
|
- UNITY_EXCLUDE_TESTING_NEW_COMMENTS
|
||||||
|
- UNITY_SUPPORT_64
|
||||||
|
object_files:
|
||||||
|
prefix: '-o'
|
||||||
|
extension: '.o'
|
||||||
|
destination: *build_path
|
||||||
|
linker:
|
||||||
|
path: gcc
|
||||||
|
options:
|
||||||
|
- -lm
|
||||||
|
- '-m64'
|
||||||
|
includes:
|
||||||
|
prefix: '-I'
|
||||||
|
object_files:
|
||||||
|
path: *build_path
|
||||||
|
extension: '.o'
|
||||||
|
bin_files:
|
||||||
|
prefix: '-o'
|
||||||
|
extension: '.exe'
|
||||||
|
destination: *build_path
|
||||||
|
colour: true
|
||||||
|
:unity:
|
||||||
|
:plugins: []
|
||||||
|
:skip_tests:
|
||||||
|
- :parameterized
|
||||||
@@ -16,13 +16,10 @@ compiler:
|
|||||||
- '-Winit-self'
|
- '-Winit-self'
|
||||||
- '-Winline'
|
- '-Winline'
|
||||||
- '-Winvalid-pch'
|
- '-Winvalid-pch'
|
||||||
- '-Wmissing-declarations'
|
|
||||||
- '-Wmissing-include-dirs'
|
- '-Wmissing-include-dirs'
|
||||||
- '-Wmissing-prototypes'
|
|
||||||
- '-Wnonnull'
|
- '-Wnonnull'
|
||||||
- '-Wpacked'
|
- '-Wpacked'
|
||||||
- '-Wpointer-arith'
|
- '-Wpointer-arith'
|
||||||
- '-Wredundant-decls'
|
|
||||||
- '-Wswitch-default'
|
- '-Wswitch-default'
|
||||||
- '-Wstrict-aliasing'
|
- '-Wstrict-aliasing'
|
||||||
- '-Wstrict-overflow=5'
|
- '-Wstrict-overflow=5'
|
||||||
@@ -33,10 +30,7 @@ compiler:
|
|||||||
- '-Wshadow'
|
- '-Wshadow'
|
||||||
- '-Wundef'
|
- '-Wundef'
|
||||||
- '-Wwrite-strings'
|
- '-Wwrite-strings'
|
||||||
- '-Wno-missing-declarations'
|
|
||||||
- '-Wno-missing-prototypes'
|
|
||||||
- '-Wno-nested-externs'
|
- '-Wno-nested-externs'
|
||||||
- '-Wno-redundant-decls'
|
|
||||||
- '-Wno-unused-parameter'
|
- '-Wno-unused-parameter'
|
||||||
- '-Wno-variadic-macros'
|
- '-Wno-variadic-macros'
|
||||||
- '-Wbad-function-cast'
|
- '-Wbad-function-cast'
|
||||||
|
|||||||
@@ -16,13 +16,10 @@ compiler:
|
|||||||
- '-Winit-self'
|
- '-Winit-self'
|
||||||
- '-Winline'
|
- '-Winline'
|
||||||
- '-Winvalid-pch'
|
- '-Winvalid-pch'
|
||||||
- '-Wmissing-declarations'
|
|
||||||
- '-Wmissing-include-dirs'
|
- '-Wmissing-include-dirs'
|
||||||
- '-Wmissing-prototypes'
|
|
||||||
- '-Wnonnull'
|
- '-Wnonnull'
|
||||||
- '-Wpacked'
|
- '-Wpacked'
|
||||||
- '-Wpointer-arith'
|
- '-Wpointer-arith'
|
||||||
- '-Wredundant-decls'
|
|
||||||
- '-Wswitch-default'
|
- '-Wswitch-default'
|
||||||
- '-Wstrict-aliasing'
|
- '-Wstrict-aliasing'
|
||||||
- '-Wstrict-overflow=5'
|
- '-Wstrict-overflow=5'
|
||||||
@@ -33,16 +30,13 @@ compiler:
|
|||||||
- '-Wshadow'
|
- '-Wshadow'
|
||||||
- '-Wundef'
|
- '-Wundef'
|
||||||
- '-Wwrite-strings'
|
- '-Wwrite-strings'
|
||||||
- '-Wno-missing-declarations'
|
|
||||||
- '-Wno-missing-prototypes'
|
|
||||||
- '-Wno-nested-externs'
|
- '-Wno-nested-externs'
|
||||||
- '-Wno-redundant-decls'
|
|
||||||
- '-Wno-unused-parameter'
|
- '-Wno-unused-parameter'
|
||||||
- '-Wno-variadic-macros'
|
- '-Wno-variadic-macros'
|
||||||
- '-Wbad-function-cast'
|
- '-Wbad-function-cast'
|
||||||
- '-fms-extensions'
|
- '-fms-extensions'
|
||||||
- '-fno-omit-frame-pointer'
|
- '-fno-omit-frame-pointer'
|
||||||
- '-ffloat-store'
|
#- '-ffloat-store'
|
||||||
- '-fno-common'
|
- '-fno-common'
|
||||||
- '-fstrict-aliasing'
|
- '-fstrict-aliasing'
|
||||||
- '-std=gnu99'
|
- '-std=gnu99'
|
||||||
@@ -61,8 +55,6 @@ compiler:
|
|||||||
- UNITY_INCLUDE_DOUBLE
|
- UNITY_INCLUDE_DOUBLE
|
||||||
- UNITY_SUPPORT_TEST_CASES
|
- UNITY_SUPPORT_TEST_CASES
|
||||||
- UNITY_SUPPORT_64
|
- UNITY_SUPPORT_64
|
||||||
- UNITY_OUTPUT_FLUSH
|
|
||||||
- UNITY_OMIT_OUTPUT_FLUSH_HEADER_DECLARATION
|
|
||||||
object_files:
|
object_files:
|
||||||
prefix: '-o'
|
prefix: '-o'
|
||||||
extension: '.o'
|
extension: '.o'
|
||||||
|
|||||||
2
test/testdata/CException.h
vendored
2
test/testdata/CException.h
vendored
@@ -8,4 +8,4 @@
|
|||||||
#define Try if (e)
|
#define Try if (e)
|
||||||
#define Catch(a) if (!a)
|
#define Catch(a) if (!a)
|
||||||
|
|
||||||
#endif //CEXCEPTION_H
|
#endif
|
||||||
|
|||||||
2
test/testdata/Defs.h
vendored
2
test/testdata/Defs.h
vendored
@@ -5,4 +5,4 @@
|
|||||||
|
|
||||||
extern int CounterSuiteSetup;
|
extern int CounterSuiteSetup;
|
||||||
|
|
||||||
#endif //DEF_H
|
#endif
|
||||||
|
|||||||
2
test/testdata/cmock.h
vendored
2
test/testdata/cmock.h
vendored
@@ -11,4 +11,4 @@ void mockMock_Init(void) { mockMock_Init_Counter++; }
|
|||||||
void mockMock_Verify(void) { mockMock_Verify_Counter++; }
|
void mockMock_Verify(void) { mockMock_Verify_Counter++; }
|
||||||
void mockMock_Destroy(void) { mockMock_Destroy_Counter++; }
|
void mockMock_Destroy(void) { mockMock_Destroy_Counter++; }
|
||||||
|
|
||||||
#endif //CMOCK_H
|
#endif
|
||||||
|
|||||||
2
test/testdata/mockMock.h
vendored
2
test/testdata/mockMock.h
vendored
@@ -10,4 +10,4 @@ void mockMock_Init(void);
|
|||||||
void mockMock_Verify(void);
|
void mockMock_Verify(void);
|
||||||
void mockMock_Destroy(void);
|
void mockMock_Destroy(void);
|
||||||
|
|
||||||
#endif //MOCK_MOCK_H
|
#endif
|
||||||
|
|||||||
12
test/testdata/testRunnerGenerator.c
vendored
12
test/testdata/testRunnerGenerator.c
vendored
@@ -21,7 +21,10 @@
|
|||||||
|
|
||||||
/* Support for Meta Test Rig */
|
/* Support for Meta Test Rig */
|
||||||
#define TEST_CASE(a)
|
#define TEST_CASE(a)
|
||||||
void putcharSpy(int c) { (void)putchar(c);} // include passthrough for linking tests
|
|
||||||
|
/* Include Passthroughs for Linking Tests */
|
||||||
|
void putcharSpy(int c) { (void)putchar(c);}
|
||||||
|
void flushSpy(void) {}
|
||||||
|
|
||||||
/* Global Variables Used During These Tests */
|
/* Global Variables Used During These Tests */
|
||||||
int CounterSetup = 0;
|
int CounterSetup = 0;
|
||||||
@@ -105,10 +108,12 @@ void custtest_ThisTestPassesWhenCustomTeardownRan(void)
|
|||||||
TEST_ASSERT_EQUAL_MESSAGE(2, CounterTeardown, "Custom Teardown Wasn't Run");
|
TEST_ASSERT_EQUAL_MESSAGE(2, CounterTeardown, "Custom Teardown Wasn't Run");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#ifndef UNITY_EXCLUDE_TESTING_NEW_COMMENTS
|
||||||
//void test_NewStyleCommentsShouldBeIgnored(void)
|
//void test_NewStyleCommentsShouldBeIgnored(void)
|
||||||
//{
|
//{
|
||||||
// TEST_ASSERT_FAIL("New Style Comments Should Be Ignored");
|
// TEST_ASSERT_FAIL("New Style Comments Should Be Ignored");
|
||||||
//}
|
//}
|
||||||
|
#endif
|
||||||
|
|
||||||
void test_NotBeConfusedByLongComplicatedStrings(void)
|
void test_NotBeConfusedByLongComplicatedStrings(void)
|
||||||
{
|
{
|
||||||
@@ -117,10 +122,13 @@ void test_NotBeConfusedByLongComplicatedStrings(void)
|
|||||||
TEST_ASSERT_EQUAL_STRING_MESSAGE(crazyString, crazyString, "These Strings Are The Same");
|
TEST_ASSERT_EQUAL_STRING_MESSAGE(crazyString, crazyString, "These Strings Are The Same");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* The next test should still appear even though we have this confusing nested comment thing going on http://looks_like_comments.com */
|
||||||
void test_NotDisappearJustBecauseTheTestBeforeAndAfterHaveCrazyStrings(void)
|
void test_NotDisappearJustBecauseTheTestBeforeAndAfterHaveCrazyStrings(void)
|
||||||
{
|
{
|
||||||
TEST_ASSERT_TRUE_MESSAGE(1, "1 Should be True");
|
TEST_ASSERT_TRUE_MESSAGE(1, "1 Should be True");
|
||||||
|
/* still should not break anything */
|
||||||
}
|
}
|
||||||
|
/* nor should this */
|
||||||
|
|
||||||
void test_StillNotBeConfusedByLongComplicatedStrings(void)
|
void test_StillNotBeConfusedByLongComplicatedStrings(void)
|
||||||
{
|
{
|
||||||
@@ -179,5 +187,3 @@ void suitetest_ThisTestPassesWhenCustomSuiteSetupAndTeardownRan(void)
|
|||||||
{
|
{
|
||||||
TEST_ASSERT_EQUAL_MESSAGE(1, CounterSuiteSetup, "Suite Setup Should Have Run");
|
TEST_ASSERT_EQUAL_MESSAGE(1, CounterSuiteSetup, "Suite Setup Should Have Run");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
7
test/testdata/testRunnerGeneratorSmall.c
vendored
7
test/testdata/testRunnerGeneratorSmall.c
vendored
@@ -4,6 +4,8 @@
|
|||||||
#include "unity.h"
|
#include "unity.h"
|
||||||
#include "Defs.h"
|
#include "Defs.h"
|
||||||
|
|
||||||
|
TEST_FILE("some_file.c")
|
||||||
|
|
||||||
/* Notes about prefixes:
|
/* Notes about prefixes:
|
||||||
test - normal default prefix. these are "always run" tests for this procedure
|
test - normal default prefix. these are "always run" tests for this procedure
|
||||||
spec - normal default prefix. required to run default setup/teardown calls.
|
spec - normal default prefix. required to run default setup/teardown calls.
|
||||||
@@ -11,7 +13,10 @@
|
|||||||
|
|
||||||
/* Support for Meta Test Rig */
|
/* Support for Meta Test Rig */
|
||||||
#define TEST_CASE(a)
|
#define TEST_CASE(a)
|
||||||
void putcharSpy(int c) { (void)putchar(c);} // include passthrough for linking tests
|
|
||||||
|
/* Include Passthroughs for Linking Tests */
|
||||||
|
void putcharSpy(int c) { (void)putchar(c);}
|
||||||
|
void flushSpy(void) {}
|
||||||
|
|
||||||
/* Global Variables Used During These Tests */
|
/* Global Variables Used During These Tests */
|
||||||
int CounterSetup = 0;
|
int CounterSetup = 0;
|
||||||
|
|||||||
11
test/testdata/testRunnerGeneratorWithMocks.c
vendored
11
test/testdata/testRunnerGeneratorWithMocks.c
vendored
@@ -22,7 +22,10 @@
|
|||||||
|
|
||||||
/* Support for Meta Test Rig */
|
/* Support for Meta Test Rig */
|
||||||
#define TEST_CASE(a)
|
#define TEST_CASE(a)
|
||||||
void putcharSpy(int c) { (void)putchar(c);} // include passthrough for linking tests
|
|
||||||
|
/* Include Passthroughs for Linking Tests */
|
||||||
|
void putcharSpy(int c) { (void)putchar(c);}
|
||||||
|
void flushSpy(void) {}
|
||||||
|
|
||||||
/* Global Variables Used During These Tests */
|
/* Global Variables Used During These Tests */
|
||||||
int CounterSetup = 0;
|
int CounterSetup = 0;
|
||||||
@@ -106,10 +109,12 @@ void custtest_ThisTestPassesWhenCustomTeardownRan(void)
|
|||||||
TEST_ASSERT_EQUAL_MESSAGE(2, CounterTeardown, "Custom Teardown Wasn't Run");
|
TEST_ASSERT_EQUAL_MESSAGE(2, CounterTeardown, "Custom Teardown Wasn't Run");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#ifndef UNITY_EXCLUDE_TESTING_NEW_COMMENTS
|
||||||
//void test_NewStyleCommentsShouldBeIgnored(void)
|
//void test_NewStyleCommentsShouldBeIgnored(void)
|
||||||
//{
|
//{
|
||||||
// TEST_ASSERT_FAIL("New Style Comments Should Be Ignored");
|
// TEST_ASSERT_FAIL("New Style Comments Should Be Ignored");
|
||||||
//}
|
//}
|
||||||
|
#endif
|
||||||
|
|
||||||
void test_NotBeConfusedByLongComplicatedStrings(void)
|
void test_NotBeConfusedByLongComplicatedStrings(void)
|
||||||
{
|
{
|
||||||
@@ -183,9 +188,9 @@ void suitetest_ThisTestPassesWhenCustomSuiteSetupAndTeardownRan(void)
|
|||||||
|
|
||||||
void test_ShouldCallMockInitAndVerifyFunctionsForEachTest(void)
|
void test_ShouldCallMockInitAndVerifyFunctionsForEachTest(void)
|
||||||
{
|
{
|
||||||
int passes = (int)(Unity.NumberOfTests - Unity.TestFailures - Unity.TestIgnores);
|
int passesOrIgnores = (int)(Unity.NumberOfTests - Unity.TestFailures);
|
||||||
TEST_ASSERT_EQUAL_MESSAGE(Unity.NumberOfTests, mockMock_Init_Counter, "Mock Init Should Be Called Once Per Test Started");
|
TEST_ASSERT_EQUAL_MESSAGE(Unity.NumberOfTests, mockMock_Init_Counter, "Mock Init Should Be Called Once Per Test Started");
|
||||||
TEST_ASSERT_EQUAL_MESSAGE(passes, mockMock_Verify_Counter, "Mock Verify Should Be Called Once Per Test Passed");
|
TEST_ASSERT_EQUAL_MESSAGE(passesOrIgnores, mockMock_Verify_Counter, "Mock Verify Should Be Called Once Per Test Passed");
|
||||||
TEST_ASSERT_EQUAL_MESSAGE(Unity.NumberOfTests - 1, mockMock_Destroy_Counter, "Mock Destroy Should Be Called Once Per Test Completed");
|
TEST_ASSERT_EQUAL_MESSAGE(Unity.NumberOfTests - 1, mockMock_Destroy_Counter, "Mock Destroy Should Be Called Once Per Test Completed");
|
||||||
TEST_ASSERT_EQUAL_MESSAGE(0, CMockMemFreeFinalCounter, "Mock MemFreeFinal Should Not Be Called Until End");
|
TEST_ASSERT_EQUAL_MESSAGE(0, CMockMemFreeFinalCounter, "Mock MemFreeFinal Should Not Be Called Until End");
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -144,12 +144,13 @@ RUNNER_TESTS = [
|
|||||||
:test_prefix => "paratest",
|
:test_prefix => "paratest",
|
||||||
:use_param_tests => true,
|
:use_param_tests => true,
|
||||||
},
|
},
|
||||||
|
:features => [ :parameterized ],
|
||||||
:expected => {
|
:expected => {
|
||||||
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(125\)',
|
'paratest_ShouldHandleParameterizedTests\(125\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(5\)',
|
'paratest_ShouldHandleParameterizedTests\(5\)',
|
||||||
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
||||||
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid\(RUN_TEST_NO_ARGS\)',
|
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid',
|
||||||
],
|
],
|
||||||
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
||||||
:to_ignore => [ ],
|
:to_ignore => [ ],
|
||||||
@@ -160,12 +161,13 @@ RUNNER_TESTS = [
|
|||||||
:testfile => 'testdata/testRunnerGenerator.c',
|
:testfile => 'testdata/testRunnerGenerator.c',
|
||||||
:testdefines => ['TEST'],
|
:testdefines => ['TEST'],
|
||||||
:cmdline => " --test_prefix=\"paratest\" --use_param_tests=1",
|
:cmdline => " --test_prefix=\"paratest\" --use_param_tests=1",
|
||||||
|
:features => [ :parameterized ],
|
||||||
:expected => {
|
:expected => {
|
||||||
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(125\)',
|
'paratest_ShouldHandleParameterizedTests\(125\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(5\)',
|
'paratest_ShouldHandleParameterizedTests\(5\)',
|
||||||
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
||||||
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid\(RUN_TEST_NO_ARGS\)',
|
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid',
|
||||||
],
|
],
|
||||||
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
||||||
:to_ignore => [ ],
|
:to_ignore => [ ],
|
||||||
@@ -179,12 +181,13 @@ RUNNER_TESTS = [
|
|||||||
:yaml => {
|
:yaml => {
|
||||||
:test_prefix => "paratest"
|
:test_prefix => "paratest"
|
||||||
},
|
},
|
||||||
|
:features => [ :parameterized ],
|
||||||
:expected => {
|
:expected => {
|
||||||
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(125\)',
|
'paratest_ShouldHandleParameterizedTests\(125\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(5\)',
|
'paratest_ShouldHandleParameterizedTests\(5\)',
|
||||||
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
||||||
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid\(RUN_TEST_NO_ARGS\)',
|
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid',
|
||||||
],
|
],
|
||||||
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
||||||
:to_ignore => [ ],
|
:to_ignore => [ ],
|
||||||
@@ -468,12 +471,13 @@ RUNNER_TESTS = [
|
|||||||
:test_prefix => "paratest",
|
:test_prefix => "paratest",
|
||||||
:use_param_tests => true,
|
:use_param_tests => true,
|
||||||
},
|
},
|
||||||
|
:features => [ :parameterized ],
|
||||||
:expected => {
|
:expected => {
|
||||||
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(125\)',
|
'paratest_ShouldHandleParameterizedTests\(125\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(5\)',
|
'paratest_ShouldHandleParameterizedTests\(5\)',
|
||||||
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
||||||
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid\(RUN_TEST_NO_ARGS\)',
|
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid',
|
||||||
],
|
],
|
||||||
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
||||||
:to_ignore => [ ],
|
:to_ignore => [ ],
|
||||||
@@ -484,12 +488,13 @@ RUNNER_TESTS = [
|
|||||||
:testfile => 'testdata/testRunnerGeneratorWithMocks.c',
|
:testfile => 'testdata/testRunnerGeneratorWithMocks.c',
|
||||||
:testdefines => ['TEST'],
|
:testdefines => ['TEST'],
|
||||||
:cmdline => " --test_prefix=\"paratest\" --use_param_tests=1",
|
:cmdline => " --test_prefix=\"paratest\" --use_param_tests=1",
|
||||||
|
:features => [ :parameterized ],
|
||||||
:expected => {
|
:expected => {
|
||||||
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(125\)',
|
'paratest_ShouldHandleParameterizedTests\(125\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(5\)',
|
'paratest_ShouldHandleParameterizedTests\(5\)',
|
||||||
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
||||||
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid\(RUN_TEST_NO_ARGS\)',
|
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid',
|
||||||
],
|
],
|
||||||
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
||||||
:to_ignore => [ ],
|
:to_ignore => [ ],
|
||||||
@@ -503,12 +508,13 @@ RUNNER_TESTS = [
|
|||||||
:yaml => {
|
:yaml => {
|
||||||
:test_prefix => "paratest"
|
:test_prefix => "paratest"
|
||||||
},
|
},
|
||||||
|
:features => [ :parameterized ],
|
||||||
:expected => {
|
:expected => {
|
||||||
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(125\)',
|
'paratest_ShouldHandleParameterizedTests\(125\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(5\)',
|
'paratest_ShouldHandleParameterizedTests\(5\)',
|
||||||
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
||||||
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid\(RUN_TEST_NO_ARGS\)',
|
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid',
|
||||||
],
|
],
|
||||||
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
:to_fail => [ 'paratest_ShouldHandleParameterizedTestsThatFail\(17\)' ],
|
||||||
:to_ignore => [ ],
|
:to_ignore => [ ],
|
||||||
@@ -1044,6 +1050,7 @@ RUNNER_TESTS = [
|
|||||||
:test_prefix => "paratest"
|
:test_prefix => "paratest"
|
||||||
},
|
},
|
||||||
:cmdline_args => "-n ShouldHandleParameterizedTests",
|
:cmdline_args => "-n ShouldHandleParameterizedTests",
|
||||||
|
:features => [ :parameterized ],
|
||||||
:expected => {
|
:expected => {
|
||||||
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
:to_pass => [ 'paratest_ShouldHandleParameterizedTests\(25\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(125\)',
|
'paratest_ShouldHandleParameterizedTests\(125\)',
|
||||||
@@ -1090,6 +1097,7 @@ RUNNER_TESTS = [
|
|||||||
:cmdline_args => true,
|
:cmdline_args => true,
|
||||||
},
|
},
|
||||||
:cmdline_args => "-l",
|
:cmdline_args => "-l",
|
||||||
|
:features => [ :parameterized ],
|
||||||
:expected => {
|
:expected => {
|
||||||
:to_pass => [ ],
|
:to_pass => [ ],
|
||||||
:to_fail => [ ],
|
:to_fail => [ ],
|
||||||
@@ -1099,7 +1107,7 @@ RUNNER_TESTS = [
|
|||||||
'paratest_ShouldHandleParameterizedTests\(125\)',
|
'paratest_ShouldHandleParameterizedTests\(125\)',
|
||||||
'paratest_ShouldHandleParameterizedTests\(5\)',
|
'paratest_ShouldHandleParameterizedTests\(5\)',
|
||||||
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
'paratest_ShouldHandleParameterizedTests2\(7\)',
|
||||||
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid\(RUN_TEST_NO_ARGS\)',
|
'paratest_ShouldHandleNonParameterizedTestsWhenParameterizationValid',
|
||||||
'paratest_ShouldHandleParameterizedTestsThatFail\(17\)'
|
'paratest_ShouldHandleParameterizedTestsThatFail\(17\)'
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
@@ -1151,10 +1159,18 @@ RUNNER_TESTS = [
|
|||||||
},
|
},
|
||||||
]
|
]
|
||||||
|
|
||||||
def runner_test(test, runner, expected, test_defines, cmdline_args)
|
def runner_test(test, runner, expected, test_defines, cmdline_args, features)
|
||||||
# Tack on TEST define for compiling unit tests
|
# Tack on TEST define for compiling unit tests
|
||||||
load_configuration($cfg_file)
|
load_configuration($cfg_file)
|
||||||
|
|
||||||
|
# Drop Out if we're skipping this type of test
|
||||||
|
if $cfg[:skip_tests] && features
|
||||||
|
if $cfg[:skip_tests].include?(:parameterized) && features.include?(:parameterized)
|
||||||
|
report("Skipping Parameterized Tests for this Target:IGNORE")
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
#compile objects
|
#compile objects
|
||||||
obj_list = [
|
obj_list = [
|
||||||
compile(runner, test_defines),
|
compile(runner, test_defines),
|
||||||
@@ -1170,11 +1186,11 @@ def runner_test(test, runner, expected, test_defines, cmdline_args)
|
|||||||
simulator = build_simulator_fields
|
simulator = build_simulator_fields
|
||||||
cmdline_args ||= ""
|
cmdline_args ||= ""
|
||||||
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension'] + " #{cmdline_args}"
|
executable = $cfg['linker']['bin_files']['destination'] + test_base + $cfg['linker']['bin_files']['extension'] + " #{cmdline_args}"
|
||||||
if simulator.nil?
|
cmd_str = if simulator.nil?
|
||||||
cmd_str = executable
|
executable
|
||||||
else
|
else
|
||||||
cmd_str = "#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
"#{simulator[:command]} #{simulator[:pre_support]} #{executable} #{simulator[:post_support]}"
|
||||||
end
|
end
|
||||||
output = execute(cmd_str, true)
|
output = execute(cmd_str, true)
|
||||||
|
|
||||||
#compare to the expected pass/fail
|
#compare to the expected pass/fail
|
||||||
@@ -1239,7 +1255,7 @@ RUNNER_TESTS.each do |testset|
|
|||||||
end
|
end
|
||||||
|
|
||||||
#test the script against the specified test file and check results
|
#test the script against the specified test file and check results
|
||||||
if (runner_test(testset[:testfile], runner_name, testset[:expected], testset[:testdefines], testset[:cmdline_args]))
|
if (runner_test(testset[:testfile], runner_name, testset[:expected], testset[:testdefines], testset[:cmdline_args], testset[:features]))
|
||||||
report "#{testset_name}:PASS"
|
report "#{testset_name}:PASS"
|
||||||
else
|
else
|
||||||
report "#{testset_name}:FAIL"
|
report "#{testset_name}:FAIL"
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user