cdi_test_unit_api.c File Reference

This file contains the definitions of the functions that comprise the CDI Utility Functions API. More...

#include "cdi_utility_api.h"
#include "cdi_logger_api.h"
#include <assert.h>
#include <stddef.h>
#include "cdi_test_unit_api.h"

Data Structures
struct	RunTestParams
	Enum/name/function keys. More...

Typedefs
typedef CdiReturnStatus(*	RunTestAPI) (void)
	Type used as a pointer to function that runs a unit test.

Functions
CdiReturnStatus	TestUnitAll (void)
	External declarations.
CdiReturnStatus	TestUnitAvmApi (void)
	External declarations.
CdiReturnStatus	TestUnitSgl (void)
	External declarations.
CdiReturnStatus	TestUnitTimeout (void)
	External declarations.
CdiReturnStatus	TestUnitTDigest (void)
	External declarations.
CdiReturnStatus	TestUnitRxReorderPackets (void)
	External declarations.
CdiReturnStatus	TestUnitRxReorderPayloads (void)
	External declarations.
CdiReturnStatus	TestUnitList (void)
	External declarations.
CdiReturnStatus	TestUnitLogger (void)
	External declarations.
static bool	RunTest (CdiTestUnitName test_key)
	Log a pass/fail status message.
const CdiEnumStringKey *	CdiTestUnitGetKeyArray (void)
	Get key array, only used internally by the CDI-SDK.
bool	CdiTestUnitRun (CdiTestUnitName test_name)

Variables
static const RunTestParams	tests []
	Enum/string keys for CdiTestUnitRun.
static CdiEnumStringKey	test_unit_name_key_array [sizeof(tests)/sizeof(tests[0])] = { 0 }
	Enum/string keys for CdiConnectionStatus.

Detailed Description

This file contains the definitions of the functions that comprise the CDI Utility Functions API.

Function Documentation

CdiTestUnitGetKeyArray()

const CdiEnumStringKey * CdiTestUnitGetKeyArray

(

void

)

Get key array, only used internally by the CDI-SDK.

Returns

Pointer to enum string array.

CdiTestUnitRun()

bool CdiTestUnitRun

(

CdiTestUnitName

test_name

)

Function used to convert a string to a matching enum value.

Parameters

test_name

Enum from CdiTestUnitName which indicates which unit test to run.

Returns

true if all tests were successful, otherwise false.

RunTest()

static bool RunTest ( CdiTestUnitName test_key )

static

Log a pass/fail status message.

Parameters

test_key

Key identifying a test.

Returns

true if success, otherwise false.

TestUnitSgl()

CdiReturnStatus TestUnitSgl ( void )

extern

External declarations.

Runs all of the defined CdiCoreGather() test cases. Testing stops on the first failed case.

Returns

bool true if all of the cases passed, false if one case failed.

TestUnitTDigest()

CdiReturnStatus TestUnitTDigest ( void )

extern

External declarations.

External declarations.

Returns

Status code.

TestUnitTimeout()

CdiReturnStatus TestUnitTimeout ( void )

extern

External declarations.

External declarations.

Variable Documentation

tests

const RunTestParams tests[]

static

Initial value:

= {
    { kTestUnitAll,                 "All",              NULL },
    { kTestUnitAvmApi,              "AvmApi",           TestUnitAvmApi },
    { kTestUnitSgl,                 "Sgl",              TestUnitSgl },
    { kTestUnitTimeout,             "Timeout",          TestUnitTimeout },
    { kTestUnitTDigest,             "TDigest",          TestUnitTDigest },
    { kTestUnitRxpacketReorder,     "RxPacketReorder",  TestUnitRxReorderPackets },
    { kTestUnitRxPayloadReorder,    "RxPayloadReorder", TestUnitRxReorderPayloads },
    { kTestUnitList,                "List",             TestUnitList },
    { kTestUnitLogger,              "Logger",           TestUnitLogger },
    { CDI_INVALID_ENUM_VALUE, NULL, NULL } 
}

Enum/string keys for CdiTestUnitRun.