Skip to content

Unit test status code discrepancies in osapi-idmap.h #1015

@jphickey

Description

@jphickey

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-idmap.h, function OS_GetResourceName():
NO CURRENT TESTS - Test cases and retvals likely need to be added

File src/os/inc/osapi-idmap.h, function OS_ConvertToArrayIndex():

  • ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_TYPE
  • ONLY IN DOXY: OS_SUCCESS

File src/os/inc/osapi-idmap.h, function OS_ObjectIdToArrayIndex():

  • ONLY IN DOXY: OS_ERR_INCORRECT_OBJ_TYPE
  • 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.

Metadata

Metadata

Assignees

Labels

unit-testTickets related to the OSAL unit testing (functional and/or coverage)

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions