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 other public headers #1024

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

Unit test status code discrepancies in other public headers #1024

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

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-network.h, function OS_NetworkGetHostName():

  • OK: OS_ERR_INVALID_SIZE
  • OK: OS_INVALID_POINTER
  • ONLY IN TEST: OS_SUCCESS

File src/os/inc/osapi-shell.h, function OS_ShellOutputToFile():

  • ONLY IN DOXY: OS_ERROR
  • OK: OS_ERR_INVALID_ID
  • OK: 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 12, 2021
jphickey added a commit to jphickey/osal that referenced this issue May 19, 2021
@jphickey
Fix nasa#1024, check misc API return codes
327b181 
Fix missing doxygen retvals

Note, other tests were OK, but depend on support being enabled and
supported by RTOS.  Script will report N/A items (due to no impl) as
missing.  Confirmed OS_HeapGetInfo OK on RTEMS.
@jphickey jphickey mentioned this issue May 19, 2021
Merged
jphickey added a commit to jphickey/osal that referenced this issue May 19, 2021
@jphickey
Fix nasa#1024, check misc API return codes
8989f7b 
Fix missing doxygen retvals

Note, other tests were OK, but depend on support being enabled and
supported by RTOS.  Script will report N/A items (due to no impl) as
missing.  Confirmed OS_HeapGetInfo OK on RTEMS.
jphickey added a commit to jphickey/osal that referenced this issue May 21, 2021
@jphickey
Fix nasa#1024, check misc API return codes
e3bd1ad 
Fix missing doxygen retvals

Note, other tests were OK, but depend on support being enabled and
supported by RTOS.  Script will report N/A items (due to no impl) as
missing.  Confirmed OS_HeapGetInfo OK on RTEMS.

For test cases where a function is invoked before OS_API_Init, only
check that the result is not success.  This will remain as "undocumented"
behavior - users should not call functions before init, because it is
not valid to do so.  A specific error code is not guaranteed here.
jphickey added a commit to jphickey/osal that referenced this issue May 21, 2021
@jphickey
Fix nasa#1024, check misc API return codes
e54acfc 
Fix missing doxygen retvals

Note, other tests were OK, but depend on support being enabled and
supported by RTOS.  Script will report N/A items (due to no impl) as
missing.  Confirmed OS_HeapGetInfo OK on RTEMS.

For test cases where a function is invoked before OS_API_Init, only
check that the result is not success.  This will remain as "undocumented"
behavior - users should not call functions before init, because it is
not valid to do so.  A specific error code is not guaranteed here.
astrogeco added a commit that referenced this issue Jun 2, 2021
@astrogeco
Merge pull request #1030 from jphickey/fix-1024-api-test-retcodes
36a2923 
Fix #1024, check misc API return codes
@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#1024, check misc API return codes
a8c5e8b 
Fix missing doxygen retvals

Note, other tests were OK, but depend on support being enabled and
supported by RTOS.  Script will report N/A items (due to no impl) as
missing.  Confirmed OS_HeapGetInfo OK on RTEMS.

For test cases where a function is invoked before OS_API_Init, only
check that the result is not success.  This will remain as "undocumented"
behavior - users should not call functions before init, because it is
not valid to do so.  A specific error code is not guaranteed here.
@skliper skliper mentioned this issue Jun 29, 2021
Closed
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
@astrogeco
Merge pull request nasa#1024 from jphickey/fix-1023-stub-appid
0edf8c2 
Fix nasa#1023, correct stub appid parameter
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