Fix disposeNullAndroidView with Robolectric 4.8.1

Before Robolectric 4.8, Surface#lockHardwareCanvas will throw
exception at PlatformViewWrapper#setTexture, because Robolectric
doesn't support to shadow Surface#lockHardwareCanvas, and it
uses real Android logic with native pointer address is 0.
This failure will ensure embeddedView's parent is null, because
PlatformViewsController#createForTextureLayer will fail because
of previous mentioned error, and PlatformViewsController#createForTextureLayer
will not add embeddedView to wrapperView. So this test can pass.
From Robolectric 4.8, it supports to shadow Surface#lockHardwareCanvas
and it can pass with default true valid value, and
PlatformViewsController#createForTextureLayer will run correctly
and add embeddedView to wrapperView, and initializePlatformViewIfNeeded
will fail because embeddedView's parent is not null. So adding a new shadow
class called ShadowReleasedSurface to simulate previous
Surface#lockHardwareCanvas failure to ensure this test can work with
Robolectric 4.8 and later versions. But it is just a workaround,
the root cause is this test case depends on just-failure behavior of
Surface#lockHardwareCanvas in old Robolectric.

Signed-off-by: utzcoz <[email protected]>

Author: utzcoz

shell/platform/android/test/io/flutter/plugin/platform/PlatformViewsControllerTest.java

@@ -10,6 +10,7 @@
 import android.content.Context;
 import android.content.MutableContextWrapper;
 import android.content.res.AssetManager;
+import android.graphics.Canvas;
 import android.graphics.SurfaceTexture;
 import android.util.SparseArray;
 import android.view.MotionEvent;
@@ -53,6 +54,7 @@
 import org.robolectric.annotation.Config;
 import org.robolectric.annotation.Implementation;
 import org.robolectric.annotation.Implements;
+import org.robolectric.shadows.ShadowSurface;
 import org.robolectric.shadows.ShadowSurfaceView;
 
 @Config(manifest = Config.NONE)
@@ -691,7 +693,12 @@ public void disposeAndroidView__hybridComposition() {
   }
 
   @Test
-  @Config(shadows = {ShadowFlutterJNI.class, ShadowPlatformTaskQueue.class})
+  @Config(
+      shadows = {
+        ShadowFlutterJNI.class,
+        ShadowReleasedSurface.class,
+        ShadowPlatformTaskQueue.class
+      })
   public void disposeNullAndroidView() {
     PlatformViewsController platformViewsController = new PlatformViewsController();
 
@@ -711,6 +718,20 @@ public void disposeNullAndroidView() {
     attach(jni, platformViewsController);
 
     // Simulate create call from the framework.
+    // Before Robolectric 4.8, Surface#lockHardwareCanvas will throw exception at
+    // PlatformViewWrapper#setTexture, because Robolectric doesn't support to shadow
+    // Surface#lockHardwareCanvas, and it uses real Android logic with native pointer address is 0.
+    // This failure will ensure embeddedView's parent is null, because
+    // PlatformViewsController#createForTextureLayer will fail because of previous mentioned error,
+    // and PlatformViewsController#createForTextureLayer will not add embeddedView to wrapperView.
+    // So this test can pass. From Robolectric 4.8, it supports to shadow Surface#lockHardwareCanvas
+    // and it can pass with default true valid value, and
+    // PlatformViewsController#createForTextureLayer will run correctly and add embeddedView to
+    // wrapperView, and initializePlatformViewIfNeeded will fail because embeddedView's parent is
+    // not null. So adding a new shadow class called ShadowReleasedSurface to simulate previous
+    // Surface#lockHardwareCanvas failure to ensure this test can work with Robolectric 4.8 and
+    // later versions. But it is just a workaround, the root cause is this test case depends on
+    // just-failure behavior of Surface#lockHardwareCanvas in old Robolectric.
     createPlatformView(
         jni, platformViewsController, platformViewId, "testType", /* hybrid=*/ false);
     platformViewsController.initializePlatformViewIfNeeded(platformViewId);
@@ -1339,6 +1360,22 @@ public void dispatch(Runnable runnable) {
     }
   }
 
+  /**
+   * The shadow class of {@link Surface} to simulate released surface.
+   *
+   * <p>This shadow class's usage is restricted, not for normal purpose.
+   */
+  @Implements(Surface.class)
+  public static class ShadowReleasedSurface extends ShadowSurface {
+    public ShadowReleasedSurface() {}
+
+    @Implementation
+    @Override
+    protected Canvas lockHardwareCanvas() {
+      throw new IllegalStateException("Surface has already been released.");
+    }
+  }
+
   @Implements(FlutterJNI.class)
   public static class ShadowFlutterJNI {
     private static SparseArray<ByteBuffer> replies = new SparseArray<>();