Add ViewActions.captureToBitmap

This API will replace ViewInteraction.captureToBitmap in a subsequent change.

PiperOrigin-RevId: 615565807

Author: brettchabot

espresso/CHANGELOG.md

@@ -27,6 +27,8 @@ The following artifacts were released:
 
 **API Changes**
 
+* Delete ViewInteraction.captureToBitmap in favor of ViewActions.captureToBitmap
+
 **Breaking API Changes**
 
 **Known Issues**

espresso/core/java/androidx/test/espresso/action/BUILD

@@ -2,6 +2,7 @@
 #  View Actions for espresso.
 
 load("@build_bazel_rules_android//android:rules.bzl", "android_library")
+load("//build_extensions:kt_android_library.bzl", "kt_android_library")
 
 licenses(["notice"])
 
@@ -30,15 +31,20 @@ android_library(
     ],
 )
 
-android_library(
+kt_android_library(
     name = "action",
     srcs = glob(
-        ["*.java"],
+        [
+            "*.java",
+            "*.kt",
+        ],
         exclude = ADAPTER_VIEW_PROTOCOL,
     ),
     javacopts = COMMON_JAVACOPTS,
     deps = [
         ":adapter_view_protocol",
+        "//annotation/java/androidx/test/annotation",
+        "//core/java/androidx/test/core:core_not_test_only",
         "//espresso/core/java/androidx/test/espresso:framework",
         "//espresso/core/java/androidx/test/espresso:interface",
         "//espresso/core/java/androidx/test/espresso/matcher",

espresso/core/java/androidx/test/espresso/action/CaptureToBitmapAction.kt

@@ -0,0 +1,46 @@
+package androidx.test.espresso.action
+
+import android.os.Handler
+import android.os.Looper
+import android.view.View
+import androidx.test.annotation.ExperimentalTestApi
+import androidx.test.core.internal.os.HandlerExecutor
+import androidx.test.core.view.captureToBitmap
+import androidx.test.espresso.IdlingRegistry
+import androidx.test.espresso.UiController
+import androidx.test.espresso.ViewAction
+import java.util.Locale
+import java.util.concurrent.TimeUnit
+import org.hamcrest.Matcher
+import org.hamcrest.Matchers.any
+
+@ExperimentalTestApi
+class CaptureToBitmapAction(val bitmapReceiver: ViewActions.BitmapReceiver) : ViewAction {
+  override fun getConstraints(): Matcher<View> {
+    return any(View::class.java)
+  }
+
+  override fun getDescription(): String {
+    return String.format(Locale.ROOT, "capture view to Bitmap")
+  }
+
+  override fun perform(uiController: UiController, view: View) {
+    uiController.loopMainThreadUntilIdle()
+    // Create an idling resource for the bitmap creation work.
+    val captureIdlingResource = RunnableIdlingResource()
+    IdlingRegistry.getInstance().register(captureIdlingResource)
+
+    // Have the bitmap mark the idling resource as idle when it completes.
+    val futureBitmap = view.captureToBitmap()
+    val mainExecutor = HandlerExecutor(Handler(Looper.getMainLooper()))
+    futureBitmap.addListener(captureIdlingResource, mainExecutor)
+
+    // Wait for it to complete and unregister
+    uiController.loopMainThreadUntilIdle()
+    IdlingRegistry.getInstance().unregister(captureIdlingResource)
+
+    // Acquire the bitmap (should be instant)
+    val destBitmap = futureBitmap.get(1, TimeUnit.MILLISECONDS)
+    bitmapReceiver.onBitmapCaptured(destBitmap)
+  }
+}

espresso/core/java/androidx/test/espresso/action/RunnableIdlingResource.kt

@@ -0,0 +1,28 @@
+package androidx.test.espresso.action
+
+import androidx.test.espresso.IdlingResource
+import java.util.concurrent.atomic.AtomicBoolean
+
+/** An idling resource that waits for a callback to mark it as idle. */
+internal class RunnableIdlingResource : IdlingResource, Runnable {
+
+  private var idle: AtomicBoolean = AtomicBoolean(false)
+  private var resourceCallback: IdlingResource.ResourceCallback? = null
+
+  override fun getName(): String {
+    return "RunnableIdlingResource"
+  }
+
+  override fun isIdleNow(): Boolean {
+    return idle.get()
+  }
+
+  override fun registerIdleTransitionCallback(callback: IdlingResource.ResourceCallback) {
+    this.resourceCallback = callback
+  }
+
+  override fun run() {
+    idle.set(true)
+    resourceCallback?.onTransitionToIdle()
+  }
+}

espresso/core/java/androidx/test/espresso/action/ViewActions.java

@@ -21,6 +21,7 @@
 import static org.hamcrest.Matchers.any;
 import static org.hamcrest.Matchers.is;
 
+import android.graphics.Bitmap;
 import android.net.Uri;
 import android.util.Log;
 import android.util.Pair;
@@ -29,6 +30,7 @@
 import android.view.MotionEvent;
 import android.view.View;
 import androidx.annotation.NonNull;
+import androidx.test.annotation.ExperimentalTestApi;
 import androidx.test.espresso.PerformException;
 import androidx.test.espresso.UiController;
 import androidx.test.espresso.ViewAction;
@@ -568,4 +570,23 @@ public static ViewAction repeatedlyUntil(
     return actionWithAssertions(
         new RepeatActionUntilViewState(action, desiredStateMatcher, maxAttempts));
   }
+
+  @ExperimentalTestApi
+  public interface BitmapReceiver {
+    void onBitmapCaptured(Bitmap bitmap);
+  }
+
+  /**
+   * Returns an action that captures an image of the desired View and performs some other operation
+   * on the result.
+   *
+   * @see androidx.test.core.view.ViewCapture.captureToBitmap
+   * @param bitmapReceiver the BitmapReceiver that receives the result. This will be called on main
+   *     thread.
+   * @return the ViewAction
+   */
+  @ExperimentalTestApi
+  public static ViewAction captureToBitmap(BitmapReceiver bitmapReceiver) {
+    return new CaptureToBitmapAction(bitmapReceiver);
+  }
 }

espresso/core/javatests/androidx/test/espresso/action/BUILD

@@ -391,3 +391,18 @@ axt_android_library_test(
         "@maven//:junit_junit",
     ],
 )
+
+axt_android_library_test(
+    name = "CaptureToBitmapActionTest",
+    srcs =
+        ["CaptureToBitmapActionTest.kt"],
+    deps = [
+        "//core",
+        "//espresso/core/java/androidx/test/espresso",
+        "//espresso/core/java/androidx/test/espresso:espresso_compiletime",
+        "//ext/junit",
+        "//testapps/ui_testapp/java/androidx/test/ui/app:lib_exported",
+        "@maven//:com_google_truth_truth",
+        "@maven//:junit_junit",
+    ],
+)

espresso/core/javatests/androidx/test/espresso/action/CaptureToBitmapActionTest.kt

@@ -0,0 +1,26 @@
+package androidx.test.espresso.action
+
+import androidx.test.core.graphics.writeToTestStorage
+import androidx.test.espresso.Espresso.onView
+import androidx.test.espresso.action.ViewActions.captureToBitmap
+import androidx.test.espresso.matcher.ViewMatchers
+import androidx.test.ext.junit.rules.ActivityScenarioRule
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.ui.app.MainActivity
+import java.io.IOException
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+
+/** A simple scuba test to ensure captureToImage works from hjava */
+@RunWith(AndroidJUnit4::class)
+class CaptureToBitmapActionTest {
+  @JvmField @Rule var activityScenarioRule = ActivityScenarioRule(MainActivity::class.java)
+
+  @Test
+  @Throws(IOException::class)
+  fun captureToBitmapAndSave() {
+    onView(ViewMatchers.isRoot())
+      .perform(captureToBitmap { bitmap -> bitmap.writeToTestStorage("captureToBitmapAndSave") })
+  }
+}