forked from flutter/engine
-
Notifications
You must be signed in to change notification settings - Fork 2
/
FlutterEngineTest.java
326 lines (273 loc) · 12.3 KB
/
FlutterEngineTest.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
package test.io.flutter.embedding.engine;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.anyInt;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import android.content.Context;
import android.content.pm.PackageManager.NameNotFoundException;
import android.content.res.Configuration;
import android.content.res.Resources;
import android.os.LocaleList;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import io.flutter.FlutterInjector;
import io.flutter.embedding.engine.FlutterEngine;
import io.flutter.embedding.engine.FlutterEngine.EngineLifecycleListener;
import io.flutter.embedding.engine.FlutterJNI;
import io.flutter.embedding.engine.loader.FlutterLoader;
import io.flutter.plugin.platform.PlatformViewsController;
import io.flutter.plugins.GeneratedPluginRegistrant;
import java.util.List;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.robolectric.annotation.Config;
import org.robolectric.shadows.ShadowLog;
@Config(manifest = Config.NONE)
@RunWith(AndroidJUnit4.class)
public class FlutterEngineTest {
private final Context ctx = ApplicationProvider.getApplicationContext();
private final Context mockContext = mock(Context.class);
@Mock FlutterJNI flutterJNI;
boolean jniAttached;
@Before
public void setUp() {
MockitoAnnotations.openMocks(this);
Resources mockResources = mock(Resources.class);
Configuration mockConfiguration = mock(Configuration.class);
doReturn(mockResources).when(mockContext).getResources();
doReturn(mockConfiguration).when(mockResources).getConfiguration();
doReturn(LocaleList.getEmptyLocaleList()).when(mockConfiguration).getLocales();
jniAttached = false;
when(flutterJNI.isAttached()).thenAnswer(invocation -> jniAttached);
doAnswer(
new Answer() {
@Override
public Object answer(InvocationOnMock invocation) throws Throwable {
jniAttached = true;
return null;
}
})
.when(flutterJNI)
.attachToNative();
GeneratedPluginRegistrant.clearRegisteredEngines();
}
@After
public void tearDown() {
GeneratedPluginRegistrant.clearRegisteredEngines();
// Make sure to not forget to remove the mock exception in the generated plugin registration
// mock, or everything subsequent will break.
GeneratedPluginRegistrant.pluginRegistrationException = null;
}
@Test
public void itAutomaticallyRegistersPluginsByDefault() {
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(true);
FlutterEngine flutterEngine = new FlutterEngine(ctx, mockFlutterLoader, flutterJNI);
List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
assertEquals(1, registeredEngines.size());
assertEquals(flutterEngine, registeredEngines.get(0));
}
@Test
public void itSendLocalesOnEngineInit() {
FlutterJNI mockFlutterJNI = mock(FlutterJNI.class);
when(mockFlutterJNI.isAttached()).thenReturn(true);
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(true);
FlutterEngine flutterEngine = new FlutterEngine(ctx, mockFlutterLoader, mockFlutterJNI);
verify(mockFlutterJNI, times(1))
.dispatchPlatformMessage(eq("flutter/localization"), any(), anyInt(), anyInt());
}
// Helps show the root cause of MissingPluginException type errors like
// https://github.com/flutter/flutter/issues/78625.
@Test
public void itCatchesAndDisplaysRegistrationExceptions() {
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
GeneratedPluginRegistrant.pluginRegistrationException =
new RuntimeException("I'm a bug in the plugin");
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(true);
FlutterEngine flutterEngine = new FlutterEngine(ctx, mockFlutterLoader, flutterJNI);
List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
// When it crashes, it doesn't end up registering anything.
assertEquals(0, registeredEngines.size());
// Check the logs actually says registration failed, so a subsequent MissingPluginException
// isn't mysterious.
assertTrue(
ShadowLog.getLogsForTag("GeneratedPluginsRegister")
.get(0)
.msg
.contains("Tried to automatically register plugins"));
assertEquals(
GeneratedPluginRegistrant.pluginRegistrationException,
ShadowLog.getLogsForTag("GeneratedPluginsRegister").get(1).throwable.getCause());
GeneratedPluginRegistrant.pluginRegistrationException = null;
}
@Test
public void itDoesNotAutomaticallyRegistersPluginsWhenFlutterLoaderDisablesIt() {
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(false);
new FlutterEngine(ctx, mockFlutterLoader, flutterJNI);
List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
assertTrue(registeredEngines.isEmpty());
}
@Test
public void itDoesNotAutomaticallyRegistersPluginsWhenFlutterEngineDisablesIt() {
assertTrue(GeneratedPluginRegistrant.getRegisteredEngines().isEmpty());
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
when(mockFlutterLoader.automaticallyRegisterPlugins()).thenReturn(true);
new FlutterEngine(
ctx,
mockFlutterLoader,
flutterJNI,
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);
List<FlutterEngine> registeredEngines = GeneratedPluginRegistrant.getRegisteredEngines();
assertTrue(registeredEngines.isEmpty());
}
@Test
public void itNotifiesPlatformViewsControllerWhenDevHotRestart() {
// Setup test.
FlutterJNI mockFlutterJNI = mock(FlutterJNI.class);
when(mockFlutterJNI.isAttached()).thenReturn(true);
PlatformViewsController platformViewsController = mock(PlatformViewsController.class);
ArgumentCaptor<FlutterEngine.EngineLifecycleListener> engineLifecycleListenerArgumentCaptor =
ArgumentCaptor.forClass(FlutterEngine.EngineLifecycleListener.class);
// Execute behavior under test.
new FlutterEngine(
ctx,
mock(FlutterLoader.class),
mockFlutterJNI,
platformViewsController,
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);
// Obtain the EngineLifecycleListener within FlutterEngine that was given to FlutterJNI.
verify(mockFlutterJNI)
.addEngineLifecycleListener(engineLifecycleListenerArgumentCaptor.capture());
FlutterEngine.EngineLifecycleListener engineLifecycleListener =
engineLifecycleListenerArgumentCaptor.getValue();
assertNotNull(engineLifecycleListener);
// Simulate a pre-engine restart, AKA hot restart.
engineLifecycleListener.onPreEngineRestart();
// Verify that FlutterEngine notified PlatformViewsController of the pre-engine restart,
// AKA hot restart.
verify(platformViewsController, times(1)).onPreEngineRestart();
}
@Test
public void itNotifiesPlatformViewsControllerAboutJNILifecycle() {
PlatformViewsController platformViewsController = mock(PlatformViewsController.class);
// Execute behavior under test.
FlutterEngine engine =
new FlutterEngine(
ctx,
mock(FlutterLoader.class),
flutterJNI,
platformViewsController,
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);
verify(platformViewsController, times(1)).onAttachedToJNI();
engine.destroy();
verify(platformViewsController, times(1)).onDetachedFromJNI();
}
@Test
public void itUsesApplicationContext() throws NameNotFoundException {
Context packageContext = mock(Context.class);
when(mockContext.createPackageContext(any(), anyInt())).thenReturn(packageContext);
new FlutterEngine(
mockContext,
mock(FlutterLoader.class),
flutterJNI,
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);
verify(mockContext, atLeast(1)).getApplicationContext();
}
@Test
public void itUsesPackageContextForAssetManager() throws NameNotFoundException {
Context packageContext = mock(Context.class);
when(mockContext.createPackageContext(any(), anyInt())).thenReturn(packageContext);
new FlutterEngine(
mockContext,
mock(FlutterLoader.class),
flutterJNI,
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);
verify(packageContext, atLeast(1)).getAssets();
verify(mockContext, times(0)).getAssets();
}
@Test
public void itCanUseFlutterLoaderInjectionViaFlutterInjector() throws NameNotFoundException {
FlutterInjector.reset();
FlutterLoader mockFlutterLoader = mock(FlutterLoader.class);
FlutterInjector.setInstance(
new FlutterInjector.Builder().setFlutterLoader(mockFlutterLoader).build());
Context packageContext = mock(Context.class);
when(mockContext.createPackageContext(any(), anyInt())).thenReturn(packageContext);
new FlutterEngine(mockContext, null, flutterJNI);
verify(mockFlutterLoader, times(1)).startInitialization(any());
verify(mockFlutterLoader, times(1)).ensureInitializationComplete(any(), any());
FlutterInjector.reset();
}
@Test
public void itNotifiesListenersForDestruction() throws NameNotFoundException {
Context packageContext = mock(Context.class);
when(mockContext.createPackageContext(any(), anyInt())).thenReturn(packageContext);
FlutterEngine engineUnderTest =
new FlutterEngine(
mockContext,
mock(FlutterLoader.class),
flutterJNI,
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);
EngineLifecycleListener listener = mock(EngineLifecycleListener.class);
engineUnderTest.addEngineLifecycleListener(listener);
engineUnderTest.destroy();
verify(listener, times(1)).onEngineWillDestroy();
}
@Test
public void itDoesNotAttachAgainWhenBuiltWithAnAttachedJNI() throws NameNotFoundException {
Context packageContext = mock(Context.class);
when(mockContext.createPackageContext(any(), anyInt())).thenReturn(packageContext);
when(flutterJNI.isAttached()).thenReturn(true);
FlutterEngine engineUnderTest =
new FlutterEngine(
mockContext,
mock(FlutterLoader.class),
flutterJNI,
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);
verify(flutterJNI, never()).attachToNative();
}
@Test
public void itComesWithARunningDartExecutorIfJNIIsAlreadyAttached() throws NameNotFoundException {
Context packageContext = mock(Context.class);
when(mockContext.createPackageContext(any(), anyInt())).thenReturn(packageContext);
when(flutterJNI.isAttached()).thenReturn(true);
FlutterEngine engineUnderTest =
new FlutterEngine(
mockContext,
mock(FlutterLoader.class),
flutterJNI,
/*dartVmArgs=*/ new String[] {},
/*automaticallyRegisterPlugins=*/ false);
assertTrue(engineUnderTest.getDartExecutor().isExecutingDart());
}
}