CU_Suite Struct Reference
[Framework]

#include <TestDB.h>

---

Detailed Description

CUnit suite data type.

CU_Suite is a linked list of CU_Test containers. Each suite has a name and count of associated unit tests. It also holds a pointer to optional initialization and cleanup functions. If non-NULL, these are called before and after running the suite's tests, respectively. In addition, the suite holds a pointer to the head of the linked list of associated CU_Test objects. Finally, pointers to the next and previous suites in the linked list are maintained.

Generally, the linked list includes suites which are associated with each other in a CU_TestRegistry. As a result, suites are run in the order in which they are registered (see CU_add_suite()).

In the current implementation, the name of each CU_Suite in a test registry must have a unique name. There is no restriction on the contained tests. This means that the same CU_Test could, in principle, be run more than once as long as it is registered with different suites having distinct names.

See also:

CU_Test

CU_TestRegistry

Data Fields
char *	pName
	Suite name.
CU_pTest	pTest
	Pointer to the 1st test in the suite.
CU_InitializeFunc	pInitializeFunc
	Pointer to the suite initialization function.
CU_CleanupFunc	pCleanupFunc
	Pointer to the suite cleanup function.
unsigned int	uiNumberOfTests
	Number of tests in the suite.
CU_Suite *	pNext
	Pointer to the next suite in linked list.
CU_Suite *	pPrev
	Pointer to the previous suite in linked list.

---

Field Documentation

CU_CleanupFunc CU_Suite::pCleanupFunc

Pointer to the suite cleanup function.

CU_InitializeFunc CU_Suite::pInitializeFunc

Pointer to the suite initialization function.

char* CU_Suite::pName

Suite name.

struct CU_Suite* CU_Suite::pNext

Pointer to the next suite in linked list.

struct CU_Suite* CU_Suite::pPrev

Pointer to the previous suite in linked list.

CU_pTest CU_Suite::pTest

Pointer to the 1st test in the suite.

unsigned int CU_Suite::uiNumberOfTests

Number of tests in the suite.

---

The documentation for this struct was generated from the following file:

• TestDB.h

---