Fix #1527, Implement common command-handler return pattern across cFE

[thnkslprpt]

Checklist

• I reviewed the Contributing Guide.
• I signed and emailed the appropriate Contributor License Agreement to [email protected] and copied [email protected].

Describe the contribution

• Fixes Implement single pattern for command handler returns #1527
  • Major changes are to convert ES, TIME and SB to the pattern already used by TBL and EVS - namely, to increment the command counters centrally in the command processing function (in XX_dispatch.c), rather than individually inside each command.
    • this results in a reduction of locations where CommandCounter's are incremented from 41 to 5, and ErrorCounter's from 71 to 11
  • Introduced the CFE_STATUS_COMMAND_FAILURE macro which can be used by command functions to signal a general failure to execute their command. This macro can also be used by other cFS components and apps for command execution failures.

Summary of module-specific changes:
ES

• move incrementing of Command/Error counters from the individual commands into CFE_ES_TaskPipe()
  • there were 4 locations (in CFE_ES_QueryAllCmd() and CFE_ES_QueryAllTasksCmd()) where CFE_SUCCESS was returned during a failure/error event after the ErrorCounter was incremented. These now return CFE_STATUS_COMMAND_FAILURE which improves the clarity of these functions.

TIME

• move incrementing of Command/Error counters from the individual commands into CFE_TIME_TaskPipe()
• CFE_TIME_SetDelayImpl(), CFE_TIME_AdjustImpl() and CFE_TIME_1HzAdjImpl() were changed from void return type to CFE_Status_t in order to carry through the result of their respective add/subtract versions over to CFE_TIME_TaskPipe() and increment the required counters

SB

• move incrementing of Command/Error counters from the individual commands into CFE_SB_ProcessCmdPipePkt()
• removed the CFE_SB_IncrCmdCtr() helper function as it is no longer required with these changes - its functionality has been folded into CFE_SB_ProcessCmdPipePkt()

TBL

• removed CFE_TBL_MESSAGE_ERROR (essentially replaced by CFE_STATUS_COMMAND_FAILURE)
• removed the CFE_TBL_CmdProcRet_t enumeration
  • The constants in this enum were already mapped to CFE macros anyway. The only real change here is that CFE_TBL_INC_ERR_CTR, which was previously mapped to CFE_TBL_MESSAGE_ERROR, has now been replaced by the new CFE_STATUS_COMMAND_FAILURE macro which was introduced in this PR.
    • Note: I haven't added any deprecation for the removal of CFE_TBL_MESSAGE_ERROR or CFE_TBL_CmdProcRet_t - if this is required in this case, just let me know.
• CFE_TBL_NoopCmd() erroneously noted a possible error return in doxygen comments - this has been removed as the function always returns CFE_SUCCESS.

Note: #2264 which converts the remaining int32 return types to CFE_Status_t (along with most of the local status/return variables) is complementary to this PR.

Testing performed
GitHub CI actions all passing successfully.

Local testing with full cFS suite confirms net coverage unchanged.
Prior to changes:

  lines......: 98.1% (13074 of 13326 lines)
  functions..: 97.0% (1041 of 1073 functions)
  branches...: 97.1% (5870 of 6047 branches)

After changes:

  lines......: 98.1% (13056 of 13308 lines)
  functions..: 97.0% (1040 of 1072 functions)
  branches...: 97.1% (5886 of 6063 branches)

Expected behavior changes
Behavior largely unchanged, other than the modifications listed above.

cFE command-handling code is now simpler, more consistent and easier to maintain.

System(s) tested on
Debian GNU/Linux 11 (bullseye)
Current main branch of cFS bundle.

Contributor Info
Avi Weiss @thnkslprpt