readme.md
1# Unity Fixtures
2
3This Framework is an optional add-on to Unity. By including unity_framework.h in place of unity.h,
4you may now work with Unity in a manner similar to CppUTest. This framework adds the concepts of
5test groups and gives finer control of your tests over the command line.
6
7This framework is primarily supplied for those working through James Grenning's book on Embedded
8Test Driven Development, or those coming to Unity from CppUTest. We should note that using this
9framework glosses over some of the features of Unity, and makes it more difficult
10to integrate with other testing tools like Ceedling and CMock.
11
12# Dependency Notification
13
14Fixtures, by default, uses the Memory addon as well. This is to make it simple for those trying to
15follow along with James' book. Using them together is completely optional. You may choose to use
16Fixtures without Memory handling by defining `UNITY_FIXTURE_NO_EXTRAS`. It will then stop automatically
17pulling in extras and leave you to do it as desired.
18
19# Usage information
20
21By default the test executables produced by Unity Fixtures run all tests once, but the behavior can
22be configured with command-line flags. Run the test executable with the `--help` flag for more
23information.
24
25It's possible to add a custom line at the end of the help message, typically to point to
26project-specific or company-specific unit test documentation. Define `UNITY_CUSTOM_HELP_MSG` to
27provide a custom message, e.g.:
28
29 #define UNITY_CUSTOM_HELP_MSG "If any test fails see https://example.com/troubleshooting"
30