/* ***************************************************************************************** * * Copyright (C) 1996-2004, International Business Machines * Corporation and others. All Rights Reserved. * ***************************************************************************************** */ #include #include #include #include #include #include "unicode/utrace.h" /* NOTES: 3/20/1999 srl - strncpy called w/o setting nulls at the end */ #define MAXTESTNAME 128 #define MAXTESTS 512 #define MAX_TEST_LOG 4096 struct TestNode { char name[MAXTESTNAME]; void (*test)(void); struct TestNode* sibling; struct TestNode* child; }; static const struct TestNode* currentTest; typedef enum { RUNTESTS, SHOWTESTS } TestMode; #define TEST_SEPARATOR '/' #ifndef C_TEST_IMPL #define C_TEST_IMPL #endif #include "unicode/ctest.h" static char ERROR_LOG[MAX_TEST_LOG][MAXTESTNAME]; /* Local prototypes */ static TestNode* addTestNode( TestNode *root, const char *name ); static TestNode* createTestNode(); static int strncmp_nullcheck( const char* s1, const char* s2, int n ); static void getNextLevel( const char* name, int* nameLen, const char** nextName ); static void iterateTestsWithLevel( const TestNode *root, int len, const TestNode** list, TestMode mode); static void help ( const char *argv0 ); /** * Do the work of logging an error. Doesn't increase the error count. * * @prefix optional prefix prepended to message, or NULL. * @param pattern printf style pattern * @param ap vprintf style arg list */ static void vlog_err(const char *prefix, const char *pattern, va_list ap); static void vlog_verbose(const char *prefix, const char *pattern, va_list ap); /* If we need to make the framework multi-thread safe we need to pass around the following vars */ static int ERRONEOUS_FUNCTION_COUNT = 0; static int ERROR_COUNT = 0; /* Count of errors from all tests. */ static int DATA_ERROR_COUNT = 0; /* count of data related errors or warnings */ static int INDENT_LEVEL = 0; int REPEAT_TESTS_INIT = 0; /* Was REPEAT_TESTS initialized? */ int REPEAT_TESTS = 1; /* Number of times to run the test */ int VERBOSITY = 0; /* be No-verbose by default */ int ERR_MSG =1; /* error messages will be displayed by default*/ int QUICK = 1; /* Skip some of the slower tests? */ int WARN_ON_MISSING_DATA = 0; /* Reduce data errs to warnings? */ UTraceLevel ICU_TRACE = UTRACE_OFF; /* ICU tracing level */ /*-------------------------------------------*/ /* strncmp that also makes sure there's a \0 at s2[0] */ static int strncmp_nullcheck( const char* s1, const char* s2, int n ) { if (((int)strlen(s2) >= n) && s2[n] != 0) { return 3; /* null check fails */ } else { return strncmp ( s1, s2, n ); } } static void getNextLevel( const char* name, int* nameLen, const char** nextName ) { /* Get the next component of the name */ *nextName = strchr(name, TEST_SEPARATOR); if( *nextName != 0 ) { char n[255]; *nameLen = (int)((*nextName) - name); (*nextName)++; /* skip '/' */ strncpy(n, name, *nameLen); n[*nameLen] = 0; /*printf("->%s-< [%d] -> [%s]\n", name, *nameLen, *nextName);*/ } else { *nameLen = (int)strlen(name); } } static TestNode *createTestNode( ) { TestNode *newNode; newNode = (TestNode*)malloc ( sizeof ( TestNode ) ); newNode->name[0] = '\0'; newNode->test = NULL; newNode->sibling = NULL; newNode->child = NULL; return newNode; } void T_CTEST_EXPORT2 cleanUpTestTree(TestNode *tn) { if(tn->child != NULL) { cleanUpTestTree(tn->child); } if(tn->sibling != NULL) { cleanUpTestTree(tn->sibling); } free(tn); } void T_CTEST_EXPORT2 addTest(TestNode** root, TestFunctionPtr test, const char* name ) { TestNode *newNode; /*if this is the first Test created*/ if (*root == NULL) *root = createTestNode(); newNode = addTestNode( *root, name ); assert(newNode != 0 ); /* printf("addTest: nreName = %s\n", newNode->name );*/ newNode->test = test; } /* non recursive insert function */ static TestNode *addTestNode ( TestNode *root, const char *name ) { const char* nextName; TestNode *nextNode, *curNode; int nameLen; /* length of current 'name' */ /* remove leading slash */ if ( *name == TEST_SEPARATOR ) name++; curNode = root; for(;;) { /* Start with the next child */ nextNode = curNode->child; getNextLevel ( name, &nameLen, &nextName ); /* printf("* %s\n", name );*/ /* if nextNode is already null, then curNode has no children -- add them */ if( nextNode == NULL ) { /* Add all children of the node */ do { curNode->child = createTestNode ( ); /* Get the next component of the name */ getNextLevel ( name, &nameLen, &nextName ); /* update curName to have the next name segment */ strncpy ( curNode->child->name , name, nameLen ); curNode->child->name[nameLen] = 0; /* printf("*** added %s\n", curNode->child->name );*/ curNode = curNode->child; name = nextName; } while( name != NULL ); return curNode; } /* Search across for the name */ while (strncmp_nullcheck ( name, nextNode->name, nameLen) != 0 ) { curNode = nextNode; nextNode = nextNode -> sibling; if ( nextNode == NULL ) { /* Did not find 'name' on this level. */ nextNode = createTestNode ( ); strncpy( nextNode->name, name, nameLen ); nextNode->name[nameLen] = 0; curNode->sibling = nextNode; break; } } /* nextNode matches 'name' */ if (nextName == NULL) /* end of the line */ { return nextNode; } /* Loop again with the next item */ name = nextName; curNode = nextNode; } } static void iterateTestsWithLevel ( const TestNode* root, int len, const TestNode** list, TestMode mode) { int i; int saveIndent; char pathToFunction[MAXTESTNAME] = ""; char separatorString[2] = { TEST_SEPARATOR, '\0'}; if ( root == NULL ) return; list[len++] = root; for ( i=0;i<(len-1);i++ ) { strcat(pathToFunction, list[i]->name); strcat(pathToFunction, separatorString); } strcat(pathToFunction, list[i]->name); INDENT_LEVEL = len; if ( (mode == RUNTESTS) && (root->test != NULL)) { int myERROR_COUNT = ERROR_COUNT; currentTest = root; root->test(); currentTest = NULL; if (myERROR_COUNT != ERROR_COUNT) { log_info("---[%d ERRORS] ", ERROR_COUNT - myERROR_COUNT); strcpy(ERROR_LOG[ERRONEOUS_FUNCTION_COUNT++], pathToFunction); } else log_info("---[OK] "); } /* we want these messages to be at 0 indent. so just push the indent level breifly. */ saveIndent = INDENT_LEVEL; INDENT_LEVEL = 0; log_info("%s%s%c\n", (list[i]->test||mode==SHOWTESTS)?"---":"",pathToFunction, list[i]->test?' ':TEST_SEPARATOR ); INDENT_LEVEL = saveIndent; iterateTestsWithLevel ( root->child, len, list, mode ); len--; if ( len != 0 ) /* DO NOT iterate over siblings of the root. */ iterateTestsWithLevel ( root->sibling, len, list, mode ); } void T_CTEST_EXPORT2 showTests ( const TestNode *root ) { /* make up one for them */ const TestNode *aList[MAXTESTS]; if (root == NULL) log_err("TEST CAN'T BE FOUND!"); iterateTestsWithLevel ( root, 0, aList, SHOWTESTS ); } void T_CTEST_EXPORT2 runTests ( const TestNode *root ) { int i; const TestNode *aList[MAXTESTS]; /* make up one for them */ if (root == NULL) log_err("TEST CAN'T BE FOUND!\n"); ERRONEOUS_FUNCTION_COUNT = ERROR_COUNT = 0; iterateTestsWithLevel ( root, 0, aList, RUNTESTS ); /*print out result summary*/ if (ERROR_COUNT) { log_info("\nSUMMARY:\n******* [Total error count:\t%d]\n Errors in\n", ERROR_COUNT); for (i=0;i < ERRONEOUS_FUNCTION_COUNT; i++) log_info("[%s]\n",ERROR_LOG[i]); } else { log_info("\n[All tests passed successfully...]\n"); } if(DATA_ERROR_COUNT) { if(WARN_ON_MISSING_DATA==0) { log_info("\t*Note* some errors are data-loading related. If the data used is not the \n" "\tstock ICU data (i.e some have been added or removed), consider using\n" "\tthe '-w' option to turn these errors into warnings.\n"); } else { log_info("\t*WARNING* some data-loading errors were ignored by the -w option.\n"); } } } const char* T_CTEST_EXPORT2 getTestName(void) { if(currentTest != NULL) { return currentTest->name; } else { return NULL; } } const TestNode* T_CTEST_EXPORT2 getTest(const TestNode* root, const char* name) { const char* nextName; TestNode *nextNode; const TestNode* curNode; int nameLen; /* length of current 'name' */ if (root == NULL) log_err("TEST CAN'T BE FOUND!\n"); /* remove leading slash */ if ( *name == TEST_SEPARATOR ) name++; curNode = root; for(;;) { /* Start with the next child */ nextNode = curNode->child; getNextLevel ( name, &nameLen, &nextName ); /* printf("* %s\n", name );*/ /* if nextNode is already null, then curNode has no children -- add them */ if( nextNode == NULL ) { return NULL; } /* Search across for the name */ while (strncmp_nullcheck ( name, nextNode->name, nameLen) != 0 ) { curNode = nextNode; nextNode = nextNode -> sibling; if ( nextNode == NULL ) { /* Did not find 'name' on this level. */ return NULL; } } /* nextNode matches 'name' */ if (nextName == NULL) /* end of the line */ { return nextNode; } /* Loop again with the next item */ name = nextName; curNode = nextNode; } } static void vlog_err(const char *prefix, const char *pattern, va_list ap) { if( ERR_MSG == FALSE){ return; } fprintf(stderr, "%-*s", INDENT_LEVEL," " ); if(prefix) { fputs(prefix, stderr); } vfprintf(stderr, pattern, ap); fflush(stderr); va_end(ap); } void T_CTEST_EXPORT2 vlog_info(const char *prefix, const char *pattern, va_list ap) { fprintf(stdout, "%-*s", INDENT_LEVEL," " ); if(prefix) { fputs(prefix, stderr); } vfprintf(stdout, pattern, ap); fflush(stdout); va_end(ap); } static void vlog_verbose(const char *prefix, const char *pattern, va_list ap) { if ( VERBOSITY == FALSE ) return; fprintf(stdout, "%-*s", INDENT_LEVEL," " ); if(prefix) { fputs(prefix, stderr); } vfprintf(stdout, pattern, ap); fflush(stdout); va_end(ap); } void T_CTEST_EXPORT2 log_err(const char* pattern, ...) { va_list ap; if(strchr(pattern, '\n') != NULL) { /* * Count errors only if there is a line feed in the pattern * so that we do not exaggerate our error count. */ ++ERROR_COUNT; } va_start(ap, pattern); vlog_err(NULL, pattern, ap); } void T_CTEST_EXPORT2 log_info(const char* pattern, ...) { va_list ap; va_start(ap, pattern); vlog_info(NULL, pattern, ap); } void T_CTEST_EXPORT2 log_verbose(const char* pattern, ...) { va_list ap; va_start(ap, pattern); vlog_verbose(NULL, pattern, ap); } void T_CTEST_EXPORT2 log_data_err(const char* pattern, ...) { va_list ap; va_start(ap, pattern); ++DATA_ERROR_COUNT; /* for informational message at the end */ if(WARN_ON_MISSING_DATA == 0) { /* Fatal error. */ if(strchr(pattern, '\n') != NULL) { ++ERROR_COUNT; } vlog_err(NULL, pattern, ap); /* no need for prefix in default case */ } else { vlog_info("[Data] ", pattern, ap); } } int T_CTEST_EXPORT2 processArgs(const TestNode* root, int argc, const char* const argv[]) { /** * This main will parse the l, v, h, n, and path arguments */ const TestNode* toRun; int i; int doList = FALSE; int subtreeOptionSeen = FALSE; int errorCount = 0; toRun = root; VERBOSITY = FALSE; ERR_MSG = TRUE; for( i=1; i 0 ) ) printf(" Total errors: %d\n", errorCount ); } REPEAT_TESTS_INIT = 1; return errorCount; /* total error count */ } /** * Display program invocation arguments */ static void help ( const char *argv0 ) { printf("Usage: %s [ -l ] [ -v ] [ -verbose] [-a] [ -all] [-n] [ -no_err_msg]\n" " [ -h ] [-t_info | -t_error | -t_warn | -t_oc | -t_verbose]" " [ /path/to/test ]\n", argv0); printf(" -l To get a list of test names\n"); printf(" -e to do exhaustive testing\n"); printf(" -verbose To turn ON verbosity\n"); printf(" -v To turn ON verbosity(same as -verbose)\n"); printf(" -h To print this message\n"); printf(" -n To turn OFF printing error messages\n"); printf(" -w Don't fail on data-loading errs, just warn. Useful if\n" " user has reduced/changed the common set of ICU data \n"); printf(" -t_info | -t_error | -t_warn | -t_oc | -t_verbose Enable ICU tracing\n"); printf(" -no_err_msg (same as -n) \n"); printf(" -r repeat tests after calling u_cleanup \n"); printf(" -[/subtest] To run a subtest \n"); printf(" eg: to run just the utility tests type: cintltest /tsutil) \n"); }