diff --git a/docs/README_functionaltest.md b/docs/README_functionaltest.md index dddb45484..29e4b7cc6 100644 --- a/docs/README_functionaltest.md +++ b/docs/README_functionaltest.md @@ -36,3 +36,23 @@ 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. + + UTASSERT_CASETYPE_NONE, /**< Reserved value, No messages should be used with this */ + UTASSERT_CASETYPE_ABORT, /**< Test sequence abort (major failure, cannot continue) */ + UTASSERT_CASETYPE_FAILURE, /**< Test case failure status messages */ + UTASSERT_CASETYPE_TSF, /**< Test Setup Failure (TSF) status messages */ + UTASSERT_CASETYPE_TTF, /**< Test Teardown Failure (TTF) status messages */ + UTASSERT_CASETYPE_MIR, /**< Manual Inspection Required (MIR) status messages */ + UTASSERT_CASETYPE_WARN, /**< Test was unable to run (WARN) status messages (e.g. initial condition wrong) */ + UTASSERT_CASETYPE_NA, /**< Test Not Applicable (NA) status messages */ + UTASSERT_CASETYPE_BEGIN, /**< Beginning of test status messages */ + UTASSERT_CASETYPE_END, /**< End of test status messages */ + UTASSERT_CASETYPE_INFO, /**< All other informational status messages */ + UTASSERT_CASETYPE_PASS, /**< Test case passed (normal) status messages */ + UTASSERT_CASETYPE_FLOW, /**< Other condition checks/messages that record test flow, but are not assertions */ + UTASSERT_CASETYPE_DEBUG, /**< Debugging messages */ + UTASSERT_CASETYPE_MAX /**< Reserved value, No messages should be used with this */ \ No newline at end of file