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-queue.h #1018

Closed
29 tasks done
jphickey opened this issue May 12, 2021 · 0 comments · Fixed by #1038 or #1058
Closed
29 tasks done

Unit test status code discrepancies in osapi-queue.h #1018

jphickey opened this issue May 12, 2021 · 0 comments · Fixed by #1038 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-queue.h, function OS_QueueCreate():

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

File src/os/inc/osapi-queue.h, function OS_QueueDelete():

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

File src/os/inc/osapi-queue.h, function OS_QueueGet():

  • OK: OS_ERR_INVALID_ID
  • OK: OS_INVALID_POINTER
  • OK: OS_QUEUE_EMPTY
  • OK: OS_QUEUE_INVALID_SIZE
  • OK: OS_QUEUE_TIMEOUT
  • OK: OS_SUCCESS

File src/os/inc/osapi-queue.h, function OS_QueuePut():

  • ONLY IN DOXY: OS_ERROR
  • OK: OS_ERR_INVALID_ID
  • OK: OS_INVALID_POINTER
  • OK: OS_QUEUE_FULL
  • OK: OS_SUCCESS

File src/os/inc/osapi-queue.h, function OS_QueueGetIdByName():

  • OK: OS_ERR_NAME_NOT_FOUND
  • OK: OS_ERR_NAME_TOO_LONG
  • OK: OS_INVALID_POINTER
  • OK: OS_SUCCESS

File src/os/inc/osapi-queue.h, function OS_QueueGetInfo():

  • 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 20, 2021
jphickey added a commit to jphickey/osal that referenced this issue May 20, 2021
@jphickey
Fix nasa#1018, resolve descrepancies between queue API and unit tests
643a5a6 
Ensures correlation between the unit-tests and documented return
values for the OSAL queue API.
@jphickey jphickey mentioned this issue May 20, 2021
Merged
jphickey added a commit to jphickey/osal that referenced this issue May 20, 2021
@jphickey
Fix nasa#1018, resolve descrepancies between queue API and unit tests
a58c47a 
Ensures correlation between the unit-tests and documented return
values for the OSAL queue API.
jphickey added a commit to jphickey/osal that referenced this issue May 21, 2021
@jphickey
Fix nasa#1018, resolve descrepancies between queue API and unit tests
acdb16f 
Ensures correlation between the unit-tests and documented return
values for the OSAL queue API.
jphickey added a commit to jphickey/osal that referenced this issue May 26, 2021
@jphickey
Fix nasa#1018, resolve discrepancies between queue API and unit tests
fce66b5 
Ensures correlation between the unit-tests and documented return
values for the OSAL queue API.
astrogeco added a commit that referenced this issue Jun 1, 2021
@astrogeco
Merge pull request #1038 from jphickey/fix-1018-queue-api-retcodes
b339de0 
Fix #1018, resolve discrepancies between queue API and unit tests
@astrogeco astrogeco mentioned this issue Jun 1, 2021
Merged
pepepr08 pushed a commit to pepepr08/osal that referenced this issue Jun 9, 2021
@jphickey @pepepr08
Fix nasa#1018, resolve discrepancies between queue API and unit tests
3c0c36a 
Ensures correlation between the unit-tests and documented return
values for the OSAL queue API.
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