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-idmap.h #1015

Closed
6 tasks
jphickey opened this issue May 12, 2021 · 0 comments · Fixed by #1055 or #1076
Closed
6 tasks

Unit test status code discrepancies in osapi-idmap.h #1015

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

Comments

@jphickey
Copy link
Contributor

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-idmap.h, function OS_GetResourceName():
NO CURRENT TESTS - Test cases and retvals likely need to be added

File src/os/inc/osapi-idmap.h, function OS_ConvertToArrayIndex():

  • ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_TYPE
  • ONLY IN DOXY: OS_SUCCESS

File src/os/inc/osapi-idmap.h, function OS_ObjectIdToArrayIndex():

  • ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_TYPE
  • ONLY IN DOXY: OS_ERR_INVALID_ID
  • ONLY IN DOXY: OS_INVALID_POINTER
  • ONLY IN DOXY: 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 25, 2021
jphickey added a commit to jphickey/osal that referenced this issue May 27, 2021
@jphickey
Fix nasa#1015, resolve discrepancies between idmap API and unit tests
bf8426e 
Ensures correlation between the test cases and documented return
values for the OSAL idmap API.
@jphickey jphickey mentioned this issue May 27, 2021
Merged
jphickey added a commit to jphickey/osal that referenced this issue May 27, 2021
@jphickey
Fix nasa#1015, resolve discrepancies between idmap API and unit tests
1ca64fc 
Ensures correlation between the test cases and documented return
values for the OSAL idmap API.
jphickey added a commit to jphickey/osal that referenced this issue May 27, 2021
@jphickey
Fix nasa#1015, resolve discrepancies between idmap API and unit tests
8d4bf62 
Ensures correlation between the test cases and documented return
values for the OSAL idmap API.
astrogeco added a commit that referenced this issue Jun 10, 2021
@astrogeco
Merge pull request #1055 from jphickey/fix-1015-idmap-api-retcodes
0d6fd14 
Fix #1015, resolve discrepancies between idmap API and unit tests
@astrogeco astrogeco mentioned this issue Jun 15, 2021
Merged
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
@astrogeco
Merge pull request nasa#1015 from skliper/fix1009-alignment-pattern
d1ea3c4 
Fix# 1009, Apply consistent alignment pattern
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