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-common.h #1010

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

Unit test status code discrepancies in osapi-common.h #1010

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

  • ONLY IN DOXY: OS_ERROR
  • OK: OS_SUCCESS

File src/os/inc/osapi-common.h, function OS_RegisterEventHandler():

  • ONLY IN DOXY: OS_ERROR
  • 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 21, 2021
jphickey added a commit to jphickey/osal that referenced this issue May 21, 2021
@jphickey
Fix nasa#1010, resolve descrepancies between common API and unit tests
2894f2a 
Ensures correlation between the unit-tests and documented return
values for the OSAL common 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#1010, resolve descrepancies between common API and unit tests
5daff1e 
Ensures correlation between the unit-tests and documented return
values for the OSAL common API.
jphickey added a commit to jphickey/osal that referenced this issue May 26, 2021
@jphickey
Fix nasa#1010, resolve discrepancies between common API and unit tests
c831aeb 
Ensures correlation between the unit-tests and documented return
values for the OSAL common API.
@astrogeco astrogeco mentioned this issue Jun 1, 2021
Merged
astrogeco added a commit that referenced this issue Jun 1, 2021
@astrogeco
Merge pull request #1046 from jphickey/fix-1010-common-api-retcodes
0783a86 
Fix #1010, resolve discrepancies between common API and unit tests
pepepr08 pushed a commit to pepepr08/osal that referenced this issue Jun 9, 2021
@jphickey @pepepr08
Fix nasa#1010, resolve discrepancies between common API and unit tests
a5445ab 
Ensures correlation between the unit-tests and documented return
values for the OSAL common API.
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
@skliper
Fix nasa#1010, CFE_ES_RegisterCDSEx stub update
53d0422
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
@astrogeco
Merge pull request nasa#1011 from skliper/fix1010-cfe_es_registercdse…
d7b5839 
…x-stub

Fix nasa#1010, CFE_ES_RegisterCDSEx stub update
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