mirror of
https://github.com/HDFGroup/hdf5.git
synced 2024-11-27 02:10:55 +08:00
ce2b03097b
Code cleanup
Description:
Refactor library testing framework (used for the testhdf5 & ttsafe tests)
to remove almost all of the duplicated code, moving the common code into a
new 'testframe.c' source file.
Platforms tested:
FreeBSD 4.9 (sleipnir) w & w/o thread-safety
h5committest
299 lines
9.8 KiB
C
299 lines
9.8 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||
* Copyright by the Board of Trustees of the University of Illinois. *
|
||
* All rights reserved. *
|
||
* *
|
||
* This file is part of HDF5. The full HDF5 copyright notice, including *
|
||
* terms governing use, modification, and redistribution, is contained in *
|
||
* the files COPYING and Copyright.html. COPYING can be found at the root *
|
||
* of the source code distribution tree; Copyright.html can be found at the *
|
||
* root level of an installed copy of the electronic HDF5 document set and *
|
||
* is linked from the top-level documents page. It can also be found at *
|
||
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
|
||
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
|
||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||
|
||
/*
|
||
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
|
||
* Tuesday, January 6, 2004
|
||
*
|
||
* Purpose: Provides support functions for the testing framework.
|
||
*
|
||
*/
|
||
|
||
#include "testhdf5.h"
|
||
|
||
/*
|
||
* Definitions for the testing structure.
|
||
*/
|
||
#define MAXNUMOFTESTS 30
|
||
#define MAXTESTNAME 16
|
||
#define MAXTESTDESC 64
|
||
|
||
typedef struct TestStruct {
|
||
int NumErrors;
|
||
char Description[MAXTESTDESC];
|
||
int SkipFlag;
|
||
char Name[MAXTESTNAME];
|
||
void (*Call)(void);
|
||
void (*Cleanup)(void);
|
||
} TestStruct;
|
||
|
||
|
||
/*
|
||
* Global variables used by InitTest().
|
||
*/
|
||
static TestStruct Test[MAXNUMOFTESTS];
|
||
static int Index = 0;
|
||
|
||
|
||
/*
|
||
* Setup a test function and add it to the list of tests.
|
||
* It must have no parameters and returns void.
|
||
*/
|
||
void
|
||
AddTest(const char *TheName, void (*TheCall) (void), void (*Cleanup) (void), const char *TheDescr)
|
||
{
|
||
/* Sanity checking */
|
||
if (Index >= MAXNUMOFTESTS) {
|
||
printf("Too many tests added, increase MAXNUMOFTEST(%d).\n",
|
||
MAXNUMOFTESTS);
|
||
exit(-1);
|
||
} /* end if */
|
||
if (HDstrlen(TheDescr) >= MAXTESTDESC) {
|
||
printf("Test description too long, increase MAXTESTDESC(%d).\n",
|
||
MAXTESTDESC);
|
||
exit(-1);
|
||
} /* end if */
|
||
if (HDstrlen(TheName) >= MAXTESTNAME) {
|
||
printf("Test name too long, increase MAXTESTNAME(%d).\n",
|
||
MAXTESTNAME);
|
||
exit(-1);
|
||
} /* end if */
|
||
|
||
/* Set up test function */
|
||
HDstrcpy(Test[Index].Description, TheDescr);
|
||
HDstrcpy(Test[Index].Name, TheName);
|
||
Test[Index].Call = TheCall;
|
||
Test[Index].Cleanup = Cleanup;
|
||
Test[Index].NumErrors = -1;
|
||
Test[Index].SkipFlag = 0;
|
||
|
||
/* Increment test count */
|
||
Index++;
|
||
}
|
||
|
||
|
||
/*
|
||
* Initialize testing framework
|
||
*/
|
||
void TestInit(void)
|
||
{
|
||
#if !(defined MAC || defined __MWERKS__ || defined SYMANTEC_C)
|
||
/* Un-buffer the stdout and stderr */
|
||
setbuf(stderr, NULL);
|
||
setbuf(stdout, NULL);
|
||
#endif
|
||
|
||
/*
|
||
* Turn off automatic error reporting since we do it ourselves. Besides,
|
||
* half the functions this test calls are private, so automatic error
|
||
* reporting wouldn't do much good since it's triggered at the API layer.
|
||
*/
|
||
#ifdef H5_WANT_H5_V1_6_COMPAT
|
||
H5Eset_auto (NULL, NULL);
|
||
#else
|
||
H5Eset_auto (H5E_DEFAULT, NULL, NULL);
|
||
#endif /* H5_WANT_H5_V1_6_COMPAT */
|
||
|
||
}
|
||
|
||
|
||
/*
|
||
* Print test usage.
|
||
*/
|
||
void TestUsage(void)
|
||
{
|
||
int i;
|
||
|
||
print_func("Usage: ttsafe [-v[erbose] (l[ow]|m[edium]|h[igh]|0-10)] \n");
|
||
print_func(" [-[e]x[clude] name+] \n");
|
||
print_func(" [-o[nly] name+] \n");
|
||
print_func(" [-b[egin] name] \n");
|
||
print_func(" [-s[ummary]] \n");
|
||
print_func(" [-c[leanoff]] \n");
|
||
print_func(" [-h[elp]] \n");
|
||
print_func("\n\n");
|
||
print_func("verbose controls the amount of information displayed\n");
|
||
print_func("exclude to exclude tests by name\n");
|
||
print_func("only to name tests which should be run\n");
|
||
print_func("begin start at the name of the test givin\n");
|
||
print_func("summary prints a summary of test results at the end\n");
|
||
print_func("cleanoff does not delete *.hdf files after execution of tests\n");
|
||
print_func("help print out this information\n");
|
||
print_func("\n\n");
|
||
print_func("This program currently tests the following: \n\n");
|
||
print_func("%16s %s\n", "Name", "Description");
|
||
print_func("%16s %s\n", "----", "-----------");
|
||
|
||
for (i = 0; i < Index; i++)
|
||
print_func("%16s %s\n", Test[i].Name, Test[i].Description);
|
||
|
||
print_func("\n\n");
|
||
}
|
||
|
||
|
||
/*
|
||
* Print test info.
|
||
*/
|
||
void TestInfo(const char *ProgName)
|
||
{
|
||
unsigned major, minor, release;
|
||
|
||
H5get_libversion(&major, &minor, &release);
|
||
|
||
print_func("\nFor help use: %s -help\n",ProgName);
|
||
print_func("Linked with hdf5 version %u.%u release %u\n", major, minor, release);
|
||
}
|
||
|
||
|
||
/*
|
||
* Parse command line information
|
||
*/
|
||
void TestParseCmdLine(int argc, char *argv[], int *Summary, int *CleanUp)
|
||
{
|
||
int CLLoop; /* Command Line Loop */
|
||
int Loop, Loop1;
|
||
|
||
for (CLLoop = 1; CLLoop < argc; CLLoop++) {
|
||
if ((argc > CLLoop + 1) && ((HDstrcmp(argv[CLLoop], "-verbose") == 0) ||
|
||
(HDstrcmp(argv[CLLoop], "-v") == 0))) {
|
||
if (argv[CLLoop + 1][0] == 'l')
|
||
Verbosity = 4;
|
||
else if (argv[CLLoop + 1][0] == 'm')
|
||
Verbosity = 6;
|
||
else if (argv[CLLoop + 1][0] == 'h')
|
||
Verbosity = 10;
|
||
else
|
||
Verbosity = atoi(argv[CLLoop + 1]);
|
||
} /* end if */
|
||
if ((argc > CLLoop) && ((HDstrcmp(argv[CLLoop], "-summary") == 0) ||
|
||
(HDstrcmp(argv[CLLoop], "-s") == 0)))
|
||
*Summary = 1;
|
||
|
||
if ((argc > CLLoop) && ((HDstrcmp(argv[CLLoop], "-help") == 0) ||
|
||
(HDstrcmp(argv[CLLoop], "-h") == 0))) {
|
||
TestUsage();
|
||
exit(0);
|
||
}
|
||
if ((argc > CLLoop) && ((HDstrcmp(argv[CLLoop], "-cleanoff") == 0) ||
|
||
(HDstrcmp(argv[CLLoop], "-c") == 0)))
|
||
*CleanUp = 0;
|
||
|
||
if ((argc > CLLoop + 1) && ((HDstrcmp(argv[CLLoop], "-exclude") == 0) ||
|
||
(HDstrcmp(argv[CLLoop], "-x") == 0))) {
|
||
Loop = CLLoop + 1;
|
||
while ((Loop < argc) && (argv[Loop][0] != '-')) {
|
||
for (Loop1 = 0; Loop1 < Index; Loop1++)
|
||
if (HDstrcmp(argv[Loop], Test[Loop1].Name) == 0)
|
||
Test[Loop1].SkipFlag = 1;
|
||
Loop++;
|
||
} /* end while */
|
||
} /* end if */
|
||
if ((argc > CLLoop + 1) && ((HDstrcmp(argv[CLLoop], "-begin") == 0) ||
|
||
(HDstrcmp(argv[CLLoop], "-b") == 0))) {
|
||
Loop = CLLoop + 1;
|
||
while ((Loop < argc) && (argv[Loop][0] != '-')) {
|
||
for (Loop1 = 0; Loop1 < Index; Loop1++) {
|
||
if (HDstrcmp(argv[Loop], Test[Loop1].Name) != 0)
|
||
Test[Loop1].SkipFlag = 1;
|
||
if (HDstrcmp(argv[Loop], Test[Loop1].Name) == 0)
|
||
Loop1 = Index;
|
||
} /* end for */
|
||
Loop++;
|
||
} /* end while */
|
||
} /* end if */
|
||
if ((argc > CLLoop + 1) && ((HDstrcmp(argv[CLLoop], "-only") == 0) ||
|
||
(HDstrcmp(argv[CLLoop], "-o") == 0))) {
|
||
for (Loop = 0; Loop < Index; Loop++)
|
||
Test[Loop].SkipFlag = 1;
|
||
|
||
Loop = CLLoop + 1;
|
||
while ((Loop < argc) && (argv[Loop][0] != '-')) {
|
||
for (Loop1 = 0; Loop1 < Index; Loop1++)
|
||
if (HDstrcmp(argv[Loop], Test[Loop1].Name) == 0)
|
||
Test[Loop1].SkipFlag = 0;
|
||
Loop++;
|
||
} /* end while */
|
||
} /* end if */
|
||
} /* end for */
|
||
|
||
}
|
||
|
||
|
||
/*
|
||
* Perform Tests.
|
||
*/
|
||
void PerformTests(void)
|
||
{
|
||
int Loop;
|
||
|
||
for (Loop = 0; Loop < Index; Loop++)
|
||
if (Test[Loop].SkipFlag) {
|
||
MESSAGE(2, ("Skipping -- %s \n", Test[Loop].Description));
|
||
} else {
|
||
MESSAGE(2, ("Testing -- %s (%s) \n", Test[Loop].Description, Test[Loop].Name));
|
||
MESSAGE(5, ("===============================================\n"));
|
||
Test[Loop].NumErrors = num_errs;
|
||
Test[Loop].Call();
|
||
Test[Loop].NumErrors = num_errs - Test[Loop].NumErrors;
|
||
MESSAGE(5, ("===============================================\n"));
|
||
MESSAGE(5, ("There were %d errors detected.\n\n", (int)Test[Loop].NumErrors));
|
||
}
|
||
|
||
MESSAGE(2, ("\n\n"))
|
||
|
||
if (num_errs)
|
||
print_func("!!! %d Error(s) were detected !!!\n\n", (int) num_errs);
|
||
else
|
||
print_func("All tests were successful. \n\n");
|
||
}
|
||
|
||
|
||
/*
|
||
* Display test summary.
|
||
*/
|
||
void TestSummary(void)
|
||
{
|
||
int Loop;
|
||
|
||
print_func("Summary of Test Results:\n");
|
||
print_func("Name of Test Errors Description of Test\n");
|
||
print_func("---------------- ------ --------------------------------------\n");
|
||
|
||
for (Loop = 0; Loop < Index; Loop++) {
|
||
if (Test[Loop].NumErrors == -1)
|
||
print_func("%16s %6s %s\n", Test[Loop].Name, "N/A", Test[Loop].Description);
|
||
else
|
||
print_func("%16s %6d %s\n", Test[Loop].Name, (int)Test[Loop].NumErrors, Test[Loop].Description);
|
||
}
|
||
|
||
print_func("\n\n");
|
||
}
|
||
|
||
|
||
/*
|
||
* Cleanup files from testing
|
||
*/
|
||
void TestCleanup(void)
|
||
{
|
||
int Loop;
|
||
|
||
MESSAGE(2, ("\nCleaning Up temp files...\n\n"));
|
||
|
||
/* call individual cleanup routines in each source module */
|
||
for (Loop = 0; Loop < Index; Loop++)
|
||
if (!Test[Loop].SkipFlag && Test[Loop].Cleanup!=NULL)
|
||
Test[Loop].Cleanup();
|
||
}
|
||
|