//

//  Test.m

//  MYUtilities

//

//  Created by Jens Alfke on 1/5/08.

//  Copyright 2008 Jens Alfke. All rights reserved.

//

#import "Test.h"

#import <unistd.h>

#if DEBUG

struct TestCaseLink *gAllTestCases;

static int sPassed, sFailed;

static BOOL RunTestCase( struct TestCaseLink *test )

{

    if( test->testptr ) {

        NSAutoreleasePool *pool = [NSAutoreleasePool new];

        Log(@"=== Testing %s ...",test->name);

        @try{

            test->testptr();

            Log(@"√√√ %s passed\n\n",test->name);

            test->passed = YES;

            sPassed++;

        }@catch( NSException *x ) {

            if( [x.name isEqualToString: @"TestCaseSkipped"] )

                Log(@"... skipping test %s since %@\n\n", test->name, x.reason);

            else {

                Log(@"XXX FAILED test case '%s' due to:\nException: %@\n%@\n\n", 

                      test->name,x,x.my_callStack);

                sFailed++;

            }

        }@finally{

            [pool drain];

            test->testptr = NULL;       // prevents test from being run again

        }

    }

    return test->passed;

}

static BOOL RunTestCaseNamed( const char *name )

{

    for( struct TestCaseLink *test = gAllTestCases; test; test=test->next )

        if( strcmp(name,test->name)==0 ) {

            return RunTestCase(test);

        }

    Log(@"... WARNING: Could not find test case named '%s'\n\n",name);

    return NO;

}

void _RequireTestCase( const char *name )

{

    if( ! RunTestCaseNamed(name) ) {

        [NSException raise: @"TestCaseSkipped" 

                    format: @"prerequisite %s failed", name];

    }

}

void RunTestCases( int argc, const char **argv )

{

    gShouldLog = YES;

    sPassed = sFailed = 0;

    BOOL stopAfterTests = NO;

    for( int i=1; i<argc; i++ ) {

        const char *arg = argv[i];

        if( strncmp(arg,"Test_",5)==0 ) {

            arg += 5;

            if( strcmp(arg,"Only")==0 )

                stopAfterTests = YES;

            else if( strcmp(arg,"All") == 0 ) {

                for( struct TestCaseLink *link = gAllTestCases; link; link=link->next )

                    RunTestCase(link);

            } else {

                RunTestCaseNamed(arg);

            }

        }

    }

    if( sPassed>0 || sFailed>0 || stopAfterTests ) {

        if( sFailed==0 )

            Log(@"√√√√√√ ALL %i TESTS PASSED √√√√√√", sPassed);

        else {

            Log(@"****** %i TESTS FAILED, %i PASSED ******", sFailed,sPassed);

            exit(1);

        }

        if( stopAfterTests ) {

            Log(@"Stopping after tests ('Test_Only' arg detected)");

            exit(0);

        }

    }

}

#endif DEBUG

#pragma mark -

#pragma mark ASSERTION FAILURE HANDLER:

void _AssertFailed( id rcvr, const char *selOrFn, const char *sourceFile, int sourceLine,

                    const char *condString, NSString *message, ... )

{

    if( message ) {

        va_list args;

        va_start(args,message);

        message = [[[NSString alloc] initWithFormat: message arguments: args] autorelease];

        va_end(args);

    } else

        message = [NSString stringWithUTF8String: condString];

    if( rcvr )

        [[NSAssertionHandler currentHandler] handleFailureInMethod: (SEL)selOrFn

                                                            object: rcvr 

                                                              file: [NSString stringWithUTF8String: sourceFile]

                                                        lineNumber: sourceLine 

                                                       description: @"%@", message];

    else

        [[NSAssertionHandler currentHandler] handleFailureInFunction: [NSString stringWithUTF8String:selOrFn]

                                                                file: [NSString stringWithUTF8String: sourceFile]

                                                          lineNumber: sourceLine 

                                                         description: @"%@", message];

    abort(); // unreachable, but appeases compiler

}

#pragma mark -

#pragma mark EXCEPTION BACKTRACES:

@implementation NSException (MooseyardUtil)

- (NSArray*) my_callStackReturnAddresses

{

    // On 10.5 or later, can get the backtrace:

    if( [self respondsToSelector: @selector(callStackReturnAddresses)] )

        return [self valueForKey: @"callStackReturnAddresses"];

    else

        return nil;

}

- (NSArray*) my_callStackReturnAddressesSkipping: (unsigned)skip limit: (unsigned)limit

{

    NSArray *addresses = [self my_callStackReturnAddresses];

    if( addresses ) {

        unsigned n = [addresses count];

        skip = MIN(skip,n);

        limit = MIN(limit,n-skip);

        addresses = [addresses subarrayWithRange: NSMakeRange(skip,limit)];

    }

    return addresses;

}

- (NSString*) my_callStack

{

    NSArray *addresses = [self my_callStackReturnAddressesSkipping: 2 limit: 15];

    if (!addresses)

        return nil;

    // We pipe the hex return addresses through the 'atos' tool to get symbolic names:

    // Adapted from <http://paste.lisp.org/display/47196>:

    NSMutableString *cmd = [NSMutableString stringWithFormat: @"/usr/bin/atos -p %d", getpid()];

    NSValue *addr;

    foreach(addr,addresses) {

        [cmd appendFormat: @" %p", [addr pointerValue]];

    }

    FILE *file = popen( [cmd UTF8String], "r" );

    if( ! file )

        return nil;

    NSMutableData *output = [NSMutableData data];

    char buffer[512];

    size_t length;

    while ((length = fread( buffer, 1, sizeof( buffer ), file ) ))

        [output appendBytes: buffer length: length];

    pclose( file );

    NSString *outStr = [[[NSString alloc] initWithData: output encoding: NSUTF8StringEncoding] autorelease];

    NSMutableString *result = [NSMutableString string];

    NSString *line;

    foreach( line, [outStr componentsSeparatedByString: @"\n"] ) {

        // Skip  frames that are part of the exception/assertion handling itself:

        if( [line hasPrefix: @"-[NSAssertionHandler"] || [line hasPrefix: @"+[NSException"] 

                || [line hasPrefix: @"-[NSException"] || [line hasPrefix: @"_AssertFailed"] )

            continue;

        if( result.length )

            [result appendString: @"\n"];

        [result appendString: @"\t"];

        [result appendString: line];

        // Don't show the "__start" frame below "main":

        if( [line hasPrefix: @"main "] )

            break;

    }

    return result;

}

@end