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-sockets.h #1020

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

Unit test status code discrepancies in osapi-sockets.h #1020

jphickey opened this issue May 12, 2021 · 0 comments · Fixed by #1060 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

NOTE: This API does not have a "unit-tests" program to test these status codes - Hence why they are all flagged as being only in doxygen. The "network-api-test" program does exercise many of them, but isn't included in this test run.

Resolve the following mismatches:

File src/os/inc/osapi-sockets.h, function OS_SocketAddrInit():

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketAddrToString():

  • ONLY IN DOXY: OS_ERR_INVALID_SIZE
  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketAddrFromString():

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketAddrGetPort():

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketAddrSetPort():

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketOpen():

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketBind():

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketConnect():

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketShutdown():

File src/os/inc/osapi-sockets.h, function OS_SocketAccept():

  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketRecvFrom():

  • ONLY IN DOXY: OS_ERR_INVALID_SIZE
  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketSendTo():

  • ONLY IN DOXY: OS_ERR_INVALID_SIZE
  • ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-sockets.h, function OS_SocketGetIdByName():

  • ONLY IN DOXY: OS_ERR_NAME_NOT_FOUND
  • ONLY IN DOXY: OS_ERR_NAME_TOO_LONG
  • ONLY IN DOXY: OS_INVALID_POINTER
  • ONLY IN DOXY: OS_SUCCESS

File src/os/inc/osapi-sockets.h, function OS_SocketGetInfo():

  • 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 mentioned this issue May 27, 2021
Merged
@jphickey jphickey self-assigned this May 27, 2021
jphickey added a commit to jphickey/osal that referenced this issue May 28, 2021
@jphickey
Fix nasa#1020, resolve discrepancies between socket API and unit tests
5fe26e1 
Ensures correlation between the test cases and documented return
values for the OSAL socket API.
@jphickey jphickey mentioned this issue May 28, 2021
Merged
jphickey added a commit to jphickey/osal that referenced this issue May 28, 2021
@jphickey
Fix nasa#1020, resolve discrepancies between socket API and unit tests
331f286 
Ensures correlation between the test cases and documented return
values for the OSAL socket API.
astrogeco added a commit that referenced this issue Jun 10, 2021
@astrogeco
Merge pull request #1060 from jphickey/fix-1020-socket-api-retcodes
fbda2b0 
Fix #1020, resolve discrepancies between socket API and unit tests
@astrogeco astrogeco mentioned this issue Jun 15, 2021
Merged
jphickey added a commit to jphickey/osal that referenced this issue Aug 10, 2022
@jphickey
Fix nasa#1020, refactor SB buffer descriptor
cc1d984 
Combine the "zero copy" and the normal CFE buffer descriptor into a single
unified CFE_SB_BufferD_t object.  This cleans up a bunch of extra logic
related to zero-copy buffers, including the extra descriptor object.  The
result is a simpler zero-copy design that is much less different from the
standard (non-zero-copy) message path.

All message descriptor objects are now tracked in a list by SB, not just
the zero-copy descriptors (for consistency - if any buffers need to be
tracked, they should all be tracked).
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
@astrogeco
Merge pull request nasa#1154 from jphickey/fix-1020-sb-buffers
c808e91 
Fix nasa#1020, refactor SB buffer descriptor object
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