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.

Sign up for GitHub

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

Jump to bottom

Unit test status code discrepancies in osapi-module.h #1016

Closed
21 of 23 tasks
jphickey opened this issue May 12, 2021 · 0 comments · Fixed by #1043 or #1058
Closed
21 of 23 tasks

Unit test status code discrepancies in osapi-module.h #1016

jphickey opened this issue May 12, 2021 · 0 comments · Fixed by #1043 or #1058
Assignees
@jphickey
Labels
unit-test Tickets related to the OSAL unit testing (functional and/or coverage)
Milestone
Caelum

Comments

@jphickey
Copy link
Contributor

jphickey commented May 12, 2021 •
edited
Loading

Is your feature request related to a problem? Please describe.
The unit tests and API documentation should match, where all status codes in the API documentation are tested in a unit test, and likewise all codes being tested for are documented in the API.

Describe the solution you'd like
Resolve the following mismatches:

File src/os/inc/osapi-module.h, function OS_SymbolLookup():

  • OK: OS_ERROR
  • OK: OS_INVALID_POINTER
  • OK: OS_SUCCESS

File src/os/inc/osapi-module.h, function OS_ModuleSymbolLookup():

  • OK: OS_ERROR
  • OK: OS_INVALID_POINTER
  • OK: OS_SUCCESS

File src/os/inc/osapi-module.h, function OS_SymbolTableDump():

  • ONLY IN DOXY: OS_ERROR
  • ONLY IN DOXY: OS_ERR_NOT_IMPLEMENTED
  • ONLY IN TEST: OS_FS_ERR_PATH_INVALID
  • OK: OS_INVALID_POINTER
  • ONLY IN DOXY: OS_SUCCESS

File src/os/inc/osapi-module.h, function OS_ModuleLoad():

  • ONLY IN DOXY: OS_ERROR
  • OK: OS_ERR_NAME_TAKEN
  • ONLY IN DOXY: OS_ERR_NAME_TOO_LONG
  • OK: OS_ERR_NO_FREE_IDS
  • OK: OS_INVALID_POINTER
  • OK: OS_SUCCESS

File src/os/inc/osapi-module.h, function OS_ModuleUnload():

  • ONLY IN DOXY: OS_ERROR
  • ONLY IN TEST: OS_ERR_INVALID_ID
  • OK: OS_SUCCESS

File src/os/inc/osapi-module.h, function OS_ModuleInfo():

  • OK: OS_ERR_INVALID_ID
  • OK: OS_INVALID_POINTER
  • OK: OS_SUCCESS

Additional context
Originally noted in #331, split into separate work items.

Requester Info
Joseph Hickey, Vantage Systems, Inc.
@skliper skliper added the unit-test Tickets related to the OSAL unit testing (functional and/or coverage) label May 12, 2021
@skliper skliper added this to the 6.0.0 milestone May 12, 2021
@jphickey jphickey self-assigned this May 21, 2021
jphickey added a commit to jphickey/osal that referenced this issue May 21, 2021
@jphickey
Fix nasa#1016, resolve descrepancies between module API and unit tests
d9070fb 
Ensures correlation between the unit-tests and documented return
values for the OSAL module API.
@jphickey jphickey mentioned this issue May 21, 2021
Merged
jphickey added a commit to jphickey/osal that referenced this issue May 25, 2021
@jphickey
Fix nasa#1016, additional codes from symbol table dump
f384359 
Adds documentation for OS_ERR_OUTPUT_TOO_LARGE and
OS_ERR_NAME_TOO_LONG.  These are primarily validated
via coverage test, as symbol table dump is only
possible on VxWorks.
jphickey added a commit to jphickey/osal that referenced this issue May 25, 2021
@jphickey
Fix nasa#1016, move pointer check on OS_ModuleInfo test
ebc789a 
Move the test for OS_INVALiD_POINTER to after setup,
where the module ID is valid.
jphickey added a commit to jphickey/osal that referenced this issue May 26, 2021
@jphickey
Fix nasa#1016, resolve discrepancies between module API and unit tests
b420e8d 
Ensures correlation between the unit-tests and documented return
values for the OSAL module API.

Adds documentation for OS_ERR_OUTPUT_TOO_LARGE and
OS_ERR_NAME_TOO_LONG.  These are primarily validated
via coverage test, as symbol table dump is only
possible on VxWorks.

Move the test for OS_INVALID_POINTER to after setup,
where the module ID is valid.
@astrogeco astrogeco mentioned this issue Jun 1, 2021
Merged
astrogeco added a commit that referenced this issue Jun 1, 2021
@astrogeco
Merge pull request #1043 from jphickey/fix-1016-module-api-retcodes
976d1fa 
Fix #1016, resolve discrepancies between module API and unit tests
pepepr08 pushed a commit to pepepr08/osal that referenced this issue Jun 9, 2021
@jphickey @pepepr08
Fix nasa#1016, resolve discrepancies between module API and unit tests
29f38d7 
Ensures correlation between the unit-tests and documented return
values for the OSAL module API.

Adds documentation for OS_ERR_OUTPUT_TOO_LARGE and
OS_ERR_NAME_TOO_LONG.  These are primarily validated
via coverage test, as symbol table dump is only
possible on VxWorks.

Move the test for OS_INVALID_POINTER to after setup,
where the module ID is valid.
jphickey added a commit to jphickey/osal that referenced this issue Aug 10, 2022
@jphickey
Fix nasa#1016, bogus warning in strncpy
5eba09e 
Add an extra write of a null char which squelches a warning.
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
@astrogeco
Merge pull request nasa#1018 from jphickey/fix-1016-fix-warning
113abb9 
Fix nasa#1016, bogus warning in strncpy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jphickey jphickey

Labels
unit-test Tickets related to the OSAL unit testing (functional and/or coverage)
Projects
None yet
Milestone
Caelum
2 participants
@jphickey @skliper