-
Notifications
You must be signed in to change notification settings - Fork 217
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
Partial #331, scrub return values #980
Partial #331, scrub return values #980
Conversation
Confirm consistency between the return values generated by each OSAL API and the doxygen documentation. Each explicitly-returned status code should have a corresponding "retval" entry in the documentation. Also confirms that each explicitly-returned status code has a matching case in the coverage tests that specifically checks for that return value. Some were actually missing, where as some were just being reported incorrectly. Finally this also corrects one argument name mismatch in QueueCreate where it was prototyped as "data_size" but implemented as "max_size".
Note this currently just focuses on the coverage test aspect - i.e. that every return value directly generated by an API is both documented and tested for in the coverage test. |
CCB:2021-05-05 APPROVED
|
Needs a follow-on to add all of our standard input checking (even for pass through return codes) along with the black box tests. Probably would benefit from documenting the list - NULL pointer checks (if enabled), filename/path validity checks, etc. |
Should we open a new issue for these? Also, did we open the issue in cFE to do the same scrub?
|
#331 is still open to complete the follow-on in OSAL. Note the tests are still being added in cFE, and have associated open issues. We just need to confirm they check the necessary return codes (follow the same patter as OSAL). |
nasa/cFE#1489, removes --quiet option so files checked go to stdout nasa/osal#997, Enable cppcheck results output nasa/osal#980, Scrub return values
nasa/cFE#1492, cFE v6.8.0-rc1+dev575 nasa/osal#996, osal v5.1.0-rc1+dev434 nasa/cFE#1487, Remove broken travis-ci script nasa/cFE#1463, generated coverage stubs for CFE core nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API nasa/cFE#1451, OSAL config file simplification nasa/cFE#1489, removes --quiet option so files checked go to stdout nasa/osal#978, configuration guide updates nasa/osal#974, improve documentation of UtAssert API calls nasa/osal#977, update OS_TaskCreate doc nasa/osal#997, Enable cppcheck results output nasa/osal#980, Scrub return values nasa/osal#992, add local mutex to BSP console nasa/osal#993, do not require nonblock mode
nasa/cFE#1492, cFE v6.8.0-rc1+dev575 nasa/osal#996, osal v5.1.0-rc1+dev434 nasa/cFE#1487, Remove broken travis-ci script nasa/cFE#1463, generated coverage stubs for CFE core nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API nasa/cFE#1451, OSAL config file simplification nasa/cFE#1489, removes --quiet option so files checked go to stdout nasa/osal#978, configuration guide updates nasa/osal#974, improve documentation of UtAssert API calls nasa/osal#977, update OS_TaskCreate doc nasa/osal#997, Enable cppcheck results output nasa/osal#980, Scrub return values nasa/osal#992, add local mutex to BSP console nasa/osal#993, do not require nonblock mode Co-authored-by: Jacob Hageman <[email protected]> Co-authored-by: Joseph Hickey <[email protected]>
Fix nasa#973, CFE_MSG_Init clear option removed
Describe the contribution
Confirm consistency between the return values generated by each OSAL API and the doxygen documentation. Each explicitly-returned status code should have a corresponding "retval" entry in the documentation.
Also confirms that each explicitly-returned status code has a matching case in the coverage tests that specifically checks for
that return value. Some were actually missing, where as some were just being reported incorrectly.
Finally this also corrects one argument name mismatch in QueueCreate where it was prototyped as "data_size" but implemented as "max_size".
Related to #331 (but more work to do, so should not close yet)
Testing performed
Build and sanity check CFE, run all unit tests, build osalguide documentation and confirmed no warnings
Expected behavior changes
None, test and documentation updates only.
System(s) tested on
Ubuntu 20.04
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.