blob: b8cf4231e4d3b64d4cbc21bef4fac21ce15d639a [file] [log] [blame]
stuartmorgan4733f552015-02-14 22:19:301// Copyright 2014 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#import "base/ios/crb_protocol_observers.h"
6#include "base/ios/weak_nsobject.h"
justincohen5a862992015-06-10 17:38:167#include "base/logging.h"
stuartmorgan4733f552015-02-14 22:19:308#include "base/mac/scoped_nsautorelease_pool.h"
9#include "base/mac/scoped_nsobject.h"
10#include "testing/gtest/include/gtest/gtest.h"
11#include "testing/gtest_mac.h"
12#include "testing/platform_test.h"
13
14@protocol TestObserver
15
16@required
17- (void)requiredMethod;
18- (void)reset;
19
20@optional
21- (void)optionalMethod;
jbbegue12d50e72015-06-05 08:12:4322- (void)mutateByAddingObserver:(id<TestObserver>)observer;
23- (void)mutateByRemovingObserver:(id<TestObserver>)observer;
24- (void)nestedMutateByAddingObserver:(id<TestObserver>)observer;
25- (void)nestedMutateByRemovingObserver:(id<TestObserver>)observer;
stuartmorgan4733f552015-02-14 22:19:3026
27@end
28
29// Implements only the required methods in the TestObserver protocol.
30@interface TestPartialObserver : NSObject<TestObserver>
31@property(nonatomic, readonly) BOOL requiredMethodInvoked;
32@end
33
34// Implements all the methods in the TestObserver protocol.
35@interface TestCompleteObserver : TestPartialObserver<TestObserver>
36@property(nonatomic, readonly) BOOL optionalMethodInvoked;
37@end
38
jbbegue12d50e72015-06-05 08:12:4339@interface TestMutateObserver : TestCompleteObserver
jbbegue12d50e72015-06-05 08:12:4340- (instancetype)initWithObserver:(CRBProtocolObservers*)observer
41 NS_DESIGNATED_INITIALIZER;
justincohen5a862992015-06-10 17:38:1642- (instancetype)init NS_UNAVAILABLE;
jbbegue12d50e72015-06-05 08:12:4343@end
44
stuartmorgan4733f552015-02-14 22:19:3045namespace {
46
47class CRBProtocolObserversTest : public PlatformTest {
48 public:
49 CRBProtocolObserversTest() {}
50
51 protected:
52 void SetUp() override {
53 PlatformTest::SetUp();
54
55 observers_.reset([[CRBProtocolObservers observersWithProtocol:
56 @protocol(TestObserver)] retain]);
57
58 partial_observer_.reset([[TestPartialObserver alloc] init]);
59 EXPECT_FALSE([partial_observer_ requiredMethodInvoked]);
60
61 complete_observer_.reset([[TestCompleteObserver alloc] init]);
62 EXPECT_FALSE([complete_observer_ requiredMethodInvoked]);
63 EXPECT_FALSE([complete_observer_ optionalMethodInvoked]);
jbbegue12d50e72015-06-05 08:12:4364
65 mutate_observer_.reset(
66 [[TestMutateObserver alloc] initWithObserver:observers_.get()]);
67 EXPECT_FALSE([mutate_observer_ requiredMethodInvoked]);
stuartmorgan4733f552015-02-14 22:19:3068 }
69
70 base::scoped_nsobject<id> observers_;
71 base::scoped_nsobject<TestPartialObserver> partial_observer_;
72 base::scoped_nsobject<TestCompleteObserver> complete_observer_;
jbbegue12d50e72015-06-05 08:12:4373 base::scoped_nsobject<TestMutateObserver> mutate_observer_;
stuartmorgan4733f552015-02-14 22:19:3074};
75
76// Verifies basic functionality of -[CRBProtocolObservers addObserver:] and
77// -[CRBProtocolObservers removeObserver:].
78TEST_F(CRBProtocolObserversTest, AddRemoveObserver) {
79 // Add an observer and verify that the CRBProtocolObservers instance forwards
80 // an invocation to it.
81 [observers_ addObserver:partial_observer_];
82 [observers_ requiredMethod];
83 EXPECT_TRUE([partial_observer_ requiredMethodInvoked]);
84
85 [partial_observer_ reset];
86 EXPECT_FALSE([partial_observer_ requiredMethodInvoked]);
87
88 // Remove the observer and verify that the CRBProtocolObservers instance no
89 // longer forwards an invocation to it.
90 [observers_ removeObserver:partial_observer_];
91 [observers_ requiredMethod];
92 EXPECT_FALSE([partial_observer_ requiredMethodInvoked]);
93}
94
95// Verifies that CRBProtocolObservers correctly forwards the invocation of a
96// required method in the protocol.
97TEST_F(CRBProtocolObserversTest, RequiredMethods) {
98 [observers_ addObserver:partial_observer_];
99 [observers_ addObserver:complete_observer_];
100 [observers_ requiredMethod];
101 EXPECT_TRUE([partial_observer_ requiredMethodInvoked]);
102 EXPECT_TRUE([complete_observer_ requiredMethodInvoked]);
103}
104
105// Verifies that CRBProtocolObservers correctly forwards the invocation of an
106// optional method in the protocol.
107TEST_F(CRBProtocolObserversTest, OptionalMethods) {
108 [observers_ addObserver:partial_observer_];
109 [observers_ addObserver:complete_observer_];
110 [observers_ optionalMethod];
111 EXPECT_FALSE([partial_observer_ requiredMethodInvoked]);
112 EXPECT_FALSE([complete_observer_ requiredMethodInvoked]);
113 EXPECT_TRUE([complete_observer_ optionalMethodInvoked]);
114}
115
116// Verifies that CRBProtocolObservers only holds a weak reference to an
117// observer.
118TEST_F(CRBProtocolObserversTest, WeakReference) {
119 base::WeakNSObject<TestPartialObserver> weak_observer(
120 partial_observer_);
121 EXPECT_TRUE(weak_observer);
122
123 [observers_ addObserver:partial_observer_];
124
125 {
126 // Need an autorelease pool here, because
127 // -[CRBProtocolObservers forwardInvocation:] creates a temporary
128 // autoreleased array that holds all the observers.
129 base::mac::ScopedNSAutoreleasePool pool;
130 [observers_ requiredMethod];
131 EXPECT_TRUE([partial_observer_ requiredMethodInvoked]);
132 }
133
134 partial_observer_.reset();
135 EXPECT_FALSE(weak_observer.get());
136}
137
jbbegue12d50e72015-06-05 08:12:43138// Verifies that an observer can safely remove itself as observer while being
139// notified.
140TEST_F(CRBProtocolObserversTest, SelfMutateObservers) {
141 [observers_ addObserver:mutate_observer_];
142 EXPECT_FALSE([observers_ empty]);
143
144 [observers_ requiredMethod];
145 EXPECT_TRUE([mutate_observer_ requiredMethodInvoked]);
146
147 [mutate_observer_ reset];
148
149 [observers_ nestedMutateByRemovingObserver:mutate_observer_];
150 EXPECT_FALSE([mutate_observer_ requiredMethodInvoked]);
151
152 [observers_ addObserver:partial_observer_];
153
154 [observers_ requiredMethod];
155 EXPECT_FALSE([mutate_observer_ requiredMethodInvoked]);
156 EXPECT_TRUE([partial_observer_ requiredMethodInvoked]);
157
158 [observers_ removeObserver:partial_observer_];
159 EXPECT_TRUE([observers_ empty]);
160}
161
162// Verifies that - [CRBProtocolObservers addObserver:] and
163// - [CRBProtocolObservers removeObserver:] can be called while methods are
164// being forwarded.
165TEST_F(CRBProtocolObserversTest, MutateObservers) {
166 // Indirectly add an observer while forwarding an observer method.
167 [observers_ addObserver:mutate_observer_];
168
169 [observers_ mutateByAddingObserver:partial_observer_];
170 EXPECT_FALSE([partial_observer_ requiredMethodInvoked]);
171
172 // Check that methods are correctly forwared to the indirectly added observer.
173 [mutate_observer_ reset];
174 [observers_ requiredMethod];
175 EXPECT_TRUE([mutate_observer_ requiredMethodInvoked]);
176 EXPECT_TRUE([partial_observer_ requiredMethodInvoked]);
177
178 [mutate_observer_ reset];
179 [partial_observer_ reset];
180
181 // Indirectly remove an observer while forwarding an observer method.
182 [observers_ mutateByRemovingObserver:partial_observer_];
183
184 // Check that method is not forwared to the indirectly removed observer.
185 [observers_ requiredMethod];
186 EXPECT_TRUE([mutate_observer_ requiredMethodInvoked]);
187 EXPECT_FALSE([partial_observer_ requiredMethodInvoked]);
188}
189
190// Verifies that - [CRBProtocolObservers addObserver:] and
191// - [CRBProtocolObservers removeObserver:] can be called while methods are
192// being forwarded with a nested invocation depth > 0.
193TEST_F(CRBProtocolObserversTest, NestedMutateObservers) {
194 // Indirectly add an observer while forwarding an observer method.
195 [observers_ addObserver:mutate_observer_];
196
197 [observers_ nestedMutateByAddingObserver:partial_observer_];
198 EXPECT_FALSE([partial_observer_ requiredMethodInvoked]);
199
200 // Check that methods are correctly forwared to the indirectly added observer.
201 [mutate_observer_ reset];
202 [observers_ requiredMethod];
203 EXPECT_TRUE([mutate_observer_ requiredMethodInvoked]);
204 EXPECT_TRUE([partial_observer_ requiredMethodInvoked]);
205
206 [mutate_observer_ reset];
207 [partial_observer_ reset];
208
209 // Indirectly remove an observer while forwarding an observer method.
210 [observers_ nestedMutateByRemovingObserver:partial_observer_];
211
212 // Check that method is not forwared to the indirectly removed observer.
213 [observers_ requiredMethod];
214 EXPECT_TRUE([mutate_observer_ requiredMethodInvoked]);
215 EXPECT_FALSE([partial_observer_ requiredMethodInvoked]);
216}
217
stuartmorgan4733f552015-02-14 22:19:30218} // namespace
219
220@implementation TestPartialObserver {
221 BOOL _requiredMethodInvoked;
222}
223
224- (BOOL)requiredMethodInvoked {
225 return _requiredMethodInvoked;
226}
227
228- (void)requiredMethod {
229 _requiredMethodInvoked = YES;
230}
231
232- (void)reset {
233 _requiredMethodInvoked = NO;
234}
235
236@end
237
238@implementation TestCompleteObserver {
239 BOOL _optionalMethodInvoked;
240}
241
242- (BOOL)optionalMethodInvoked {
243 return _optionalMethodInvoked;
244}
245
246- (void)optionalMethod {
247 _optionalMethodInvoked = YES;
248}
249
250- (void)reset {
251 [super reset];
252 _optionalMethodInvoked = NO;
253}
254
255@end
jbbegue12d50e72015-06-05 08:12:43256
257@implementation TestMutateObserver {
258 __weak id _observers;
259}
260
261- (instancetype)initWithObserver:(CRBProtocolObservers*)observers {
262 self = [super init];
263 if (self) {
264 _observers = observers;
265 }
266 return self;
267}
268
justincohen5a862992015-06-10 17:38:16269- (instancetype)init {
270 NOTREACHED();
271 return nil;
272}
273
jbbegue12d50e72015-06-05 08:12:43274- (void)mutateByAddingObserver:(id<TestObserver>)observer {
275 [_observers addObserver:observer];
276}
277
278- (void)mutateByRemovingObserver:(id<TestObserver>)observer {
279 [_observers removeObserver:observer];
280}
281
282- (void)nestedMutateByAddingObserver:(id<TestObserver>)observer {
283 [_observers mutateByAddingObserver:observer];
284}
285
286- (void)nestedMutateByRemovingObserver:(id<TestObserver>)observer {
287 [_observers mutateByRemovingObserver:observer];
288}
289
290@end