GHAsyncTestCase.h
3.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
//
// GHAsyncTestCase.h
// GHUnit
//
// Created by Gabriel Handford on 4/8/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.
//
#import "GHTestCase.h"
// Some default statuses to use; Or define and use your own
enum {
kGHUnitWaitStatusUnknown = 0,
kGHUnitWaitStatusSuccess,
kGHUnitWaitStatusFailure,
kGHUnitWaitStatusCancelled
};
/*!
Asynchronous test case with wait and notify.
Handles the case of notify occuring before wait has started (if it was a synchronous call).
Be sure to call prepare before the asynchronous method (otherwise an exception will raise).
@code
- (void)testSuccess {
[self prepare];
// Do asynchronous task here
[self performSelector:@selector(_succeed) withObject:nil afterDelay:0.1];
[self waitFor:kGHUnitWaitStatusSuccess timeout:1.0];
}
- (void)_succeed {
// Notice the forSelector points to the test above. This is so that
// stray notifies don't error or falsely succeed other tests.
[self notify:kGHUnitWaitStatusSuccess forSelector:@selector(testSuccess)];
}
@endcode
*/
@interface GHAsyncTestCase : GHTestCase {
NSInteger waitForStatus_;
NSInteger notifiedStatus_;
BOOL prepared_; // Whether prepared was called before waitFor:timeout:
NSRecursiveLock *lock_; // Lock to synchronize on
SEL waitSelector_; // The selector we are waiting on
NSArray *_runLoopModes; // Run loop modes to run while waiting; Defaults to NSDefaultRunLoopMode, NSRunLoopCommonModes, NSConnectionReplyMode
}
@property (retain) NSArray *runLoopModes;
/*!
Prepare before calling the asynchronous method.
*/
- (void)prepare;
/*!
Prepare and specify the selector we will use in notify.
@param selector
*/
- (void)prepare:(SEL)selector;
/*!
Wait for notification of status or timeout.
Be sure to prepare before calling your asynchronous method.
For example,
@code
- (void)testFoo {
[self prepare];
// Do asynchronous task here
[self waitFor:kGHUnitWaitStatusSuccess timeout:1.0];
}
@endcode
@param status kGHUnitWaitStatusSuccess, kGHUnitWaitStatusFailure or custom status
@param timeout Timeout in seconds
*/
- (void)waitFor:(NSInteger)status timeout:(NSTimeInterval)timeout;
/*!
Wait for timeout to occur.
Fails if we did _NOT_ timeout.
@param timeout
*/
- (void)waitForTimeout:(NSTimeInterval)timeout;
/*!
Notify of status for test selector.
@param status For example, kGHUnitWaitStatusSuccess
@param selector If not NULL, then will verify this selector is where we are waiting.
This prevents stray asynchronous callbacks to fail a later test
*/
- (void)notify:(NSInteger)status forSelector:(SEL)selector;
@end