Index: /trunk/psModules/src/parseErrorCodes.pl =================================================================== --- /trunk/psModules/src/parseErrorCodes.pl (revision 1876) +++ /trunk/psModules/src/parseErrorCodes.pl (revision 1876) @@ -0,0 +1,97 @@ +#!/usr/bin/perl + +# Provides functions for handling long command line options +use Getopt::Long; + +my @ErrorCodes = (); +my @ErrorDescriptions = (); + +my $data = "psErrorCodes.dat"; + +# Assign variables based on the presence of command line options to the script +GetOptions( + "data=s" => \$data, + "verbose" => \$verbose, + "help" => \$help +); + +if ($help) { + print "Usage: parseErrorCodes ", "[--data=$data] ", "[--help] ", + "[--verbose] filename [filename ...]\n\n"; + exit(0); +} + +print "Using data file '$data'\n" if $verbose; +unless ( open( DATAFILE, "<", $data ) ) { + die "Can not open data file $data."; +} + +print "Datafile:\n" if $verbose; +while () { + chop; + if (/^\s*\#/) { + print "C $_\n" if $verbose; + } + else { + if (/^\s*(\w+)\s+([\%\w].*)/) { + my $ErrorCode = $1; + my $ErrorDescription = $2; + print " $ErrorCode: '$ErrorDescription'\n" if $verbose; + push( @ErrorCodes, $ErrorCode ); + push( @ErrorDescriptions, $ErrorDescription ); + } else { + print "I $_\n" if $verbose; + } + } +} +close(DATAFILE); + +my $found = $#ErrorCodes + 1; +print "\nFound $found error codes.\n" if $verbose; + +foreach (@ARGV) { + my $filename = $_; + my @result = (); + + die "Failed to open input file" + if !open( INFILE, "<", $filename ); + + print "\nOutput File:\n" if $verbose; + while () { + chop; + push( @result, $_ ); + if (/^\s*\/\/~Start(.*)$/) { + $line = $1; + for ( $n = 0 ; $n < $found ; $n++ ) { + $_ = $line; + s/\$1/$ErrorCodes[$n]/g; + s/\$2/$ErrorDescriptions[$n]/g; + s/\$n/$n/g; + push( @result, $_ ); + print "$_\n" if $verbose; + } + + $break = 0; + while ( ( $break == 0 ) && ( $_ = ) ) { + if (/^\s*\/\/~End/) { + $break = 1; + } + } + chop; + push( @result, $_ ); + } + } + + close(INFILE); + + die "Failed to overwrite input file" + if !open( OUTFILE, ">", $filename ); + + foreach (@result) { + print OUTFILE "$_\n"; + print "$_\n" if $verbose; + } + + close(OUTFILE); + +} Index: /trunk/psModules/src/pmFlatFieldErrors.h =================================================================== --- /trunk/psModules/src/pmFlatFieldErrors.h (revision 1876) +++ /trunk/psModules/src/pmFlatFieldErrors.h (revision 1876) @@ -0,0 +1,47 @@ +/** @file psFlatFieldErrors.h + * + * @brief Contains the error text for the flat field module + * + * @ingroup ErrorHandling + * + * @author Ross Harman, MHPCC + * + * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-09-24 18:00:28 $ + * + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii + */ + +#ifndef PM_FLATFIELD_ERRORS_H +#define PM_FLATFIELD_ERRORS_H + +/* N.B., lines between '//~Start' and '//~End' are automatic generated from + * the template following the '//~Start'. The template is used to generate + * the other lines by, for each error text in psDataManipErrors.dat, the following + * substitutions are made: + * $1 The error text macro name (first word in the psFlatFieldErrors.h lines) + * $2 The error text (rest of the line in psFlatFieldErrors.h) + * $n The order of the source line in psFlatFieldErrors.h (comments excluded) + * + * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. + */ + +#define PS_ERRORNAME_DOMAIN "psModule.src." + +//~Start #define PS_ERRORTEXT_$1 "$2" +#define PS_ERRORTEXT_pmFlatField_NULL_FLAT_READOUT "Null not allowed for flat readout." +#define PS_ERRORTEXT_pmFlatField_NULL_INPUT_IMAGE "Null not allowed for input image." +#define PS_ERRORTEXT_pmFlatField_NULL_FLAT_IMAGE "Null not allowed for flat image." +#define PS_ERRORTEXT_pmFlatField_SIZE_INPUT_IMAGE "Input image size exceeds that of flat image: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmFlatField_SIZE_MASK_IMAGE "Input image mask size exceeds that of flat image: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmFlatField_OFFSET_FLAT_IMAGE "Total offset >= flat image size: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmFlatField_OFFSET_INPUT_IMAGE "Total offset >= input image: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmFlatField_OFFSET_MASK_IMAGE "Total offset >= input image mask: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmFlatField_TYPE_INPUT_IMAGE "Complex types not allowed for input image. Type: %d" +#define PS_ERRORTEXT_pmFlatField_TYPE_FLAT_IMAGE "Complex types not allowed for flat image. Type: %d" +#define PS_ERRORTEXT_pmFlatField_TYPE_MASK_IMAGE "Mask must be PS_TYPE_MASK type. Type: %d" +#define PS_ERRORTEXT_pmFlatField_TYPE_MISMATCH "Input and flat image types differ: (%d vs %d)" +#define PS_ERRORTEXT_pmFlatField_TYPE_UNSUPPORTED "Unsupported image datatype. Type: %d" +//~End + +#endif Index: /trunk/psModules/src/pmMaskBadPixelsErrors.h =================================================================== --- /trunk/psModules/src/pmMaskBadPixelsErrors.h (revision 1876) +++ /trunk/psModules/src/pmMaskBadPixelsErrors.h (revision 1876) @@ -0,0 +1,45 @@ +/** @file pmMaskBadPixelsErrors.h + * + * @brief Contains the error text for the mask bad pixels module + * + * @ingroup ErrorHandling + * + * @author Ross Harman, MHPCC + * + * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-09-24 18:00:28 $ + * + * Copyright 2004 Maui High Performance Computing Center, University of Hawaii + */ + +#ifndef PM_FLATFIELD_ERRORS_H +#define PM_FLATFIELD_ERRORS_H + +/* N.B., lines between '//~Start' and '//~End' are automatic generated from + * the template following the '//~Start'. The template is used to generate + * the other lines by, for each error text in pmMaskBadPixelsErrors.dat, the following + * substitutions are made: + * $1 The error text macro name (first word in the pmMaskBadPixelsErrors.h lines) + * $2 The error text (rest of the line in pmMaskBadPixelsErrors.h) + * $n The order of the source line in pmMaskBadPixelsErrors.h (comments excluded) + * + * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. + */ + +#define PS_ERRORNAME_DOMAIN "psModule.src." + +//~Start #define PS_ERRORTEXT_$1 "$2" +#define PS_ERRORTEXT_pmMaskBadPixels_NULL_MASK_IMAGE "Null not allowed for mask image." +#define PS_ERRORTEXT_pmMaskBadPixels_NULL_INPUT_IMAGE "Null not allowed for input image." +#define PS_ERRORTEXT_pmMaskBadPixels_SIZE_INPUT_IMAGE "Input image size exceeds that of mask image: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmMaskBadPixels_SIZE_MASK_IMAGE "Input image mask size exceeds that of mask image: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmMaskBadPixels_OFFSET_MASK_IMAGE "Total offset >= mask image: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmMaskBadPixels_OFFSET_INPUT_IMAGE "Total offset >= input image: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmMaskBadPixels_OFFSET_INPUT_IMAGE_MASK "Total offset >= input image mask: (%d, %d) vs (%d, %d)" +#define PS_ERRORTEXT_pmMaskBadPixels_TYPE_INPUT_IMAGE "Complex types not allowed for input image. Type: %d" +#define PS_ERRORTEXT_pmMaskBadPixels_TYPE_MASK_IMAGE "Mask must be PS_TYPE_MASK type. Type: %d" +#define PS_ERRORTEXT_pmMaskBadPixels_TYPE_MISMATCH "Input and flat image types differ: (%d vs %d)" +#define PS_ERRORTEXT_pmMaskBadPixels_TYPE_UNSUPPORTED "Unsupported image datatype. Type: %d" +//~End + +#endif Index: /trunk/psModules/src/psTest.c =================================================================== --- /trunk/psModules/src/psTest.c (revision 1876) +++ /trunk/psModules/src/psTest.c (revision 1876) @@ -0,0 +1,244 @@ +// +// C Implementation: psTest +// +// Description: +// +// +// Author: Robert DeSonia , (C) 2004 +// +// Copyright: See COPYING file that comes with this distribution +// +// + + +#include +#include +#include +#include +#include + +#include "psTest.h" +#include "psMemory.h" +#include "psError.h" +#include "psTrace.h" + +#define HEADER_TOP "/***************************** TESTPOINT ******************************************\\\n" +#define HEADER_LINE_STRING "* %20s: %-58s *\n" +#define HEADER_LINE_INT "* %20s: %-58d *\n" +#define HEADER_BOTTOM "\\**********************************************************************************/\n\n" + +bool p_runTestSuite( FILE *fp, const char* testPointFile, const char* packageName, + testDescription tests[], int argc, char * const argv[] ) +{ + bool success = true; + bool runAll = true; + bool useFork = true; + bool found; + int c; + int n; + extern char *optarg; + + if ( argc > 0 ) { + while ( ( c = getopt( argc, argv, "lhn:dt:" ) ) != -1 ) { + switch ( c ) { + case 'h': + printf( "Usage: %s [-l] [-d] [-h] [-n=Testpoint#] [-t=TestpointName]\n" + " where:\n" + " -l : lists the testpoints contained in this test driver executable\n" + " -d : turns on debugger-friendly mode (no forking, aborts/signals are not handled)\n" + " -h : prints this help\n" + " -n : specifies a particular testpoint by number to run\n" + " -t : specifies a particular testpoint by name to run\n" + " (if no -l, -n or -t options are given, all testpoints are run)\n", + argv[ 0 ] ); + runAll = false; + break; + case 'd': + useFork = false; + break; + case 'l': + printf( "Test Driver: %s\n", testPointFile ); + printf( "Package Name: %s\n", packageName ); + printf( "Testpoints:\n" ); + runAll = false; + for ( int index = 0; tests[ index ].fcn != NULL; index++ ) { + printf( " %6d - %s \n", tests[ index ].testPointNumber, + tests[ index ].testPointName ); + } + printf( "\n" ); + break; + case 't': + runAll = false; + for ( int index = 0; tests[ index ].fcn != NULL; index++ ) { + if ( strcmp( optarg, tests[ index ].testPointName ) == 0 ) { + success = p_runTest( fp, + testPointFile, + packageName, + tests[ index ].testPointName, + tests[ index ].fcn, + tests[ index ].expectedReturn, + useFork ) && success; + } + } + break; + case 'n': + runAll = false; + if ( sscanf( optarg, "%i", &n ) != 1 ) { + psError( __func__, "Failed to parse the testpoint number (%s).", + optarg ); + break; + } + found = false; + for ( int index = 0; tests[ index ].fcn != NULL; index++ ) { + if ( n == tests[ index ].testPointNumber ) { + found = true; + success = p_runTest( fp, + testPointFile, + packageName, + tests[ index ].testPointName, + tests[ index ].fcn, + tests[ index ].expectedReturn, + useFork ) && success; + } + } + if ( ! found ) { + psError( __func__, "The specified testpoint number (%d) doesn't exist in this test driver.", + n ); + break; + } + break; + case '?': + psError( __func__, "Option %s is not recognized and is ignored.", optarg ); + break; + } + } + } + + if ( runAll ) { + for ( int index = 0; tests[ index ].fcn != NULL; index++ ) { + if ( ! tests[ index ].isDuplicateEntry ) { + success = p_runTest( fp, + testPointFile, + packageName, + tests[ index ].testPointName, + tests[ index ].fcn, + tests[ index ].expectedReturn, + useFork ) && success; + } + } + } + + if ( ! success ) { + psError( testPointFile, "One or more tests failed" ); + } + + return success; +} + +bool p_runTest( FILE *fp, const char* testPointFile, const char* packageName, const char* testPointName, + testFcn fcn, int expectedReturn, bool useFork ) +{ + int childReturn = 0; + pid_t child; + + p_printPositiveTestHeader( fp, testPointFile, packageName, testPointName ); + + if ( useFork ) { + child = fork(); + if ( child == 0 ) { // I am the child process, run the test + int currentId = psMemGetId(); + int retVal = fcn(); + if ( retVal == 0 ) { // only bother checking memory if test executed to end. + if ( psMemCheckLeaks( currentId, NULL, stderr ) != 0 ) { + psError( __func__, "Memory Leaks Detected" ); + retVal = 64; + } + psMemCheckCorruption( 1 ); + } + exit( retVal ); + } else + if ( child < 0 ) { + fprintf( fp, "Couldn't fork a process to run a negative test (%s|%s)", + packageName, testPointName ); + abort(); + } + + waitpid( child, &childReturn, 0 ); + if ( WIFSIGNALED( childReturn ) ) { + childReturn = -WTERMSIG( childReturn ); + } else { + childReturn = WEXITSTATUS( childReturn ); + } + } else { + int currentId = psMemGetId(); + childReturn = fcn(); + if ( childReturn == 0 ) { // only bother checking memory if test executed to end. + if ( psMemCheckLeaks( currentId, NULL, stderr ) != 0 ) { + psError( __func__, "Memory Leaks Detected" ); + childReturn = 64; + } + psMemCheckCorruption( 1 ); + } + } + + + if ( childReturn != expectedReturn ) { + fprintf( fp, "Return value mismatch: expected %d, got %d", + expectedReturn, childReturn ); + } + + p_printFooter( fp, testPointFile, packageName, testPointName, + ( childReturn == expectedReturn ) ); + + return ( childReturn == expectedReturn ); +} + +void p_printPositiveTestHeader( FILE *fp, + const char* testPointFile, + const char* packageName, + const char* testPointName ) +{ + char TP[ 80 ]; + + snprintf( TP, 80, "%s{%s}", packageName, testPointName ); + + fprintf( fp, HEADER_TOP ); + fprintf( fp, HEADER_LINE_STRING, "TestFile", testPointFile ); + fprintf( fp, HEADER_LINE_STRING, "TestPoint", TP ); + fprintf( fp, HEADER_LINE_STRING, "TestType", "Positive" ); + fprintf( fp, HEADER_BOTTOM ); +} + +void p_printNegativeTestHeader( FILE *fp, + const char* testPointFile, + const char* packageName, + const char* testPointName, + const char* expectedError, + int exitValue ) +{ + char TP[ 80 ]; + + snprintf( TP, 80, "%s{%s}", packageName, testPointName ); + + fprintf( fp, HEADER_TOP ); + fprintf( fp, HEADER_LINE_STRING, "TestFile", testPointFile ); + fprintf( fp, HEADER_LINE_STRING, "TestPoint", TP ); + fprintf( fp, HEADER_LINE_STRING, "TestType", "Negative" ); + fprintf( fp, HEADER_LINE_STRING, "ExpectedErrorText", expectedError ); + fprintf( fp, HEADER_LINE_INT, "ExpectedStatusValue", exitValue ); + fprintf( fp, HEADER_BOTTOM ); +} + + +void p_printFooter( FILE *fp, + const char* testPointFile, + const char* packageName, + const char* testPointName, + bool success ) +{ + if ( success ) { + fprintf( fp, "\n---> TESTPOINT PASSED (%s{%s} | %s)\n\n", packageName, testPointName, testPointFile ); + } else { + fprintf( fp, "\n---> TESTPOINT FAILED (%s{%s} | %s)\n\n", packageName, testPointName, testPointFile ); + } +} Index: /trunk/psModules/src/psTest.h =================================================================== --- /trunk/psModules/src/psTest.h (revision 1876) +++ /trunk/psModules/src/psTest.h (revision 1876) @@ -0,0 +1,81 @@ + +#ifndef PSTEST_H +#define PSTEST_H + +#include +#include + +#define printPositiveTestHeader(filePtr, packageName, testPointName) \ +p_printPositiveTestHeader(filePtr, __FILE__, packageName, testPointName) + +#define printNegativeTestHeader(filePtr, packageName, testPointName, expectedError, exitValue) \ +p_printNegativeTestHeader(filePtr, __FILE__, packageName, testPointName, expectedError, exitValue) + +#define printFooter(filePtr, packageName, testPointName, success) \ +p_printFooter(filePtr, __FILE__, packageName, testPointName, success) + +typedef int (*testFcn)(void); + +typedef struct +{ + testFcn fcn; + int testPointNumber; + const char* testPointName; + int expectedReturn; + bool isDuplicateEntry; +} +testDescription; + +#define runTest(filePtr, packageName, testPointName, fcn, expectedReturn, useFork) \ +p_runTest(filePtr, __FILE__, packageName, testPointName, fcn, expectedReturn, useFork) + +#define runTestSuite(filePtr, packageName, tests, argc, argv) \ +p_runTestSuite(filePtr, __FILE__, packageName, tests, argc, argv) + + +/////////////////////////// PRIVATE FUNCTIONS ////////////////////////////// + +bool p_runTest( + FILE *fp, + const char* testPointFile, + const char* packageName, + const char* testPointName, + testFcn fcn, + int expectedReturn, + bool useFork +); + +bool p_runTestSuite( + FILE *fp, + const char* testPointFile, + const char* packageName, + testDescription tests[], + int argc, + char * const argv[] +); + +void p_printPositiveTestHeader( + FILE *fp, + const char* testPointFile, + const char* packageName, + const char* testPointName +); + +void p_printNegativeTestHeader( + FILE *fp, + const char* testPointFile, + const char* packageName, + const char* testPointName, + const char* expectedError, + int exitValue +); + +void p_printFooter( + FILE *fp, + const char* testPointFile, + const char* packageName, + const char* testPointName, + bool success +); + +#endif