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-task.h #1021

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

Unit test status code discrepancies in osapi-task.h #1021

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

  • ONLY IN DOXY: OS_ERROR
  • ONLY IN DOXY: OS_ERR_INVALID_PRIORITY
  • 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
  • OK: OS_SUCCESS

File src/os/inc/osapi-task.h, function OS_TaskDelete():

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

File src/os/inc/osapi-task.h, function OS_TaskInstallDeleteHandler():

  • ONLY IN TEST: OS_ERR_INVALID_ID

File src/os/inc/osapi-task.h, function OS_TaskDelay():

  • ONLY IN DOXY: OS_ERROR
  • OK: OS_SUCCESS

File src/os/inc/osapi-task.h, function OS_TaskSetPriority():

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

File src/os/inc/osapi-task.h, function OS_TaskGetIdByName():

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

File src/os/inc/osapi-task.h, function OS_TaskGetInfo():

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

File src/os/inc/osapi-task.h, function OS_TaskFindIdBySystemData():

  • 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 18, 2021
jphickey added a commit to jphickey/osal that referenced this issue May 20, 2021
@jphickey
Fix nasa#1021, resolve descrepancies between task API and unit tests
b1ed5b0 
Ensures correlation between the unit-tests and documented return
values for the OSAL task 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#1021, resolve descrepancies between task API and unit tests
965a1fd 
Ensures correlation between the unit-tests and documented return
values for the OSAL task API.
jphickey added a commit to jphickey/osal that referenced this issue May 21, 2021
@jphickey
Fix nasa#1021, resolve descrepancies between task API and unit tests
11fe719 
Ensures correlation between the unit-tests and documented return
values for the OSAL task API.
jphickey added a commit to jphickey/osal that referenced this issue May 26, 2021
@jphickey
Fix nasa#1021, add additional test cases
1870d32 
Call OS_TaskCreate with a NULL stack pointer
Confirm OS_TaskDeleteHandler function was invoked
Confirm OS_TaskDelay interval
jphickey added a commit to jphickey/osal that referenced this issue May 26, 2021
@jphickey
Fix nasa#1021, add additional test cases
2d7d575 
Call OS_TaskCreate with a NULL stack pointer
Confirm OS_TaskDeleteHandler function was invoked
Confirm OS_TaskDelay interval
jphickey added a commit to jphickey/osal that referenced this issue May 26, 2021
@jphickey
Fix nasa#1021, resolve discrepancies between task API and unit tests
a987a20 
Ensures correlation between the unit-tests and documented return
values for the OSAL task API.

Also adds the following test cases:
- Call OS_TaskCreate with a NULL stack pointer
- Confirm OS_TaskDeleteHandler function was invoked
- Confirm OS_TaskDelay interval
astrogeco added a commit that referenced this issue Jun 2, 2021
@astrogeco
Merge pull request #1037 from jphickey/fix-1021-task-api-retcodes
f3c3692 
Fix #1021, resolve discrepancies between task API and unit tests
@astrogeco astrogeco mentioned this issue Jun 2, 2021
Merged
pepepr08 pushed a commit to pepepr08/osal that referenced this issue Jun 9, 2021
@jphickey @pepepr08
Fix nasa#1021, resolve discrepancies between task API and unit tests
081f543 
Ensures correlation between the unit-tests and documented return
values for the OSAL task API.

Also adds the following test cases:
- Call OS_TaskCreate with a NULL stack pointer
- Confirm OS_TaskDeleteHandler function was invoked
- Confirm OS_TaskDelay interval
jphickey added a commit to jphickey/osal that referenced this issue Aug 10, 2022
@jphickey
Fix nasa#1021, use void* for pool buffer pointers
1f8f082 
Using void* instead of uint32* here makes the interface
easier to use and may avoid some nuisance alignment warnings.
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
@astrogeco
Merge pull request nasa#1025 from jphickey/fix-1021-poolbuf-ptr
2f92178 
Fix nasa#1021, pool buffer type
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