Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #2360, Adds utassert message descriptions to README_Functionaltes… #2361

Merged
merged 1 commit into from
Jun 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/README_functionaltest.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,21 @@ It is important that `cfe_assert` is loaded first, as all other test application
symbols provided in this library. The order of loading other test cases should not
matter with respect to symbol resolution, but note that test apps may be executed in
a different order than they are listed in the startup script.

## Utassert messages

Below are various types of messages that can be generated by a test.

"ABORT", /**< Test sequence abort (major failure, cannot continue) */
"FAIL", /**< Test case failure status messages */
"TSF", /**< Test Setup Failure (TSF) status messages */
"TTF", /**< Test Teardown Failure (TTF) status messages */
"MIR", /**< Manual Inspection Required (MIR) status messages */
"WARN", /**< Test was unable to run (WARN) status messages (e.g. initial condition wrong) */
"N/A", /**< Test Not Applicable (NA) status messages */
"BEGIN", /**< Beginning of test status messages */
"END", /**< End of test status messages */
"INFO", /**< All other informational status messages */
"PASS", /**< Test case passed (normal) status messages */
"FLOW", /**< Other condition checks/messages that record test flow, but are not assertions */
"DEBUG", /**< Debugging messages */