Fix #11, Update OS_TimerSet to return OS_ERROR

[avan989]

Describe the contribution
Update OS_TimerSet to return OS_ERROR when both parameters are zero.

Fix #11

Testing performed
Steps taken to test the contribution:

1. Build steps
2. Modify sample app to make OS_TimerSet API call with both parameters as zero
3. Verify return.

Expected behavior changes

• API Change: OS_TimerSet

System(s) tested on:

• Hardware
• OS: Ubuntu 18.04.03
• cFS 6.7, GroundSystem 2.1.0,

Contributor Info
Anh Van, NASA Goddard

Community contributors
You must attach a signed CLA (required for acceptance) or reference one already submitted

[jphickey]

Looks good to me

[skliper]

Likely needs unit test update to cover this logic. Check if one of the test packages exercise this error, and if not add it.

[skliper]

See code below, ensure it covers and checks for the error case:

osal/src/unit-test-coverage/shared/src/coveragetest-time.c

Lines 153 to 181 in d0f1a39

	void Test_OS_TimerSet(void)
	{
	/*
	* Test Case For:
	* int32 OS_TimerSet(uint32 timer_id, uint32 start_time, uint32 interval_time)
	*/
	int32 expected = OS_SUCCESS;
	int32 actual = OS_TimerSet(1, 0, 0);
	UtAssert_True(actual == expected, "OS_TimerSet() (%ld) == OS_SUCCESS", (long)actual);
	OS_timecb_table[2].timebase_ref = 0;
	OS_timecb_table[2].flags = TIMECB_FLAG_DEDICATED_TIMEBASE;
	OS_global_timebase_table[0].active_id = 2;
	actual = OS_TimerSet(2, 0, 0);
	UtAssert_True(actual == expected, "OS_TimerSet() (%ld) == OS_SUCCESS", (long)actual);
	memset(OS_timecb_table, 0, sizeof(OS_timecb_table));
	expected = OS_TIMER_ERR_INVALID_ARGS;
	actual = OS_TimerSet(2, 1 << 31, 1 << 31);
	UtAssert_True(actual == expected, "OS_TimerSet() (%ld) == OS_TIMER_ERR_INVALID_ARGS", (long)actual);
	UT_SetForceFail(UT_KEY(OS_TaskGetId_Impl), 1 | (OS_OBJECT_TYPE_OS_TIMEBASE << OS_OBJECT_TYPE_SHIFT));
	expected = OS_ERR_INCORRECT_OBJ_STATE;
	actual = OS_TimerSet(2, 0, 0);
	UtAssert_True(actual == expected, "OS_TimerSet() (%ld) == OS_ERR_INCORRECT_OBJ_STATE", (long)actual);
	UT_ClearForceFail(UT_KEY(OS_TaskGetId_Impl));
	}

[avan989]

update coverage test, unit test successful.

Had to do some modification to the original unit test, all unit test cases where both start time and interval time = 0 are no longer valid because of the new condition in OS_TimerSet. Changed those conditions to start_time = o and interval_time =1 to make valid:

[BEGIN] 04 OS_TimerSet
[ PASS] 04.001 coveragetest-time.c:161 - OS_TimerSet() (-1) == OS_ERROR
[ PASS] 04.002 coveragetest-time.c:165 - OS_TimerSet() (0) == OS_SUCCESS
[ PASS] 04.003 coveragetest-time.c:171 - OS_TimerSet() (0) == OS_SUCCESS
[ PASS] 04.004 coveragetest-time.c:176 - OS_TimerSet() (-29) == OS_TIMER_ERR_INVALID_ARGS
[ PASS] 04.005 coveragetest-time.c:181 - OS_TimerSet() (-35) == OS_ERR_INCORRECT_OBJ_STATE
[  END] 04 OS_TimerSet          TOTAL::5     PASS::5     FAIL::0      MIR::0      TSF::0      N/A::0