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

Fix #380, Add OS_TimeBase Api Functional Tests #481

Merged
merged 2 commits into from
Jun 8, 2020
Merged

Fix #380, Add OS_TimeBase Api Functional Tests #481

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4731755
Fix #380, Add OS_TimeBase Api Functional Tests
yammajamma May 21, 2020
f3f8b8a
fix #380, Updated test to implement changes requested
yammajamma Jun 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
284 changes: 284 additions & 0 deletions src/tests/time-base-api-test/time-base-api-test.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
/*
* Copyright (c) 2020, United States government as represented by the
* administrator of the National Aeronautics Space Administration.
* All rights reserved. This software was created at NASA Goddard
* Space Flight Center pursuant to government contracts.
*
* This is governed by the NASA Open Source Agreement and may be used,
* distributed and modified only according to the terms of that agreement.
*/

/*
* Filename: time-base-api-test.c
*
* Purpose: This file contains functional tests for "osapi-timebase"
*
*/

#include <stdio.h>
#include <string.h>
#include <stdlib.h>

#include "common_types.h"
#include "osapi.h"
#include "utassert.h"
#include "uttest.h"
#include "utbsp.h"

static uint32 UT_TimerSync(uint32 timer_id)
{
OS_TaskDelay(1);
return 1;
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note this sync function is going to immediately return 0, which causes a "spin loop" in the timebase. There is some protection against this but its really not something you should do, its just to protect against locking the CPU.


/* *************************************** MAIN ************************************** */

void TestTimeBaseApi(void)
{
int32 expected;
int32 actual;
int32 TimeBaseNum;
int32 tbc_results[OS_MAX_TIMEBASES];
uint32 freerun;
uint32 objid;
uint32 time_base_id;
uint32 time_base_id2;
uint32 tb_id[OS_MAX_TIMEBASES];
char overMaxTimeBase[12];
char TimeBaseIter[OS_MAX_TIMEBASES][12];
OS_timebase_prop_t timebase_prop;

/*
* Test Case For:
* int32 OS_TimeBaseCreate(uint32 *timer_id, const char *timebase_name, OS_TimerSync_t external_sync)
*/

/* Test for nominal inputs */
expected = OS_SUCCESS;

actual= OS_TimeBaseCreate(&time_base_id, "TimeBaseA", 0);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_SUCCESS", (long)actual);

actual = OS_TimeBaseCreate(&time_base_id2, "TimeBaseB", NULL);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_SUCCESS", (long)actual);

actual = OS_TimeBaseCreate(&time_base_id, "TimeBaseC", UT_TimerSync);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_SUCCESS", (long)actual);

/* Test for nominal, max/min cases */
objid = 0xFFFFFFFF;
actual = OS_TimeBaseCreate(&objid, "TimeBaseD", 0);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_SUCCESS", (long)actual);


/* Checking for OS_MAX_TIMEBASES */
for ( int i = 0; i < OS_MAX_TIMEBASES; i++ )
{
snprintf(TimeBaseIter[i], 12, "TimeBase%d", i);
tbc_results[i] = OS_TimeBaseCreate(&tb_id[i], TimeBaseIter[i], 0);
UtAssert_True(tbc_results[i] == expected, "OS_TimeBaseCreate() (%ld) == OS_SUCCESS", (long)actual);

OS_TimeBaseDelete(tb_id[i]);
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The OS_MAX_TIMEBASES is a configurable parameter. Could we turn this into a loop based on OS_MAX_TIMEBASES so that this test case still works if the user changes this value?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read in the OS_MAX_TIMEBASES, so shouldn't it automatically always read in the max value if the user reconfigured it it before this point?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea is to confirm that one can create entities all the way up to OS_MAX_TIMEBASES (i.e. all OS_SUCCESS), then attempt to create one more which should return an error. The point at which this happens is user configurable so this would have to be converted into a loop. This is currently hardcoding 5 timebase objects, so it will fail with OS_MAX_TIMEBASES set to anything other than 5.


/* Test for invalid inputs */
expected = OS_INVALID_POINTER;
actual = OS_TimeBaseCreate(NULL, NULL, NULL);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_INVALID_POINTER", (long)actual);

expected = OS_INVALID_POINTER;
actual = OS_TimeBaseCreate(NULL, "TimeBase6", 0);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_INVALID_POINTER", (long)actual);

expected = OS_INVALID_POINTER;
actual = OS_TimeBaseCreate(&time_base_id, NULL, 0);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_INVALID_POINTER", (long)actual);

expected = OS_ERR_NAME_TAKEN;
actual= OS_TimeBaseCreate(&time_base_id, "TimeBaseA", 0);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_ERR_NAME_TAKEN", (long)actual);

/* Checking OS_MAX_TIMEBASES + 1 */
for ( int i = 0; i < OS_MAX_TIMEBASES; i++ )
{
snprintf(TimeBaseIter[i], 12, "TimeBase%d", i);
tbc_results[i] = OS_TimeBaseCreate(&tb_id[i], TimeBaseIter[i], 0);
}
TimeBaseNum = OS_MAX_TIMEBASES+1;
snprintf(overMaxTimeBase, 12, "TimeBase%d", TimeBaseNum);
expected = OS_ERR_NO_FREE_IDS;
actual= OS_TimeBaseCreate(&time_base_id, "overMaxTimeBase", 0);
UtAssert_True(actual == expected, "OS_TimeBaseCreate() (%ld) == OS_ERR_NO_FREE_IDS", (long)actual);



/*
* Test Case For:
* int32 OS_TimeBaseSet(uint32 timer_id, uint32 start_time, uint32 interval_time)
*/

/* Test for nominal inputs */
expected = OS_SUCCESS;
actual = OS_TimeBaseSet(time_base_id, 1000, 1000);
UtAssert_True(actual == expected, "OS_TimeBaseSet() (%ld) == OS_SUCCESS", (long)actual);

expected = OS_SUCCESS;
actual = OS_TimeBaseSet(time_base_id, 0, 0);
UtAssert_True(actual == expected, "OS_TimeBaseSet() (%ld) == OS_SUCCESS", (long)actual);

/* Test for invalid inputs */
/* overflow on input */
expected = OS_TIMER_ERR_INVALID_ARGS;
actual = OS_TimeBaseSet(time_base_id, UINT32_MAX, UINT32_MAX);
UtAssert_True(actual == expected, "OS_TimeBaseSet() (%ld) == OS_TIMER_ERR_INVALID_ARGS", (long)actual);

expected = OS_TIMER_ERR_INVALID_ARGS;
actual = OS_TimeBaseSet(time_base_id, -1000, -1000);
UtAssert_True(actual == expected, "OS_TimeBaseSet() (%ld) == OS_TIMER_ERR_INVALID_ARGS", (long)actual);

expected = OS_TIMER_ERR_INVALID_ARGS;
actual = OS_TimeBaseSet(time_base_id, 1000, -1000);
UtAssert_True(actual == expected, "OS_TimeBaseSet() (%ld) == OS_TIMER_ERR_INVALID_ARGS", (long)actual);

expected = OS_TIMER_ERR_INVALID_ARGS;
actual = OS_TimeBaseSet(time_base_id, -1000, 1000);
UtAssert_True(actual == expected, "OS_TimeBaseSet() (%ld) == OS_TIMER_ERR_INVALID_ARGS", (long)actual);

expected = OS_ERR_INVALID_ID;
actual = OS_TimeBaseSet(0, 1000, 1000);
UtAssert_True(actual == expected, "OS_TimeBaseSet() (%ld) == OS_ERR_INVALID_ID", (long)actual);


/*
* Test Case For:
* int32 OS_TimeBaseDelete(uint32 timer_id)
*/

/* Test for nominal inputs */
expected = OS_SUCCESS;
actual = OS_TimeBaseDelete(time_base_id);
UtAssert_True(actual == expected, "OS_TimeBaseDelete() (%ld) == OS_SUCCESS", (long)actual);

/* Test for invalid inputs */
expected = OS_ERR_INVALID_ID;
actual = OS_TimeBaseDelete(0x0000000);
UtAssert_True(actual == expected, "OS_TimeBaseDelete() (%ld) == OS_ERR_INVALID_ID", (long)actual);

expected = OS_ERR_INVALID_ID;
actual = OS_TimeBaseDelete(0xFFFFFFF);
UtAssert_True(actual == expected, "OS_TimeBaseDelete() (%ld) == OS_ERR_INVALID_ID", (long)actual);

/*
* Test Case For:
* int32 OS_TimeBaseGetIdByName (uint32 *timer_id, const char *timebase_name)
*/

/* Test for nominal inputs */
/* Note: TimeBase2 was created above using TimeBaseCreate and id was set to time_base_id2 */
expected = OS_SUCCESS;
objid = 0;
actual = OS_TimeBaseGetIdByName(&objid, "TimeBaseB");
UtAssert_True(actual == expected, "OS_TimeBaseGetIdByName() (%ld) == OS_SUCCESS", (long)actual);
UtAssert_True(objid == time_base_id2, "OS_TimeBaseGetIdByName() objid (%lu) Matches!", (unsigned long)objid);


/* Test for invalid inputs */
expected = OS_ERR_NAME_NOT_FOUND;
objid = 0;
actual = OS_TimeBaseGetIdByName(&objid, "NF");
UtAssert_True(actual == expected, "OS_TimeBaseGetIdByName() (%ld) == OS_ERR_NAME_NOT_FOUND",(long)actual);
UtAssert_True(objid == 0, "OS_TimeBaseGetIdByName() objid (%lu) still 0", (unsigned long)objid);

expected = OS_INVALID_POINTER;
actual = OS_TimeBaseGetIdByName(NULL, NULL);
UtAssert_True(actual == expected, "OS_TimeBaseGetIdByName() (%ld) == OS_INVALID_POINTER", (long)actual);


/*
* Test Case For:
* int32 OS_TimeBaseGetInfo (uint32 timebase_id, OS_timebase_prop_t *timebase_prop)
*/
expected = OS_SUCCESS;

/* Test for nominal inputs */
/* Note: TimeBase2 was created above using TimeBaseCreate */

/* Initializing timebase_prop values to something other than time_base_id2 to ensure they have changed */
timebase_prop.creator = 1111;
strncpy(timebase_prop.name, "ABC", sizeof(
timebase_prop.name));
timebase_prop.nominal_interval_time = 2222;
timebase_prop.freerun_time = 3333;
timebase_prop.accuracy = 0;

actual = OS_TimeBaseGetInfo(time_base_id2, &timebase_prop);

UtAssert_True(actual == expected, "OS_TimeBaseGetInfo() (%ld) == OS_SUCCESS", (long)actual);

UtAssert_True(timebase_prop.creator == 0, "timebase_prop.creator (%lu) == 0",
(unsigned long)timebase_prop.creator);
UtAssert_True(strcmp(timebase_prop.name, "TimeBaseB") == 0, "timebase_prop.name (%s) == TimeBase2",
timebase_prop.name);
UtAssert_True(timebase_prop.nominal_interval_time == 0,
"timebase_prop.nominal_interval_time (%lu) == 0",
(unsigned long)timebase_prop.nominal_interval_time);
UtAssert_True(timebase_prop.freerun_time == 0,
"timebase_prop.freerun_time (%lu) == 0",
(unsigned long)timebase_prop.freerun_time);
UtAssert_True(timebase_prop.accuracy >= 0,
"timebase_prop.accuracy (%lu) >= 0",
(unsigned long)timebase_prop.accuracy);

/* Test for invalid inputs */
expected = OS_ERR_INVALID_ID;
actual = OS_TimeBaseGetInfo(1, &timebase_prop);
UtAssert_True(actual == expected, "OS_TimeBaseGetInfo() (%ld) == OS_ERR_INVALID_ID", (long)actual);

expected = OS_INVALID_POINTER;
actual = OS_TimeBaseGetInfo(time_base_id2, NULL);
UtAssert_True(actual == expected, "OS_TimeBaseGetInfo() (%ld) == OS_INVALID_POINTER", (long)actual);

/*
* Test Case For:
* int32 OS_TimeBaseGetFreeRun (uint32 timebase_id, uint32 *freerun_val)
*/

/* Test for nominal inputs */
/* Note: TimeBase2 was created above using TimeBaseCreate */
expected = OS_SUCCESS;

freerun = 0xFFFFFFFF;
actual = OS_TimeBaseGetFreeRun(time_base_id2, &freerun);
UtAssert_True(actual == expected, "OS_TimeBaseGetFreeRun() (%ld) == OS_SUCCESS", (long)actual);

freerun = 0x0000000;
actual = OS_TimeBaseGetFreeRun(time_base_id2, &freerun);
UtAssert_True(actual == expected, "OS_TimeBaseGetFreeRun() (%ld) == OS_SUCCESS", (long)actual);

/* Test for invalid inputs */
expected = OS_ERR_INVALID_ID;
freerun = 0xFFFFFFFF;
actual = OS_TimeBaseGetFreeRun(1, &freerun);
UtAssert_True(actual == expected, "OS_TimeBaseGetFreeRun() (%ld) == OS_SUCCESS", (long)actual);




} /* end TestTimeBaseApi */


void UtTest_Setup(void)
{
if (OS_API_Init() != OS_SUCCESS)
{
UtAssert_Abort("OS_API_Init() failed");
}

/*
* Register the test setup and check routines in UT assert
*/
UtTest_Add(TestTimeBaseApi, NULL, NULL, "TestTimeBaseApi");
}