TestRunner.hpp File Reference

#include "TestUtil.hpp"

Include dependency graph for TestRunner.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RunnerTest

Macros
#define	REGISTER_TEST(TEST_FUNC)   runner_register_test( __FILE__, __LINE__, #TEST_FUNC, ( TEST_FUNC ), NULL )
#define	REGISTER_DEP_TEST(TEST_FUNC, REQUIRED_FUNC)    runner_register_test( __FILE__, __LINE__, #TEST_FUNC, ( TEST_FUNC ), ( REQUIRED_FUNC ) )
#define	RUN_TESTS(ARGC, ARGV)   runner_run_tests( ( ARGC ), ( ARGV ) )

Enumerations
enum	RunnerStatus { PASSED , FAILED , DESELECTED , SELECTED }

Functions
static void	runner_register_test (const char *filename, int line_number, const char *name, test_func function, test_func requisite=0)
static int	runner_run_tests (int argc, char *argv[])
static void	runner_usage (FILE *str, int argc, char *argv[])
static void	runner_list_tests (int long_format)
static void	runner_help (int argc, char *argv[])
static size_t	runner_find_test_func (test_func f)
static size_t	runner_find_test_name (const char *name)
static size_t	runner_add_test (test_func f, const char *name)
static void	runner_add_requisite (size_t idx, size_t req)
static void	free_test_list ()

Variables
struct RunnerTest *	RunnerTestList = 0
size_t	RunnerTestCount = 0
const size_t	RUNNER_NOT_FOUND = ~(size_t)0

Macro Definition Documentation

REGISTER_DEP_TEST

#define REGISTER_DEP_TEST	(		TEST_FUNC,
			REQUIRED_FUNC
	)		runner_register_test( __FILE__, __LINE__, #TEST_FUNC, ( TEST_FUNC ), ( REQUIRED_FUNC ) )

Definition at line 22 of file TestRunner.hpp.

REGISTER_TEST

#define REGISTER_TEST

(

TEST_FUNC

)

runner_register_test( __FILE__, __LINE__, #TEST_FUNC, ( TEST_FUNC ), NULL )

Definition at line 14 of file TestRunner.hpp.

RUN_TESTS

#define RUN_TESTS	(		ARGC,
			ARGV
	)		runner_run_tests( ( ARGC ), ( ARGV ) )

Definition at line 31 of file TestRunner.hpp.

Enumeration Type Documentation

RunnerStatus

enum RunnerStatus

Enumerator
PASSED
FAILED
DESELECTED
SELECTED

Definition at line 49 of file TestRunner.hpp.

{
 PASSED,
 FAILED,
 DESELECTED,
 SELECTED
};

Function Documentation

free_test_list()

static void free_test_list ( )

static

Definition at line 120 of file TestRunner.hpp.

{
 for( size_t i = 0; i < RunnerTestCount; ++i )
 {
 free( RunnerTestList[i].testName );
 free( RunnerTestList[i].testRequisites );
 }
 free( RunnerTestList );
}

References RunnerTestCount, RunnerTestList, testName, and RunnerTest::testRequisites.

Referenced by runner_add_test().

runner_add_requisite()

static void runner_add_requisite ( size_t  idx, size_t  req  )

static

Definition at line 109 of file TestRunner.hpp.

{
 size_t i;
 for( i = 0; i < RunnerTestList[idx].numRequisites; ++i )
 if( RunnerTestList[idx].testRequisites[i] == (int)req ) return;
 ++RunnerTestList[idx].numRequisites;
 RunnerTestList[idx].testRequisites =
 (int*)realloc( RunnerTestList[idx].testRequisites,
 RunnerTestList[idx].numRequisites * sizeof( *RunnerTestList[idx].testRequisites ) );
 RunnerTestList[idx].testRequisites[RunnerTestList[idx].numRequisites - 1] = req;
}

References RunnerTest::numRequisites, RunnerTestList, and RunnerTest::testRequisites.

Referenced by runner_register_test().

runner_add_test()

static size_t runner_add_test ( test_func  f, const char *  name  )

static

Definition at line 86 of file TestRunner.hpp.

{
 size_t idx = runner_find_test_func( f );
 if( idx == RUNNER_NOT_FOUND )
 {
 if( !RunnerTestCount ) atexit( &free_test_list );
 idx = RunnerTestCount++;
 RunnerTest* new_RunnerTestList = (RunnerTest*)realloc( RunnerTestList, RunnerTestCount * sizeof( RunnerTest ) );
 if( !new_RunnerTestList )
 {
 fprintf( stderr, "TestRunner::runner_add_test(): reallocation of RunnerTestList failed\n" );
 atexit( &free_test_list );
 }
 else
 RunnerTestList = new_RunnerTestList;
 RunnerTestList[idx].testFunc = f;
 RunnerTestList[idx].testName = strdup( name );
 RunnerTestList[idx].testStatus = SELECTED;
 RunnerTestList[idx].testRequisites = 0;
 RunnerTestList[idx].numRequisites = 0;
 }
 return idx;
}

References free_test_list(), RunnerTest::numRequisites, runner_find_test_func(), RUNNER_NOT_FOUND, RunnerTestCount, RunnerTestList, SELECTED, RunnerTest::testFunc, RunnerTest::testName, RunnerTest::testRequisites, and RunnerTest::testStatus.

Referenced by runner_register_test().

runner_find_test_func()

static size_t runner_find_test_func ( test_func  f )

static

Definition at line 74 of file TestRunner.hpp.

{
 for( size_t i = 0; i < RunnerTestCount; ++i )
 if( RunnerTestList[i].testFunc == f ) return i;
 return RUNNER_NOT_FOUND;
}

References RUNNER_NOT_FOUND, RunnerTestCount, RunnerTestList, and testFunc.

Referenced by runner_add_test(), and runner_register_test().

runner_find_test_name()

static size_t runner_find_test_name ( const char *  name )

static

Definition at line 80 of file TestRunner.hpp.

{
 for( size_t i = 0; i < RunnerTestCount; ++i )
 if( !strcmp( RunnerTestList[i].testName, name ) ) return i;
 return RUNNER_NOT_FOUND;
}

References RUNNER_NOT_FOUND, RunnerTestCount, RunnerTestList, and testName.

Referenced by runner_run_tests().

runner_help()

void runner_help ( int  argc, char *  argv[]  )

static

Definition at line 155 of file TestRunner.hpp.

{
 runner_usage( stdout, argc, argv );
 fprintf( stdout, "-l : List test names and exit\n"
 "-L : List test names and requisites and exit\n"
 "-h : This help text\n"
 "-r : Recursively run requisite tests for any specified test\n"
 "\n" );
}

References runner_usage().

Referenced by runner_run_tests().

runner_list_tests()

void runner_list_tests ( int  long_format )

static

Definition at line 165 of file TestRunner.hpp.

{
 size_t i, j;
 printf( "Test List:\n" );
 for( i = 0; i < RunnerTestCount; ++i )
 {
 if( RunnerTestList[i].testStatus == DESELECTED ) continue;
 printf( " o %s\n", RunnerTestList[i].testName );
 if( !long_format || !RunnerTestList[i].numRequisites ) continue;
 if( RunnerTestList[i].numRequisites == 1 )
 printf( " Requires : %s\n", RunnerTestList[RunnerTestList[i].testRequisites[0]].testName );
 else
 {
 printf( " Requires : \n" );
 for( j = 0; j < RunnerTestList[i].numRequisites; ++j )
 printf( " - %s\n", RunnerTestList[RunnerTestList[i].testRequisites[j]].testName );
 }
 }
}

References DESELECTED, RunnerTest::numRequisites, RunnerTestCount, RunnerTestList, testName, RunnerTest::testRequisites, and RunnerTest::testStatus.

Referenced by runner_run_tests().

runner_register_test()

void runner_register_test ( const char *  filename, int  line_number, const char *  name, test_func  function, test_func  requisite = 0  )

static

Definition at line 130 of file TestRunner.hpp.

{
 size_t i = runner_add_test( test, name );
 size_t req_idx;
 if( req )
 {
 req_idx = runner_find_test_func( req );
 if( RUNNER_NOT_FOUND == req_idx )
 {
 fprintf( stderr,
 "Error registering requisite for test: \"%s\"\n"
 "\tat %s:%d\n"
 "\tRequisite test function not registered.\n",
 name, filename, line_number );
 abort();
 }
 runner_add_requisite( i, req_idx );
 }
}

References filename, runner_add_requisite(), runner_add_test(), runner_find_test_func(), RUNNER_NOT_FOUND, and test.

runner_run_tests()

int runner_run_tests ( int  argc, char *  argv[]  )

static

Definition at line 185 of file TestRunner.hpp.

{
 /* Counters */
 int error_count = 0;
 int fail_count = 0;
 int num_selected = 0;
 int num_run = 0;
 
 /* Flags from parsed arguments */
 int run_requisites = 0;
 int list_tests = 0;
 int first_selected = 1;
 
 /* Misc iterator vars and such */
 int changed_some, ran_some, can_run, fail;
 int k;
 const char* c;
 size_t i, j;
 
 /* Process command line arguments */
 for( k = 1; k < argc; ++k )
 {
 if( argv[k][0] == '-' )
 {
 for( c = argv[k] + 1; *c; ++c )
 {
 switch( *c )
 {
 case 'l':
 list_tests = 1;
 break;
 case 'L':
 list_tests = 2;
 break;
 case 'r':
 run_requisites = true;
 break;
 case 'h':
 runner_help( argc, argv );
 return 0;
 default:
 runner_usage( stderr, argc, argv );
 fprintf( stderr, "Unknown flag: '%c'\n", *c );
 return 1;
 }
 }
 }
 else
 {
 // If user has specified some tests to run, begin
 // by marking all tests as de-selected.
 if( first_selected )
 {
 for( i = 0; i < RunnerTestCount; ++i )
 RunnerTestList[i].testStatus = DESELECTED;
 first_selected = 0;
 }
 // Mark specified test as selected.
 i = runner_find_test_name( argv[k] );
 if( RUNNER_NOT_FOUND == i )
 {
 fprintf( stderr, "Unknown test name: \"%s\"\n", argv[k] );
 ++error_count;
 }
 else
 {
 RunnerTestList[i].testStatus = SELECTED;
 }
 }
 }
 
 /* If recursively running requisite tests, select those also. */
 if( run_requisites )
 {
 do
 {
 changed_some = 0;
 for( i = 0; i < RunnerTestCount; ++i )
 {
 if( RunnerTestList[i].testStatus == DESELECTED ) continue;
 
 for( j = 0; j < RunnerTestList[i].numRequisites; ++j )
 {
 if( RunnerTestList[RunnerTestList[i].testRequisites[j]].testStatus == DESELECTED )
 {
 RunnerTestList[RunnerTestList[i].testRequisites[j]].testStatus = SELECTED;
 changed_some = 1;
 }
 }
 }
 } while( changed_some );
 }
 
 // Count number of selected tests
 num_selected = 0;
 for( i = 0; i < RunnerTestCount; ++i )
 if( RunnerTestList[i].testStatus == SELECTED ) ++num_selected;
 
 if( list_tests )
 {
 runner_list_tests( list_tests - 1 );
 return error_count;
 }
 
 // Now run the tests
 num_run = 0;
 do
 {
 ran_some = 0;
 for( i = 0; i < RunnerTestCount; ++i )
 {
 if( RunnerTestList[i].testStatus != SELECTED ) continue;
 can_run = 1;
 for( j = 0; j < RunnerTestList[i].numRequisites; ++j )
 {
 k = RunnerTestList[i].testRequisites[j];
 if( RunnerTestList[k].testStatus != PASSED && RunnerTestList[k].testStatus != DESELECTED )
 {
 can_run = 0;
 break;
 }
 }
 if( !can_run ) continue;
 
 ran_some = 1;
 ++num_run;
 fail = run_test( RunnerTestList[i].testFunc, RunnerTestList[i].testName );
 if( fail )
 {
 error_count++;
 fail_count++;
 RunnerTestList[i].testStatus = FAILED;
 }
 else
 {
 RunnerTestList[i].testStatus = PASSED;
 }
 }
 } while( ran_some );
 
 // check if we are running parallel MPI tests
 int rank = 0;
#ifdef MOAB_HAVE_MPI
 int isInit;
 MPI_Initialized( &isInit );
 if( isInit )
 {
 MPI_Comm_rank( MPI_COMM_WORLD, &rank );
 }
#endif
 
 // Print brief summary
 if( rank == 0 )
 {
 if( num_run == (int)RunnerTestCount && !fail_count )
 {
 printf( "All %d tests passed.\n", num_run );
 }
 else if( num_run == num_selected && !fail_count )
 {
 printf( "All %d selected tests passed.\n", num_run );
 printf( "Skipped %d non-selected tests\n", (int)( RunnerTestCount - num_selected ) );
 }
 else
 {
 printf( "%2d tests registered\n", (int)RunnerTestCount );
 if( num_selected == num_run )
 printf( "%2d tests selected\n", num_selected );
 else
 printf( "%2d of %2d tests ran\n", num_run, num_selected );
 if( num_run < (int)RunnerTestCount )
 printf( "%2d of %2d tests skipped\n", (int)RunnerTestCount - num_run, (int)RunnerTestCount );
 printf( "%2d of %2d tests passed\n", num_run - fail_count, num_run );
 if( fail_count ) printf( "%2d of %2d tests FAILED\n", fail_count, num_run );
 }
 }
 
 return error_count;
}

References DESELECTED, error_count, fail(), FAILED, list_tests(), MPI_COMM_WORLD, RunnerTest::numRequisites, PASSED, rank, run_test(), runner_find_test_name(), runner_help(), runner_list_tests(), RUNNER_NOT_FOUND, runner_usage(), RunnerTestCount, RunnerTestList, SELECTED, testFunc, testName, RunnerTest::testRequisites, and RunnerTest::testStatus.

runner_usage()

void runner_usage ( FILE *  str, int  argc, char *  argv[]  )

static

Definition at line 150 of file TestRunner.hpp.

{
 fprintf( str, "%s [-l|-L] [-h] [-r] [<test_name> [<test_name> ...]]\n", argv[0] );
}

Referenced by runner_help(), and runner_run_tests().

Variable Documentation

RUNNER_NOT_FOUND

const size_t RUNNER_NOT_FOUND = ~(size_t)0

Definition at line 67 of file TestRunner.hpp.

Referenced by runner_add_test(), runner_find_test_func(), runner_find_test_name(), runner_register_test(), and runner_run_tests().

RunnerTestCount

size_t RunnerTestCount = 0

Definition at line 66 of file TestRunner.hpp.

Referenced by free_test_list(), runner_add_test(), runner_find_test_func(), runner_find_test_name(), runner_list_tests(), and runner_run_tests().

RunnerTestList

struct RunnerTest* RunnerTestList = 0

Definition at line 65 of file TestRunner.hpp.

Referenced by free_test_list(), runner_add_requisite(), runner_add_test(), runner_find_test_func(), runner_find_test_name(), runner_list_tests(), and runner_run_tests().