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.

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

Confirm/add system log write verification explicitly documented in requirements #1773

Closed
skliper opened this issue Aug 9, 2021 · 1 comment · Fixed by #1779 or #1808
Closed

Confirm/add system log write verification explicitly documented in requirements #1773

skliper opened this issue Aug 9, 2021 · 1 comment · Fixed by #1779 or #1808
Assignees
Labels
docs This change only affects documentation. requirements unit-test
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Aug 9, 2021

Is your feature request related to a problem? Please describe.
A handful of the error handling requirements include system log writes. Need to confirm verification in the associated test.

ES: Delete Application - Reject Undefined,cES1309.1,"If the specified Application is undefined then the cFE shall record the error in the System Log, and return an error code.",Can't delete an undefined application.
ES: Restart Application- Reject Undefined,cES1310.1,"If the specified Application is undefined then the cFE shall record the error in the System Log, and return an error code.",Can't restart an undefined application.
ES: Restart Application - Reject On Missing File,cES1310.2,"If the original cFE Application file is not found then the cFE shall record the error in the System Log, and return an error code.","Can't restart the Application if the original file has been removed. In this case, the Application will continue without a restart."
ES: Restart Application - Delete On Non-Parameter Error,cES1310.3,"If the cFE Application Restart fails due to a non-parameter error, then the cFE shall record the error in the System Log, and return an error code.","If the Application is already stopped and there is an error restarting it, then the cFE application will be deleted."
ES: Create Child Task - Report Error,cES1311.1,"In the event that the cFE Child Task cannot be created, the cFE shall record the error in the System Log, and return an error code.",Need to keep track of the Child Task Create Failures.
ES: Create Child Task - Invalid From Child Task,cES1311.2,"In the event a child task attempts to create another child task, the cFE shall record the error in the System Log, and return an error code.",Only the cFE Application's main task can create a child task. This prevents confusion with parent/child task relationships and the allocation/deallocation of resources.
ES: Delete Child Task - Error If Application Main Task,cES1312.1,"If the specified task is the cFE Application Main Task, the request shall record the error in the System Log, and return an error code.",Cannot use Child Task Exit or Delete on the cFE Application Main Task.
ES: End Child Task - Error If Application Main Task,cES1314.1,"If the calling task is the cFE Application Main Task, the cFE shall record the error in the System Log, and return an error code.",Cannot use Child Task Exit or Delete on the cFE Application Main Task.
ES: Prepare Memory Pool - Too Small,cES1320.1,"If the specified size is less than the <PLATFORM_DEFINED> minimum block size, the cFE shall record the error in the System Log, and return an error code.","If the size of the Pool is not valid, then an error must be returned."
ES: Allocate Memory - Invalid ID,cES1321.2,"If the specified Memory Pool identifier is invalid then the cFE shall record the error in the System Log, and return an error code.","If the handle or Memory Pool ID is not valid, then an error must be returned."
ES: De-allocate Memory - Invalid ID,cES1322.1,"If the specified Memory Pool identifier is invalid, then the cFE shall record the error in the System Log, and return an error code.",Need to have a valid Memory Pool identifier in order to de-allocate a block of memory.
ES: Processor Reset Set Up Volatile File System - Format On Failure,cES1517.1,"If the volatile file system check fails, the cFE shall format the volatile file system and create a system log entry.","If the volatile file system is corrupt, it must be reformatted to allow the cFE to function."

Describe the solution you'd like
Confirm there's a check for the system log entry, and where required a check of the return code. If the verification is missing from the coverage check, add it. If it's not implemented, reconsider requirement (is the system log write really necessary?)

Describe alternatives you've considered
None. Need to verify requirements, and system log writes are easiest to verify from a stub call check in coverage code.

Additional context
None

Requester Info
Jacob Hageman - NASA/GSFC

@skliper skliper added this to the 7.0.0 milestone Aug 9, 2021
@skliper skliper added docs This change only affects documentation. requirements labels Aug 9, 2021
@skliper
Copy link
Contributor Author

skliper commented Aug 9, 2021

ES: Delete Application - Reject Undefined,cES1309.1 - just returns error code (out of family, see #1775)

The rest write to the sys log and return error code:
ES: Restart Application- Reject Undefined,cES1310.1
ES: Restart Application - Reject On Missing File,cES1310.2
ES: Restart Application - Delete On Non-Parameter Error,cES1310.3 - syslog on error is from CFE_ES_StartApp or CFE_ES_LoadModule
ES: Create Child Task - Report Error,cES1311.1 - syslogs param errors, CFE_ES_StartAppTask syslogs task creation error
ES: Create Child Task - Invalid From Child Task,cES1311.2
ES: Delete Child Task - Error If Application Main Task,cES1312.1
ES: Prepare Memory Pool - Too Small,cES1320.1 - syslog generated by CFE_ES_PoolCreateEx
ES: Allocate Memory - Invalid ID,cES1321.2
ES: De-allocate Memory - Invalid ID,cES1322.1
ES: Processor Reset Set Up Volatile File System - Format On Failure,cES1517.1 - syslog generated by CFE_ES_InitializeFileSystems

Just writes to syslog (void function):
ES: End Child Task - Error If Application Main Task,cES1314.1 (#1771)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation. requirements unit-test
Projects
None yet
1 participant