-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
ShadowPausedLooperTest.java
511 lines (445 loc) · 17.6 KB
/
ShadowPausedLooperTest.java
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
package org.robolectric.shadows;
import static android.os.Looper.getMainLooper;
import static com.google.common.truth.Truth.assertThat;
import static java.util.concurrent.Executors.newSingleThreadExecutor;
import static java.util.concurrent.TimeUnit.SECONDS;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.timeout;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.robolectric.Shadows.shadowOf;
import static org.robolectric.shadows.ShadowLooper.shadowMainLooper;
import android.os.Handler;
import android.os.HandlerThread;
import android.os.Looper;
import android.os.MessageQueue.IdleHandler;
import android.os.SystemClock;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import java.time.Duration;
import java.util.concurrent.Callable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TestName;
import org.junit.runner.RunWith;
import org.robolectric.annotation.LooperMode;
import org.robolectric.res.android.Ref;
import org.robolectric.shadow.api.Shadow;
@RunWith(AndroidJUnit4.class)
@LooperMode(LooperMode.Mode.PAUSED)
public class ShadowPausedLooperTest {
// testName is used when creating background threads. Makes it
// easier to debug exceptions on background threads when you
// know what test they are associated with.
@Rule public TestName testName = new TestName();
private HandlerThread handlerThread;
@Before
public void createHandlerThread() {
handlerThread = new HandlerThread(testName.getMethodName());
handlerThread.start();
}
@After
public void quitHandlerThread() {
handlerThread.quit();
}
@Test
public void mainLooper_getAllLoopers_shouldContainMainAndHandlerThread() {
Looper looper = handlerThread.getLooper();
assertThat(ShadowLooper.getAllLoopers()).contains(getMainLooper());
assertThat(ShadowLooper.getAllLoopers()).contains(looper);
}
@Test
public void mainLooper_andMyLooper_shouldBeSame_onMainThread() {
assertThat(Looper.myLooper()).isSameInstanceAs(getMainLooper());
}
@Test
public void differentThreads_getDifferentLoopers() {
assertThat(handlerThread.getLooper()).isNotSameInstanceAs(getMainLooper());
handlerThread.quit();
}
@Test
public void mainLooperThread_shouldBeTestThread() {
assertThat(getMainLooper().getThread()).isSameInstanceAs(Thread.currentThread());
}
@Test(timeout = 200)
public void junitTimeoutTestRunsOnMainThread() {
assertThat(getMainLooper().getThread()).isSameInstanceAs(Thread.currentThread());
}
@Test
public void postedMainLooperTasksAreNotExecuted() {
Runnable mockRunnable = mock(Runnable.class);
Handler handler = new Handler();
handler.post(mockRunnable);
verify(mockRunnable, timeout(20).times(0)).run();
}
@Test
public void postedBackgroundLooperTasksAreExecuted() throws InterruptedException {
Runnable mockRunnable = mock(Runnable.class);
Handler handler = new Handler(handlerThread.getLooper());
handler.post(mockRunnable);
ShadowPausedLooper shadowLooper = Shadow.extract(handlerThread.getLooper());
shadowLooper.idle();
verify(mockRunnable, times(1)).run();
}
@Test
public void postedBackgroundLooperTasksWhenPaused() throws InterruptedException {
Runnable mockRunnable = mock(Runnable.class);
shadowOf(handlerThread.getLooper()).pause();
new Handler(handlerThread.getLooper()).post(mockRunnable);
verify(mockRunnable, timeout(20).times(0)).run();
assertThat(shadowOf(handlerThread.getLooper()).isIdle()).isFalse();
shadowOf(handlerThread.getLooper()).idle();
verify(mockRunnable, times(1)).run();
}
@Test
public void pause_backgroundLooper() {
assertThat(shadowOf(handlerThread.getLooper()).isPaused()).isFalse();
shadowOf(handlerThread.getLooper()).pause();
assertThat(shadowOf(handlerThread.getLooper()).isPaused()).isTrue();
shadowOf(handlerThread.getLooper()).unPause();
assertThat(shadowOf(handlerThread.getLooper()).isPaused()).isFalse();
}
@Test
public void idle_backgroundLooperExecuteInBackgroundThread() {
Ref<Thread> threadRef = new Ref<>(null);
new Handler(handlerThread.getLooper()).post(() -> threadRef.set(Thread.currentThread()));
shadowOf(handlerThread.getLooper()).idle();
assertThat(handlerThread.getLooper().getThread()).isEqualTo(threadRef.get());
assertThat(getMainLooper().getThread()).isNotEqualTo(threadRef.get());
}
@Test
public void runOneTask_backgroundLooperExecuteInBackgroundThread() {
shadowOf(handlerThread.getLooper()).pause();
Ref<Thread> threadRef = new Ref<>(null);
new Handler(handlerThread.getLooper()).post(() -> threadRef.set(Thread.currentThread()));
shadowOf(handlerThread.getLooper()).runOneTask();
assertThat(handlerThread.getLooper().getThread()).isEqualTo(threadRef.get());
assertThat(getMainLooper().getThread()).isNotEqualTo(threadRef.get());
}
@Test
public void postedDelayedBackgroundLooperTasksAreExecutedOnlyWhenSystemClockAdvanced()
throws InterruptedException {
Runnable mockRunnable = mock(Runnable.class);
new Handler(handlerThread.getLooper()).postDelayed(mockRunnable, 10);
ShadowPausedLooper shadowLooper = Shadow.extract(handlerThread.getLooper());
shadowLooper.idle();
verify(mockRunnable, times(0)).run();
SystemClock.setCurrentTimeMillis(SystemClock.uptimeMillis() + 100);
shadowLooper.idle();
verify(mockRunnable, times(1)).run();
}
@Test
public void cannotIdleMainThreadFromBackgroundThread() throws InterruptedException {
ExecutorService executorService = newSingleThreadExecutor();
Future<Boolean> result =
executorService.submit(
new Callable<Boolean>() {
@Override
public Boolean call() throws Exception {
shadowMainLooper().idle();
return true;
}
});
try {
result.get();
fail("idling main looper from background thread unexpectedly succeeded.");
} catch (InterruptedException e) {
throw e;
} catch (ExecutionException e) {
assertThat(e.getCause()).isInstanceOf(UnsupportedOperationException.class);
} finally {
executorService.shutdown();
}
}
@Test
public void idle_mainLooper() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
shadowLooper.idle();
}
@Test
public void idle_executesTask_mainLooper() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
verify(mockRunnable, times(0)).run();
shadowLooper.idle();
verify(mockRunnable, times(1)).run();
}
@Test
public void idle_executesTask_andIdleHandler() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
IdleHandler mockIdleHandler = mock(IdleHandler.class);
getMainLooper().getQueue().addIdleHandler(mockIdleHandler);
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
verify(mockRunnable, times(0)).run();
verify(mockIdleHandler, times(0)).queueIdle();
shadowLooper.idle();
verify(mockRunnable, times(1)).run();
verify(mockIdleHandler, times(1)).queueIdle();
}
@Test
public void idle_executesTask_andIdleHandler_removesIdleHandler() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
IdleHandler mockIdleHandler = mock(IdleHandler.class);
getMainLooper().getQueue().addIdleHandler(mockIdleHandler);
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
verify(mockRunnable, times(0)).run();
verify(mockIdleHandler, times(0)).queueIdle();
shadowLooper.idle();
verify(mockRunnable, times(1)).run();
verify(mockIdleHandler, times(1)).queueIdle();
mainHandler.post(mockRunnable);
shadowLooper.idle();
verify(mockRunnable, times(2)).run();
verify(mockIdleHandler, times(1)).queueIdle(); // It was not kept, does not run again.
}
@Test
public void idle_executesTask_andIdleHandler_keepsIdleHandler() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
IdleHandler mockIdleHandler = mock(IdleHandler.class);
when(mockIdleHandler.queueIdle()).thenReturn(true);
getMainLooper().getQueue().addIdleHandler(mockIdleHandler);
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
verify(mockRunnable, times(0)).run();
verify(mockIdleHandler, times(0)).queueIdle();
shadowLooper.idle();
verify(mockRunnable, times(1)).run();
verify(mockIdleHandler, times(1)).queueIdle();
mainHandler.post(mockRunnable);
shadowLooper.idle();
verify(mockRunnable, times(2)).run();
verify(mockIdleHandler, times(2)).queueIdle(); // It was kept and runs again
}
@Test
public void runOneTask_executesTask_andIdleHandler() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
IdleHandler mockIdleHandler = mock(IdleHandler.class);
getMainLooper().getQueue().addIdleHandler(mockIdleHandler);
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
verify(mockRunnable, times(0)).run();
verify(mockIdleHandler, times(0)).queueIdle();
shadowLooper.runOneTask();
verify(mockRunnable, times(1)).run();
verify(mockIdleHandler, times(1)).queueIdle();
}
@Test
public void runOneTask_executesTwoTasks_thenIdleHandler() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
IdleHandler mockIdleHandler = mock(IdleHandler.class);
getMainLooper().getQueue().addIdleHandler(mockIdleHandler);
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
mainHandler.post(mockRunnable);
verify(mockRunnable, times(0)).run();
verify(mockIdleHandler, times(0)).queueIdle();
shadowLooper.runOneTask();
verify(mockRunnable, times(1)).run();
verify(mockIdleHandler, times(0)).queueIdle();
shadowLooper.runOneTask();
verify(mockRunnable, times(2)).run();
verify(mockIdleHandler, times(1)).queueIdle();
}
@Test
public void runOneTask_executesTask_andIdleHandler_removesIdleHandler() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
IdleHandler mockIdleHandler = mock(IdleHandler.class);
getMainLooper().getQueue().addIdleHandler(mockIdleHandler);
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
verify(mockRunnable, times(0)).run();
verify(mockIdleHandler, times(0)).queueIdle();
shadowLooper.runOneTask();
verify(mockRunnable, times(1)).run();
verify(mockIdleHandler, times(1)).queueIdle();
mainHandler.post(mockRunnable);
shadowLooper.idle();
verify(mockRunnable, times(2)).run();
verify(mockIdleHandler, times(1)).queueIdle(); // It was not kept, does not run again.
}
@Test
public void runOneTask_executesTask_andIdleHandler_keepsIdleHandler() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
IdleHandler mockIdleHandler = mock(IdleHandler.class);
when(mockIdleHandler.queueIdle()).thenReturn(true);
getMainLooper().getQueue().addIdleHandler(mockIdleHandler);
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
verify(mockRunnable, times(0)).run();
verify(mockIdleHandler, times(0)).queueIdle();
shadowLooper.runOneTask();
verify(mockRunnable, times(1)).run();
verify(mockIdleHandler, times(1)).queueIdle();
mainHandler.post(mockRunnable);
shadowLooper.runOneTask();
verify(mockRunnable, times(2)).run();
verify(mockIdleHandler, times(2)).queueIdle(); // It was kept and runs again
}
@Test
public void idleFor_executesTask_mainLooper() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
Handler mainHandler = new Handler();
mainHandler.postDelayed(mockRunnable, 100);
verify(mockRunnable, times(0)).run();
shadowLooper.idle();
verify(mockRunnable, times(0)).run();
shadowLooper.idleFor(Duration.ofMillis(200));
verify(mockRunnable, times(1)).run();
}
@Test
public void idleFor_incrementsTimeTaskByTask() {
final Handler mainHandler = new Handler();
Runnable mockRunnable = mock(Runnable.class);
Runnable postingRunnable =
() -> {
mainHandler.postDelayed(mockRunnable, 100);
};
mainHandler.postDelayed(postingRunnable, 100);
verify(mockRunnable, times(0)).run();
shadowMainLooper().idleFor(Duration.ofMillis(200));
verify(mockRunnable, times(1)).run();
}
@Test
public void idleExecutesPostedRunnables() {
ShadowPausedLooper shadowLooper = Shadow.extract(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
Runnable postingRunnable =
() -> {
Handler mainHandler = new Handler();
mainHandler.post(mockRunnable);
};
Handler mainHandler = new Handler();
mainHandler.post(postingRunnable);
verify(mockRunnable, times(0)).run();
shadowLooper.idle();
verify(mockRunnable, times(1)).run();
}
@Test
public void getNextScheduledTime() {
assertThat(shadowMainLooper().getNextScheduledTaskTime()).isEqualTo(Duration.ZERO);
Handler mainHandler = new Handler();
mainHandler.postDelayed(() -> {}, 100);
assertThat(shadowMainLooper().getNextScheduledTaskTime().toMillis())
.isEqualTo(SystemClock.uptimeMillis() + 100);
}
@Test
public void getLastScheduledTime() {
assertThat(shadowMainLooper().getLastScheduledTaskTime()).isEqualTo(Duration.ZERO);
Handler mainHandler = new Handler();
mainHandler.postDelayed(() -> {}, 200);
mainHandler.postDelayed(() -> {}, 100);
assertThat(shadowMainLooper().getLastScheduledTaskTime().toMillis())
.isEqualTo(SystemClock.uptimeMillis() + 200);
}
@Before
public void assertMainLooperEmpty() {
ShadowPausedMessageQueue queue = Shadow.extract(getMainLooper().getQueue());
assertThat(queue.isIdle()).isTrue();
}
@Test
public void mainLooperQueueIsCleared() {
postToMainLooper();
}
@Test
public void mainLooperQueueIsClearedB() {
postToMainLooper();
}
@Test
public void isIdle_mainLooper() {
assertThat(shadowMainLooper().isIdle()).isTrue();
Handler mainHandler = new Handler();
mainHandler.post(() -> {});
assertThat(shadowMainLooper().isIdle()).isFalse();
shadowMainLooper().idle();
assertThat(shadowMainLooper().isIdle()).isTrue();
}
@Test
public void isIdle_delayed() {
assertThat(shadowMainLooper().isIdle()).isTrue();
Handler mainHandler = new Handler();
mainHandler.postDelayed(() -> {}, 100);
assertThat(shadowMainLooper().isIdle()).isTrue();
ShadowSystemClock.advanceBy(Duration.ofMillis(100));
assertThat(shadowMainLooper().isIdle()).isFalse();
}
@Test
public void isIdle_taskExecuting() throws InterruptedException {
BlockingRunnable runnable = new BlockingRunnable();
Handler handler = new Handler(handlerThread.getLooper());
handler.post(runnable);
assertThat(shadowOf(handlerThread.getLooper()).isIdle()).isFalse();
runnable.latch.countDown();
// poll for isIdle to be true, since it will take some time for queue to clear
for (int i = 0; i < 3 && !shadowOf(handlerThread.getLooper()).isIdle(); i++) {
Thread.sleep(10);
}
assertThat(shadowOf(handlerThread.getLooper()).isIdle()).isTrue();
}
@Test
public void isIdle_paused() throws InterruptedException {
ShadowLooper shadowLooper = shadowOf(handlerThread.getLooper());
shadowLooper.pause();
assertThat(shadowLooper.isIdle()).isTrue();
new Handler(handlerThread.getLooper()).post(mock(Runnable.class));
assertThat(shadowLooper.isIdle()).isFalse();
shadowOf(handlerThread.getLooper()).idle();
assertThat(shadowLooper.isIdle()).isTrue();
}
@Test
public void idle_failsIfThreadQuit() {
ShadowLooper shadowLooper = shadowOf(handlerThread.getLooper());
handlerThread.quit();
try {
shadowLooper.idle();
fail("IllegalStateException not thrown");
} catch (IllegalStateException e) {
// expected
}
}
@Test
public void resetter_allowsStaticHandlerThreadsToBeReused() throws Exception {
Handler handler = new Handler(handlerThread.getLooper());
CountDownLatch countDownLatch1 = new CountDownLatch(1);
handler.post(countDownLatch1::countDown);
assertThat(countDownLatch1.await(30, SECONDS)).isTrue();
ShadowPausedLooper.resetLoopers();
CountDownLatch countDownLatch2 = new CountDownLatch(1);
handler.post(countDownLatch2::countDown);
assertThat(countDownLatch2.await(30, SECONDS)).isTrue();
}
private static class BlockingRunnable implements Runnable {
CountDownLatch latch = new CountDownLatch(1);
@Override
public void run() {
try {
latch.await();
} catch (InterruptedException e) {
}
}
}
private void postToMainLooper() {
// just post a runnable and rely on setUp to check
Handler handler = new Handler(getMainLooper());
Runnable mockRunnable = mock(Runnable.class);
handler.post(mockRunnable);
}
}