Console

Defines
#define	console_run_tests()   CU_console_run_tests()
	Deprecated (version 1).
Enumerations
enum	STATUS { CONTINUE = 1, MOVE_UP, STOP }
	Console interface status flag. More...
Functions
void	CU_console_run_tests (void)
	Run registered CUnit tests using the console interface.
void	console_registry_level_run (CU_pTestRegistry pRegistry)
	Main loop for console interface.
STATUS	console_suite_level_run (CU_pSuite pSuite)
	Run a selected suite within the console interface.
CU_ErrorCode	console_run_all_tests (CU_pTestRegistry pRegistry)
	Run all tests within the console interface.
CU_ErrorCode	console_run_suite (CU_pSuite pSuite)
	Run a specified suite within the console interface.
CU_ErrorCode	console_run_single_test (CU_pSuite pSuite, CU_pTest pTest)
	Run a specific test for the specified suite within the console interface.
void	console_test_start_message_handler (const CU_pTest pTest, const CU_pSuite pSuite)
	Handler function called at start of each test.
void	console_test_complete_message_handler (const CU_pTest pTest, const CU_pSuite pSuite, const CU_pFailureRecord pFailure)
	Handler function called at completion of each test.
void	console_all_tests_complete_message_handler (const CU_pFailureRecord pFailure)
	Handler function called at completion of all tests in a suite.
void	console_suite_init_failure_message_handler (const CU_pSuite pSuite)
	Handler function called when suite initialization fails.
CU_ErrorCode	select_test (CU_pSuite pSuite, CU_pTest *pTest)
	Read the name of a test from standard input and locate the test having the specified name.
CU_ErrorCode	select_suite (CU_pTestRegistry pRegistry, CU_pSuite *pSuite)
	Read the name of a suite from standard input and locate the suite having the specified name.
void	list_suites (CU_pTestRegistry pRegistry)
	List the suites in a registry to standard output.
void	list_tests (CU_pSuite pSuite)
	List the tests in a suite to standard output.
void	show_failures (void)
	Display the record of test failures on standard output.
Variables
CU_pSuite	f_pRunningSuite = NULL
	currently running suite.

---

Define Documentation

#define console_run_tests (   )     CU_console_run_tests()

Deprecated (version 1). Deprecated: Use CU_console_run_tests().

---

Enumeration Type Documentation

enum STATUS

Console interface status flag. Enumeration values: CONTINUE  Continue processing commands in current menu. MOVE_UP  Move up to the previous menu. STOP  Stop processing (user selected 'Quit').

---

Function Documentation

void console_all_tests_complete_message_handler (  const CU_pFailureRecord  pFailure  )  [static]

Handler function called at completion of all tests in a suite. Parameters: pFailure  Pointer to the test failure record list.

void console_registry_level_run (  CU_pTestRegistry  pRegistry  )  [static]

Main loop for console interface. Displays actions and responds based on user imput. Parameters: pRegistry  The CU_pTestRegistry to use for testing (non-NULL).

CU_ErrorCode console_run_all_tests (  CU_pTestRegistry  pRegistry  )  [static]

Run all tests within the console interface. The test registry is changed to the specified registry before running the tests, and reset to the original registry when done. Parameters: pRegistry  The CU_pTestRegistry containing the tests to be run (non-NULL). Returns: An error code indicating the error status during the test run.

CU_ErrorCode console_run_single_test (  CU_pSuite  pSuite, CU_pTest  pTest )  [static]

Run a specific test for the specified suite within the console interface. Parameters: pSuite  The suite containing the test to be run (non-NULL). pTest  The test to be run (non-NULL). Returns: An error code indicating the error status during the test run.

CU_ErrorCode console_run_suite (  CU_pSuite  pSuite  )  [static]

Run a specified suite within the console interface. Parameters: pSuite  The suite to be run (non-NULL). Returns: An error code indicating the error status during the test run.

void console_suite_init_failure_message_handler (  const CU_pSuite  pSuite  )  [static]

Handler function called when suite initialization fails. Parameters: pSuite  The suite for which initialization failed.

STATUS console_suite_level_run (  CU_pSuite  pSuite  )  [static]

Run a selected suite within the console interface. Displays actions and responds based on user imput. Parameters: pSuite  The suite to use for testing (non-NULL).

void console_test_complete_message_handler (  const CU_pTest  pTest, const CU_pSuite  pSuite, const CU_pFailureRecord  pFailure )  [static]

Handler function called at completion of each test. Parameters: pTest  The test being run. pSuite  The suite containing the test. pFailure  Pointer to the 1st failure record for this test.

void console_test_start_message_handler (  const CU_pTest  pTest, const CU_pSuite  pSuite )  [static]

Handler function called at start of each test. Parameters: pTest  The test being run. pSuite  The suite containing the test.

void CU_console_run_tests (  void   )

Run registered CUnit tests using the console interface.

void list_suites (  CU_pTestRegistry  pRegistry  )  [static]

List the suites in a registry to standard output. Parameters: pRegistry  The CU_pTestRegistry to query (non-NULL).

void list_tests (  CU_pSuite  pSuite  )  [static]

List the tests in a suite to standard output. Parameters: pSuite  The suite to query (non-NULL).

CU_ErrorCode select_suite (  CU_pTestRegistry  pRegistry, CU_pSuite *  ppSuite )  [static]

Read the name of a suite from standard input and locate the suite having the specified name. The input string is used to locate the suite having the indicated name, which is returned in pSuite. ppSuite will be NULL if there is no suite registered in pRegistry having the input name. Returns NULL if the suite is successfully located, non-NULL otherwise. Parameters: pRegistry  The CU_pTestRegistry to query (non-NULL). ppSuite  Pointer to location to store the selected suite. Returns: CUE_SUCCESS if a suite was successfully selected, CUE_NOSUITE otherwise. On return, ppSuite points to the suite selected.

CU_ErrorCode select_test (  CU_pSuite  pSuite, CU_pTest *  ppTest )  [static]

Read the name of a test from standard input and locate the test having the specified name. A pointer to the located test is stored in pTest upon return. Parameters: pSuite  The suite to be queried. ppTest  Pointer to location to store the selected test. Returns: CUE_SUCCESS if a test was successfully selected, CUE_NOTEST otherwise. On return, ppTest points to the test selected.

void show_failures (  void   )  [static]

Display the record of test failures on standard output.

---

Variable Documentation

CU_pSuite f_pRunningSuite = NULL [static]

currently running suite.

---