TeamCity Adapter for SenTestingKit/OCUnit

TeamCityAdapter.m

//
//  TeamCityAdadpter.m
//  Created by Johannes Rudolph on 27.05.11.

// Use of this source code is governed by the following license:
// 
// Redistribution and use in source and binary forms, with or without modification, 
// are permitted provided that the following conditions are met:
// 
// (1) Redistributions of source code must retain the above copyright notice, 
// this list of conditions and the following disclaimer.
// 
// (2) Redistributions in binary form must reproduce the above copyright notice, 
// this list of conditions and the following disclaimer in the documentation 
// and/or other materials provided with the distribution.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' 
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
// IN NO EVENT SHALL Sente SA OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
// OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// Note: this license is equivalent to the FreeBSD license.

#import <Foundation/Foundation.h>
#import <SenTestingKit/SenTestingKit.h>

@interface TeamCityAdapter : SenTestObserver
{
}

+ (void) testSuiteDidStart:(NSNotification *) aNotification;
+ (void) testSuiteDidStop:(NSNotification *) aNotification;

+ (void) testCaseDidStart:(NSNotification *) aNotification;
+ (void) testCaseDidStop:(NSNotification *) aNotification;

+ (void) testCaseDidFail:(NSNotification *) aNotification;

@end

static void testlog (NSString *message)
{
	NSString *line = [NSString stringWithFormat:@"%@\n", message];
	[(NSFileHandle *)[NSFileHandle fileHandleWithStandardOutput] writeData:[line dataUsingEncoding:NSUTF8StringEncoding]];
}

static NSString* escapeForTeamcity (NSString *raw)
{
    raw = [raw stringByReplacingOccurrencesOfString:@"|" withString:@"||"];
    raw = [raw stringByReplacingOccurrencesOfString:@"'" withString:@"|'"];
    raw = [raw stringByReplacingOccurrencesOfString:@"\n" withString:@"|n"];
    raw = [raw stringByReplacingOccurrencesOfString:@"\r" withString:@"|r"];
    raw = [raw stringByReplacingOccurrencesOfString:@"[" withString:@"|["];
    raw = [raw stringByReplacingOccurrencesOfString:@"]" withString:@"|]"];
    
    return raw;
}

static NSString* teamCityTestName (NSString *raw)
{
    raw = [raw stringByReplacingOccurrencesOfString:@" " withString:@"."]; 
    return escapeForTeamcity(raw);
}


@implementation TeamCityAdapter

+(void)initialize
{
    if ([self class] == [TeamCityAdapter class])
    {
        [[NSUserDefaults standardUserDefaults] setValue:@"TeamCityAdapter" forKey:@"SenTestObserverClass"];
        // we need to force SenTestObserver to register us as a handler
        // SenTestObserver is properly guarding against this invocation so nothing bad will hapen
        // but this is required (bad design on SenTestObserver's side)...
        [super initialize];
    }    
}

+ (void) testSuiteDidStart:(NSNotification *)aNotification
{

    NSString* suiteName = [aNotification.test.name hasPrefix:@"/"] ? [aNotification.test.name lastPathComponent] : aNotification.test.name;
    
    if (![suiteName hasSuffix:@".octest(Tests)"])                            
         return;
    
    testlog([NSString stringWithFormat:@"##teamcity[testSuiteStarted name='%@']", escapeForTeamcity(suiteName)]);
}

+ (void) testSuiteDidStop:(NSNotification *)aNotification
{
    NSString* suiteName = [aNotification.test.name hasPrefix:@"/"] ? [aNotification.test.name lastPathComponent] : aNotification.test.name;
    
    if (![suiteName hasSuffix:@".octest(Tests)"])                            
        return;
         
    testlog([NSString stringWithFormat:@"##teamcity[testSuiteFinished name='%@']", escapeForTeamcity(suiteName)]);
}

+ (void) testCaseDidStart:(NSNotification *)aNotification
{   
    testlog([NSString stringWithFormat:@"##teamcity[testStarted name='%@' captureStandardOutput='true']", teamCityTestName(aNotification.test.name)]);
}

+ (void) testCaseDidStop:(NSNotification *)aNotification
{
    testlog([NSString stringWithFormat:@"##teamcity[testFinished name='%@' duration='%f']", teamCityTestName(aNotification.test.name), aNotification.run.testDuration]);
}

+ (void) testCaseDidFail:(NSNotification *)aNotification
{
    testlog([NSString stringWithFormat:@"##teamcity[testFailed name='%@' message='%@' details='%@']",
             teamCityTestName(aNotification.test.name), 
             escapeForTeamcity([[aNotification exception] description]), 
             @""]);
}

@end

Now with propert suite/test separation (ocunit treats each class as a suite). Could use some prettier formatting and symbolic stack traces, but it's good enough for now.

Improved escaping of strings.

Wow, this looks awesome - I'll definitively give it a try! Is this a standalone class that just needs to be dropped into the project?
Edit: just found out how to set the observer in the plist.