Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

182 lines (150 sloc) 5.459 kb
//
// GHTest.h
// GHKit
//
// Created by Gabriel Handford on 1/18/09.
// Copyright 2009. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
/*!
Test status.
*/
typedef enum {
GHTestStatusNone = 0,
GHTestStatusRunning, // Test is running
GHTestStatusCancelling, // Test is being cancelled
GHTestStatusCancelled, // Test was cancelled
GHTestStatusSucceeded, // Test finished and succeeded
GHTestStatusErrored, // Test finished and errored
} GHTestStatus;
enum {
GHTestOptionReraiseExceptions = 1 << 0, // Allows exceptions to be raised (so you can trigger the debugger)
GHTestOptionForceSetUpTearDownClass = 1 << 1, // Runs setUpClass/tearDownClass for this (each) test; Used when re-running a single test in a group
};
typedef NSInteger GHTestOptions;
/*!
Generate string from GHTestStatus
@param status
*/
extern NSString* NSStringFromGHTestStatus(GHTestStatus status);
/*!
Check if test is running (or trying to cancel).
*/
extern BOOL GHTestStatusIsRunning(GHTestStatus status);
/*!
Check if test has succeeded, errored or cancelled.
*/
extern BOOL GHTestStatusEnded(GHTestStatus status);
/*!
Test stats.
*/
typedef struct {
NSInteger succeedCount; // Number of succeeded tests
NSInteger failureCount; // Number of failed tests
NSInteger cancelCount; // Number of aborted tests
NSInteger testCount; // Total number of tests
} GHTestStats;
/*!
Create GHTestStats.
*/
extern GHTestStats GHTestStatsMake(NSInteger succeedCount, NSInteger failureCount, NSInteger cancelCount, NSInteger testCount);
extern const GHTestStats GHTestStatsEmpty;
extern NSString *NSStringFromGHTestStats(GHTestStats stats);
@protocol GHTestDelegate;
/*!
The base interface for a runnable test.
A runnable with a unique identifier, display name, stats, timer, delegate, log and error handling.
*/
@protocol GHTest <NSObject, NSCoding, NSCopying>
- (void)run:(GHTestOptions)options;
@property (readonly, nonatomic) NSString *identifier; // Unique identifier for test
@property (readonly, nonatomic) NSString *name;
@property (assign, nonatomic) NSTimeInterval interval;
@property (assign, nonatomic) GHTestStatus status;
@property (readonly, nonatomic) GHTestStats stats;
@property (retain, nonatomic) NSException *exception;
@property (assign, nonatomic, getter=isDisabled) BOOL disabled;
@property (assign, nonatomic, getter=isHidden) BOOL hidden;
@property (assign, nonatomic) id<GHTestDelegate> delegate; // weak
- (NSArray *)log;
- (void)reset;
- (void)cancel;
- (NSInteger)disabledCount;
@end
/*!
Test delegate for notification when a test starts and ends.
*/
@protocol GHTestDelegate <NSObject>
- (void)testDidStart:(id<GHTest>)test source:(id<GHTest>)source;
- (void)testDidUpdate:(id<GHTest>)test source:(id<GHTest>)source;
- (void)testDidEnd:(id<GHTest>)test source:(id<GHTest>)source;
- (void)test:(id<GHTest>)test didLog:(NSString *)message source:(id<GHTest>)source;
@end
/*!
Delegate which is notified of log messages from inside GHTestCase.
*/
@protocol GHTestCaseLogWriter <NSObject>
- (void)log:(NSString *)message testCase:(id)testCase;
@end
/*!
Default test implementation with a target/selector pair.
- Tests a target and selector
- Notifies a test delegate
- Keeps track of status, running time and failures
- Stores any test specific logging
*/
@interface GHTest : NSObject <GHTest, GHTestCaseLogWriter> {
NSObject<GHTestDelegate> *delegate_; // weak
id target_;
SEL selector_;
NSString *identifier_;
NSString *name_;
GHTestStatus status_;
NSTimeInterval interval_;
BOOL disabled_;
BOOL hidden_;
NSException *exception_; // If failed
NSMutableArray *log_;
}
@property (readonly, nonatomic) id target;
@property (readonly, nonatomic) SEL selector;
@property (readonly, nonatomic) NSArray *log;
/*!
Create test with identifier, name.
@param identifier Unique identifier
@param name Name
*/
- (id)initWithIdentifier:(NSString *)identifier name:(NSString *)name;
/*!
Create test with target/selector.
@param target Target (usually a test case)
@param selector Selector (usually a test method)
*/
- (id)initWithTarget:(id)target selector:(SEL)selector;
/*!
Create autoreleased test with target/selector.
@param target Target (usually a test case)
@param selector Selector (usually a test method)
*/
+ (id)testWithTarget:(id)target selector:(SEL)selector;
@end
Jump to Line
Something went wrong with that request. Please try again.